Merge pull request #75 from adafruit/use_ruff

change to ruff

Author: FoamyGuy

.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

.pylintrc

@@ -14,9 +14,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_IRRemote/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://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Code Style: Ruff
 
 CircuitPython driver for use with IR Receivers.
 

README.rst

@@ -2,15 +2,15 @@
 #
 # SPDX-License-Identifier: MIT
 
-# pylint: disable=missing-module-docstring
 from __future__ import annotations
 
 import array
-from collections import namedtuple
 import time
+from collections import namedtuple
 
 try:
-    from typing import List, NamedTuple, Optional, Tuple
+    from typing import NamedTuple, Optional
+
     from pulseio import PulseOut
 except ImportError:
     pass
@@ -76,7 +76,7 @@ class IRNECRepeatException(Exception):
     """Exception when a NEC repeat is decoded"""
 
 
-def bin_data(pulses: List) -> List[List]:
+def bin_data(pulses: list) -> list[list]:
     """Compute bins of pulse lengths where pulses are +-25% of the average.
 
     :param list pulses: Input pulse lengths
@@ -99,9 +99,8 @@ def bin_data(pulses: List) -> List[List]:
     return bins
 
 
-def decode_bits(pulses: List) -> NamedTuple:
+def decode_bits(pulses: list) -> NamedTuple:
     """Decode the pulses into bits."""
-    # pylint: disable=too-many-branches,too-many-statements
 
     # TODO The name pulses is redefined several times below, so we'll stash the
     # original in a separate variable for now. It might be worth refactoring to
@@ -165,9 +164,7 @@ def decode_bits(pulses: List) -> NamedTuple:
 
     if outliers:
         # skip outliers
-        pulses = [
-            p for p in pulses if not (outliers[0] * 0.75) <= p <= (outliers[0] * 1.25)
-        ]
+        pulses = [p for p in pulses if not (outliers[0] * 0.75) <= p <= (outliers[0] * 1.25)]
     # convert marks/spaces to 0 and 1
     for i, pulse_length in enumerate(pulses):
         if (space * 0.75) <= pulse_length <= (space * 1.25):
@@ -221,7 +218,7 @@ class NonblockingGenericDecode:
     ...         ...
     """
 
-    def __init__(self, pulses: List, max_pulse: int = 10_000) -> None:
+    def __init__(self, pulses: list, max_pulse: int = 10_000) -> None:
         self.pulses = pulses  # PulseIn
         self.max_pulse = max_pulse
         self._unparsed_pulses = []  # internal buffer of partial messages
@@ -261,11 +258,11 @@ class GenericDecode:
     # this here for back-compat, hence we disable pylint for that specific
     # complaint.
 
-    def bin_data(self, pulses: List) -> List[List]:  # pylint: disable=no-self-use
+    def bin_data(self, pulses: list) -> list[list]:  # noqa: PLR6301
         "Wraps the top-level function bin_data for backward-compatibility."
         return bin_data(pulses)
 
-    def decode_bits(self, pulses: List) -> Tuple:  # pylint: disable=no-self-use
+    def decode_bits(self, pulses: list) -> tuple:  # noqa: PLR6301
         "Wraps the top-level function decode_bits for backward-compatibility."
         try:
             result = decode_bits(pulses)
@@ -275,9 +272,9 @@ def decode_bits(self, pulses: List) -> Tuple:  # pylint: disable=no-self-use
             raise IRNECRepeatException()
         return result.code
 
-    def _read_pulses_non_blocking(  # pylint: disable=no-self-use
-        self, input_pulses: List, max_pulse: int = 10000, pulse_window: float = 0.10
-    ) -> Optional[List]:
+    def _read_pulses_non_blocking(  # noqa: PLR6301
+        self, input_pulses: list, max_pulse: int = 10000, pulse_window: float = 0.10
+    ) -> Optional[list]:
         """Read out a burst of pulses without blocking until pulses stop for a specified
         period (pulse_window), pruning pulses after a pulse longer than ``max_pulse``.
 
@@ -317,7 +314,7 @@ def read_pulses(
         blocking: bool = True,
         pulse_window: float = 0.10,
         blocking_delay: float = 0.10,
-    ) -> Optional[List]:
+    ) -> Optional[list]:
         """Read out a burst of pulses until pulses stop for a specified
         period (pulse_window), pruning pulses after a pulse longer than ``max_pulse``.
 
@@ -330,9 +327,7 @@ def read_pulses(
         :param float blocking_delay: delay between pulse checks when blocking
         """
         while True:
-            pulses = self._read_pulses_non_blocking(
-                input_pulses, max_pulse, pulse_window
-            )
+            pulses = self._read_pulses_non_blocking(input_pulses, max_pulse, pulse_window)
             if blocking and pulses is None:
                 time.sleep(blocking_delay)
                 continue
@@ -351,9 +346,9 @@ class GenericTransmit:
 
     def __init__(
         self,
-        header: List[int],
-        one: List[int],
-        zero: List[int],
+        header: list[int],
+        one: list[int],
+        zero: list[int],
         trail: int,
         *,
         debug: bool = False,
@@ -388,8 +383,7 @@ def transmit(
 
         durations = array.array(
             "H",
-            [0]
-            * (len(self.header) + bits_to_send * 2 + (0 if self.trail is None else 1)),
+            [0] * (len(self.header) + bits_to_send * 2 + (0 if self.trail is None else 1)),
         )
 
         for i, _ in enumerate(self.header):

adafruit_irremote.py

@@ -1,5 +1,8 @@
 
 .. If you created a package, create one automodule per module in the package.
 
+API Reference
+#############
+
 .. automodule:: adafruit_irremote
    :members:

docs/api.rst

@@ -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(".."))
 
@@ -40,9 +38,7 @@
 creation_year = "2017"
 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 + " Scott Shawcroft"
 author = "Scott Shawcroft"

docs/conf.py

@@ -3,8 +3,9 @@
 
 # Circuit Playground Express Demo Code
 # Adjust the pulseio 'board.PIN' if using something else
-import pulseio
 import board
+import pulseio
+
 import adafruit_irremote
 
 pulsein = pulseio.PulseIn(board.REMOTEIN, maxlen=120, idle_state=True)

examples/irremote_simpletest.py

@@ -2,11 +2,13 @@
 # SPDX-License-Identifier: MIT
 
 """IR transmit example using Circuit Playground Express"""
-# pylint: disable-msg=no-member
+
 import time
-import pulseio
+
 import board
 import digitalio
+import pulseio
+
 import adafruit_irremote
 
 # Create a button object to trigger IR transmit

examples/irremote_transmit.py

@@ -0,0 +1,106 @@
+# 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
+    "UP007", # use-union-operator
+]
+
+[format]
+line-ending = "lf"