pypck 0.8.12__py3-none-any.whl → 0.9.2__py3-none-any.whl

pypck/timeout_retry.py

@@ -1,110 +0,0 @@
-"""Base classes for handling reoccurent tasks."""
-
-from __future__ import annotations
-
-import asyncio
-import logging
-from collections.abc import Awaitable, Callable
-from typing import Any
-
-from pypck.helpers import TaskRegistry, cancel_task
-
-_LOGGER = logging.getLogger(__name__)
-
-# The default timeout to use for requests. Worst case: Requesting threshold
-# 4-4 takes at least 1.8s
-DEFAULT_TIMEOUT = 3.5
-
-
-class TimeoutRetryHandler:
-    """Manage timeout and retry logic for an LCN request."""
-
-    def __init__(
-        self,
-        task_registry: TaskRegistry,
-        num_tries: int = 3,
-        timeout: float = DEFAULT_TIMEOUT,
-    ):
-        """Construct TimeoutRetryHandler."""
-        self.task_registry = task_registry
-        self.num_tries = num_tries
-        self.timeout = timeout
-        self._timeout_callback: (
-            Callable[..., None] | Callable[..., Awaitable[None]] | None
-        ) = None
-        self._timeout_args: tuple[Any, ...] = ()
-        self._timeout_kwargs: dict[str, Any] = {}
-        self.timeout_loop_task: asyncio.Task[None] | None = None
-
-    def set_timeout(self, timeout: int) -> None:
-        """Set the timeout in seconds."""
-        self.timeout = timeout
-
-    def set_timeout_callback(
-        self, timeout_callback: Any, *timeout_args: Any, **timeout_kwargs: Any
-    ) -> None:
-        """Timeout_callback function is called, if timeout expires.
-
-        Function has to take one argument:
-        Returns failed state (True if failed)
-        """
-        self._timeout_callback = timeout_callback
-        self._timeout_args = timeout_args
-        self._timeout_kwargs = timeout_kwargs
-
-    def activate(self) -> None:
-        """Schedule the next activation."""
-        self.task_registry.create_task(self.async_activate())
-
-    async def async_activate(self) -> None:
-        """Clean start of next timeout_loop."""
-        if self.is_active():
-            return
-        self.timeout_loop_task = self.task_registry.create_task(self.timeout_loop())
-
-    async def done(self) -> None:
-        """Signal the completion of the TimeoutRetryHandler."""
-        if self.timeout_loop_task is not None:
-            await self.timeout_loop_task
-
-    async def cancel(self) -> None:
-        """Must be called when a response (requested or not) is received."""
-        if self.timeout_loop_task is not None:
-            await cancel_task(self.timeout_loop_task)
-
-    def is_active(self) -> bool:
-        """Check whether the request logic is active."""
-        if self.timeout_loop_task is None:
-            return False
-        return not self.timeout_loop_task.done()
-
-    async def on_timeout(self, failed: bool = False) -> None:
-        """Is called on timeout of TimeoutRetryHandler."""
-        if self._timeout_callback is not None:
-            if asyncio.iscoroutinefunction(self._timeout_callback):
-                # mypy fails to notice that `asyncio.iscoroutinefunction`
-                # separates await-callable from ordinary callables.
-                await self._timeout_callback(
-                    failed, *self._timeout_args, **self._timeout_kwargs
-                )
-            else:
-                self._timeout_callback(
-                    failed, *self._timeout_args, **self._timeout_kwargs
-                )
-
-    async def timeout_loop(self) -> None:
-        """Timeout / retry loop."""
-        if self.timeout_loop_task is None:
-            return
-        tries_left = self.num_tries
-        while (tries_left > 0) or (tries_left == -1):
-            if not self.timeout_loop_task.done():
-                await self.on_timeout()
-                await asyncio.sleep(self.timeout)
-                if self.num_tries != -1:
-                    tries_left -= 1
-            else:
-                break
-
-        if not self.timeout_loop_task.done():
-            await self.on_timeout(failed=True)

pypck-0.8.12.dist-info/METADATA

@@ -1,145 +0,0 @@
-Metadata-Version: 2.4
-Name: pypck
-Version: 0.8.12
-Summary: LCN-PCK library
-Home-page: https://github.com/alengwenus/pypck
-Author-email: Andre Lengwenus <alengwenus@gmail.com>
-License: MIT
-Project-URL: Source Code, https://github.com/alengwenus/pypck
-Project-URL: Bug Reports, https://github.com/alengwenus/pypck/issues
-Keywords: lcn,pck
-Platform: any
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Intended Audience :: Developers
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Home Automation
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: license-file
-
-# pypck - Asynchronous LCN-PCK library written in Python
-
-![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/alengwenus/pypck?color=success)
-![GitHub Workflow Status (dev branch)](https://github.com/alengwenus/pypck/actions/workflows/ci.yaml/badge.svg?branch=dev)
-![Codecov branch](https://img.shields.io/codecov/c/github/alengwenus/pypck/dev)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/pypck)](https://pypi.org/project/pypck/)
-[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
-
-<a href="https://www.buymeacoffee.com/alengwenus" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/white_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
-
-## Overview
-
-**pypck** is an open source library written in Python which allows the connection to the [LCN (local control network) system](https://www.lcn.eu). It uses the vendor protocol LCN-PCK.
-To get started an unused license of the coupling software LCN-PCHK and a hardware coupler is necessary.
-
-**pypck** is used by the LCN integration of the [Home Assistant](https://home-assistant.io/) project.
-
-## Example
-
-```python
-"""Example for switching an output port of module 10 on and off."""
-import asyncio
-
-from pypck.connection import PchkConnectionManager
-from pypck.lcn_addr import LcnAddr
-
-async def main():
-    """Connect to PCK host, get module object and switch output port on and off."""
-    async with PchkConnectionManager(
-        "192.168.2.41",
-        4114,
-        username="lcn",
-        password="lcn",
-        settings={"SK_NUM_TRIES": 0},
-    ) as pck_client:
-        module = pck_client.get_address_conn(LcnAddr(0, 10, False))
-
-        await module.dim_output(0, 100, 0)
-        await asyncio.sleep(1)
-        await module.dim_output(0, 0, 0)
-
-asyncio.run(main())
-```
-
-## pypck REPL in ipython
-
-**pypck** relies heavily on asyncio for talking to the LCN-PCHK software. This
-makes it unusable with the standard python interactive interpreter.
-Fortunately, ipython provides some support for asyncio in its interactive
-interpreter, see
-[ipython autoawait](https://ipython.readthedocs.io/en/stable/interactive/autoawait.html#).
-
-### Requirements
-
-- **ipython** at least version 7.0 (autoawait support)
-- **pypck**
-
-### Example session
-
-```
-Python 3.8.3 (default, Jun  9 2020, 17:39:39)
-Type 'copyright', 'credits' or 'license' for more information
-IPython 7.19.0 -- An enhanced Interactive Python. Type '?' for help.
-
-In [1]: from pypck.connection import PchkConnectionManager
-   ...: from pypck.lcn_addr import LcnAddr
-   ...: import asyncio
-
-In [2]: connection = PchkConnectionManager(host='localhost', port=4114, username='lcn', password='lcn')
-
-In [3]: await connection.async_connect()
-
-In [4]: module = connection.get_address_conn(LcnAddr(seg_id=0, addr_id=10, is_group=False), request_serials=False)
-
-In [5]: await module.request_serials()
-Out[5]:
-{'hardware_serial': 127977263668,
- 'manu': 1,
- 'software_serial': 1771023,
- 'hardware_type': <HardwareType.UPU: 26>}
-
-In [6]: await module.dim_output(0, 100, 0)
-   ...: await asyncio.sleep(1)
-   ...: await module.dim_output(0, 0, 0)
-Out[6]: True
-```
-
-### Caveats
-
-ipython starts and stops the asyncio event loop for each toplevel command
-sequence. Also it only starts the loop if the toplevel commands includes async
-code (like await or a call to an async function). This can lead to unexpected
-behavior. For example, background tasks run only while ipython is executing
-toplevel commands that started the event loop. Functions that use the event
-loop only internally may fail, e.g. the following would fail:
-
-```
-In [4]: module = connection.get_address_conn(LcnAddr(seg_id=0, addr_id=10, is_group=False), request_serials=True)
----------------------------------------------------------------------------
-RuntimeError                              Traceback (most recent call last)
-<ipython-input-7-cd663974bde2> in <module>
-----> 1 module = connection.get_address_conn(modaddr)
-
-/pypck/connection.py in get_address_conn(self, addr, request_serials)
-    457                 address_conn = ModuleConnection(self, addr)
-    458                 if request_serials:
---> 459                     self.request_serials_task = asyncio.create_task(
-    460                         address_conn.request_serials()
-    461                     )
-
-/usr/local/lib/python3.8/asyncio/tasks.py in create_task(coro, name)
-    379     Return a Task object.
-    380     """
---> 381     loop = events.get_running_loop()
-    382     task = loop.create_task(coro)
-    383     _set_task_name(task, name)
-
-RuntimeError: no running event loop
-```
-
-See
-[ipython autoawait internals](https://ipython.readthedocs.io/en/stable/interactive/autoawait.html#internals)
-for details.

pypck-0.8.12.dist-info/RECORD

@@ -1,15 +0,0 @@
-pypck/__init__.py,sha256=vjI-MSv-ght8Y_tcKPXYMjL-FGlHX6Z2ofrUBrz8g4U,317
-pypck/connection.py,sha256=M9AGdq46UjrOyz0V_tZX1IHqGg5Mb3SKs2tzy4wQQhg,24379
-pypck/helpers.py,sha256=_5doqIsSRpqdQNPIUsjFh813xKGuMuEFY6sNGobJGIk,1280
-pypck/inputs.py,sha256=cjhvYKPr5QHw7Rjfkkg8LPbP8ohq_-z_Tvk51Rkx0aY,45828
-pypck/lcn_addr.py,sha256=N2Od8KuANOglqKjf596hJVH1SRcG7MhESKA5YYlDnbw,1946
-pypck/lcn_defs.py,sha256=e2KqD6r-JUwp20BcTymbpjsX16zjOihGKDqreWDsrwo,41951
-pypck/module.py,sha256=wu06MQqLJPGIimPjDd8uWEY9crj1d-2gl__OpVJsfA8,38526
-pypck/pck_commands.py,sha256=eJxmh2e8EbKGpek97L2961Kr_nVfT8rKgJCN3YgjIQM,50458
-pypck/request_handlers.py,sha256=Ft9teTysw-tc9gMdXgh1en-e3MxXmIsiqv5ZQDI_b9E,25234
-pypck/timeout_retry.py,sha256=FzeoyhmA4Tj13wR4kGXUwH8HyXnZ1RQOAYY9sSbz6rw,3859
-pypck-0.8.12.dist-info/licenses/LICENSE,sha256=iYB6zyMJvShfAzQE7nhYFgLzzZuBmhasLw5fYP9KRz4,1023
-pypck-0.8.12.dist-info/METADATA,sha256=LmeQoq11Ron4bsfu8N4-KbDHrqUfPgEHZDwXnlMx8Zs,5604
-pypck-0.8.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pypck-0.8.12.dist-info/top_level.txt,sha256=59ried49iFueDa5mQ_5BGVZcESjjzi4MZZKLcganvQA,6
-pypck-0.8.12.dist-info/RECORD,,