Merge pull request #55 from bmwcarit/XXXXX-fix-package-version

fix: refine package config

Author: yen3

.github/workflows/python-dlt-ci.yaml

@@ -24,7 +24,7 @@ jobs:
         with:
           image: python-dlt/python-dlt-unittest:${{ matrix.LIBDLT_VERSION }}
           options: -v ${{ github.workspace }}:/pydlt -w /pydlt
-          run: tox -e lint
+          run: tox -e black,ruff
       - name: Run unit test
         uses: addnab/docker-run-action@v3
         with:

dlt/dlt.py

@@ -95,7 +95,7 @@ def __del__(self):
             raise RuntimeError("Could not cleanup DLTFilter")
 
     def __repr__(self):
-        """return the 'official' string representation of an object"""
+        """Return the 'official' string representation of an object"""
         apids = [ctypes.string_at(entry[:DLT_ID_SIZE]) for entry in self.apid]
         ctids = [ctypes.string_at(entry[:DLT_ID_SIZE]) for entry in self.ctid]
 
@@ -287,7 +287,6 @@ def __setstate__(self, state):
     @staticmethod
     def from_bytes(data):
         """Create a class instance from a byte string in DLT storage format"""
-
         msg = DLTMessage()
         storageheader, remainder = msg.extract_storageheader(data)
 
@@ -863,7 +862,8 @@ def __len__(self):
 
 class DLTClient(cDltClient):
     """DLTClient class takes care about correct initialization and
-    cleanup"""
+    cleanup
+    """
 
     verbose = 0
 
@@ -1076,7 +1076,8 @@ def py_dlt_file_main_loop(dlt_reader, limit=None, callback=None):
 # pylint: disable=too-many-arguments,too-many-return-statements,too-many-branches
 def py_dlt_client_main_loop(client, limit=None, verbose=0, dumpfile=None, callback=None):
     """Reimplementation of dlt_client.c:dlt_client_main_loop() in order to handle callback
-    function return value"""
+    function return value
+    """
     bad_messages = 0
     while True:
         if bad_messages > 100:

dlt/dlt_broker.py

@@ -1,6 +1,7 @@
 # Copyright (C) 2015. BMW Car IT GmbH. All rights reserved.
 """DLT Broker is running in a loop in a separate thread until stop_flag is set and adding received messages
-to all registered queues"""
+to all registered queues
+"""
 from contextlib import contextmanager
 import ipaddress as ip
 import logging
@@ -64,7 +65,6 @@ def __init__(
         :param bool ignore_filter_set_ack_timeout: Ignore the timeout when the value is True
         :param **kwargs: All other args passed to DLTMessageHandler
         """
-
         # - dlt-time share memory init
         self._dlt_time_value = DLTTimeValue() if enable_dlt_time else None
 

dlt/dlt_broker_handlers.py

@@ -304,7 +304,8 @@ def break_blocking_main_loop(self):
         If it could constantly dispatch messages, then the main loop will not get into blocking state.
         Only when no more message could not be dispatched, the main loop would get into blocking state.
 
-        Not all message dispatchers need to implement this method"""
+        Not all message dispatchers need to implement this method
+        """
         pass
 
 

pyproject.toml

@@ -38,9 +38,13 @@ include = ["dlt*"]
 exclude = ["playbook*", "zuul.d*", "extracted_files*", "tests"]
 
 [build-system]
-requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"]
+requires = ["setuptools>=45", "setuptools-git-versioning"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools-git-versioning]
+enabled = true
+dev_template = "{tag}.dev{ccount}+{sha}"
+
 [tool.black]
 line-length = 119
 target_version = ['py37']
@@ -64,3 +68,42 @@ exclude = '''
   | _version.py
 )
 '''
+
+[tool.ruff]
+line-length = 119
+select = ["E", "F", "Q", "D"]
+# the following is equivalent to --docstring-convention=pep8
+extend-ignore = [
+    "D100",
+    "D107",
+    "D105",
+    "D401",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "D200",
+    "D400",
+    "D203",
+    "D205",
+    "D212",
+    "D213",
+    "D214",
+    "D215",
+    "D404",
+    "D405",
+    "D406",
+    "D407",
+    "D408",
+    "D409",
+    "D410",
+    "D411",
+    "D413",
+    "D415",
+    "D416",
+    "D417",
+]
+
+# D104: Missing docstring in public package
+# This D104 error will be ignored only in __init__ files
+per-file-ignores = {"__init__.py" = ["D104"]}

setup.cfg

@@ -20,7 +20,6 @@ def fake_py_dlt_client_main_loop(client, callback, *args, **kwargs):
 @contextmanager
 def dlt_broker(pydlt_main_func=fake_py_dlt_client_main_loop, enable_dlt_time=True, enable_filter_set_ack=False):
     """Initialize a fake DLTBroker"""
-
     with patch("dlt.dlt_broker_handlers.DLTMessageHandler._client_connect"), patch(
         "dlt.dlt_broker_handlers.py_dlt_client_main_loop", side_effect=pydlt_main_func
     ):
@@ -224,7 +223,6 @@ def test_add_context_with_ack_warning():
 
 def test_start_stop_dlt_filter_ack_msg_handler():
     """Test to start/stop DLTFilterAckMessageHandler normally"""
-
     with dlt_filter_ack_msg_handler() as (handler, _):
         pass
 

tests/dlt_broker_time_test.py

@@ -1,5 +1,5 @@
 [tox]
-envlist = py3,lint
+envlist = py3,black,ruff
 output_dir={env:SPHINX_OUTPUT_DIR:{toxworkdir}/_build}
 isolated_build = True
 
@@ -19,14 +19,21 @@ commands =
 filterwarnings =
     error
 
-[testenv:lint]
+[testenv:ruff]
+basepython = python3
+skip_install = true
+deps =
+    ruff
+    mypy
+commands =
+    ruff .
+
+[testenv:black]
 skip_install = True
 skipsdist = True
 deps =
-    flake8
     black
 commands =
-    flake8
     black -l 119 --check .
 
 [testenv:docs]