add ruff to pyproject dev-group

Author: ndonkoHenri

CHANGELOG.md

@@ -10,17 +10,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 - Deployed online documentation: https://flet-dev.github.io/flet-geolocator/
-- `Geolocator` control new methods: 
-  - `distance_between_async`
-- `Geolocator` control new properties: 
-  - `position`
-  - `configuration`
+- `Geolocator` control new methods: `distance_between_async`
+- `Geolocator` control new properties: `position`, `configuration`
 - New dataclasses: 
-  - `GeolocatorConfiguration`
-  - `GeolocatorWebConfiguration`
-  - `GeolocatorIosConfiguration`
-  - `GeolocatorAndroidConfiguration`
-  - `ForegroundNotificationConfiguration`
+    - `GeolocatorConfiguration`
+    - `GeolocatorWebConfiguration`
+    - `GeolocatorIosConfiguration`
+    - `GeolocatorAndroidConfiguration`
+    - `ForegroundNotificationConfiguration`
 
 ### Changed
 
@@ -30,18 +27,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - `Geolocator` must now be added to `Page.services` instead of `Page.overlay`.
 - `Geolocator` method `get_current_position_async` parameters changed: 
-  - removed `accuracy`
-  - `location_settings` renamed to `configuration` (type changed)
-  - `wait_timeout` renamed to `timeout`
+    - removed `accuracy`
+    - `location_settings` renamed to `configuration` (type changed)
+    - `wait_timeout` renamed to `timeout`
 - In all `Geolocator` methods, parameter `wait_timeout` renamed to `timeout`.
 - Removed sync methods from `Geolocator`: 
-  - `get_current_position` → use `get_current_position_async` instead
-  - `get_last_known_position` → use `get_last_known_position_async` instead
-  - `get_permission_status` → use `get_permission_status_async` instead
-  - `request_permission` → use `request_permission_async` instead
-  - `is_location_service_enabled` → use `is_location_service_enabled_async` instead
-  - `open_app_settings` → use `open_app_settings_async` instead
-  - `open_location_settings` → use `open_location_settings_async` instead
+    - `get_current_position` → use `get_current_position_async` instead
+    - `get_last_known_position` → use `get_last_known_position_async` instead
+    - `get_permission_status` → use `get_permission_status_async` instead
+    - `request_permission` → use `request_permission_async` instead
+    - `is_location_service_enabled` → use `is_location_service_enabled_async` instead
+    - `open_app_settings` → use `open_app_settings_async` instead
+    - `open_location_settings` → use `open_location_settings_async` instead
 - Enum `GeolocatorActivityType` renamed to `GeolocatorIosActivityType`
 
 ## [0.1.0] - 2025-01-15

pyproject.toml

@@ -22,6 +22,7 @@ Issues = "https://github.com/flet-dev/flet-geolocator/issues"
 [dependency-groups]
 dev = [
     "pre-commit>=4.2.0",
+    "ruff>=0.11.7",
 ]
 docs = [
     "mkdocs",

src/flet_geolocator/geolocator.py

@@ -62,12 +62,10 @@ async def get_current_position_async(
             configuration: Additional configuration for the location request.
                 If not specified, then the [`Geolocator.configuration`][(p).] property is used.
             timeout: The maximum amount of time (in seconds) to wait for a response.
-
-        Raises:
-            TimeoutError: If the request times out.
-
         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.
@@ -88,17 +86,16 @@ async def get_last_known_position_async(
         Gets the last known position stored on the user's device.
         The accuracy can be defined using the [`Geolocator.configuration`][(p).] property.
 
-        Not supported on web plaform.
+        Note:
+            This method is not supported on web plaform.
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
-
-        Raises:
-            AssertionError: If called on a web page, as this method is not supported on web.
-            TimeoutError: If the request times out.
-
         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, "get_last_known_position is not supported on web"
         r = await self._invoke_method_async("get_last_known_position", timeout=timeout)
@@ -112,12 +109,10 @@ async def get_permission_status_async(
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
-
-        Raises:
-            TimeoutError: If the request times out.
-
         Returns:
             The status of the permission.
+        Raises:
+            TimeoutError: If the request times out.
         """
         r = await self._invoke_method_async("get_permission_status", timeout=timeout)
         return GeolocatorPermissionStatus(r)
@@ -130,12 +125,10 @@ async def request_permission_async(
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
-
-        Raises:
-            TimeoutError: If the request times out.
-
         Returns:
             The status of the permission request.
+        Raises:
+            TimeoutError: If the request times out.
         """
         r = await self._invoke_method_async("request_permission", timeout=timeout)
         return GeolocatorPermissionStatus(r)
@@ -146,12 +139,10 @@ async def is_location_service_enabled_async(self, timeout: float = 10) -> bool:
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
-
-        Raises:
-            TimeoutError: If the request times out.
-
         Returns:
             `True` if location service is enabled, `False` otherwise.
+        Raises:
+            TimeoutError: If the request times out.
         """
         return await self._invoke_method_async(
             "is_location_service_enabled", timeout=timeout
@@ -161,17 +152,16 @@ async def open_app_settings_async(self, timeout: float = 10) -> bool:
         """
         Attempts to open the app's settings.
 
-        Not supported on web plaform.
+        Note:
+            This method is not supported on web plaform.
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
-
-        Raises:
-            AssertionError: If called on a web page, as this method is not supported on web.
-            TimeoutError: If the request times out.
-
         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)
@@ -180,35 +170,33 @@ def open_location_settings(self, timeout: float = 10):
         """
         Attempts to open the device's location settings.
 
-        Not supported on web plaform.
+        Note:
+            This method is not supported on web plaform.
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
-
-        Raises:
-            AssertionError: If called on a web page, as this method is not supported on web.
-            TimeoutError: If the request times out.
-
         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.
         """
         asyncio.create_task(self.open_location_settings_async(timeout=timeout))
 
     async def open_location_settings_async(self, timeout: float = 10):
         """
         Attempts to open the device's location settings.
 
-        Not supported on web plaform.
+        Note:
+            This method is not supported on web plaform.
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
-
-        Raises:
-            AssertionError: If called on a web page, as this method is not supported on web.
-            TimeoutError: If the request times out.
-
         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)
@@ -233,15 +221,13 @@ async def distance_between_async(
             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.
-
-        Raises:
-            TimeoutError: If the request times out.
-
         Returns:
             The distance between the coordinates in meters.
+        Raises:
+            TimeoutError: If the request times out.
         """
         await self._invoke_method_async(
-            "distance_between",
+            method_name="distance_between",
             arguments={
                 "start_latitude": start_latitude,
                 "start_longitude": start_longitude,