Merge pull request #26 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

@@ -13,9 +13,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_IterTools/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
 
 Python's itertools for CircuitPython
 

README.rst

@@ -22,8 +22,6 @@
 * Adafruit CircuitPython firmware for the supported boards:
   https://github.com/adafruit/circuitpython/releases
 """
-# pylint:disable=invalid-name,redefined-builtin,attribute-defined-outside-init
-# pylint:disable=stop-iteration-return,anomalous-backslash-in-string
 
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Itertools.git"
@@ -41,6 +39,7 @@
         TypeVar,
         Union,
     )
+
     from typing_extensions import TypeAlias
 
     _T = TypeVar("_T")
@@ -140,9 +139,7 @@ def combinations(iterable: Iterable[_T], r: int) -> Iterator[Tuple[_T, ...]]:
         yield tuple(pool[i] for i in indices)
 
 
-def combinations_with_replacement(
-    iterable: Iterable[_T], r: int
-) -> Iterator[Tuple[_T, ...]]:
+def combinations_with_replacement(iterable: Iterable[_T], r: int) -> Iterator[Tuple[_T, ...]]:
     """Return r length subsequences of elements from the input iterable allowing
     individual elements to be repeated more than once.
 
@@ -245,9 +242,7 @@ def dropwhile(predicate: _Predicate[_T], iterable: Iterable[_T]) -> Iterator[_T]
         yield x
 
 
-def filterfalse(
-    predicate: Optional[_Predicate[_T]], iterable: Iterable[_T]
-) -> Iterator[_T]:
+def filterfalse(predicate: Optional[_Predicate[_T]], iterable: Iterable[_T]) -> Iterator[_T]:
     """Make an iterator that filters elements from iterable returning only those
     for which the predicate is False. If predicate is None, return the items
     that are false.
@@ -391,9 +386,7 @@ def islice(
             return
 
 
-def permutations(
-    iterable: Iterable[_T], r: Optional[int] = None
-) -> Iterator[Tuple[_T, ...]]:
+def permutations(iterable: Iterable[_T], r: Optional[int] = None) -> Iterator[Tuple[_T, ...]]:
     """Return successive r length permutations of elements in the iterable.
 
     If r is not specified or is None, then r defaults to the length of the
@@ -486,9 +479,7 @@ def repeat(el: _T, n: Optional[int] = None) -> Iterator[_T]:
             yield el
 
 
-def starmap(
-    function: Callable[..., _T], iterable: Iterable[Iterable[Any]]
-) -> Iterator[_T]:
+def starmap(function: Callable[..., _T], iterable: Iterable[Iterable[Any]]) -> Iterator[_T]:
     """Make an iterator that computes the function using arguments obtained from
     the iterable. Used instead of map() when argument parameters are already
     grouped in tuples from a single iterable (the data has been “pre-zipped”).
@@ -529,9 +520,7 @@ def tee(iterable: Iterable[_T], n: int = 2) -> Sequence[Iterator[_T]]:
     return [iter(iterable) for _ in range(n)]
 
 
-def zip_longest(
-    *args: Iterable[Any], fillvalue: _OptionalFill = None
-) -> Iterator[Tuple[Any, ...]]:
+def zip_longest(*args: Iterable[Any], fillvalue: _OptionalFill = None) -> Iterator[Tuple[Any, ...]]:
     """Make an iterator that aggregates elements from each of the
     iterables. If the iterables are of uneven length, missing values are
     filled-in with fillvalue. Iteration continues until the longest

adafruit_itertools/__init__.py

@@ -37,8 +37,6 @@
   https://github.com/adafruit/circuitpython/releases
 """
 
-# pylint:disable=invalid-name,keyword-arg-before-vararg,relative-beyond-top-level
-
 import adafruit_itertools as it
 
 try:
@@ -54,6 +52,7 @@
         TypeVar,
         Union,
     )
+
     from typing_extensions import TypeAlias
 
     _T = TypeVar("_T")
@@ -230,9 +229,7 @@ def pairwise(iterable: Iterable[_T]) -> Iterator[Tuple[_T, _T]]:
     return zip(a, b)
 
 
-def partition(
-    pred: _Predicate[_T], iterable: Iterable[_T]
-) -> Tuple[Iterator[_T], Iterator[_T]]:
+def partition(pred: _Predicate[_T], iterable: Iterable[_T]) -> Tuple[Iterator[_T], Iterator[_T]]:
     """Use a predicate to partition entries into false entries and true entries.
 
     :param pred: the predicate that divides the values
@@ -267,9 +264,7 @@ def quantify(iterable: Iterable[_T], pred: _Predicate[_T] = bool) -> int:
     return sum(map(pred, iterable))
 
 
-def repeatfunc(
-    func: Callable[..., _T], times: Optional[int] = None, *args: Any
-) -> Iterator[_T]:
+def repeatfunc(func: Callable[..., _T], times: Optional[int] = None, *args: Any) -> Iterator[_T]:
     """Repeat calls to func with specified arguments.
 
     Example:  repeatfunc(random.random)

adafruit_itertools/adafruit_itertools_extras.py

@@ -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_itertools
    :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(".."))
 
@@ -41,9 +39,7 @@
 creation_year = "2019"
 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 + " Dave Astels"
 author = "Dave Astels"

docs/conf.py

@@ -24,13 +24,14 @@
 # THE SOFTWARE.
 
 import time
+
+import adafruit_si7021
 import board
 import busio
-import adafruit_si7021
+
 from adafruit_itertools import count
 from adafruit_itertools.adafruit_itertools_extras import repeatfunc
 
-
 i2c = busio.I2C(board.SCL, board.SDA)
 sensor = adafruit_si7021.SI7021(i2c)
 

examples/itertools_simpletest.py

@@ -0,0 +1,109 @@
+# 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
+    "PLR6301", # could-be-static no-self-use
+    "PLC0415", # import outside toplevel
+    "PLC2701", # private import
+    "UP028", # for loop yield
+]
+
+[format]
+line-ending = "lf"

ruff.toml

@@ -1,9 +1,11 @@
 # SPDX-FileCopyrightText: KB Sriram
 # SPDX-License-Identifier: MIT
 
-from typing import Any, Callable, Iterator, Optional, Sequence, Tuple, TypeVar, Union
 import itertools as it
+from typing import Any, Callable, Iterator, Optional, Sequence, Tuple, TypeVar, Union
+
 import pytest
+
 import adafruit_itertools as ait
 
 _K = TypeVar("_K")
@@ -41,7 +43,8 @@ def test_accumulate_types() -> None:
     assert list(x_str_f) == list(it.accumulate("abc", lambda a, x: a + x))
 
     x_bad_arg_f: Iterator[int] = ait.accumulate(
-        [1, 2], lambda a, x: a + ord(x)  # type: ignore[arg-type]
+        [1, 2],
+        lambda a, x: a + ord(x),  # type: ignore[arg-type]
     )
     with pytest.raises(TypeError):
         list(x_bad_arg_f)
@@ -206,9 +209,7 @@ def test_dropwhile(predicate: Callable[[_T], object], seq: Sequence[_T]) -> None
         (lambda x: x % 2, range(10)),
     ],
 )
-def test_filterfalse(
-    predicate: Optional[Callable[[_T], object]], seq: Sequence[_T]
-) -> None:
+def test_filterfalse(predicate: Optional[Callable[[_T], object]], seq: Sequence[_T]) -> None:
     x: Iterator[_T] = ait.filterfalse(predicate, seq)
     y: Iterator[_T] = it.filterfalse(predicate, seq)
     assert list(x) == list(y)
@@ -228,9 +229,7 @@ def test_filterfalse(
     ],
 )
 def test_groupby(data: Sequence[_T], key: Callable[[_T], _K]) -> None:
-    def _listify(
-        iterable: Iterator[Tuple[_K, Iterator[_T]]]
-    ) -> Sequence[Tuple[_K, Sequence[_T]]]:
+    def _listify(iterable: Iterator[Tuple[_K, Iterator[_T]]]) -> Sequence[Tuple[_K, Sequence[_T]]]:
         return [(k, list(group)) for k, group in iterable]
 
     it_l = _listify(it.groupby(data, key))

tests/test_itertools.py

@@ -8,10 +8,11 @@
     Sequence,
     TypeVar,
 )
-from typing_extensions import TypeAlias
 
 import more_itertools as itextras
 import pytest
+from typing_extensions import TypeAlias
+
 from adafruit_itertools import adafruit_itertools_extras as aextras
 
 _K = TypeVar("_K")
@@ -66,9 +67,7 @@ def test_dotproduct(vec1: Sequence[int], vec2: Sequence[int]) -> None:
         ([], -1, lambda _: True),
     ],
 )
-def test_first_true(
-    seq: Sequence[_T], dflt: _T, pred: Optional[_Predicate[_T]]
-) -> None:
+def test_first_true(seq: Sequence[_T], dflt: _T, pred: Optional[_Predicate[_T]]) -> None:
     assert itextras.first_true(seq, dflt, pred) == aextras.first_true(seq, dflt, pred)
 
 
@@ -84,12 +83,8 @@ def test_first_true(
 def test_flatten(seq1: str, seq2: str) -> None:
     assert list(itextras.flatten(seq1 + seq2)) == list(aextras.flatten(seq1 + seq2))
     for repeat in range(3):
-        assert list(itextras.flatten([seq1] * repeat)) == list(
-            aextras.flatten([seq1] * repeat)
-        )
-        assert list(itextras.flatten([seq2] * repeat)) == list(
-            aextras.flatten([seq2] * repeat)
-        )
+        assert list(itextras.flatten([seq1] * repeat)) == list(aextras.flatten([seq1] * repeat))
+        assert list(itextras.flatten([seq2] * repeat)) == list(aextras.flatten([seq2] * repeat))
 
 
 @pytest.mark.parametrize(
@@ -254,9 +249,7 @@ def test_roundrobin(seq1: str, seq2: str) -> None:
 )
 def test_tabulate(func: Callable[[int], int], start: int) -> None:
     assert _take(5, itextras.tabulate(func)) == _take(5, aextras.tabulate(func))
-    assert _take(5, itextras.tabulate(func, start)) == _take(
-        5, aextras.tabulate(func, start)
-    )
+    assert _take(5, itextras.tabulate(func, start)) == _take(5, aextras.tabulate(func, start))
 
 
 @pytest.mark.parametrize(