1.5 (#24)

Added option to specify custom CRC function
spacemanspiff2007 · Nov 4, 2024 · d261a65 · d261a65
1 parent 1e128bd
commit d261a65
Show file tree

Hide file tree

Showing 35 changed files with 393 additions and 225 deletions.
diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml
@@ -15,10 +15,10 @@ jobs:
     - uses: actions/checkout@v4
       with:
         ref: master
-    - name: Set up Python 3.10
+    - name: Set up Python 3.12
       uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
+        python-version: '3.12'
 
     - name: Install setuptools
       run: |

diff --git a/.github/workflows/run_tox.yml b/.github/workflows/run_tox.yml
@@ -10,8 +10,8 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
-      - uses: pre-commit/[email protected].0
+          python-version: '3.12'
+      - uses: pre-commit/[email protected].1
 
 
   tests:
@@ -20,7 +20,7 @@ jobs:
     strategy:
       max-parallel: 2
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
 
     steps:
     - uses: actions/checkout@v4

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-ast
       - id: check-builtin-literals
@@ -14,9 +14,27 @@ repos:
 
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.5
+    rev: v0.7.2
     hooks:
       - id: ruff
+        name: ruff unused imports
+        #  F401 [*] {name} imported but unused
+        args: [ "--select", "F401", "--extend-exclude", "__init__.py", "--fix"]
+
+      - id: ruff
+        #  I001 [*] Import block is un-sorted or un-formatted
+        # UP035 [*] Import from {target} instead: {names}
+        #  Q000 [*] Double quote found but single quotes preferred
+        #  Q001 [*] Double quote multiline found but single quotes preferred
+        args: [ "--select", "I001,UP035,Q000,Q001", "--fix"]
+
+
+  - repo: https://github.com/JelleZijlstra/autotyping
+    rev: 24.9.0
+    hooks:
+      - id: autotyping
+        types: [python]
+        args: [--safe]
 
 
   - repo: meta

diff --git a/.ruff.toml b/.ruff.toml
@@ -1,66 +1,96 @@
-
-line-length = 120
 indent-width = 4
+line-length  = 120
 
 target-version = "py38"
-src = ["src", "test"]
-
-[lint]
 
-# https://docs.astral.sh/ruff/settings/#ignore-init-module-imports
-ignore-init-module-imports = true
-
-select = [
-    "E", "W",   # https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
-    "I",        # https://docs.astral.sh/ruff/rules/#isort-i
-    "UP",       # https://docs.astral.sh/ruff/rules/#pyupgrade-up
-
-    "A",        # https://docs.astral.sh/ruff/rules/#flake8-builtins-a
-    "ASYNC",    # https://docs.astral.sh/ruff/rules/#flake8-async-async
-    "C4",       # https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
-    "EM",       # https://docs.astral.sh/ruff/rules/#flake8-errmsg-em
-    "FIX",      # https://docs.astral.sh/ruff/rules/#flake8-fixme-fix
-    "INP",      # https://docs.astral.sh/ruff/rules/#flake8-no-pep420-inp
-    "ISC",      # https://docs.astral.sh/ruff/rules/#flake8-implicit-str-concat-isc
-    "PIE",      # https://docs.astral.sh/ruff/rules/#flake8-pie-pie
-    "PT",       # https://docs.astral.sh/ruff/rules/#flake8-pytest-style-pt
-    "PTH",      # https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
-    "RET",      # https://docs.astral.sh/ruff/rules/#flake8-return-ret
-    "SIM",      # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
-    "SLOT",     # https://docs.astral.sh/ruff/rules/#flake8-slots-slot
-    "T10",      # https://docs.astral.sh/ruff/rules/#flake8-debugger-t10
-    "TCH",      # https://docs.astral.sh/ruff/rules/#flake8-type-checking-tch
-    "TD",       # https://docs.astral.sh/ruff/rules/#flake8-todos-td
-
-    "TRY",      # https://docs.astral.sh/ruff/rules/#tryceratops-try
-    "FLY",      # https://docs.astral.sh/ruff/rules/#flynt-fly
-    "PERF",     # https://docs.astral.sh/ruff/rules/#perflint-perf
-    "RUF",      # https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
-
-    # "PL",       # https://docs.astral.sh/ruff/rules/#pylint-pl
-    # "FURB",     # https://docs.astral.sh/ruff/rules/#refurb-furb
+src = [
+    "src",
+    "tests"
 ]
 
+
+[lint]
+select = ["ALL"]
+
 ignore = [
-    "PT007"    # Wrong values type in `@pytest.mark.parametrize` expected `list` of `tuple`
+    "D",        # https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    "T20",      # https://docs.astral.sh/ruff/rules/#flake8-print-t20
+    "DTZ",      # https://docs.astral.sh/ruff/rules/#flake8-datetimez-dtz
+    "SLF",      # https://docs.astral.sh/ruff/rules/#flake8-self-slf
+
+    "RET501",   # https://docs.astral.sh/ruff/rules/unnecessary-return-none/#unnecessary-return-none-ret501
+    "TRY400",   # https://docs.astral.sh/ruff/rules/error-instead-of-exception/
+
+    # https://docs.astral.sh/ruff/rules/#flake8-builtins-a
+    "A003",     # Python builtin is shadowed by class attribute {name} from {row}
+
+    # https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "F401",     # {name} imported but unused; consider using importlib.util.find_spec to test for availability
+
+    # https://docs.astral.sh/ruff/rules/#flake8-bandit-s
+    "S311",     # Standard pseudo-random generators are not suitable for cryptographic purposes
+
+    # https://docs.astral.sh/ruff/rules/#pyupgrade-up
+    "UP038",    # Use X | Y in {} call instead of (X, Y)
+
+    # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
+    "ANN101",   # Missing type annotation for {name} in method
+    "ANN102",   # Missing type annotation for {name} in classmethod
+    "ANN401",   # Dynamically typed expressions (typing.Any) are disallowed in {name}
+
+    # https://docs.astral.sh/ruff/rules/#flake8-blind-except-ble
+    "BLE001",   # Do not catch blind exception: {name}
+
+    # https://docs.astral.sh/ruff/rules/#flake8-raise-rse
+    "RSE102",   # Unnecessary parentheses on raised exception
+
+    # https://docs.astral.sh/ruff/rules/#flake8-commas-com
+    "COM812",   # Trailing comma missing
+    "COM819",   # Trailing comma prohibited
+
+    # https://docs.astral.sh/ruff/rules/#warning-w_1
+    "PLW0603",  # Using the global statement to update {name} is discouraged
+
+    # https://docs.astral.sh/ruff/rules/#flake8-logging-format-g
+    "G004",     # Logging statement uses f-string
+
+    # https://docs.astral.sh/ruff/rules/#refactor-r
+    "PLR1711",  # Useless return statement at end of function
+
+    # https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
+    "RUF005",  # Consider {expression} instead of concatenation
 ]
 
 
 [format]
-# Use single quotes for non-triple-quoted strings.
 quote-style = "single"
 
 
-# [lint.flake8-builtins]
-# builtins-ignorelist = ["id", "input"]
+# https://docs.astral.sh/ruff/settings/#lintflake8-quotes
+[lint.flake8-quotes]
+inline-quotes    = "single"
+multiline-quotes = "single"
 
 
-[lint.per-file-ignores]
-"src/smllib/errors.py" = ["A002"]           #  Argument `type` is shadowing a Python builtin
-"src/smllib/sml/_field_info.py" = ["A002"]  #  Argument `type` is shadowing a Python builtin
-"tests/*"  = ["INP001"] # INP001 File `PATH` is part of an implicit namespace package. Add an `__init__.py`.
+[lint.flake8-builtins]
+builtins-ignorelist = ["id", "input"]
 
 
+# https://docs.astral.sh/ruff/settings/#lintisort
 [lint.isort]
-# https://docs.astral.sh/ruff/settings/#lint_isort_lines-after-imports
-lines-after-imports = 2
+lines-after-imports = 2     # https://docs.astral.sh/ruff/settings/#lint_isort_lines-after-imports
+
+
+[lint.per-file-ignores]
+"setup.py" = ["PTH123"]
+
+"tests/*" = [
+    "ANN",  # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
+
+    # https://docs.astral.sh/ruff/rules/#flake8-bandit-s
+    "S101",     # Use of assert detected
+
+    # https://docs.astral.sh/ruff/rules/#refactor-r
+    "PLR2004",  # Magic value used in comparison, consider replacing {value} with a constant variable
+    "PLR0913",  # Too many arguments in function definition ({c_args} > {max_args})
+]
diff --git a/readme.md b/readme.md
@@ -2,7 +2,7 @@
 [![Tests Status](https://github.com/spacemanspiff2007/SmlLib/workflows/Tests/badge.svg)](https://github.com/spacemanspiff2007/SmlLib/actions?query=workflow%3ATests)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/SmlLib)](https://pypi.org/project/smllib/)
 [![PyPI](https://img.shields.io/pypi/v/SmlLib)](https://pypi.org/project/smllib/)
-[![Downloads](https://pepy.tech/badge/SmlLib)](https://pepy.tech/project/SmlLib)
+[![Downloads](https://static.pepy.tech/badge/SmlLib/month)](https://pepy.tech/project/SmlLib)
 
 
 _A SML (Smart Message Language) library_
@@ -147,3 +147,19 @@ SmlMessage
         global_signature: None
     crc16         : 56696
 ```
+
+
+## Different CRC functions
+
+Some meters e.g. the Holley DTZ541 via RS485 require a different crc function.
+You can set the crc function when creating the StreamReader.
+
+
+Example:
+```python
+from smllib import SmlStreamReader
+
+stream = SmlStreamReader(crc='kermit')  # <-- use kermit for Holley DTZ541
+stream.add(b'BytesFromSerialPort')
+sml_frame = stream.get_frame()
+```
diff --git a/requirements.txt b/requirements.txt
@@ -6,10 +6,10 @@
 # -----------------------------------------------------------------------------
 # Packages for source formatting
 # -----------------------------------------------------------------------------
-ruff       == 0.3.4
-pre-commit == 3.7.0
+ruff       == 0.7.2
+pre-commit == 5.0.0
 
 # -----------------------------------------------------------------------------
 # Packages for other developement tasks
 # -----------------------------------------------------------------------------
-pur == 7.3.1    # Update requirements.txt
+pur == 7.3.2    # Update requirements.txt
diff --git a/requirements_tests.txt b/requirements_tests.txt
@@ -1 +1 @@
-pytest == 8.1.1
+pytest == 8.3.3
diff --git a/setup.py b/setup.py
@@ -6,7 +6,7 @@
 
 def load_version() -> str:
     version: typing.Dict[str, str] = {}
-    with (Path(__file__).parent / "src/smllib/__version__.py").open() as fp:
+    with (Path(__file__).parent / 'src/smllib/__version__.py').open() as fp:
         exec(fp.read(), version)
     assert version['__version__'], version
     return version['__version__']
@@ -21,40 +21,41 @@ def load_version() -> str:
 readme = Path(__file__).with_name('readme.md')
 long_description = ''
 if readme.is_file():
-    with readme.open("r", encoding='utf-8') as fh:
+    with readme.open('r', encoding='utf-8') as fh:
         long_description = fh.read()
 
 setuptools.setup(
-    name="smllib",
+    name='smllib',
     version=__version__,
-    author="spaceman_spiff",
+    author='spaceman_spiff',
     # author_email="",
-    description="A library for the SML (Smart Message Language) protocol",
+    description='A library for the SML (Smart Message Language) protocol',
     keywords=[
         'sml',
         'obis',
         'smart message language',
         'energy meter',
     ],
     long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/spacemanspiff2007/SmlLib",
+    long_description_content_type='text/markdown',
+    url='https://github.com/spacemanspiff2007/SmlLib',
     project_urls={
-        'GitHub': "https://github.com/spacemanspiff2007/SmlLib",
+        'GitHub': 'https://github.com/spacemanspiff2007/SmlLib',
     },
     packages=setuptools.find_packages(where='src', exclude=['tests*']),
     package_dir={'': 'src'},
     package_data={'smllib': ['py.typed']},
     classifiers=[
-        "Development Status :: 4 - Beta",
-        "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "Programming Language :: Python :: 3.12",
-        "Programming Language :: Python :: 3 :: Only",
-        "Topic :: Home Automation"
+        'Development Status :: 4 - Beta',
+        'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Programming Language :: Python :: 3.13',
+        'Programming Language :: Python :: 3 :: Only',
+        'Topic :: Home Automation'
     ],
 )
diff --git a/src/smllib/__version__.py b/src/smllib/__version__.py
@@ -1 +1 @@
-__version__ = '1.4'
+__version__ = '1.5'
diff --git a/src/smllib/builder/_builder.py b/src/smllib/builder/_builder.py
@@ -8,7 +8,7 @@
 class SmlObjBuilder(Generic[T_SML_OBJ]):
     BUILDS: Type[T_SML_OBJ]
 
-    def __init__(self):
+    def __init__(self) -> None:
         assert issubclass(self.BUILDS, SmlBaseObj), self.BUILDS
         self.fields: Dict[str, SmlObjFieldInfo] = inspect_obj(self.BUILDS)
 

diff --git a/src/smllib/crc/__init__.py b/src/smllib/crc/__init__.py
@@ -0,0 +1 @@
+from . import kermit, x25
diff --git a/src/smllib/crc/kermit.py b/src/smllib/crc/kermit.py
@@ -0,0 +1,44 @@
+from typing import Union
+
+
+CRC_16_KERMIT_TABLE = [
+    0x0000, 0x1189, 0x2312, 0x329B, 0x4624, 0x57AD, 0x6536, 0x74BF,
+    0x8C48, 0x9DC1, 0xAF5A, 0xBED3, 0xCA6C, 0xDBE5, 0xE97E, 0xF8F7,
+    0x1081, 0x0108, 0x3393, 0x221A, 0x56A5, 0x472C, 0x75B7, 0x643E,
+    0x9CC9, 0x8D40, 0xBFDB, 0xAE52, 0xDAED, 0xCB64, 0xF9FF, 0xE876,
+    0x2102, 0x308B, 0x0210, 0x1399, 0x6726, 0x76AF, 0x4434, 0x55BD,
+    0xAD4A, 0xBCC3, 0x8E58, 0x9FD1, 0xEB6E, 0xFAE7, 0xC87C, 0xD9F5,
+    0x3183, 0x200A, 0x1291, 0x0318, 0x77A7, 0x662E, 0x54B5, 0x453C,
+    0xBDCB, 0xAC42, 0x9ED9, 0x8F50, 0xFBEF, 0xEA66, 0xD8FD, 0xC974,
+    0x4204, 0x538D, 0x6116, 0x709F, 0x0420, 0x15A9, 0x2732, 0x36BB,
+    0xCE4C, 0xDFC5, 0xED5E, 0xFCD7, 0x8868, 0x99E1, 0xAB7A, 0xBAF3,
+    0x5285, 0x430C, 0x7197, 0x601E, 0x14A1, 0x0528, 0x37B3, 0x263A,
+    0xDECD, 0xCF44, 0xFDDF, 0xEC56, 0x98E9, 0x8960, 0xBBFB, 0xAA72,
+    0x6306, 0x728F, 0x4014, 0x519D, 0x2522, 0x34AB, 0x0630, 0x17B9,
+    0xEF4E, 0xFEC7, 0xCC5C, 0xDDD5, 0xA96A, 0xB8E3, 0x8A78, 0x9BF1,
+    0x7387, 0x620E, 0x5095, 0x411C, 0x35A3, 0x242A, 0x16B1, 0x0738,
+    0xFFCF, 0xEE46, 0xDCDD, 0xCD54, 0xB9EB, 0xA862, 0x9AF9, 0x8B70,
+    0x8408, 0x9581, 0xA71A, 0xB693, 0xC22C, 0xD3A5, 0xE13E, 0xF0B7,
+    0x0840, 0x19C9, 0x2B52, 0x3ADB, 0x4E64, 0x5FED, 0x6D76, 0x7CFF,
+    0x9489, 0x8500, 0xB79B, 0xA612, 0xD2AD, 0xC324, 0xF1BF, 0xE036,
+    0x18C1, 0x0948, 0x3BD3, 0x2A5A, 0x5EE5, 0x4F6C, 0x7DF7, 0x6C7E,
+    0xA50A, 0xB483, 0x8618, 0x9791, 0xE32E, 0xF2A7, 0xC03C, 0xD1B5,
+    0x2942, 0x38CB, 0x0A50, 0x1BD9, 0x6F66, 0x7EEF, 0x4C74, 0x5DFD,
+    0xB58B, 0xA402, 0x9699, 0x8710, 0xF3AF, 0xE226, 0xD0BD, 0xC134,
+    0x39C3, 0x284A, 0x1AD1, 0x0B58, 0x7FE7, 0x6E6E, 0x5CF5, 0x4D7C,
+    0xC60C, 0xD785, 0xE51E, 0xF497, 0x8028, 0x91A1, 0xA33A, 0xB2B3,
+    0x4A44, 0x5BCD, 0x6956, 0x78DF, 0x0C60, 0x1DE9, 0x2F72, 0x3EFB,
+    0xD68D, 0xC704, 0xF59F, 0xE416, 0x90A9, 0x8120, 0xB3BB, 0xA232,
+    0x5AC5, 0x4B4C, 0x79D7, 0x685E, 0x1CE1, 0x0D68, 0x3FF3, 0x2E7A,
+    0xE70E, 0xF687, 0xC41C, 0xD595, 0xA12A, 0xB0A3, 0x8238, 0x93B1,
+    0x6B46, 0x7ACF, 0x4854, 0x59DD, 0x2D62, 0x3CEB, 0x0E70, 0x1FF9,
+    0xF78F, 0xE606, 0xD49D, 0xC514, 0xB1AB, 0xA022, 0x92B9, 0x8330,
+    0x7BC7, 0x6A4E, 0x58D5, 0x495C, 0x3DE3, 0x2C6A, 0x1EF1, 0x0F78
+]
+
+
+def get_crc(buf: Union[memoryview, bytes]) -> int:
+    crc = 0x0000  # Initial value for CRC16 KERMIT
+    for byte in buf:
+        crc = (crc >> 8) ^ CRC_16_KERMIT_TABLE[(crc ^ byte) & 0xFF]
+    return crc
diff --git a/src/smllib/crc.py → src/smllib/crc/x25.py b/src/smllib/crc.py → src/smllib/crc/x25.py