feat(winforms): location support

.github/workflows/ci.yml

@@ -403,6 +403,7 @@ jobs:
       with:
         name: testbed-failure-logs-${{ matrix.backend }}
         path: testbed/logs/*
+        include-hidden-files: true
 
     - name: Copy App Generated User Data
       if: failure() && matrix.backend != 'android'

changes/2979.feature.rst

@@ -0,0 +1 @@
+Location support is now available on Windows

docs/reference/data/widgets_by_platform.csv

@@ -30,7 +30,7 @@ ScrollContainer,Layout Widget,:class:`~toga.ScrollContainer`,A container that ca
 SplitContainer,Layout Widget,:class:`~toga.SplitContainer`,A container that divides an area into two panels with a movable border,|y|,|y|,|y|,,,,
 OptionContainer,Layout Widget,:class:`~toga.OptionContainer`,A container that can display multiple labeled tabs of content,|y|,|y|,|y|,|y|,|y|,,
 Camera,Hardware,:class:`~toga.hardware.camera.Camera`,A sensor that can capture photos and/or video.,|y|,,,|y|,|y|,,
-Location,Hardware,:class:`~toga.hardware.location.Location`,A sensor that can capture the geographical location of the device.,|y|,,,|y|,|y|,,
+Location,Hardware,:class:`~toga.hardware.location.Location`,A sensor that can capture the geographical location of the device.,|y|,,|y|,|y|,|y|,,
 Screen,Hardware,:class:`~toga.screens.Screen`,A representation of a screen attached to a device.,|y|,|y|,|y|,|y|,|y|,|b|,|b|
 App Paths,Resource,:class:`~toga.paths.Paths`,A mechanism for obtaining platform-appropriate filesystem locations for an application.,|y|,|y|,|y|,|y|,|y|,,|b|
 Command,Resource,:class:`~toga.Command`,Command,|y|,|y|,|y|,,|y|,,

testbed/tests/hardware/test_location.py

@@ -10,7 +10,7 @@
 
 @pytest.fixture
 async def location_probe(monkeypatch, app_probe):
-    skip_on_platforms("linux", "windows")
+    skip_on_platforms("linux")
     probe = get_probe(monkeypatch, app_probe, "Location")
     yield probe
     probe.cleanup()
@@ -90,6 +90,8 @@ async def test_grant_background_permission(app, location_probe):
 
 async def test_deny_background_permission(app, location_probe):
     """A user can deny background permission to use location."""
+    skip_on_platforms("windows")
+
     # Foreground permissions haven't been approved, so requesting background permissions
     # will raise an error.
     with pytest.raises(

testbed/tests/testbed.py

@@ -139,11 +139,17 @@ def run_tests(app, cov, args, report_coverage, run_slow, running_in_ci):
                 "win32": "toga_winforms",
             }.get(sys.platform)
 
+    if "CI" in os.environ:
+        data_file = (
+            Path(os.environ["GITHUB_WORKSPACE"]) / "testbed" / "logs" / ".coverage"
+        )
+    else:
+        data_file = None
+
     # Start coverage tracking.
     # This needs to happen in the main thread, before the app has been created
     cov = coverage.Coverage(
-        # Don't store any coverage data
-        data_file=None,
+        data_file=data_file,
         branch=True,
         source_pkgs=[toga_backend],
     )

winforms/src/toga_winforms/factory.py

@@ -4,6 +4,7 @@
 from .app import App
 from .command import Command
 from .fonts import Font
+from .hardware.location import Location
 from .icons import Icon
 from .images import Image
 from .paths import Paths
@@ -61,6 +62,7 @@ def not_implemented(feature):
     "Divider",
     "ImageView",
     "Label",
+    "Location",
     "MapView",
     "MultilineTextInput",
     "NumberInput",

winforms/src/toga_winforms/hardware/__init__.py

@@ -0,0 +1,3 @@
+import clr
+
+clr.AddReference("System.Device")

winforms/src/toga_winforms/hardware/location.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+from System import EventHandler
+from System.Device.Location import (
+    GeoCoordinate,
+    GeoCoordinateWatcher,
+    GeoPositionAccuracy,
+    GeoPositionChangedEventArgs,
+    GeoPositionPermission,
+)
+
+from toga import LatLng
+from toga.handlers import AsyncResult
+
+
+def toga_location(location: GeoCoordinate):
+    """Convert a GeoCoordinate into a Toga LatLng and altitude."""
+
+    if location.IsUnknown:
+        return None
+
+    return {
+        "location": LatLng(location.Latitude, location.Longitude),
+        "altitude": location.Altitude,
+    }
+
+
+class Location:
+    def __init__(self, interface):
+        self.interface = interface
+        self.watcher = GeoCoordinateWatcher(GeoPositionAccuracy.Default)
+        self._handler = EventHandler[GeoPositionChangedEventArgs[GeoCoordinate]](
+            self._position_changed
+        )
+        self._has_background_permission = False
+
+    def _position_changed(
+        self, sender, event: GeoPositionChangedEventArgs[GeoCoordinate]
+    ):
+        location = toga_location(event.Position.Location)
+        if location:
+            self.interface.on_change(**location)
+
+    def has_permission(self):
+        return self.watcher.Permission == GeoPositionPermission.Granted
+
+    def has_background_permission(self):
+        return self._has_background_permission
+
+    def request_permission(self, future: AsyncResult[bool]) -> None:
+        self.watcher.Start(False)  # TODO: where can we call stop?
+        future.set_result(self.has_permission())
+
+    def request_background_permission(self, future: AsyncResult[bool]) -> None:
+        if not self.has_permission():
+            raise PermissionError()
+        future.set_result(True)
+        self._has_background_permission = True
+
+    def current_location(self, result: AsyncResult[dict]) -> None:
+        self.watcher.Start()  # ensure watcher has started
+        loco = toga_location(self.watcher.Position.Location)
+        result.set_result(loco["location"] if loco else None)
+
+    def start_tracking(self) -> None:
+        self.watcher.Start()  # ensure watcher has started
+        self.watcher.add_PositionChanged(self._handler)
+
+    def stop_tracking(self) -> None:
+        self.watcher.remove_PositionChanged(self._handler)

winforms/tests_backend/hardware/hardware.py

@@ -0,0 +1,9 @@
+from ..app import AppProbe
+
+
+class HardwareProbe(AppProbe):
+
+    def __init__(self, monkeypatch, app_probe):
+        super().__init__(app_probe.app)
+
+        self.monkeypatch = monkeypatch

winforms/tests_backend/hardware/location.py

@@ -0,0 +1,72 @@
+from unittest.mock import Mock
+
+from pytest import xfail
+from System.Device.Location import (
+    GeoCoordinate,
+    GeoCoordinateWatcher,
+    GeoPositionPermission,
+)
+
+from toga.types import LatLng
+
+from .hardware import HardwareProbe
+
+
+class LocationProbe(HardwareProbe):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.app.location._impl.watcher = Mock(spec=GeoCoordinateWatcher)
+        self.reset_locations()
+
+    def cleanup(self):
+        # Delete the location service instance. This ensures that a freshly mocked
+        # LocationManager is installed for each test.
+        try:
+            del self.app._location
+        except AttributeError:
+            pass
+
+    def allow_permission(self):
+        self.app.location._impl.watcher.Permission = GeoPositionPermission.Granted
+
+    def grant_permission(self):
+        self.app.location._impl.watcher.Permission = GeoPositionPermission.Granted
+
+    def reject_permission(self):
+        self.app.location._impl.watcher.Permission = GeoPositionPermission.Denied
+
+    def add_location(self, location: LatLng, altitude, cached=False):
+        m = Mock(spec=GeoCoordinate)
+        m.Position = Mock()
+        m.Position.Location = Mock()
+        m.Position.Location.IsUnknown = False
+        m.Position.Location.Latitude = location.lat
+        m.Position.Location.Longitude = location.lng
+        m.Position.Location.Altitude = altitude
+
+        self._locations.append(m)
+        self.app.location._impl.watcher.Position = m.Position
+
+    def reset_locations(self):
+        self._locations = []
+
+    def allow_background_permission(self):
+        """
+        winforms doesn't distinguish between foreground and background access
+        """
+        pass
+
+    async def simulate_location_error(self, loco):
+        await self.redraw("Wait for location error")
+
+        xfail("Winforms's location service doesn't raise errors on failure")
+
+    async def simulate_current_location(self, location):
+        await self.redraw("Wait for current location")
+
+        self.reset_locations()
+
+        return await location
+
+    async def simulate_location_update(self):
+        self.app.location._impl._position_changed(None, self._locations[-1])