change to ruff

.gitattributes

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+.py text eol=lf
+.rst text eol=lf
+.txt text eol=lf
+.yaml text eol=lf
+.toml text eol=lf
+.license text eol=lf
+.md text eol=lf

.pre-commit-config.yaml

@@ -1,42 +1,21 @@
-# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense
 
 repos:
-  - repo: https://github.com/python/black
-    rev: 23.3.0
-    hooks:
-      - id: black
-  - repo: https://github.com/fsfe/reuse-tool
-    rev: v1.1.2
-    hooks:
-      - id: reuse
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/pycqa/pylint
-    rev: v2.17.4
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
     hooks:
-      - id: pylint
-        name: pylint (library code)
-        types: [python]
-        args:
-          - --disable=consider-using-f-string
-        exclude: "^(docs/|examples/|tests/|setup.py$)"
-      - id: pylint
-        name: pylint (example code)
-        description: Run pylint rules on "examples/*.py" files
-        types: [python]
-        files: "^examples/"
-        args:
-          - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
-      - id: pylint
-        name: pylint (test code)
-        description: Run pylint rules on "tests/*.py" files
-        types: [python]
-        files: "^tests/"
-        args:
-          - --disable=missing-docstring,consider-using-f-string,duplicate-code
+      - id: ruff-format
+      - id: ruff
+        args: ["--fix"]
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v3.0.1
+    hooks:
+      - id: reuse

README.rst

@@ -13,9 +13,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_HTS221/actions
     :alt: Build Status
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. image:: https://img.shields.io/endpoint?url=https://github.com/raw/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Code Style: Ruff
 
 Helper library for the HTS221 Humidity and Temperature Sensor
 

adafruit_hts221.py

@@ -25,17 +25,19 @@
  * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
 
 """
+
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_HTS221.git"
 
-from micropython import const
 import adafruit_bus_device.i2c_device as i2cdevice
+from adafruit_register.i2c_bit import ROBit, RWBit
+from adafruit_register.i2c_bits import ROBits, RWBits
 from adafruit_register.i2c_struct import ROUnaryStruct
-from adafruit_register.i2c_bits import RWBits, ROBits
-from adafruit_register.i2c_bit import RWBit, ROBit
+from micropython import const
 
 try:
-    from typing import Union, Sequence, Tuple
+    from typing import Sequence, Tuple, Union
+
     from busio import I2C
 except ImportError:
     pass
@@ -71,9 +73,7 @@ class CV:
     """struct helper"""
 
     @classmethod
-    def add_values(
-        cls, value_tuples: Sequence[Tuple[str, int, Union[int, float]]]
-    ) -> None:
+    def add_values(cls, value_tuples: Sequence[Tuple[str, int, Union[int, float]]]) -> None:
         """creates CV entries"""
         cls.label = {}
 
@@ -106,7 +106,7 @@ class Rate(CV):
 
     """
 
-    pass  # pylint: disable=unnecessary-pass
+    pass
 
 
 Rate.add_values(
@@ -119,7 +119,7 @@ class Rate(CV):
 )
 
 
-class HTS221:  # pylint: disable=too-many-instance-attributes
+class HTS221:
     """Library for the ST HTS221 Humidity and Temperature Sensor
 
     :param ~busio.I2C i2c_bus: The I2C bus the HTS221 is connected to
@@ -178,13 +178,11 @@ class HTS221:  # pylint: disable=too-many-instance-attributes
 
     def __init__(self, i2c_bus: I2C) -> None:
         self.i2c_device = i2cdevice.I2CDevice(i2c_bus, _HTS221_DEFAULT_ADDRESS)
-        if not self._chip_id in [_HTS221_CHIP_ID]:
-            raise RuntimeError(
-                "Failed to find HTS221HB! Found chip ID 0x%x" % self._chip_id
-            )
+        if self._chip_id not in {_HTS221_CHIP_ID}:
+            raise RuntimeError("Failed to find HTS221HB! Found chip ID 0x%x" % self._chip_id)
         self._boot()
         self.enabled = True
-        self.data_rate = Rate.RATE_12_5_HZ  # pylint:disable=no-member
+        self.data_rate = Rate.RATE_12_5_HZ
 
         t1_t0_msbs = self._t1_t0_deg_c_x8_msbits
         self.calib_temp_value_0 = self._t0_deg_c_x8_lsbyte
@@ -227,9 +225,7 @@ def relative_humidity(self) -> float:
 
         correction_factor = calibrated_value_delta / calibrated_measurement_delta
 
-        adjusted_humidity = (
-            zeroed_measured_humidity * correction_factor + calibration_value_offset
-        )
+        adjusted_humidity = zeroed_measured_humidity * correction_factor + calibration_value_offset
 
         return adjusted_humidity
 
@@ -246,9 +242,7 @@ def temperature(self) -> float:
 
         correction_factor = calibrated_value_delta / calibrated_measurement_delta
 
-        adjusted_temp = (
-            zeroed_measured_temp * correction_factor
-        ) + calibration_value_offset
+        adjusted_temp = (zeroed_measured_temp * correction_factor) + calibration_value_offset
 
         return adjusted_temp
 

docs/api.rst

@@ -4,6 +4,9 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
+API Reference
+#############
+
 .. automodule:: adafruit_hts221
    :members:
    :exclude-members: CV

docs/conf.py

@@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
+import datetime
 import os
 import sys
-import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -55,9 +53,7 @@
 creation_year = "2020"
 current_year = str(datetime.datetime.now().year)
 year_duration = (
-    current_year
-    if current_year == creation_year
-    else creation_year + " - " + current_year
+    current_year if current_year == creation_year else creation_year + " - " + current_year
 )
 copyright = year_duration + " Bryan Siepert"
 author = "Bryan Siepert"

examples/hts221_simpletest.py

@@ -2,19 +2,21 @@
 # SPDX-License-Identifier: MIT
 
 import time
+
 import board
+
 import adafruit_hts221
 
 i2c = board.I2C()  # uses board.SCL and board.SDA
 # i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
 hts = adafruit_hts221.HTS221(i2c)
 
 data_rate = adafruit_hts221.Rate.label[hts.data_rate]
-print("Using data rate of: {:.1f} Hz".format(data_rate))
+print(f"Using data rate of: {data_rate:.1f} Hz")
 print("")
 
 while True:
-    print("Relative Humidity: {:.2f} % rH".format(hts.relative_humidity))
-    print("Temperature: {:.2f} C".format(hts.temperature))
+    print(f"Relative Humidity: {hts.relative_humidity:.2f} % rH")
+    print(f"Temperature: {hts.temperature:.2f} C")
     print("")
     time.sleep(1)

ruff.toml

@@ -0,0 +1,105 @@
+# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+target-version = "py38"
+line-length = 100
+
+[lint]
+preview = true
+select = ["I", "PL", "UP"]
+
+extend-select = [
+  "D419",  # empty-docstring
+  "E501",  # line-too-long
+  "W291",  # trailing-whitespace
+  "PLC0414",  # useless-import-alias
+  "PLC2401",  # non-ascii-name
+  "PLC2801",  # unnecessary-dunder-call
+  "PLC3002",  # unnecessary-direct-lambda-call
+  "E999",  # syntax-error
+  "PLE0101",  # return-in-init
+  "F706",  # return-outside-function
+  "F704",  # yield-outside-function
+  "PLE0116",  # continue-in-finally
+  "PLE0117",  # nonlocal-without-binding
+  "PLE0241",  # duplicate-bases
+  "PLE0302",  # unexpected-special-method-signature
+  "PLE0604",  # invalid-all-object
+  "PLE0605",  # invalid-all-format
+  "PLE0643",  # potential-index-error
+  "PLE0704",  # misplaced-bare-raise
+  "PLE1141",  # dict-iter-missing-items
+  "PLE1142",  # await-outside-async
+  "PLE1205",  # logging-too-many-args
+  "PLE1206",  # logging-too-few-args
+  "PLE1307",  # bad-string-format-type
+  "PLE1310",  # bad-str-strip-call
+  "PLE1507",  # invalid-envvar-value
+  "PLE2502",  # bidirectional-unicode
+  "PLE2510",  # invalid-character-backspace
+  "PLE2512",  # invalid-character-sub
+  "PLE2513",  # invalid-character-esc
+  "PLE2514",  # invalid-character-nul
+  "PLE2515",  # invalid-character-zero-width-space
+  "PLR0124",  # comparison-with-itself
+  "PLR0202",  # no-classmethod-decorator
+  "PLR0203",  # no-staticmethod-decorator
+  "UP004",  # useless-object-inheritance
+  "PLR0206",  # property-with-parameters
+  "PLR0904",  # too-many-public-methods
+  "PLR0911",  # too-many-return-statements
+  "PLR0912",  # too-many-branches
+  "PLR0913",  # too-many-arguments
+  "PLR0914",  # too-many-locals
+  "PLR0915",  # too-many-statements
+  "PLR0916",  # too-many-boolean-expressions
+  "PLR1702",  # too-many-nested-blocks
+  "PLR1704",  # redefined-argument-from-local
+  "PLR1711",  # useless-return
+  "C416",  # unnecessary-comprehension
+  "PLR1733",  # unnecessary-dict-index-lookup
+  "PLR1736",  # unnecessary-list-index-lookup
+
+  # ruff reports this rule is unstable
+  #"PLR6301",  # no-self-use
+
+  "PLW0108",  # unnecessary-lambda
+  "PLW0120",  # useless-else-on-loop
+  "PLW0127",  # self-assigning-variable
+  "PLW0129",  # assert-on-string-literal
+  "B033",  # duplicate-value
+  "PLW0131",  # named-expr-without-context
+  "PLW0245",  # super-without-brackets
+  "PLW0406",  # import-self
+  "PLW0602",  # global-variable-not-assigned
+  "PLW0603",  # global-statement
+  "PLW0604",  # global-at-module-level
+
+  # fails on the try: import typing used by libraries
+  #"F401",  # unused-import
+
+  "F841",  # unused-variable
+  "E722",  # bare-except
+  "PLW0711",  # binary-op-exception
+  "PLW1501",  # bad-open-mode
+  "PLW1508",  # invalid-envvar-default
+  "PLW1509",  # subprocess-popen-preexec-fn
+  "PLW2101",  # useless-with-lock
+  "PLW3301",  # nested-min-max
+]
+
+ignore = [
+    "PLR2004", # magic-value-comparison
+    "UP030", # format literals
+    "PLW1514",  # unspecified-encoding
+    "PLR0913", # too-many-arguments
+    "PLR0915", # too-many-statements
+    "PLR0917", # too-many-positional-arguments
+    "PLR0904", # too-many-public-methods
+    "PLR0912", # too-many-branches
+    "PLR0916", # too-many-boolean-expressions
+]
+
+[format]
+line-ending = "lf"