ul-data-logger-api-sdk 1.3.6__tar.gz → 2.0.0__tar.gz

{ul-data-logger-api-sdk-1.3.6 → ul-data-logger-api-sdk-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-data-logger-api-sdk
-Version: 1.3.6
+Version: 2.0.0
 Summary: Data logger API sdk
 Author: Unic-lab
 License: MIT

{ul-data-logger-api-sdk-1.3.6 → ul-data-logger-api-sdk-2.0.0}/data_logger_api_sdk/data_logger_api_sdk.py

@@ -2,16 +2,16 @@ import json
 import time
 from datetime import datetime
 from functools import lru_cache
-from typing import List, Type, Optional
+from typing import List, Type
 
 from ul_api_utils.internal_api.internal_api import InternalApi
 from ul_api_utils.internal_api.internal_api_response import TPyloadType
 from ul_api_utils.utils.api_method import ApiMethod
 
-from data_logger_api_sdk.types.api_device_data_history import ApiDeviceDataHistoryResponse, ApiDeviceDataHistoryBody
+from data_logger_api_sdk.data_logger_sdk_config import DataLoggerApiSdkConfig
+from data_logger_api_sdk.types.api_device_data_history import ApiDeviceDataHistoryBody, ApiDeviceDataHistoryResponse
 from data_logger_api_sdk.types.api_packet_types import ApiPacketTypesListResponse
 from data_logger_api_sdk.types.api_protocol_types import ApiProtocolTypesListResponse
-from data_logger_api_sdk.data_logger_sdk_config import DataLoggerApiSdkConfig
 
 
 class DataLoggerApiSdk:
@@ -20,45 +20,47 @@ class DataLoggerApiSdk:
         self._config = config
         self._api = InternalApi(entry_point=self._config.api_url, default_auth_token=self._config.api_token)
 
-    @lru_cache(maxsize=None)  # noqa: B019 # there should not be leaks memory leaks. flake8 just scared inmemory cache ;)
+    @lru_cache(maxsize=None)  # there should not be leaks memory leaks. flake8 just scared inmemory cache ;)
     def request_payload(
         self,
         _: int,
         method: ApiMethod,
         endpoint: str,
         typed_as: Type[TPyloadType],
-        body: Optional[str],
+        body: str | None,
     ) -> TPyloadType:
-        return self._api.request(
-            method=method,
-            path=endpoint,
-            json=json.loads(body) if body is not None else None,
-        ) \
-            .typed(typed_as) \
-            .check() \
+        return (
+            self._api.request(
+                method=method,
+                path=endpoint,
+                json=json.loads(body) if body is not None else None,
+            )
+            .typed(typed_as)
+            .check()
             .payload
+        )
 
     def _get_cache_post_payload(
         self,
         method: ApiMethod,
         path: str,
         typed: Type[TPyloadType],
-        body: Optional[str] = None,
+        body: str | None = None,
     ) -> TPyloadType:
         ttl_status = round(time.time() / self._config.cache_ttl_s)
-        return self.request_payload(ttl_status, method, path, typed, body)     # type: ignore  # Type[TPyloadType] is hashable
+        return self.request_payload(ttl_status, method, path, typed, body)  # type: ignore  # Type[TPyloadType] is hashable
 
     def get_protocol_types_list(self, mac: int) -> List[str]:
         return self._get_cache_post_payload(
             ApiMethod.GET,
-            f'/devices/mac/{mac}/logs/protocol-types',
+            f"/devices/mac/{mac}/logs/protocol-types",
             ApiProtocolTypesListResponse,
         ).protocol_types
 
     def get_packet_types_list(self, mac: int) -> List[str]:
         return self._get_cache_post_payload(
             ApiMethod.GET,
-            f'/devices/mac/{mac}/logs/packet-types',
+            f"/devices/mac/{mac}/logs/packet-types",
             ApiPacketTypesListResponse,
         ).packet_types
 
@@ -67,8 +69,8 @@ class DataLoggerApiSdk:
         period_from: datetime,
         period_to: datetime,
         mac: int,
-        protocol_type: Optional[str] = None,
-        packet_type: Optional[str] = None,
+        protocol_type: str | None = None,
+        packet_type: str | None = None,
     ) -> List[ApiDeviceDataHistoryResponse]:
         api_device_history_body = ApiDeviceDataHistoryBody(
             period_from=period_from,
@@ -76,10 +78,10 @@ class DataLoggerApiSdk:
             mac=mac,
             protocol_type=protocol_type,
             packet_type=packet_type,
-        ).json()
+        ).model_dump_json()
         return self._get_cache_post_payload(
             ApiMethod.POST,
-            '/device-data-history',
-            List[ApiDeviceDataHistoryResponse],     # type: ignore
+            "/device-data-history",
+            List[ApiDeviceDataHistoryResponse],  # type: ignore
             api_device_history_body,
         )

{ul-data-logger-api-sdk-1.3.6 → ul-data-logger-api-sdk-2.0.0}/data_logger_api_sdk/data_logger_sdk_config.py

@@ -1,7 +1,7 @@
-from typing import NamedTuple, Optional
+from typing import NamedTuple
 
 
 class DataLoggerApiSdkConfig(NamedTuple):
     api_url: str
-    api_token: Optional[str] = None
+    api_token: str | None = None
     cache_ttl_s: int = 3600

{ul-data-logger-api-sdk-1.3.6 → ul-data-logger-api-sdk-2.0.0}/data_logger_api_sdk/types/api_device_data_history.py

@@ -1,26 +1,27 @@
 from datetime import datetime
-from typing import Optional
 from uuid import UUID
 
-from ul_api_utils.api_resource.api_response import JsonApiResponsePayload
 from data_aggregator_sdk.integration_message import IntegrationV0MessageMeta
-from pydantic import BaseModel, validator
+from pydantic import BaseModel, field_validator
+from ul_api_utils.api_resource.api_response import JsonApiResponsePayload
 
 
 class ApiDeviceDataHistoryBody(BaseModel):
     period_from: datetime
     period_to: datetime
     mac: int
-    protocol_type: Optional[str]
-    packet_type: Optional[str]
+    protocol_type: str | None = None
+    packet_type: str | None = None
 
-    @validator('period_from', pre=True)
+    @field_validator("period_from", mode="before")
+    @classmethod
     def validate_period_from(cls, value: str | datetime) -> datetime:
         if isinstance(value, str):
             return datetime.combine(datetime.fromisoformat(value), datetime.min.time())
         return value
 
-    @validator('period_to', pre=True)
+    @field_validator("period_to", mode="before")
+    @classmethod
     def validate_period_to(cls, value: str | datetime) -> datetime:
         if isinstance(value, str):
             return datetime.combine(datetime.fromisoformat(value), datetime.max.time())
@@ -29,9 +30,9 @@ class ApiDeviceDataHistoryBody(BaseModel):
 
 class ApiDeviceDataHistoryResponse(JsonApiResponsePayload):
     mac: int
-    bs_serial_numer: int
+    bs_serial_number: int | None = None
     date_created: datetime
-    id: Optional[UUID]
+    id: UUID | None = None
     raw_dt: datetime
     raw_payload: str
     raw_message: str

ul-data-logger-api-sdk-2.0.0/pyproject.toml

@@ -0,0 +1,130 @@
+[tool.pytest.ini_options]
+addopts = """
+    --cov src \
+    --no-cov-on-fail \
+    --cov-report term-missing \
+    --cov-report html:./.tmp/coverage \
+    --maxfail=1 \
+    --tb=short \
+    -vvv \
+    -ra \
+    -q \
+    --showlocals \
+    -p pytest_cov"""
+log_cli = true
+cache_dir = "./.tmp/pytest-cache"
+testpaths = [
+    "__tests__",
+]
+norecursedirs = [
+    ".*",
+    ".git",
+    ".tmp",
+    "srv",
+    "node_modules",
+]
+
+[tool.mypy]
+plugins = [
+    "sqlmypy",
+    "sqlalchemy.ext.mypy.plugin",
+    "pydantic.mypy"
+]
+#packages = [
+#    "src",
+#    "__tests__",
+#]
+exclude = ["migrations"]
+cache_dir = "./.tmp/mypy-cache"
+python_version = "3.10"
+warn_return_any = false
+warn_unused_configs = true
+ignore_missing_imports = false
+follow_imports = "normal"
+namespace_packages = true
+explicit_package_bases = true
+follow_imports_for_stubs = true
+implicit_reexport = true
+allow_untyped_globals = false
+disallow_any_generics = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = false
+no_implicit_optional = true
+strict_optional = true
+warn_unused_ignores = true
+warn_no_return = true
+show_none_errors = true
+ignore_errors = false
+allow_redefinition = false
+strict_equality = true
+show_error_context = false
+show_column_numbers = false
+warn_redundant_casts = true
+warn_unreachable = true
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
+warn_untyped_fields = true
+
+[[tool.mypy.overrides]]
+module = [
+    "sqlalchemy_serializer",
+    "api_utils"
+]
+ignore_missing_imports = true
+
+[tool.ruff]
+exclude = ["migrations"]
+line-length = 150
+target-version = "py310"
+cache-dir = "./.tmp/ruff-cache"
+
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = ["D", "RUF001", "PGH003"]
+extend-ignore = [
+    "S311",     # Generated data isn't always used for cryptographic purposes
+    "N805",     # First argument of a method should be named `self` - but pydantic docs use cls
+    "TRY003",   # Avoid specifying long messages outside the exception class - but pydantic allow to use simple raise error
+    "EM101",    # Exception must not use a string literal, assign to variable first - duplicate msg? ok
+    "S101",     # Use of `assert` detected - only way to deal with paranoic mypy
+    "PLR0913",  # Too many arguments in function definition (6 > 5) - maybe good. wiil be refactored later
+    "RUF012",   # Mutable class attributes should be annotated with `typing.ClassVar` - sqlalchemy allow to mutations
+    "G004",     # Logging statement uses f-string - it's OK
+    "UP035",    # `typing.List` is deprecated, use `list` instead - yes, but `list` broke api-utils @rest_api
+    "UP006",    # Use `list` instead of `List` for type annotation - yes, but `list` broke api-utils @rest_api
+    "ANN401",   # Checks that function arguments are annotated with a more specific type than Any
+    "ANN101",   # This rule is commonly disabled because type checkers can infer this type without annotation. It will be removed in a future release
+    "C901",     # Checks for functions with a high McCabe complexity
+    "ERA001",   # Checks for commented-out Python code
+    "ANN102",   # Checks that class method cls arguments have type annotations
+    "PGH004",   # Check for noqa annotations that suppress all diagnostics, as opposed to targeting specific diagnostics
+    "A002",     # Checks for any function arguments that use the same name as a builtin
+    "A001",     # Checks for variable (and function) assignments that use the same name as a builtin
+    "B019",     # Checks for uses of the functools.lru_cache and functools.cache decorators on methods
+    "PLW0603",  # Checks for the use of global statements to update identifiers
+    "UP033",    # Checks for uses of functools.lru_cache that set maxsize=None
+    "FIX002",   # Checks for "TODO" comments
+    "TD002",    # Checks that a TODO comment includes an author
+    "TD003",    # Checks that a TODO comment is associated with a link to a relevant issue or ticket
+    "FBT001",   # Checks for the use of boolean positional arguments in function definitions, as determined by the presence of a bool type hint
+    "PERF203",  # Checks for uses of except handling via try-except within for and while loops
+    "A005",     # Checks if module shadows a Python standard-library module
+]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 4
+
+[tool.black]
+target-version = ["py310"]
+exclude = "migrations"
+#include = [
+#    "^/src",
+#    "^/notification_sdk",
+#]
+check = false

{ul-data-logger-api-sdk-1.3.6 → ul-data-logger-api-sdk-2.0.0}/setup.py

@@ -1,27 +1,28 @@
 import sys
-from os import path
-from setuptools import setup, find_packages
+from pathlib import Path
 
-HERE = path.abspath(path.dirname(__file__))
+from setuptools import find_packages, setup
 
-with open(path.join(HERE, 'README.md'), encoding='utf-8') as f:
+HERE = Path(__file__).resolve().parent
+
+with Path.open(Path(HERE) / "README.md", encoding="utf-8") as f:
     long_description = f.read()
 
 if sys.argv:
-    if 'broker_sdk' in set(sys.argv):
+    if "broker_sdk" in set(sys.argv):
         sys.argv.remove("broker_sdk")
         setup(
-            name='ul-data-logger-sdk',
-            version='2.1.6',
-            description='Data logger sdk',
-            author='Unic-lab',
+            name="ul-data-logger-sdk",
+            version="3.0.0",
+            description="Data logger sdk",
+            author="Unic-lab",
             long_description=long_description,
             long_description_content_type="text/markdown",
-            packages=find_packages(include=['data_logger_sdk*']),
+            packages=find_packages(include=["data_logger_sdk*"]),
             include_package_data=True,
             package_data={
-                '': ['*.yml', 'py.typed'],
-                'data_logger_sdk': ['py.typed'],
+                "": ["*.yml", "py.typed"],
+                "data_logger_sdk": ["py.typed"],
             },
             license="MIT",
             classifiers=[
@@ -34,30 +35,30 @@ if sys.argv:
                 "Programming Language :: Python :: 3.9",
                 "Operating System :: OS Independent",
             ],
-            platforms='any',
+            platforms="any",
             install_requires=[
-                "unipipeline>=1.4.5",
-                # "ul-data-aggregator-sdk==8.12.0,
-                # "ul-py-tool==1.15.20",
-                # "ul-db-utils==2.10.7",
-                # "ul-api-utils==7.3.0",
-                # "ul-data-gateway-sdk==0.4.5",
+                "ul-unipipeline>=2.0.0",
+                # "ul-data-aggregator-sdk>=8.13.2",
+                # "ul-py-tool==2.1.2,
+                # "ul-api-utils==8.1.6",
+                # "ul-db-utils==4.0.2",
+                # "ul-data-gateway-sdk==1.0.3",
             ],
         )
-    elif 'api_sdk' in set(sys.argv):
+    elif "api_sdk" in set(sys.argv):
         sys.argv.remove("api_sdk")
         setup(
-            name='ul-data-logger-api-sdk',
-            version='1.3.6',
-            description='Data logger API sdk',
-            author='Unic-lab',
+            name="ul-data-logger-api-sdk",
+            version="2.0.0",
+            description="Data logger API sdk",
+            author="Unic-lab",
             long_description=long_description,
             long_description_content_type="text/markdown",
-            packages=find_packages(include=['data_logger_api_sdk*']),
+            packages=find_packages(include=["data_logger_api_sdk*"]),
             include_package_data=True,
             package_data={
-                '': ['*.yml', 'py.typed'],
-                'data_logger_api_sdk': ['py.typed'],
+                "": ["*.yml", "py.typed"],
+                "data_logger_api_sdk": ["py.typed"],
             },
             license="MIT",
             classifiers=[
@@ -70,13 +71,14 @@ if sys.argv:
                 "Programming Language :: Python :: 3.9",
                 "Operating System :: OS Independent",
             ],
-            platforms='any',
+            platforms="any",
             install_requires=[
-                "unipipeline>=1.4.5",
+                "ul-unipipeline>=2.0.0",
+                "tqdm==4.66.1",
                 # "ul-data-aggregator-sdk>=8.13.2",
-                # "ul-data-aggregator-sdk==8.13.2,
-                # "ul-py-tool==1.15.20",
-                # "ul-api-utils==7.3.5",
-                # "ul-data-gateway-sdk==0.4.7",
+                # "ul-py-tool==2.1.2,
+                # "ul-api-utils==8.1.6",
+                # "ul-db-utils==4.0.2",
+                # "ul-data-gateway-sdk==1.0.3",
             ],
         )

{ul-data-logger-api-sdk-1.3.6 → ul-data-logger-api-sdk-2.0.0}/ul_data_logger_api_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-data-logger-api-sdk
-Version: 1.3.6
+Version: 2.0.0
 Summary: Data logger API sdk
 Author: Unic-lab
 License: MIT

{ul-data-logger-api-sdk-1.3.6 → ul-data-logger-api-sdk-2.0.0}/ul_data_logger_api_sdk.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 README.md
+pyproject.toml
 setup.py
 data_logger_api_sdk/__init__.py
 data_logger_api_sdk/data_logger_api_sdk.py

ul-data-logger-api-sdk-2.0.0/ul_data_logger_api_sdk.egg-info/requires.txt

@@ -0,0 +1,2 @@
+ul-unipipeline>=2.0.0
+tqdm==4.66.1

ul-data-logger-api-sdk-1.3.6/ul_data_logger_api_sdk.egg-info/requires.txt

@@ -1 +0,0 @@
-unipipeline>=1.4.5