HAP-python 5.0.0__tar.gz → 5.2.0__tar.gz

{hap_python-5.0.0 → hap_python-5.2.0}/HAP_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: HAP-python
-Version: 5.0.0
+Version: 5.2.0
 Summary: HomeKit Accessory Protocol implementation in python
 Author: Ivan Kalchev
 License-Expression: Apache-2.0
@@ -12,14 +12,13 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Home Automation
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS
@@ -32,9 +31,14 @@ Requires-Dist: h11
 Provides-Extra: qrcode
 Requires-Dist: base36; extra == "qrcode"
 Requires-Dist: pyqrcode; extra == "qrcode"
+Provides-Extra: talkback
+Requires-Dist: pylibsrtp; extra == "talkback"
+Provides-Extra: bench
+Requires-Dist: psutil; extra == "bench"
+Requires-Dist: py-spy; extra == "bench"
 Dynamic: license-file
 
-[![PyPI version](https://badge.fury.io/py/HAP-python.svg)](https://badge.fury.io/py/HAP-python) [![Build Status](https://github.com/ikalchev/HAP-python/workflows/CI/badge.svg)](https://github.com/ikalchev/HAP-python) [![codecov](https://codecov.io/gh/ikalchev/HAP-python/branch/master/graph/badge.svg)](https://codecov.io/gh/ikalchev/HAP-python) [![Python Versions](https://img.shields.io/pypi/pyversions/HAP-python.svg)](https://pypi.python.org/pypi/HAP-python/) [![Documentation Status](https://readthedocs.org/projects/hap-python/badge/?version=latest)](http://hap-python.readthedocs.io/en/latest/?badge=latest) [![Downloads](https://pepy.tech/badge/hap-python)](https://pepy.tech/project/hap-python)
+[![PyPI version](https://badge.fury.io/py/HAP-python.svg)](https://badge.fury.io/py/HAP-python) [![CI](https://github.com/ikalchev/HAP-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/ikalchev/HAP-python/actions/workflows/ci.yaml) [![codecov](https://codecov.io/gh/ikalchev/HAP-python/graph/badge.svg)](https://codecov.io/gh/ikalchev/HAP-python) [![Python Versions](https://img.shields.io/pypi/pyversions/HAP-python.svg)](https://pypi.python.org/pypi/HAP-python/) [![Documentation Status](https://readthedocs.org/projects/hap-python/badge/?version=latest)](http://hap-python.readthedocs.io/en/latest/?badge=latest) [![Downloads](https://pepy.tech/badge/hap-python)](https://pepy.tech/project/hap-python)
 # HAP-python
 
 HomeKit Accessory Protocol implementation in python 3.

{hap_python-5.0.0 → hap_python-5.2.0}/HAP_python.egg-info/SOURCES.txt

@@ -1,9 +1,7 @@
 AUTHORS
 LICENSE
-MANIFEST.in
 README.md
 pyproject.toml
-setup.cfg
 HAP_python.egg-info/PKG-INFO
 HAP_python.egg-info/SOURCES.txt
 HAP_python.egg-info/dependency_links.txt
@@ -13,6 +11,7 @@ pyhap/__init__.py
 pyhap/accessory.py
 pyhap/accessory_driver.py
 pyhap/camera.py
+pyhap/camera_talkback.py
 pyhap/characteristic.py
 pyhap/const.py
 pyhap/encoder.py
@@ -21,6 +20,11 @@ pyhap/hap_event.py
 pyhap/hap_handler.py
 pyhap/hap_protocol.py
 pyhap/hap_server.py
+pyhap/hds.py
+pyhap/hds_protocol.py
+pyhap/hds_recording.py
+pyhap/hds_server.py
+pyhap/hksv_recording.py
 pyhap/hsrp.py
 pyhap/iid_manager.py
 pyhap/loader.py
@@ -35,12 +39,19 @@ pyhap/resources/snapshot.jpg
 tests/test_accessory.py
 tests/test_accessory_driver.py
 tests/test_camera.py
+tests/test_camera_talkback.py
 tests/test_characteristic.py
 tests/test_encoder.py
+tests/test_fmp4_packets.py
 tests/test_hap_crypto.py
 tests/test_hap_handler.py
 tests/test_hap_protocol.py
 tests/test_hap_server.py
+tests/test_hds_recording.py
+tests/test_hksv_gating.py
+tests/test_hksv_recording.py
+tests/test_hksv_state.py
+tests/test_hksv_transport.py
 tests/test_hsrp.py
 tests/test_iid_manager.py
 tests/test_loader.py

{hap_python-5.0.0 → hap_python-5.2.0}/HAP_python.egg-info/requires.txt

@@ -10,3 +10,10 @@ async_timeout
 [QRCode]
 base36
 pyqrcode
+
+[Talkback]
+pylibsrtp
+
+[bench]
+psutil
+py-spy

{hap_python-5.0.0 → hap_python-5.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: HAP-python
-Version: 5.0.0
+Version: 5.2.0
 Summary: HomeKit Accessory Protocol implementation in python
 Author: Ivan Kalchev
 License-Expression: Apache-2.0
@@ -12,14 +12,13 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Home Automation
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS
@@ -32,9 +31,14 @@ Requires-Dist: h11
 Provides-Extra: qrcode
 Requires-Dist: base36; extra == "qrcode"
 Requires-Dist: pyqrcode; extra == "qrcode"
+Provides-Extra: talkback
+Requires-Dist: pylibsrtp; extra == "talkback"
+Provides-Extra: bench
+Requires-Dist: psutil; extra == "bench"
+Requires-Dist: py-spy; extra == "bench"
 Dynamic: license-file
 
-[![PyPI version](https://badge.fury.io/py/HAP-python.svg)](https://badge.fury.io/py/HAP-python) [![Build Status](https://github.com/ikalchev/HAP-python/workflows/CI/badge.svg)](https://github.com/ikalchev/HAP-python) [![codecov](https://codecov.io/gh/ikalchev/HAP-python/branch/master/graph/badge.svg)](https://codecov.io/gh/ikalchev/HAP-python) [![Python Versions](https://img.shields.io/pypi/pyversions/HAP-python.svg)](https://pypi.python.org/pypi/HAP-python/) [![Documentation Status](https://readthedocs.org/projects/hap-python/badge/?version=latest)](http://hap-python.readthedocs.io/en/latest/?badge=latest) [![Downloads](https://pepy.tech/badge/hap-python)](https://pepy.tech/project/hap-python)
+[![PyPI version](https://badge.fury.io/py/HAP-python.svg)](https://badge.fury.io/py/HAP-python) [![CI](https://github.com/ikalchev/HAP-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/ikalchev/HAP-python/actions/workflows/ci.yaml) [![codecov](https://codecov.io/gh/ikalchev/HAP-python/graph/badge.svg)](https://codecov.io/gh/ikalchev/HAP-python) [![Python Versions](https://img.shields.io/pypi/pyversions/HAP-python.svg)](https://pypi.python.org/pypi/HAP-python/) [![Documentation Status](https://readthedocs.org/projects/hap-python/badge/?version=latest)](http://hap-python.readthedocs.io/en/latest/?badge=latest) [![Downloads](https://pepy.tech/badge/hap-python)](https://pepy.tech/project/hap-python)
 # HAP-python
 
 HomeKit Accessory Protocol implementation in python 3.

{hap_python-5.0.0 → hap_python-5.2.0}/README.md

@@ -1,4 +1,4 @@
-[![PyPI version](https://badge.fury.io/py/HAP-python.svg)](https://badge.fury.io/py/HAP-python) [![Build Status](https://github.com/ikalchev/HAP-python/workflows/CI/badge.svg)](https://github.com/ikalchev/HAP-python) [![codecov](https://codecov.io/gh/ikalchev/HAP-python/branch/master/graph/badge.svg)](https://codecov.io/gh/ikalchev/HAP-python) [![Python Versions](https://img.shields.io/pypi/pyversions/HAP-python.svg)](https://pypi.python.org/pypi/HAP-python/) [![Documentation Status](https://readthedocs.org/projects/hap-python/badge/?version=latest)](http://hap-python.readthedocs.io/en/latest/?badge=latest) [![Downloads](https://pepy.tech/badge/hap-python)](https://pepy.tech/project/hap-python)
+[![PyPI version](https://badge.fury.io/py/HAP-python.svg)](https://badge.fury.io/py/HAP-python) [![CI](https://github.com/ikalchev/HAP-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/ikalchev/HAP-python/actions/workflows/ci.yaml) [![codecov](https://codecov.io/gh/ikalchev/HAP-python/graph/badge.svg)](https://codecov.io/gh/ikalchev/HAP-python) [![Python Versions](https://img.shields.io/pypi/pyversions/HAP-python.svg)](https://pypi.python.org/pypi/HAP-python/) [![Documentation Status](https://readthedocs.org/projects/hap-python/badge/?version=latest)](http://hap-python.readthedocs.io/en/latest/?badge=latest) [![Downloads](https://pepy.tech/badge/hap-python)](https://pepy.tech/project/hap-python)
 # HAP-python
 
 HomeKit Accessory Protocol implementation in python 3.

{hap_python-5.0.0 → hap_python-5.2.0}/pyhap/accessory.py

@@ -1,11 +1,13 @@
 """Module for the Accessory classes."""
 
+from collections.abc import Callable, Iterable
 import itertools
 import logging
-from typing import TYPE_CHECKING, Any, Callable, Dict, Iterable, List, Optional
+from typing import TYPE_CHECKING, Any
 from uuid import UUID
 
 from . import SUPPORT_QR_CODE, util
+from .characteristic import Characteristic
 from .const import (
     CATEGORY_BRIDGE,
     CATEGORY_OTHER,
@@ -26,7 +28,6 @@ if SUPPORT_QR_CODE:
 
 if TYPE_CHECKING:
     from .accessory_driver import AccessoryDriver
-    from .characteristic import Characteristic
 
 
 HAP_PROTOCOL_INFORMATION_SERVICE_UUID = UUID("000000A2-0000-1000-8000-0026BB765291")
@@ -45,9 +46,9 @@ class Accessory:
     def __init__(
         self,
         driver: "AccessoryDriver",
-        display_name: Optional[str],
-        aid: Optional[int] = None,
-        iid_manager: Optional[IIDManager] = None,
+        display_name: str | None,
+        aid: int | None = None,
+        iid_manager: IIDManager | None = None,
     ) -> None:
         """Initialise with the given properties.
 
@@ -60,12 +61,12 @@ class Accessory:
             will assign the standalone AID to this `Accessory`.
         :type aid: int
         """
-        self.aid: Optional[int] = aid
-        self.display_name: Optional[str] = display_name
+        self.aid: int | None = aid
+        self.display_name: str | None = display_name
         self.driver = driver
-        self.services: List[Service] = []
+        self.services: list[Service] = []
         self.iid_manager = iid_manager or IIDManager()
-        self.setter_callback: Optional[Callable[[Any], None]] = None
+        self.setter_callback: Callable[[Any], None] | None = None
 
         self.add_info_service()
         if aid == STANDALONE_AID:
@@ -99,7 +100,7 @@ class Accessory:
         serv_info.configure_char("SerialNumber", value="default")
         self.add_service(serv_info)
 
-    def add_protocol_version_service(self):
+    def add_protocol_version_service(self) -> None:
         """Helper method to add the required HAP Protocol Information service"""
         serv_hap_proto_info = Service(
             HAP_PROTOCOL_INFORMATION_SERVICE_UUID, "HAPProtocolInformation"
@@ -109,10 +110,15 @@ class Accessory:
         self.add_service(serv_hap_proto_info)
 
     def set_info_service(
-        self, firmware_revision=None, manufacturer=None, model=None, serial_number=None
-    ):
+        self,
+        firmware_revision: str | None = None,
+        manufacturer: str | None = None,
+        model: str | None = None,
+        serial_number: str | None = None,
+    ) -> None:
         """Quick assign basic accessory information."""
         serv_info = self.get_service("AccessoryInformation")
+        assert serv_info is not None  # noqa: S101
         if firmware_revision:
             serv_info.configure_char("FirmwareRevision", value=firmware_revision)
         if manufacturer:
@@ -131,21 +137,21 @@ class Accessory:
 
     def add_preload_service(
         self,
-        service: Service,
-        chars: Optional[Iterable["Characteristic"]] = None,
-        unique_id: Optional[str] = None,
+        service: str,
+        chars: str | Iterable[str] | None = None,
+        unique_id: str | int | None = None,
     ) -> Service:
         """Create a service with the given name and add it to this acc."""
-        service = self.driver.loader.get_service(service)
+        serv: Service = self.driver.loader.get_service(service)
         if unique_id is not None:
-            service.unique_id = unique_id
+            serv.unique_id = unique_id
         if chars:
-            chars = chars if isinstance(chars, list) else [chars]
-            for char_name in chars:
+            char_names = [chars] if isinstance(chars, str) else chars
+            for char_name in char_names:
                 char = self.driver.loader.get_char(char_name)
-                service.add_characteristic(char)
-        self.add_service(service)
-        return service
+                serv.add_characteristic(char)
+        self.add_service(serv)
+        return serv
 
     def set_primary_service(self, primary_service: Service) -> None:
         """Set the primary service of the acc."""
@@ -157,8 +163,8 @@ class Accessory:
 
         This also assigns unique IIDS to the services and their Characteristics.
 
-        .. note:: Do not add or remove characteristics from services that have been added
-            to an Accessory, as this will lead to inconsistent IIDs.
+        .. note:: Do not add or remove characteristics from services that have
+            been added to an Accessory, as this will lead to inconsistent IIDs.
 
         :param servs: Variable number of services to add to this Accessory.
         :type: Service
@@ -171,7 +177,7 @@ class Accessory:
                 c.broker = self
                 self.iid_manager.assign(c)
 
-    def get_service(self, name: str) -> Optional[Service]:
+    def get_service(self, name: str) -> Service | None:
         """Return a Service with the given name.
 
         A single Service is returned even if more than one Service with the same name
@@ -208,13 +214,12 @@ class Accessory:
             int(self.driver.state.pincode.replace(b"-", b""), 10) & 0x7FFFFFFF
         )  # pincode
 
-        # pylint: disable-next=possibly-used-before-assignment
-        encoded_payload = base36.dumps(payload).upper()
+        encoded_payload: str = base36.dumps(payload).upper()
         encoded_payload = encoded_payload.rjust(9, "0")
 
         return "X-HM://" + encoded_payload + self.driver.state.setup_id
 
-    def get_characteristic(self, aid: int, iid: int) -> Optional["Characteristic"]:
+    def get_characteristic(self, aid: int, iid: int) -> "Characteristic | None":
         """Get the characteristic for the given IID.
 
         The AID is used to verify if the search is in the correct accessory.
@@ -222,9 +227,10 @@ class Accessory:
         if aid != self.aid:
             return None
 
-        return self.iid_manager.get_obj(iid)
+        obj = self.iid_manager.get_obj(iid)
+        return obj if isinstance(obj, Characteristic) else None
 
-    def to_HAP(self, include_value: bool = True) -> Dict[str, Any]:
+    def to_HAP(self, include_value: bool = True) -> dict[str, Any]:
         """A HAP representation of this Accessory.
 
         :return: A HAP representation of this accessory. For example:
@@ -248,7 +254,7 @@ class Accessory:
             ],
         }
 
-    def setup_message(self):
+    def setup_message(self) -> None:
         """Print setup message to console.
 
         For QRCode `base36`, `pyqrcode` are required.
@@ -277,7 +283,9 @@ class Accessory:
             )
 
     @staticmethod
-    def run_at_interval(seconds):
+    def run_at_interval(
+        seconds: float,
+    ) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
         """Decorator that runs decorated method every x seconds, until stopped.
 
         Can be used with normal and async methods.
@@ -293,8 +301,8 @@ class Accessory:
         :type seconds: float
         """
 
-        def _repeat(func):
-            async def _wrapper(self, *args):
+        def _repeat(func: Callable[..., Any]) -> Callable[..., Any]:
+            async def _wrapper(self: Any, *args: Any) -> None:
                 while True:
                     await self.driver.async_add_job(func, self, *args)
                     if await util.event_wait(self.driver.aio_stop_event, seconds):
@@ -304,22 +312,43 @@ class Accessory:
 
         return _repeat
 
-    async def run(self):
+    async def run(self) -> None:
         """Called when the Accessory should start doing its thing.
 
         Called when HAP server is running, advertising is set, etc.
         Can be overridden with a normal or async method.
         """
 
-    async def stop(self):
-        """Called when the Accessory should stop what is doing and clean up any resources.
+    async def stop(self) -> None:
+        """Called when the Accessory should stop what it is doing and clean up
+        any resources.
 
         Can be overridden with a normal or async method.
         """
 
+    def restore_accessory_state(self) -> None:
+        """Apply this accessory's entry of ``driver.state.accessory_states``.
+
+        The driver calls this after it loads its state file, for accessories
+        built before that. Does nothing by default.
+        """
+
+    def reset_accessory_state(self) -> None:
+        """Forget settings made by the previous home.
+
+        The driver calls this when the last pairing is removed. Does nothing by
+        default.
+        """
+
     # Driver
 
-    def publish(self, value, sender, sender_client_addr=None, immediate=False):
+    def publish(
+        self,
+        value: Any,
+        sender: Service | Characteristic,
+        sender_client_addr: Any = None,
+        immediate: bool = False,
+    ) -> None:
         """Append AID and IID of the sender and forward it to the driver.
 
         Characteristics call this method to send updates.
@@ -349,13 +378,13 @@ class Bridge(Accessory):
     def __init__(
         self,
         driver: "AccessoryDriver",
-        display_name: Optional[str],
-        iid_manager: Optional[IIDManager] = None,
+        display_name: str | None,
+        iid_manager: IIDManager | None = None,
     ) -> None:
         super().__init__(
             driver, display_name, aid=STANDALONE_AID, iid_manager=iid_manager
         )
-        self.accessories = {}  # aid: acc
+        self.accessories: dict[int, Accessory] = {}  # aid: acc
 
     def add_accessory(self, acc: "Accessory") -> None:
         """Add the given ``Accessory`` to this ``Bridge``.
@@ -364,16 +393,17 @@ class Bridge(Accessory):
         unique among all the ``Accessories`` in the same `Bridge`. If the given
         ``Accessory``'s AID is None, a unique AID will be assigned to it. Otherwise,
         it will be verified that the AID is not the standalone aid (``STANDALONE_AID``)
-        and that there is no other ``Accessory`` already in this ``Bridge`` with that AID.
+        and that there is no other ``Accessory`` already in this ``Bridge``
+        with that AID.
 
         .. note:: A ``Bridge`` cannot be added to another ``Bridge``.
 
         :param acc: The ``Accessory`` to be bridged.
         :type acc: Accessory
 
-        :raise ValueError: When the given ``Accessory`` is of category ``CATEGORY_BRIDGE``
-            or if the AID of the ``Accessory`` clashes with another ``Accessory`` already in this
-            ``Bridge``.
+        :raise ValueError: When the given ``Accessory`` is of category
+            ``CATEGORY_BRIDGE`` or if the AID of the ``Accessory`` clashes with
+            another ``Accessory`` already in this ``Bridge``.
         """
         if acc.category == CATEGORY_BRIDGE:
             raise ValueError("Bridges cannot be bridged")
@@ -390,7 +420,11 @@ class Bridge(Accessory):
 
         self.accessories[acc.aid] = acc
 
-    def to_HAP(self, include_value: bool = True) -> List[Dict[str, Any]]:
+    # A Bridge serializes one HAP dict per bridged accessory, which
+    # legitimately widens the parent's single-dict return type.
+    def to_HAP(  # ty: ignore[invalid-method-override]
+        self, include_value: bool = True
+    ) -> list[dict[str, Any]]:
         """Returns a HAP representation of itself and all contained accessories.
 
         .. seealso:: Accessory.to_HAP
@@ -400,10 +434,11 @@ class Bridge(Accessory):
             for acc in (super(), *self.accessories.values())
         ]
 
-    def get_characteristic(self, aid: int, iid: int) -> Optional["Characteristic"]:
+    def get_characteristic(self, aid: int, iid: int) -> "Characteristic | None":
         """.. seealso:: Accessory.to_HAP"""
         if self.aid == aid:
-            return self.iid_manager.get_obj(iid)
+            obj = self.iid_manager.get_obj(iid)
+            return obj if isinstance(obj, Characteristic) else None
 
         acc = self.accessories.get(aid)
         if acc is None:
@@ -411,6 +446,26 @@ class Bridge(Accessory):
 
         return acc.get_characteristic(aid, iid)
 
+    def restore_accessory_state(self) -> None:
+        """Restore the state of each bridged accessory."""
+        for acc in self.accessories.values():
+            try:
+                acc.restore_accessory_state()
+            except Exception:
+                logger.warning(
+                    "Failed to restore the state of %s", acc.display_name, exc_info=True
+                )
+
+    def reset_accessory_state(self) -> None:
+        """Reset the state of each bridged accessory."""
+        for acc in self.accessories.values():
+            try:
+                acc.reset_accessory_state()
+            except Exception:
+                logger.warning(
+                    "Failed to reset the state of %s", acc.display_name, exc_info=True
+                )
+
     async def run(self) -> None:
         """Schedule tasks for each of the accessories' run method."""
         for acc in self.accessories.values():