flet-geolocator 0.2.0.dev35__tar.gz → 0.2.0.dev45__tar.gz

{flet_geolocator-0.2.0.dev35/src/flet_geolocator.egg-info → flet_geolocator-0.2.0.dev45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-geolocator
-Version: 0.2.0.dev35
+Version: 0.2.0.dev45
 Summary: Adds geolocation capabilities to your Flet apps.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0

{flet_geolocator-0.2.0.dev35 → flet_geolocator-0.2.0.dev45}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flet-geolocator"
-version = "0.2.0.dev35"
+version = "0.2.0.dev45"
 description = "Adds geolocation capabilities to your Flet apps."
 readme = "README.md"
 authors = [{ name = "Flet contributors", email = "hello@flet.dev" }]
@@ -20,22 +20,43 @@ Issues = "https://github.com/flet-dev/flet-geolocator/issues"
 "flutter.flet_geolocator" = ["**/*"]
 
 [dependency-groups]
+test = [
+    "pytest >=7.2.0",
+]
+lint = [
+    "ruff >=0.11.7",
+]
 dev = [
-    "pre-commit>=4.2.0",
-    "ruff>=0.11.7",
+    "pre-commit >=4.2.0",
+    { include-group = 'lint' },
+    { include-group = 'test' },
+]
+docs-coverage = [
+    "docstr-coverage >=2.3.2",
 ]
 docs = [
-    "mkdocs",
-    "mkdocs-material",
-    "mkdocstrings[python]",
-    "mkdocstrings-python-xref",
-    "mike",
-    "markdown>=3.6",
-    "pymdown-extensions",
-    "mkdocs-glightbox",
-    "mkdocs-section-index",
-    "griffe-modernized-annotations",
-    "pygments>=2.16",
+    "mkdocs >=1.6.1",
+    "mkdocs-material >=9.6.15",
+    "mkdocstrings-python >=1.16.12",
+    "mkdocstrings-python-xref >=1.16.3",
+    "mike >=2.1.3",
+    "markdown >=3.6",
+    "pymdown-extensions >=10.16",
+    "mkdocs-exclude >=1.0.2",
+    "mkdocs-glightbox >=0.4.0",
+    "mkdocs-open-in-new-tab >=1.0.8",
+    "mkdocs-section-index >=0.3.10",
+    "griffe-modernized-annotations >=1.0.8",
+    "griffe-warnings-deprecated >=1.1.0",
+    "pygments >=2.16",
+    "markdown-exec[ansi] >=1.11.0",
+    "pydocstyle >=6.3.0",
+    "linkcheckmd >=1.4.0",
+    { include-group = 'docs-coverage' },
+]
+all = [
+    { include-group = 'dev' },
+    { include-group = 'docs' },
 ]
 
 [build-system]
@@ -64,6 +85,7 @@ select = [
     "I"
 ]
 preview = true
+pydocstyle = { convention = 'google' }
 
 [tool.ruff.format]
 quote-style = "double"

{flet_geolocator-0.2.0.dev35 → flet_geolocator-0.2.0.dev45}/src/flet_geolocator/__init__.py

@@ -11,3 +11,17 @@ from .types import (
     GeolocatorPositionChangeEvent,
     GeolocatorWebConfiguration,
 )
+
+__all__ = [
+    "ForegroundNotificationConfiguration",
+    "Geolocator",
+    "GeolocatorAndroidConfiguration",
+    "GeolocatorConfiguration",
+    "GeolocatorIosActivityType",
+    "GeolocatorIosConfiguration",
+    "GeolocatorPermissionStatus",
+    "GeolocatorPosition",
+    "GeolocatorPositionAccuracy",
+    "GeolocatorPositionChangeEvent",
+    "GeolocatorWebConfiguration",
+]

{flet_geolocator-0.2.0.dev35 → flet_geolocator-0.2.0.dev45}/src/flet_geolocator/geolocator.py

@@ -19,7 +19,8 @@ class Geolocator(ft.Service):
     """
     A control that allows you to fetch GPS data from your device.
 
-    This control is non-visual and should be added to `page.overlay` list.
+    This control is non-visual and should be added to
+    [`Page.overlay`][flet.] list.
     """
 
     configuration: Optional[GeolocatorConfiguration] = None
@@ -27,23 +28,22 @@ class Geolocator(ft.Service):
     Some additional configuration.
     """
 
-    on_position_change: ft.OptionalEventHandler[
-        GeolocatorPositionChangeEvent["Geolocator"]
-    ] = None
+    on_position_change: Optional[ft.EventHandler[GeolocatorPositionChangeEvent]] = None
     """
     Fires when the position of the device changes.
-
-    Event handler argument is of type [`GeolocatorPositionChangeEvent`][(p).].
     """
 
-    on_error: ft.OptionalControlEventHandler["Geolocator"] = None
+    on_error: Optional[ft.ControlEventHandler["Geolocator"]] = None
     """
     Fires when an error occurs.
-    
-    The `data` property of the event handler argument contains information on the error. 
+
+    The [`data`][flet.Event.data] property of the event
+    handler argument contains information on the error.
     """
 
-    position: Optional[GeolocatorPosition] = field(default=None, init=False)  # todo: make this property readonly
+    position: Optional[GeolocatorPosition] = field(
+        default=None, init=False
+    )  # TODO: make this property readonly
     """
     The current position of the device. (read-only)
 
@@ -58,19 +58,24 @@ class Geolocator(ft.Service):
         """
         Gets the current position of the device with the desired accuracy and settings.
 
+        Note:
+            Depending on the availability of different location services,
+            this can take several seconds. It is recommended to call the
+            [`get_last_known_position`][..] method first to receive a
+            known/cached position and update it with the result of the
+            [`get_current_position`][..] method.
+
         Args:
             configuration: Additional configuration for the location request.
-                If not specified, then the [`Geolocator.configuration`][(p).] property is used.
+                If not specified, then the [`Geolocator.configuration`][(p).]
+                property is used.
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             The current position of the device as a [`GeolocatorPosition`][(p).].
+
         Raises:
             TimeoutError: If the request times out.
-
-        Note:
-            Depending on the availability of different location services, this can take several seconds.
-            It is recommended to call the [`get_last_known_position`][..] method first to receive a
-            known/cached position and update it with the result of the [`get_current_position`][..] method.
         """
         r = await self._invoke_method_async(
             method_name="get_current_position",
@@ -84,21 +89,27 @@ class Geolocator(ft.Service):
     ) -> GeolocatorPosition:
         """
         Gets the last known position stored on the user's device.
-        The accuracy can be defined using the [`Geolocator.configuration`][(p).] property.
+        The accuracy can be defined using the
+        [`Geolocator.configuration`][(p).] property.
 
         Note:
             This method is not supported on web plaform.
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
-            `True` if the app's settings were opened successfully, `False` otherwise.
+            The last known position of the device as a [`GeolocatorPosition`][(p).].
+
         Raises:
             AssertionError: If invoked on a web platform.
             TimeoutError: If the request times out.
         """
         assert not self.page.web, "get_last_known_position is not supported on web"
-        r = await self._invoke_method_async("get_last_known_position", timeout=timeout)
+        r = await self._invoke_method_async(
+            "get_last_known_position",
+            timeout=timeout,
+        )
         return GeolocatorPosition(**r)
 
     async def get_permission_status_async(
@@ -109,12 +120,17 @@ class Geolocator(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             The status of the permission.
+
         Raises:
             TimeoutError: If the request times out.
         """
-        r = await self._invoke_method_async("get_permission_status", timeout=timeout)
+        r = await self._invoke_method_async(
+            "get_permission_status",
+            timeout=timeout,
+        )
         return GeolocatorPermissionStatus(r)
 
     async def request_permission_async(
@@ -125,12 +141,17 @@ class Geolocator(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             The status of the permission request.
+
         Raises:
             TimeoutError: If the request times out.
         """
-        r = await self._invoke_method_async("request_permission", timeout=timeout)
+        r = await self._invoke_method_async(
+            "request_permission",
+            timeout=timeout,
+        )
         return GeolocatorPermissionStatus(r)
 
     async def is_location_service_enabled_async(self, timeout: float = 10) -> bool:
@@ -139,8 +160,10 @@ class Geolocator(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             `True` if location service is enabled, `False` otherwise.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -157,14 +180,19 @@ class Geolocator(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             `True` if the app's settings were opened successfully, `False` otherwise.
+
         Raises:
             AssertionError: If invoked on a web platform.
             TimeoutError: If the request times out.
         """
         assert not self.page.web, "open_app_settings is not supported on web"
-        return await self._invoke_method_async("open_app_settings", timeout=timeout)
+        return await self._invoke_method_async(
+            "open_app_settings",
+            timeout=timeout,
+        )
 
     def open_location_settings(self, timeout: float = 10):
         """
@@ -175,8 +203,10 @@ class Geolocator(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             `True` if the device's settings were opened successfully, `False` otherwise.
+
         Raises:
             AssertionError: If invoked on a web platform.
             TimeoutError: If the request times out.
@@ -192,14 +222,19 @@ class Geolocator(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             `True` if the device's settings were opened successfully, `False` otherwise.
+
         Raises:
             AssertionError: If invoked on a web platform.
             TimeoutError: If the request times out.
         """
         assert not self.page.web, "open_location_settings is not supported on web"
-        await self._invoke_method_async("open_location_settings", timeout=timeout)
+        await self._invoke_method_async(
+            "open_location_settings",
+            timeout=timeout,
+        )
 
     async def distance_between_async(
         self,
@@ -221,8 +256,10 @@ class Geolocator(ft.Service):
             end_latitude: The latitude of the ending point, in degrees.
             end_longitude: The longitude of the ending point, in degrees.
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             The distance between the coordinates in meters.
+
         Raises:
             TimeoutError: If the request times out.
         """

{flet_geolocator-0.2.0.dev35 → flet_geolocator-0.2.0.dev45}/src/flet_geolocator/types.py

@@ -1,21 +1,24 @@
 import datetime
 from dataclasses import dataclass, field
 from enum import Enum
-from typing import Optional
+from typing import TYPE_CHECKING, Optional
 
 import flet as ft
 
+if TYPE_CHECKING:
+    from .geolocator import Geolocator  # noqa
+
 __all__ = [
-    "GeolocatorPositionAccuracy",
-    "GeolocatorPermissionStatus",
-    "GeolocatorIosActivityType",
-    "GeolocatorPosition",
+    "ForegroundNotificationConfiguration",
+    "GeolocatorAndroidConfiguration",
     "GeolocatorConfiguration",
-    "GeolocatorWebConfiguration",
+    "GeolocatorIosActivityType",
     "GeolocatorIosConfiguration",
-    "GeolocatorAndroidConfiguration",
+    "GeolocatorPermissionStatus",
+    "GeolocatorPosition",
+    "GeolocatorPositionAccuracy",
     "GeolocatorPositionChangeEvent",
-    "ForegroundNotificationConfiguration",
+    "GeolocatorWebConfiguration",
 ]
 
 
@@ -89,7 +92,7 @@ class GeolocatorPermissionStatus(Enum):
 
     DENIED = "denied"
     """
-    Permission to access the device's location is denied. 
+    Permission to access the device's location is denied.
 
     The app should try to request permission using the [`Geolocator.request_permission`][(p).] method.
     """
@@ -175,7 +178,7 @@ class GeolocatorPosition:
     """
     The speed at which the device is traveling in meters per second over ground.
 
-    The speed is not available on all devices. 
+    The speed is not available on all devices.
     In these cases the value is `0.0`.
     """
 
@@ -183,7 +186,7 @@ class GeolocatorPosition:
     """
     The altitude of the device in meters.
 
-    The altitude is not available on all devices. 
+    The altitude is not available on all devices.
     In these cases the returned value is `0.0`.
     """
 
@@ -196,7 +199,7 @@ class GeolocatorPosition:
     """
     The estimated horizontal accuracy of the position in meters.
 
-    The accuracy is not available on all devices. 
+    The accuracy is not available on all devices.
     In these cases the value is `0.0`.
     """
 
@@ -204,7 +207,7 @@ class GeolocatorPosition:
     """
     The estimated vertical accuracy of the position in meters.
 
-    The accuracy is not available on all devices. 
+    The accuracy is not available on all devices.
     In these cases the value is `0.0`.
     """
 
@@ -212,7 +215,7 @@ class GeolocatorPosition:
     """
     The heading in which the device is traveling in degrees.
 
-    The heading is not available on all devices. 
+    The heading is not available on all devices.
     In these cases the value is `0.0`.
     """
 
@@ -220,7 +223,7 @@ class GeolocatorPosition:
     """
     The estimated heading accuracy of the position in degrees.
 
-    The heading accuracy is not available on all devices. 
+    The heading accuracy is not available on all devices.
     In these cases the value is `0.0`.
     """
 
@@ -228,7 +231,7 @@ class GeolocatorPosition:
     """
     The estimated speed accuracy of this position, in meters per second.
 
-    The speed accuracy is not available on all devices. 
+    The speed accuracy is not available on all devices.
     In these cases the value is `0.0`.
     """
 
@@ -237,7 +240,7 @@ class GeolocatorPosition:
     The floor specifies the floor of the building on which the device is
     located.
 
-    The floor property is only available on iOS and only when the information is available. 
+    The floor property is only available on iOS and only when the information is available.
     In all other cases this value will be `None`.
     """
 
@@ -261,7 +264,7 @@ class GeolocatorConfiguration:
     """
     The minimum distance (measured in meters) a device must move
     horizontally before an update event is generated.
-    
+
     Set to `0` when you want to be notified of all movements.
     """
 
@@ -280,8 +283,8 @@ class GeolocatorWebConfiguration(GeolocatorConfiguration):
     maximum_age: ft.DurationValue = field(default_factory=lambda: ft.Duration())
     """
     A value indicating the maximum age of a possible cached
-    position that is acceptable to return. If set to 0, it means 
-    that the device cannot use a cached position and must 
+    position that is acceptable to return. If set to 0, it means
+    that the device cannot use a cached position and must
     attempt to retrieve the real current position.
     """
 
@@ -300,7 +303,7 @@ class GeolocatorIosConfiguration(GeolocatorConfiguration):
     """
     Allows the location manager to pause updates to improve battery life
     on the target device without sacrificing location data.
-    When this property is set to `true`, the location manager pauses updates
+    When this property is set to `True`, the location manager pauses updates
     (and powers down the appropriate hardware) at times when the
     location data is unlikely to change.
     """
@@ -309,7 +312,7 @@ class GeolocatorIosConfiguration(GeolocatorConfiguration):
     """
     Flag to ask the Apple OS to show the background location indicator (iOS only)
     if app starts up and background and requests the users location.
-    
+
     For this setting to work and for the location to be retrieved the user must
     have granted "always" permissions for location retrieval.
     """
@@ -317,7 +320,7 @@ class GeolocatorIosConfiguration(GeolocatorConfiguration):
     allow_background_location_updates: bool = True
     """
     Flag to allow the app to receive location updates in the background (iOS only)
-    
+
     Note:
         For this setting to work `Info.plist` should contain the following keys:
             - UIBackgroundModes and the value should contain "location"
@@ -390,13 +393,13 @@ class GeolocatorAndroidConfiguration(GeolocatorConfiguration):
     Whether altitude should be calculated as MSL (EGM2008) from NMEA messages
     and reported as the altitude instead of using the geoidal height (WSG84). Setting
     this property true will help to align Android altitude to that of iOS which uses MSL.
-    
+
     If the NMEA message is empty then the altitude reported will still be the standard WSG84
     altitude from the GPS receiver.
-    
+
     MSL Altitude is only available starting from Android N and not all devices support
     NMEA message returning $GPGGA sequences.
-    
+
     This property only works with position stream updates and has no effect when getting the
     current position or last known position.
     """
@@ -405,7 +408,7 @@ class GeolocatorAndroidConfiguration(GeolocatorConfiguration):
 
 
 @dataclass
-class GeolocatorPositionChangeEvent(ft.Event[ft.EventControlType]):
+class GeolocatorPositionChangeEvent(ft.Event["Geolocator"]):
     position: GeolocatorPosition
     """
     The current/new position of the device.

{flet_geolocator-0.2.0.dev35 → flet_geolocator-0.2.0.dev45/src/flet_geolocator.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-geolocator
-Version: 0.2.0.dev35
+Version: 0.2.0.dev45
 Summary: Adds geolocation capabilities to your Flet apps.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0

{flet_geolocator-0.2.0.dev35 → flet_geolocator-0.2.0.dev45}/src/flutter/flet_geolocator/pubspec.lock

@@ -142,7 +142,7 @@ packages:
     description:
       path: "packages/flet"
       ref: main
-      resolved-ref: b996d06ff462b88f5b31d6cceafac34ea6f57968
+      resolved-ref: cf8823c5d766ea7866480986aa3ee871f4091e78
       url: "https://github.com/flet-dev/flet.git"
     source: git
     version: "0.70.0"
@@ -163,10 +163,10 @@ packages:
     dependency: "direct dev"
     description:
       name: flutter_lints
-      sha256: a25a15ebbdfc33ab1cd26c63a6ee519df92338a9c10f122adda92938253bef04
+      sha256: "9e8c3858111da373efc5aa341de011d9bd23e2c5c5e0c62bccf32438e192d7b1"
       url: "https://pub.dev"
     source: hosted
-    version: "2.0.3"
+    version: "3.0.2"
   flutter_localizations:
     dependency: transitive
     description: flutter
@@ -346,10 +346,10 @@ packages:
     dependency: transitive
     description:
       name: lints
-      sha256: "0a217c6c989d21039f1498c3ed9f3ed71b354e69873f13a8dfc3c9fe76f1b452"
+      sha256: cbf8d4b858bb0134ef3ef87841abdf8d63bfc255c266b7bf6b39daa1085c4290
       url: "https://pub.dev"
     source: hosted
-    version: "2.1.1"
+    version: "3.0.0"
   logging:
     dependency: transitive
     description:
@@ -855,10 +855,10 @@ packages:
     dependency: transitive
     description:
       name: window_manager
-      sha256: "51d50168ab267d344b975b15390426b1243600d436770d3f13de67e55b05ec16"
+      sha256: "7eb6d6c4164ec08e1bf978d6e733f3cebe792e2a23fb07cbca25c2872bfdbdcd"
       url: "https://pub.dev"
     source: hosted
-    version: "0.5.0"
+    version: "0.5.1"
   window_to_front:
     dependency: transitive
     description:

{flet_geolocator-0.2.0.dev35 → flet_geolocator-0.2.0.dev45}/src/flutter/flet_geolocator/pubspec.yaml

@@ -20,4 +20,4 @@ dependencies:
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  flutter_lints: ^2.0.0
+  flutter_lints: ^3.0.0