v1: Remove _async suffix from all methods, remove fire-n-forget counterparts, code improvements (#5)

ndonkoHenri · web-flow · commit 2a56423dd77d · 2025-08-17T17:40:28.000-07:00
* remove fire-and-forget methods | remove _async in methods name

* updates
diff --git a/.ci/patch_pubspec_version.py b/.ci/patch_pubspec_version.py
@@ -1,3 +1,7 @@
+# /// script
+# dependencies = ["pyyaml"]
+# ///
+
 import os
 import pathlib
 import sys
@@ -17,7 +21,7 @@
     "flet",
 ]
 
-with open(pubspec_path, "r") as f:
+with open(pubspec_path) as f:
     data = yaml.safe_load(f)
 
     # patch version
diff --git a/.ci/patch_toml_version.py b/.ci/patch_toml_version.py
@@ -1,3 +1,7 @@
+# /// script
+# dependencies = ["tomlkit"]
+# ///
+
 import os
 import pathlib
 import sys
@@ -14,7 +18,7 @@
 print(f"Patching TOML file {toml_path} to {ver}")
 
 # read
-with open(toml_path, "r") as f:
+with open(toml_path) as f:
     t = tomlkit.parse(f.read())
 
 # patch version
diff --git a/.docstr.yaml b/.docstr.yaml
@@ -0,0 +1,7 @@
+paths: src/flet_permission_handler
+badge: ./docs/assets/badges/docs-coverage.svg
+skip_file_doc: True
+skip_private: False
+ignore_patterns: # Dict with key/value pairs of file-pattern/node-pattern
+  .*: __post_init__  # Ignore __post_init__ in all files
+fail_under: 50
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - dev
     paths:
       - 'LICENSE'
       - 'CHANGELOG.md'
diff --git a/README.md b/README.md
@@ -30,7 +30,9 @@ This package supports the following platforms:
 | Android  |     ✅     |
 | Web      |     ✅     |
 
-## Installation
+## Usage
+
+### Installation
 
 To install the `flet-permission-handler` package and add it to your project dependencies:
 
@@ -50,6 +52,6 @@ To install the `flet-permission-handler` package and add it to your project depe
     poetry add flet-permission-handler
     ```
 
-## Examples
+### Examples
 
-For examples, see [this](./examples)
+For examples, see [these](./examples).
diff --git a/appveyor.yml b/appveyor.yml
@@ -3,23 +3,20 @@ image: ubuntu
 version: '0.1.{build}'
 
 environment:
+  PYTHON_VERSION: 3.12
   UV_PUBLISH_TOKEN:
     secure: 174ncAbF5IjSIkmioPt62jeSnzmTlRNchUkE4QdjDWH8xK1olYtySXLJpo2q95HcP7lWJky1hv4APESiRRHnBWoY0XRFafzM/mbCDMzG1tZXiXZmpP1qzHAtRP2QSCIg18xh1TMktraUdTi7sbJnjjRhqzgbW1k0kLBxKw79MPFBhYQ/TiGcmaYWZbWVZNY3HCUCb6Dt7bG1OE2Ul9rD1gvs55xwO9Oq9FOVA1VnMYw=
 
-stack:
-- python 3.12
-
 install:
 - source .ci/update_build_version.sh
-- python --version
-- python -m ensurepip --upgrade
-- pip3 install --upgrade tomlkit pyyaml
 - curl -LsSf https://astral.sh/uv/install.sh | sh
-- export PATH=$HOME/.local/bin:$PATH
+- export PATH="$HOME/.local/bin:$PATH"
+- uv python install $PYTHON_VERSION
+- uv python pin $PYTHON_VERSION
 
 build_script:
-- python .ci/patch_toml_version.py pyproject.toml $PYPI_VER
-- python .ci/patch_pubspec_version.py src/flutter/flet_*/pubspec.yaml $PKG_VER
+- uv run .ci/patch_toml_version.py pyproject.toml $PYPI_VER
+- uv run .ci/patch_pubspec_version.py src/flutter/flet_*/pubspec.yaml $PKG_VER
 - (cd src/flutter/* && dart pub get && dart analyze && cd -)
 - uv build
 
@@ -32,4 +29,4 @@ deploy_script:
 artifacts:
 - path: dist/*.whl
 
-test: off
+test: off
diff --git a/docs/index.md b/docs/index.md
@@ -51,13 +51,12 @@ To install the `flet-permission-handler` package and add it to your project depe
 
 ### Declaring Permissions
 
-Ensure that your app has the necessary [permissions declared](https://flet.dev/docs/publish#permissions).
+On mobile platforms, while the permissions are being requested during runtime,
+you'll still need to tell the respective OS which permissions your app
+might potentially use.
 
-## Example
+See [this guide](https://flet.dev/docs/publish#permissions) on how to declare permissions.
 
-```python title="main.py"
---8<-- "examples/permission_handler_example/src/main.py"
-``` 
+### Examples
 
-1. The [`PermissionHandler`][flet_permission_handler.permission_handler.PermissionHandler] instance must be added to the
-   [`Page.services`][flet.Page.services] list to work properly.
+See [these](permission_handler.md#examples).
diff --git a/docs/permission_handler.md b/docs/permission_handler.md
@@ -1 +1,12 @@
-::: flet_permission_handler.permission_handler.PermissionHandler
+## Examples
+
+### Example 1
+
+```python title="example_1.py"
+--8<-- "examples/permission_handler_example/src/example_1.py"
+```
+
+1. The [`PermissionHandler`][flet_permission_handler.permission_handler.PermissionHandler] instance must be added to the
+   [`Page.services`][flet.Page.services] list to work properly.
+
+::: flet_permission_handler.permission_handler.PermissionHandler
diff --git a/examples/permission_handler_example/src/example_1.py b/examples/permission_handler_example/src/example_1.py
@@ -10,16 +10,16 @@ def show_snackbar(message: str):
         page.show_dialog(ft.SnackBar(ft.Text(message)))
 
     async def get_permission_status(e: ft.Event[ft.OutlinedButton]):
-        status = await p.get_status_async(fph.Permission.MICROPHONE)
+        status = await p.get_status(fph.Permission.MICROPHONE)
         show_snackbar(f"Microphone permission status: {status.name}")
 
     async def request_permission(e: ft.Event[ft.OutlinedButton]):
-        status = await p.request_async(fph.Permission.MICROPHONE)
+        status = await p.request(fph.Permission.MICROPHONE)
         show_snackbar(f"Requested microphone permission: {status.name}")
 
     async def open_app_settings(e: ft.Event[ft.OutlinedButton]):
         show_snackbar("Opening app settings...")
-        await p.open_app_settings_async()
+        await p.open_app_settings()
 
     p = fph.PermissionHandler()
     page.services.append(p)  # (1)!
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -109,6 +109,11 @@ plugins:
       alias_type: symlink
   - glightbox
   - section-index
+  - external-images:
+      mappings:
+        - source_dir: examples
+          target_url_path: examples
+          include_exts: [ ".png", ".gif", ".svg" ]
   - mkdocstrings:
       default_handler: python_xref
       handlers:
@@ -134,7 +139,6 @@ plugins:
             preload_modules: [ flet ]
             filters:
               - "!^_"   # Exclude private members starting with only one underscore
-              - "!get_event_field_type"
             extensions:
               - griffe_modernized_annotations
               - griffe_warnings_deprecated
@@ -185,3 +189,4 @@ markdown_extensions:
   - pymdownx.tasklist:
       custom_checkbox: true
   - pymdownx.tilde
+  - pymdownx.blocks.caption
diff --git a/pyproject.toml b/pyproject.toml
@@ -54,13 +54,17 @@ docs = [
     "markdown-exec[ansi] >=1.11.0",
     "pydocstyle >=6.3.0",
     "linkcheckmd >=1.4.0",
+    "mkdocs-external-images",
     { include-group = 'docs-coverage' },
 ]
 all = [
     { include-group = 'dev' },
     { include-group = 'docs' },
 ]
 
+[tool.uv.sources]
+mkdocs-external-images = { git = "https://github.com/flet-dev/mkdocs-external-images", tag = "v0.2.0" }
+
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
diff --git a/src/flet_permission_handler/__init__.py b/src/flet_permission_handler/__init__.py
@@ -1,5 +1,5 @@
-from .permission_handler import PermissionHandler
-from .types import Permission, PermissionStatus
+from flet_permission_handler.permission_handler import PermissionHandler
+from flet_permission_handler.types import Permission, PermissionStatus
 
 __all__ = [
     "Permission",
diff --git a/src/flet_permission_handler/permission_handler.py b/src/flet_permission_handler/permission_handler.py
@@ -2,7 +2,7 @@
 
 import flet as ft
 
-from .types import Permission, PermissionStatus
+from flet_permission_handler.types import Permission, PermissionStatus
 
 __all__ = ["PermissionHandler"]
 
@@ -40,7 +40,7 @@ def before_update(self):
                 "Windows, and Web platforms."
             )
 
-    async def get_status_async(
+    async def get_status(
         self, permission: Permission, timeout: int = 10
     ) -> Optional[PermissionStatus]:
         """
@@ -56,14 +56,14 @@ async def get_status_async(
         Raises:
             TimeoutError: If the request times out.
         """
-        status = await self._invoke_method_async(
+        status = await self._invoke_method(
             method_name="get_status",
             arguments={"permission": permission},
             timeout=timeout,
         )
         return PermissionStatus(status) if status is not None else None
 
-    async def request_async(
+    async def request(
         self, permission: Permission, timeout: int = 60
     ) -> Optional[PermissionStatus]:
         """
@@ -81,14 +81,14 @@ async def request_async(
         Raises:
             TimeoutError: If the request times out.
         """
-        r = await self._invoke_method_async(
+        r = await self._invoke_method(
             method_name="request",
             arguments={"permission": permission},
             timeout=timeout,
         )
         return PermissionStatus(r) if r is not None else None
 
-    async def open_app_settings_async(self, timeout: int = 10) -> bool:
+    async def open_app_settings(self, timeout: int = 10) -> bool:
         """
         Opens the app settings page.
 
@@ -101,7 +101,7 @@ async def open_app_settings_async(self, timeout: int = 10) -> bool:
         Raises:
             TimeoutError: If the request times out.
         """
-        return await self._invoke_method_async(
+        return await self._invoke_method(
             method_name="open_app_settings",
             timeout=timeout,
         )
diff --git a/src/flutter/flet_permission_handler/lib/src/utils/permission_handler.dart b/src/flutter/flet_permission_handler/lib/src/utils/permission_handler.dart
@@ -5,11 +5,7 @@ Permission? parsePermission(String? value, [Permission? defaultValue]) {
   if (value == null) return defaultValue;
   return Permission.values.firstWhereOrNull(
         (Permission p) =>
-        p
-            .toString()
-            .split('.')
-            .last
-            .toLowerCase() == value.toLowerCase(),
+            p.toString().split('.').last.toLowerCase() == value.toLowerCase(),
       ) ??
       defaultValue;
 }
