Update ruff configuration

- Run ruff in GitHub test workflow

Author: ThyMYthOS

.github/workflows/test-python-package.yml

@@ -25,6 +25,8 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: uv sync --locked --all-extras --dev
+    - name: Run Ruff
+      run: uvx ruff check . --output-format=github
     - name: Run tests
       run: |
         uv run pytest \

example.py

@@ -1,15 +1,18 @@
 #!/usr/bin/env python3
 import time
-from pystiebeleltron import pystiebeleltron as pyse
+
 from pymodbus.client import ModbusTcpClient as ModbusClient
 
+from pystiebeleltron import pystiebeleltron as pyse
+
 host_ip = "192.168.1.20"
 host_port = 502
 device_id = 1
 
+
 def test_function(mod, fun):
     """Executes the given function on the Stiebel Heatpump and prints the result."""
-    result = getattr(mod, fun) # Executes function directly, instead of giving back the function reference
+    result = getattr(mod, fun)  # Executes function directly, instead of giving back the function reference
     print("{}: {}".format(str(fun), str(result)))
 
 
@@ -40,9 +43,7 @@ def execute_tests(unit):
 
 
 def main():
-    client = ModbusClient(host=host_ip,
-                          port=host_port,
-                          timeout=2)
+    client = ModbusClient(host=host_ip, port=host_port, timeout=2)
     client.connect()
 
     unit = pyse.StiebelEltronAPI(client, device_id)
@@ -52,5 +53,6 @@ def main():
 
     client.close()
 
+
 if __name__ == "__main__":
     main()

pyproject.toml

@@ -31,7 +31,7 @@ dev = [
     "pytest>=8.3.5",
     "pytest-asyncio>=0.26.0",
     "pytest-mock>=3.14.0",
-    "ruff>=0.9.6",
+    "ruff>=0.12.0",
 ]
 
 [tool.hatch.build.targets.sdist]
@@ -45,6 +45,12 @@ path = "pystiebeleltron/__init__.py"
 
 [tool.ruff]
 line-length = 200
+lint.select = ["E", "F", "B", "I"]
+lint.ignore = []
+target-version = "py310"
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
 
 [tool.pytest.ini_options]
 

pystiebeleltron/__init__.py

@@ -1,12 +1,10 @@
 import asyncio
 import logging
-
+from dataclasses import dataclass
 from enum import Enum
 
-from dataclasses import dataclass
 from pymodbus.client import AsyncModbusTcpClient
 
-
 __version__ = "0.2.2"
 
 _LOGGER: logging.Logger = logging.getLogger(__package__)

pystiebeleltron/lwz.py

@@ -3,16 +3,16 @@
 from enum import Enum
 
 from . import (
-    ModbusRegister,
-    ModbusRegisterBlock,
-    StiebelEltronAPI,
-    IsgRegisters,
-    RegisterType,
     ENERGY_DATA_BLOCK_NAME,
-    VIRTUAL_REGISTER_OFFSET,
-    VIRTUAL_TOTAL_AND_DAY_REGISTER_OFFSET,
     ENERGY_MANAGEMENT_SETTINGS_REGISTERS,
     ENERGY_SYSTEM_INFORMATION_REGISTERS,
+    VIRTUAL_REGISTER_OFFSET,
+    VIRTUAL_TOTAL_AND_DAY_REGISTER_OFFSET,
+    IsgRegisters,
+    ModbusRegister,
+    ModbusRegisterBlock,
+    RegisterType,
+    StiebelEltronAPI,
 )
 
 

pystiebeleltron/pystiebeleltron.py

@@ -225,13 +225,12 @@ def get_conv_val(self, name: str):
     #            self.update()
     #        return self._block_2_holding_regs[name]
 
-#    def set_raw_holding_register(self, name, value):
-#        """Write to register by name."""
-#        self._conn.write_register(
-#            device_id=self._device_id,
-#            address=(self._holding_regs[name]['addr']),
-#            value=value)
-
+    #    def set_raw_holding_register(self, name, value):
+    #        """Write to register by name."""
+    #        self._conn.write_register(
+    #            device_id=self._device_id,
+    #            address=(self._holding_regs[name]['addr']),
+    #            value=value)
 
     # Handle room temperature & humidity
 
@@ -251,7 +250,6 @@ def set_target_temp(self, temp: float):
         """Set the target room temperature (day)(HC1)."""
         self._conn.write_register(device_id=self._device_id, address=(self._block_2_holding_regs["ROOM_TEMP_HEAT_DAY_HC1"]["addr"]), value=round(temp * 10.0))
 
-
     def get_current_humidity(self):
         """Get the current room humidity."""
         if self._update_on_read:

pystiebeleltron/wpm.py

@@ -1,16 +1,16 @@
 """Modbus api for stiebel eltron heat pumps. This file is generated. Do not modify it manually."""
 
 from . import (
-    ModbusRegister,
-    ModbusRegisterBlock,
-    StiebelEltronAPI,
-    IsgRegisters,
-    RegisterType,
     ENERGY_DATA_BLOCK_NAME,
-    VIRTUAL_REGISTER_OFFSET,
     ENERGY_MANAGEMENT_SETTINGS_REGISTERS,
     ENERGY_SYSTEM_INFORMATION_REGISTERS,
+    VIRTUAL_REGISTER_OFFSET,
     VIRTUAL_TOTAL_AND_DAY_REGISTER_OFFSET,
+    IsgRegisters,
+    ModbusRegister,
+    ModbusRegisterBlock,
+    RegisterType,
+    StiebelEltronAPI,
 )
 
 

scripts/gen.sh

@@ -2,3 +2,4 @@
 
 uv run scripts/generate.py
 uvx ruff format pystiebeleltron
+uvx ruff check --fix pystiebeleltron

scripts/generate.py

@@ -1,11 +1,11 @@
 """Generate python files to access the stiebel eltron heat pumps."""
 
-from pathlib import Path
 import csv
-
 from dataclasses import dataclass
+from pathlib import Path
 
 from jinja2 import Environment, FileSystemLoader, Template, select_autoescape
+
 from pystiebeleltron import RegisterType
 
 ENERGY_DATA_BLOCK_NAME = "Energy Data"

test/mock_modbus_server.py

@@ -7,23 +7,22 @@
 twisted library as its backend.  This allows it to scale to many thousands
 of nodes which can be helpful for testing monitoring software.
 """
+
 # --------------------------------------------------------------------------- #
 # import the various server implementations
 # --------------------------------------------------------------------------- #
-from pymodbus.server import StartTcpServer, ServerStop
-
+from pymodbus.datastore import ModbusDeviceContext, ModbusSequentialDataBlock, ModbusServerContext
 from pymodbus.pdu.device import ModbusDeviceIdentification
-from pymodbus.datastore import ModbusSequentialDataBlock
-from pymodbus.datastore import ModbusDeviceContext, ModbusServerContext
+from pymodbus.server import ServerStop, StartTcpServer
 
 
 class MockModbusServer(object):
     # --------------------------------------------------------------------------- #
     # configure the service logging
     # --------------------------------------------------------------------------- #
     import logging
-    FORMAT = ('%(asctime)-15s %(threadName)-15s'
-              ' %(levelname)-8s %(module)-15s:%(lineno)-8s %(message)s')
+
+    FORMAT = "%(asctime)-15s %(threadName)-15s %(levelname)-8s %(module)-15s:%(lineno)-8s %(message)s"
     logging.basicConfig(format=FORMAT)
     log = logging.getLogger()
     log.setLevel(logging.DEBUG)
@@ -83,9 +82,7 @@ def run_async_server(self):
         #
         #     store = ModbusDeviceContext(..., zero_mode=True)
         # ----------------------------------------------------------------------- #
-        store = ModbusDeviceContext(
-            hr=ModbusSequentialDataBlock(0, [0]*3000),
-            ir=ModbusSequentialDataBlock(0, [0]*3000))
+        store = ModbusDeviceContext(hr=ModbusSequentialDataBlock(0, [0] * 3000), ir=ModbusSequentialDataBlock(0, [0] * 3000))
         self.context = ModbusServerContext(devices=store, single=True)
 
         # ----------------------------------------------------------------------- #
@@ -94,12 +91,12 @@ def run_async_server(self):
         # If you don't set this or any fields, they are defaulted to empty strings.
         # ----------------------------------------------------------------------- #
         identity = ModbusDeviceIdentification()
-        identity.VendorName = 'Pymodbus'
-        identity.ProductCode = 'PM'
-        identity.VendorUrl = 'http://github.com/bashwork/pymodbus/'
-        identity.ProductName = 'Pymodbus Server'
-        identity.ModelName = 'Pymodbus Server'
-        identity.MajorMinorRevision = '1.5'
+        identity.VendorName = "Pymodbus"
+        identity.ProductCode = "PM"
+        identity.VendorUrl = "http://github.com/bashwork/pymodbus/"
+        identity.ProductName = "Pymodbus Server"
+        identity.ModelName = "Pymodbus Server"
+        identity.MajorMinorRevision = "1.5"
 
         # ----------------------------------------------------------------------- #
         # run the server you want
@@ -112,7 +109,7 @@ def stop_async_server(self):
         ServerStop()
 
     def update_context(self, register, address, values):
-        """ Update values of the active context. It should be noted
+        """Update values of the active context. It should be noted
         that there is a race condition for the update.
 
         :param register: Type of register to update,
@@ -123,30 +120,26 @@ def update_context(self, register, address, values):
         """
         assert register == 3 or register == 4
         device_id = 0x00
-        old_values = self.context[device_id].getValues(register,
-                                                      address, count=1)
-        self.log.debug("Change value at address {} from {} to {}".format(
-            address, old_values, values))
+        old_values = self.context[device_id].getValues(register, address, count=1)
+        self.log.debug("Change value at address {} from {} to {}".format(address, old_values, values))
         self.context[device_id].setValues(register, address, values)
 
     def update_holding_register(self, address, value):
-        """ Update value of a holding register.
+        """Update value of a holding register.
 
         :param address: Address to update
         :param value: Value to save
         """
-        self.log.debug("Update holding register: {}:{}".format(address,
-                                                               int(value)))
+        self.log.debug("Update holding register: {}:{}".format(address, int(value)))
         self.update_context(3, address, [int(value)])
 
     def update_input_register(self, address, value):
-        """ Update value of an input register.
+        """Update value of an input register.
 
         :param address: Address to update
         :param value: Value to save
         """
-        self.log.debug("Update input register: {}:{}".format(address,
-                                                             int(value)))
+        self.log.debug("Update input register: {}:{}".format(address, int(value)))
         self.update_context(4, address, [int(value)])