tinytoolslib 0.5.0__tar.gz → 0.6.0__tar.gz

{tinytoolslib-0.5.0 → tinytoolslib-0.6.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: tinytoolslib
-Version: 0.5.0
-Summary: Set of tools for use with Tinycontrol devices like LK2.X, LK3.X, LK4.X or tcPDU.
+Version: 0.6.0
+Summary: Set of tools for use with tinycontrol devices like LK2.X, LK3.X, LK4.X or tcPDU.
 Author-email: Bartek Barszczewski <tinycontrol.software@gmail.com>
 License-Expression: Apache-2.0
 Keywords: tinycontrol,lk,tcpdu
@@ -12,7 +12,7 @@ Description-Content-Type: text/markdown
 Requires-Dist: aiohttp<4,>=3.9.3
 Requires-Dist: netifaces<1,>=0.11.0
 Requires-Dist: requests<3,>=2.31.0
-Requires-Dist: tftpy<1,>=0.8.2
+Requires-Dist: tftpy<=0.8.5,>=0.8.2
 
 # tinyToolsLib
 

{tinytoolslib-0.5.0 → tinytoolslib-0.6.0}/pyproject.toml

@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tinytoolslib"
-version = "0.5.0"
+version = "0.6.0"
 authors = [
     { name="Bartek Barszczewski", email="tinycontrol.software@gmail.com" },
 ]
 license = "Apache-2.0"
-description = "Set of tools for use with Tinycontrol devices like LK2.X, LK3.X, LK4.X or tcPDU."
+description = "Set of tools for use with tinycontrol devices like LK2.X, LK3.X, LK4.X or tcPDU."
 requires-python = ">=3.7"
 classifiers = [
    "Programming Language :: Python :: 3",
@@ -19,7 +19,7 @@ dependencies = [
    "aiohttp >= 3.9.3, < 4",
    "netifaces >= 0.11.0, < 1",
    "requests >= 2.31.0, < 3",
-   "tftpy >= 0.8.2, < 1",
+   "tftpy >= 0.8.2, <= 0.8.5",
 ]
 readme = "README.md"
 keywords = ["tinycontrol", "lk", "tcpdu"]

tinytoolslib-0.6.0/tinytoolslib/__version__.py

@@ -0,0 +1 @@
+__version__ = '0.6.0'

{tinytoolslib-0.5.0 → tinytoolslib-0.6.0}/tinytoolslib/models.py

@@ -59,7 +59,6 @@ class DeviceModel(ABC):
     session: Union[ClientSession, None] = None
 
     _context: Dict[str, Dict] = field(init=False, default_factory=dict)
-    _close_session: bool = False
 
     def __post_init__(self):
         if self.schema == "https" and self.port != 443:
@@ -129,7 +128,9 @@ class DeviceModel(ABC):
             password=self.password,
             **kwargs,
         )
-        return self._get(response.get("parsed"), path, skip_keys, remove_mapped_keys)
+        parsed_data = response.get("parsed")
+        parsed_data["_ping"] = response.get("ping")
+        return self._get(parsed_data, path, skip_keys, remove_mapped_keys)
 
     def set_out(self, index, value=None):
         """Set output state to value or toggle if value is None."""
@@ -215,9 +216,6 @@ class DeviceModel(ABC):
         **kwargs,
     ):
         """Async version of get."""
-        if self.session is None:
-            self.session = ClientSession()
-            self._close_session = True
         response = await async_get(
             self.host,
             path,
@@ -228,7 +226,9 @@ class DeviceModel(ABC):
             session=self.session,
             **kwargs,
         )
-        return self._get(response.get("parsed"), path, skip_keys, remove_mapped_keys)
+        parsed_data = response.get("parsed")
+        parsed_data["_ping"] = response.get("ping")
+        return self._get(parsed_data, path, skip_keys, remove_mapped_keys)
 
     async def async_set_out(self, index, value=None):
         """Async set_out."""
@@ -265,30 +265,6 @@ class DeviceModel(ABC):
             f"{self.__class__.__name__} does not support get_all command"
         )
 
-    # region Session handling for asyncio
-    async def close(self) -> None:
-        """Close open client session."""
-        await self.session.close()
-
-    async def __aenter__(self) -> "DeviceModel":
-        """Async enter.
-
-        Returns
-        -------
-            The Device object.
-        """
-        return self
-
-    async def __aexit__(self, *_exc_info: object) -> None:
-        """Async exit.
-
-        Args:
-        ----
-            _exc_info: Exec type.
-        """
-        await self.close()
-
-    # endregion
     # endregion
 
 

{tinytoolslib-0.5.0 → tinytoolslib-0.6.0}/tinytoolslib/requests.py

@@ -1,9 +1,21 @@
-"""Functions to send HTTP requests via requests and aiohttp modules."""
+"""Functions to send HTTP requests via requests and aiohttp modules.
+
+Ping can be included in response for aiohttp request if the ClientSession
+uses our trace_configs. It can be achieved in two ways:
+
+1. Using `get_session()` to get it with trace_configs set.
+2. When creating own session adding `get_trace_config()` in constructor params:
+    ```py
+    session = ClientSession(trace_configs=[get_trace_config()])
+    ```
+"""
 
 import asyncio
 import json
 import socket
+import time
 from functools import wraps
+from types import SimpleNamespace
 from typing import Any, Dict, Union
 from xml.etree import ElementTree
 
@@ -18,6 +30,7 @@ from aiohttp import (
     ClientTimeout,
     InvalidURL,
     ServerDisconnectedError,
+    TraceConfig,
 )
 
 from .exceptions import (
@@ -35,6 +48,7 @@ DEFAULT_TIMEOUT = 3
 DEFAULT_RETRIES = 1
 
 
+# region Helper functions for handling requests/responses
 def _parse_parameters(
     host, path, schema, port, username, password, timeout, retries, verify
 ):
@@ -77,7 +91,7 @@ def _handle_errors(exc, response=None):
         ClientConnectionError,
         socket.gaierror,
     ) as exc:
-        raise TinyToolsRequestConnectionError("Connection error") from exc
+        raise TinyToolsRequestConnectionError(f"Connection error ({exc})") from exc
     except (requests.exceptions.InvalidURL, InvalidURL) as exc:
         raise TinyToolsRequestError("Invalid URL") from exc
     except (requests.exceptions.HTTPError, ClientResponseError) as exc:
@@ -103,10 +117,12 @@ def _handle_content(content_type, content, response):
         "_response": response,
         "parsed": None,
     }
-    # TODO: Add ping for requests method (ATM missing for aiohttp).
     if hasattr(response, "elapsed"):
         result["elapsed"] = response.elapsed.total_seconds()
-        result["ping"] = round(result["elapsed"] * 1000, 3)
+        result["ping"] = round(result["elapsed"] * 1000, 3) # in ms
+    elif hasattr(response, "elapsed_aio"):
+        result["elapsed"] = response.elapsed_aio
+        result["ping"] = round(result["elapsed"] * 1000, 3) # in ms
     try:
         if content_type == "application/json":
             result["parsed"] = json.loads(content)
@@ -119,8 +135,10 @@ def _handle_content(content_type, content, response):
     except (ElementTree.ParseError, ValueError) as exc:
         raise TinyToolsRequestError("Cannot parse response") from exc
     return result
+# endregion
 
 
+# region Synchronous requests
 def request(
     method: str,
     host: str,
@@ -156,7 +174,7 @@ def request(
             verify=verify,
         )
         response.raise_for_status()
-    except requests.exceptions.ConnectTimeout as exc:
+    except (requests.exceptions.ConnectTimeout, requests.exceptions.ReadTimeout) as exc:
         if retries:
             return request(
                 method,
@@ -209,6 +227,33 @@ def post(*args, **kwargs):
         headers={"Content-Type": "application/x-www-form-urlencoded; charset=UTF-8"},
         **kwargs,
     )
+# endregion
+
+
+# region Asynchronous requests (aiohttp based)
+async def on_request_start(session, trace_config_ctx, params):
+    """Set timestamp for timing tracking."""
+    trace_config_ctx.start = time.perf_counter()
+
+
+async def on_request_end(session, trace_config_ctx, params):
+    """Calculate timing and set in the request context."""
+    elapsed = time.perf_counter() - trace_config_ctx.start
+    if hasattr(trace_config_ctx, "trace_request_ctx"):
+        trace_config_ctx.trace_request_ctx.elapsed = elapsed
+
+
+def get_trace_config() -> TraceConfig:
+    """Return TraceConfig with signal handlers to track request timing."""
+    trace_config = TraceConfig()
+    trace_config.on_request_start.append(on_request_start)
+    trace_config.on_request_end.append(on_request_end)
+    return trace_config
+
+
+def get_session() -> ClientSession:
+    """Return ClientSession with trace_config for timing tracking."""
+    return ClientSession(trace_configs=[get_trace_config()])
 
 
 async def async_request(
@@ -238,6 +283,7 @@ async def async_request(
         auth = BasicAuth(*auth)
     response = None
     try:
+        timing = SimpleNamespace(elapsed=None)
         async with session.request(
             method,
             url,
@@ -245,9 +291,14 @@ async def async_request(
             params=params,
             timeout=ClientTimeout(total=timeout),
             verify_ssl=verify,
+            trace_request_ctx=timing,
         ) as response:
             response.raise_for_status()
             content = await response.text()
+            # Try to handle timing
+            elapsed = timing.elapsed
+            if elapsed is not None:
+                response.elapsed_aio = elapsed
     except (asyncio.TimeoutError, ClientOSError, ServerDisconnectedError) as exc:
         # Retry only on timeout and few specific client connection errors
         # (they happen randomly at least on Windows).
@@ -287,3 +338,4 @@ async def async_get(*args, silent=False, **kwargs):
         if silent:
             return None
         raise
+# endregion

{tinytoolslib-0.5.0 → tinytoolslib-0.6.0}/tinytoolslib.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: tinytoolslib
-Version: 0.5.0
-Summary: Set of tools for use with Tinycontrol devices like LK2.X, LK3.X, LK4.X or tcPDU.
+Version: 0.6.0
+Summary: Set of tools for use with tinycontrol devices like LK2.X, LK3.X, LK4.X or tcPDU.
 Author-email: Bartek Barszczewski <tinycontrol.software@gmail.com>
 License-Expression: Apache-2.0
 Keywords: tinycontrol,lk,tcpdu
@@ -12,7 +12,7 @@ Description-Content-Type: text/markdown
 Requires-Dist: aiohttp<4,>=3.9.3
 Requires-Dist: netifaces<1,>=0.11.0
 Requires-Dist: requests<3,>=2.31.0
-Requires-Dist: tftpy<1,>=0.8.2
+Requires-Dist: tftpy<=0.8.5,>=0.8.2
 
 # tinyToolsLib
 

{tinytoolslib-0.5.0 → tinytoolslib-0.6.0}/tinytoolslib.egg-info/requires.txt

@@ -1,4 +1,4 @@
 aiohttp<4,>=3.9.3
 netifaces<1,>=0.11.0
 requests<3,>=2.31.0
-tftpy<1,>=0.8.2
+tftpy<=0.8.5,>=0.8.2

tinytoolslib-0.5.0/tinytoolslib/__version__.py

@@ -1 +0,0 @@
-__version__ = '0.5.0'