Conditional imports refactoring

Changed
-------
- `build_and_test.yml` workflow_dispatch trigger added
- Updated `typing_extensions` dependency platform flags
- Simplified conditional imports from `typing` with alternatives from `typing_extensions`
  that resolves it under the hood, so we need no control it manually
- Legacy `collections.abc` imports replaced with `typing_extensions`
  cause current required `typing_extensions>=4.7` version already supports all them
- Removed redundant (legacy) imports from `__future__`
- Undefined annotations fixed

Added
-----
- Added `_compat.py` module to simplify future support for other python implementations, like `pypy` or `circuitpython`

Author: o-murphy

.github/workflows/build_and_test.yml

@@ -7,6 +7,7 @@ on:
     pull_request:
         branches: [ master, develop ]
         paths: [ 'bleak/**', 'tests/**' ]
+    workflow_dispatch:
 
 jobs:
     build_desktop:

CHANGELOG.rst

@@ -10,6 +10,26 @@ and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0
 `Unreleased`_
 =============
 
+Changed
+-------
+- `build_and_test.yml` workflow_dispatch trigger added
+- Updated `typing_extensions` dependency platform flags
+- Simplified conditional imports from `typing` with alternatives from `typing_extensions`
+  that resolves it under the hood, so we need no control it manually
+- Legacy `collections.abc` imports replaced with `typing_extensions`
+  cause current required `typing_extensions>=4.7` version already supports all them
+- Removed redundant (legacy) imports from `__future__`
+- Undefined annotations fixed
+
+Added
+-----
+- Added `_compat.py` module to simplify future support for other python implementations, like `pypy` or `circuitpython`
+
+Added
+-----
+- Added support for Pythonista iOS app backend.
+- Added ``BleakClient.name`` property for getting the peripheral's name. Fixes #1802.
+
 Fixed
 -----
 - Fixed ``AttributeError`` in Python4Android backend when accessing ``is_connected`` before connecting. Fixes #1791.

bleak/__init__.py

@@ -2,8 +2,6 @@
 
 """Top-level package for bleak."""
 
-from __future__ import annotations
-
 __author__ = """Henrik Blidh"""
 __email__ = "[email protected]"
 
@@ -14,22 +12,24 @@
 import os
 import sys
 import uuid
-from collections.abc import AsyncGenerator, Awaitable, Callable, Iterable
 from types import TracebackType
-from typing import Any, Literal, Optional, TypedDict, Union, cast, overload
-
-if sys.version_info < (3, 12):
-    from typing_extensions import Buffer
-else:
-    from collections.abc import Buffer
+from typing import (
+    Any,
+    AsyncGenerator,
+    Awaitable,
+    Callable,
+    Iterable,
+    Literal,
+    Optional,
+    TypedDict,
+    Union,
+    cast,
+    overload,
+)
 
-if sys.version_info < (3, 11):
-    from async_timeout import timeout as async_timeout
-    from typing_extensions import Never, Self, Unpack, assert_never
-else:
-    from asyncio import timeout as async_timeout
-    from typing import Never, Self, Unpack, assert_never
+from typing_extensions import Buffer, Never, Self, Unpack, assert_never
 
+from bleak._compat import async_timeout
 from bleak.args.bluez import BlueZScannerArgs
 from bleak.args.corebluetooth import CBScannerArgs, CBStartNotifyArgs
 from bleak.args.winrt import WinRTClientArgs
@@ -481,7 +481,7 @@ class BleakClient:
     def __init__(
         self,
         address_or_ble_device: Union[BLEDevice, str],
-        disconnected_callback: Optional[Callable[[BleakClient], None]] = None,
+        disconnected_callback: Optional[Callable[["BleakClient"], None]] = None,
         services: Optional[Iterable[str]] = None,
         *,
         timeout: float = 10.0,

bleak/_compat.py

@@ -0,0 +1,57 @@
+import asyncio
+import sys
+
+if sys.implementation.name == "cpython":
+    if sys.version_info < (3, 11):
+        from async_timeout import timeout as async_timeout
+    else:
+        from asyncio import timeout as async_timeout
+
+elif sys.implementation.name == "circuitpython":
+    # This code is preparing the bleak to be compatible with `circuitpython>=9`
+
+    if sys.implementation.version <= (9,):
+        raise NotImplementedError("Bleak does not support CircuitPython < 9")
+    else:
+
+        class _AsyncTimeout:
+            def __init__(self, timeout):
+                if sys.implementation.name != "circuitpython":
+                    print(
+                        "Warning: This timeout manager is for CircuitPython. "
+                        "Use the native `asyncio.timeout` on standard Python."
+                    )
+                self.timeout = timeout
+                self._task = None
+
+            async def __aenter__(self):
+                self._task = asyncio.create_task(asyncio.sleep(self.timeout))
+                return self
+
+            async def __aexit__(self, exc_type, exc_val, exc_tb):
+                if self._task and not self._task.done():
+                    self._task.cancel()
+                    try:
+                        await self._task
+                    except asyncio.CancelledError:
+                        pass
+
+                if exc_type is asyncio.CancelledError and self._task.done():
+                    if self._task.cancelled():
+                        raise asyncio.TimeoutError("Operation timed out") from exc_val
+
+                # If any other exception occurred, let it propagate.
+                return False
+
+        async_timeout = _AsyncTimeout
+
+elif sys.implementation.name == "pypy":
+    raise NotImplementedError("Unsupported Python implementation: pypy")
+
+else:
+    # can't use on pypy for example
+    raise NotImplementedError(
+        f"Unsupported Python implementation: {sys.implementation.name}"
+    )
+
+assert async_timeout  # Ensure we have async_timeout defined

bleak/args/corebluetooth.py

@@ -4,8 +4,7 @@
 -------------------------------
 """
 
-from collections.abc import Callable
-from typing import Optional, TypedDict
+from typing import Callable, Optional, TypedDict
 
 
 class CBScannerArgs(TypedDict, total=False):

bleak/backends/bluezdbus/advertisement_monitor.py

@@ -14,8 +14,7 @@
         assert False, "This backend is only available on Linux"
 
 import logging
-from collections.abc import Iterable
-from typing import Any, no_type_check
+from typing import Any, Iterable, no_type_check
 from warnings import warn
 
 from dbus_fast import PropertyAccess

bleak/backends/bluezdbus/client.py

@@ -13,15 +13,10 @@
 import logging
 import os
 import warnings
-from collections.abc import Callable
 from contextlib import AsyncExitStack
-from typing import Any, Optional, Union
+from typing import Any, Callable, Optional, Union
 
-if sys.version_info < (3, 12):
-    from typing_extensions import Buffer, override
-else:
-    from collections.abc import Buffer
-    from typing import override
+from typing_extensions import Buffer, override
 
 if sys.version_info < (3, 11):
     from async_timeout import timeout as async_timeout

bleak/backends/bluezdbus/manager.py

@@ -18,8 +18,7 @@
 import logging
 import os
 from collections import defaultdict
-from collections.abc import Callable, Coroutine, MutableMapping
-from typing import Any, NamedTuple, Optional, cast
+from typing import Any, Callable, Coroutine, MutableMapping, NamedTuple, Optional, cast
 from weakref import WeakKeyDictionary
 
 from dbus_fast import BusType, Message, MessageType, Variant, unpack_variants

bleak/backends/bluezdbus/scanner.py

@@ -6,16 +6,11 @@
         assert False, "This backend is only available on Linux"
 
 import logging
-from collections.abc import Callable, Coroutine
-from typing import Any, Literal, Optional
+from typing import Any, Callable, Coroutine, Literal, Optional
 from warnings import warn
 
-if sys.version_info < (3, 12):
-    from typing_extensions import override
-else:
-    from typing import override
-
 from dbus_fast import Variant
+from typing_extensions import override
 
 from bleak.args.bluez import BlueZDiscoveryFilters as _BlueZDiscoveryFilters
 from bleak.args.bluez import BlueZScannerArgs as _BlueZScannerArgs

bleak/backends/bluezdbus/signals.py

@@ -1,6 +1,4 @@
 # -*- coding: utf-8 -*-
-from __future__ import annotations
-
 import sys
 from typing import TYPE_CHECKING
 
@@ -144,7 +142,7 @@ def __init__(
             self.args = None
 
     @staticmethod
-    def parse(rules: str) -> MatchRules:
+    def parse(rules: str) -> "MatchRules":
         return MatchRules(**dict(r.split("=") for r in rules.split(",")))
 
     def __str__(self) -> str: