Py bump and ruff over black/isort

Author: CoMPaTech

.github/workflows/merge.yml

@@ -5,7 +5,7 @@ name: Latest release
 
 env:
   CACHE_VERSION: 7
-  DEFAULT_PYTHON: "3.11"
+  DEFAULT_PYTHON: "3.12"
 
 # Only run on merges
 on:

.github/workflows/verify.yml

@@ -5,7 +5,7 @@ name: Latest commit
 
 env:
   CACHE_VERSION: 6
-  DEFAULT_PYTHON: "3.11"
+  DEFAULT_PYTHON: "3.12"
   PRE_COMMIT_HOME: ~/.cache/pre-commit
 
 on:
@@ -65,9 +65,9 @@ jobs:
           . venv/bin/activate
           pre-commit install-hooks
 
-  black:
+  ruff:
     runs-on: ubuntu-latest
-    name: Black check and force
+    name: Ruff check and force
     needs: prepare
     steps:
       - name: Check out committed code
@@ -94,27 +94,27 @@ jobs:
         run: |
           echo "Failed to restore Python ${{ env.DEFAULT_PYTHON }} virtual environment from cache"
           exit 1
-      - name: Run black --check --exclude venv .
+      - name: Ruff (with fix)
         run: |
           . venv/bin/activate
-          black --check --exclude venv .
-      - name: If needed, commit black changes to the pull request
+          ruff plugwise/*py tests/*py
+      - name: If needed, commit ruff changes to the pull request
         if: failure()
         run: |
           . venv/bin/activate
-          black --exclude venv .
-          git config --global user.name 'autoblack'
+          ruff --fix plugwise/*py tests/*py
+          git config --global user.name 'autoruff'
           git config --global user.email 'plugwise@users.noreply.github.com'
           git remote set-url origin https://x-access-token:${{ secrets.PAT_CT }}@github.com/$GITHUB_REPOSITORY
           git checkout $GITHUB_HEAD_REF
-          git commit -am "fixup: ${GITHUB_REF##*/} Python code reformatted using Black"
+          git commit -am "fixup: ${GITHUB_REF##*/} Python code fixed using ruff"
           git push origin ${GITHUB_REF##*/}
 
   commitcheck:
     runs-on: ubuntu-latest
     name: Check commit
     needs:
-      - black
+      - ruff
       - shellcheck
       - dependencies_check
     steps:

.pre-commit-config.yaml

@@ -16,10 +16,6 @@ repos:
       - id: ruff
         args:
           - --fix
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:
@@ -33,14 +29,6 @@ repos:
     hooks:
       - id: pyupgrade
         args: [--py39-plus]
-  - repo: https://github.com/psf/black
-    rev: 23.12.1
-    hooks:
-      - id: black
-        args:
-          - --safe
-          - --quiet
-        files: ^((plugwise|tests|scripts)/.+)?[^/]+\.py$
   #  Moved codespell configuration to setup.cfg as per 'all-files' issues not reading args
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.6

CHANGELOG.md

@@ -3,6 +3,8 @@
 ## Ongoing
 
 - Refresh adam_plus_anna_new userdata and adapt.
+- Bump actions and requirements to Python 3.12
+- Ruff as per #470 (defaulting black and isort to ruff)
 
 ## v0.35.4
 

README.md

@@ -14,11 +14,13 @@ Our main usage for this module is supporting [Home Assistant](https://www.home-a
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/plugwise/python-plugwise/main.svg)](https://results.pre-commit.ci/latest/github/plugwise/python-plugwise/main)
 [![renovate maintained](https://img.shields.io/badge/maintained%20with-renovate-blue?logo=renovatebot)](https://github.com/plugwise/python-plugwise/issues/291)
 
-The below scoring only applies to Plugwise Smile components:
-
 [![CodeFactor](https://www.codefactor.io/repository/github/plugwise/python-plugwise/badge)](https://www.codefactor.io/repository/github/plugwise/python-plugwise)
 [![codecov](https://codecov.io/gh/plugwise/python-plugwise/branch/main/graph/badge.svg)](https://codecov.io/gh/plugwise/python-plugwise)
 
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=plugwise_python-plugwise&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise)
+[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=plugwise_python-plugwise&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=plugwise_python-plugwise&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise)
+
 ## Integration
 
 ### Home-Assistant Integration

plugwise/__init__.py

@@ -424,22 +424,21 @@ async def _smile_detect_legacy(
                 locator = f"./{network}/mac"
                 if (net_locator := self._system.find(locator)) is not None:
                     self.smile_mac_address = net_locator.text
-        else:
-            # P1 legacy:
-            if dsmrmain is not None:
-                self._status = await self._request(STATUS)
-                self.smile_fw_version = self._status.find("./system/version").text
-                model = self._status.find("./system/product").text
-                self.smile_hostname = self._status.find("./network/hostname").text
-                self.smile_mac_address = self._status.find("./network/mac_address").text
-
-            else:  # pragma: no cover
-                # No cornercase, just end of the line
-                LOGGER.error(
-                    "Connected but no gateway device information found, please create"
-                    " an issue on http://github.com/plugwise/python-plugwise"
-                )
-                raise ResponseError
+        # P1 legacy:
+        elif dsmrmain is not None:
+            self._status = await self._request(STATUS)
+            self.smile_fw_version = self._status.find("./system/version").text
+            model = self._status.find("./system/product").text
+            self.smile_hostname = self._status.find("./network/hostname").text
+            self.smile_mac_address = self._status.find("./network/mac_address").text
+
+        else:  # pragma: no cover
+            # No cornercase, just end of the line
+            LOGGER.error(
+                "Connected but no gateway device information found, please create"
+                " an issue on http://github.com/plugwise/python-plugwise"
+            )
+            raise ResponseError
 
         self._smile_legacy = True
         return model

plugwise/helper.py

@@ -1095,14 +1095,13 @@ def _get_measurement_data(self, dev_id: str) -> DeviceData:
 
             # Loria/Thermastage: cooling-related is based on cooling_state
             # and modulation_level
-            else:
-                if self._cooling_present and "cooling_state" in data["binary_sensors"]:
-                    self._cooling_enabled = data["binary_sensors"]["cooling_state"]
-                    self._cooling_active = data["sensors"]["modulation_level"] == 100
-                    # For Loria the above does not work (pw-beta issue #301)
-                    if "cooling_ena_switch" in data["switches"]:
-                        self._cooling_enabled = data["switches"]["cooling_ena_switch"]
-                        self._cooling_active = data["binary_sensors"]["cooling_state"]
+            elif self._cooling_present and "cooling_state" in data["binary_sensors"]:
+                self._cooling_enabled = data["binary_sensors"]["cooling_state"]
+                self._cooling_active = data["sensors"]["modulation_level"] == 100
+                # For Loria the above does not work (pw-beta issue #301)
+                if "cooling_ena_switch" in data["switches"]:
+                    self._cooling_enabled = data["switches"]["cooling_ena_switch"]
+                    self._cooling_active = data["binary_sensors"]["cooling_state"]
 
         self._cleanup_data(data)
 

plugwise/util.py

@@ -38,13 +38,12 @@ def format_measure(measure: str, unit: str) -> float | int:
             result = float(f"{round(float_measure, 3):.3f}")
         elif unit == ELECTRIC_POTENTIAL_VOLT:
             result = float(f"{round(float_measure, 1):.1f}")
-        else:
-            if abs(float_measure) < 10:
-                result = float(f"{round(float_measure, 2):.2f}")
-            elif abs(float_measure) >= 10 and abs(float_measure) < 100:
-                result = float(f"{round(float_measure, 1):.1f}")
-            elif abs(float_measure) >= 100:
-                result = int(round(float_measure))
+        elif abs(float_measure) < 10:
+            result = float(f"{round(float_measure, 2):.2f}")
+        elif abs(float_measure) >= 10 and abs(float_measure) < 100:
+            result = float(f"{round(float_measure, 1):.1f}")
+        elif abs(float_measure) >= 100:
+            result = int(round(float_measure))
 
     return result
 

pyproject.toml

@@ -14,8 +14,6 @@ classifiers     = [
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Topic :: Home Automation",
 ]
@@ -26,7 +24,7 @@ maintainers = [
         { name = "bouwew"},
         { name = "CoMPaTech" }
 ]
-requires-python = ">=3.10.0"
+requires-python = ">=3.12.0"
 dependencies    = [
         "aiohttp",
         "async_timeout",
@@ -53,7 +51,7 @@ include-package-data = true
 include = ["plugwise*"]
 
 [tool.black]
-target-version = ["py310", "py311", "py312"]
+target-version = ["py312"]
 exclude = 'generated'
 
 [tool.isort]
@@ -189,7 +187,7 @@ norecursedirs = [
 ]
 
 [tool.mypy]
-python_version = "3.11"
+python_version = "3.12"
 show_error_codes = true
 follow_imports = "silent"
 ignore_missing_imports = true
@@ -219,28 +217,70 @@ omit= [
 ]
 
 [tool.ruff]
-target-version = "py311"
+target-version = "py312"
 
 select = [
+    "B002", # Python does not support the unary prefix increment
     "B007", # Loop control variable {name} not used within loop body
     "B014", # Exception handler with duplicate exception
+    "B023", # Function definition does not bind loop variable {name}
+    "B026", # Star-arg unpacking after a keyword argument is strongly discouraged
     "C",  # complexity
+    "COM818", # Trailing comma on bare tuple prohibited
     "D",  # docstrings
+    "DTZ003",  # Use datetime.now(tz=) instead of datetime.utcnow()
+    "DTZ004",  # Use datetime.fromtimestamp(ts, tz=) instead of datetime.utcfromtimestamp(ts)
     "E",  # pycodestyle
     "F",  # pyflakes/autoflake
+    "G", # flake8-logging-format
+    "I",  # isort
     "ICN001", # import concentions; {name} should be imported as {asname}
-    "PGH004",  # Use specific rule codes when using noqa
+    "ISC001", # Implicitly concatenated string literals on one line
+    "N804", # First argument of a class method should be named cls
+    "N805", # First argument of a method should be named self
+    "N815", # Variable {name} in class scope should not be mixedCase
+    "PGH001", # No builtin eval() allowed
+    "PGH004", # Use specific rule codes when using noqa
+    "PL", # https://github.com/astral-sh/ruff/issues/7491#issuecomment-1730008111
     "PLC0414", # Useless import alias. Import alias does not rename original package.
+    "PLC", # pylint
+    "PLE", # pylint
+    "PLR", # pylint
+    "PLW", # pylint
+    "Q000", # Double quotes found but single quotes preferred
+    "RUF006", # Store a reference to the return value of asyncio.create_task
+    "S102", # Use of exec detected
+    "S103",  # bad-file-permissions
+    "S108",  # hardcoded-temp-file
+    "S306",  # suspicious-mktemp-usage
+    "S307",  # suspicious-eval-usage
+    "S313",  # suspicious-xmlc-element-tree-usage
+    "S314",  # suspicious-xml-element-tree-usage
+    "S315",  # suspicious-xml-expat-reader-usage
+    "S316",  # suspicious-xml-expat-builder-usage
+    "S317",  # suspicious-xml-sax-usage
+    "S318",  # suspicious-xml-mini-dom-usage
+    "S319",  # suspicious-xml-pull-dom-usage
+    "S320",  # suspicious-xmle-tree-usage
+    "S601",  # paramiko-call
+    "S602",  # subprocess-popen-with-shell-equals-true
+    "S604",  # call-with-shell-equals-true
+    "S608",  # hardcoded-sql-expression
+    "S609",  # unix-command-wildcard-injection
     "SIM105", # Use contextlib.suppress({exception}) instead of try-except-pass
     "SIM117", # Merge with-statements that use the same scope
     "SIM118", # Use {key} in {dict} instead of {key} in {dict}.keys()
     "SIM201", # Use {left} != {right} instead of not {left} == {right}
+    "SIM208", # Use {expr} instead of not (not {expr})
     "SIM212", # Use {a} if {a} else {b} instead of {b} if not {a} else {a}
     "SIM300", # Yoda conditions. Use 'age == 42' instead of '42 == age'.
     "SIM401", # Use get from dict with default instead of an if block
+    "T100", # Trace found: {name} used
     "T20",  # flake8-print
+    "TID251", # Banned imports
     "TRY004", # Prefer TypeError exception for invalid type
-    "RUF006", # Store a reference to the return value of asyncio.create_task
+    "TRY200", # Use raise from to specify exception cause
+    "TRY302", # Remove exception handler; error is immediately re-raised
     "UP",  # pyupgrade
     "W",  # pycodestyle
 ]
@@ -253,9 +293,19 @@ ignore = [
     "D407",  # Section name underlining
     "E501",  # line too long
     "E731",  # do not assign a lambda expression, use a def
+    # False positives https://github.com/astral-sh/ruff/issues/5386
+    "PLC0208", # Use a sequence type instead of a `set` when iterating over values
+    "PLR0911", # Too many return statements ({returns} > {max_returns})
+    "PLR0912", # Too many branches ({branches} > {max_branches})
+    "PLR0913", # Too many arguments to function call ({c_args} > {max_args})
+    "PLR0915", # Too many statements ({statements} > {max_statements})
+    "PLR2004",  # Magic value used in comparison, consider replacing {value} with a constant variable
+    "PLW2901", # Outer {outer_kind} variable {name} overwritten by inner {inner_kind} target
+    "UP006", # keep type annotation style as is
+    "UP007", # keep type annotation style as is
+    # Ignored due to performance: https://github.com/charliermarsh/ruff/issues/2923
+    #"UP038", # Use `X | Y` in `isinstance` call instead of `(X, Y)`
 ]
-#    # Ignored due to performance: https://github.com/charliermarsh/ruff/issues/2923
-#    "UP038", # Use `X | Y` in `isinstance` call instead of `(X, Y)`
 
 exclude = []
 
@@ -272,3 +322,23 @@ fixture-parentheses = false
 
 [tool.ruff.mccabe]
 max-complexity = 25
+
+[tool.ruff.flake8-tidy-imports.banned-api]
+"pytz".msg = "use zoneinfo instead"
+
+[tool.ruff.isort]
+force-sort-within-sections = true
+section-order = ["future", "standard-library", "first-party", "third-party", "local-folder"]
+known-third-party = [
+    "tests",
+]
+known-first-party = [
+    "plugwise",
+    "voluptuous",
+    "pytest",
+]
+forced-separate = [
+    "tests",
+]
+combine-as-imports = true
+split-on-trailing-comma = false

requirements_commit.txt

@@ -2,7 +2,6 @@
 -e .
 # Minimal requirements for committing
 # Versioning omitted (leave this up to HA-core)
-black
 coverage
 ruff
 mypy