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_Logger
     :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
 
 Logging module for CircuitPython
 

README.rst

@@ -55,16 +55,14 @@
 
 """
 
-# pylint: disable=invalid-name,undefined-variable
-
-import time
-import sys
 import os
+import sys
+import time
 from collections import namedtuple
 
 try:
-    # pylint: disable=deprecated-class
-    from typing import Optional, Hashable, Dict
+    from typing import Dict, Hashable, Optional
+
     from typing_extensions import Protocol
 
     class WriteableStream(Protocol):
@@ -82,7 +80,6 @@ def write(self, buf: str) -> int:
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Logger.git"
 
-# pylint:disable=undefined-all-variable
 __all__ = [
     "LEVELS",
     "NOTSET",
@@ -129,9 +126,7 @@ def _level_for(value: int) -> str:
     return LEVELS[0][1]
 
 
-LogRecord = namedtuple(
-    "_LogRecord", ("name", "levelno", "levelname", "msg", "created", "args")
-)
+LogRecord = namedtuple("_LogRecord", ("name", "levelno", "levelname", "msg", "created", "args"))
 """An object used to hold the contents of a log record.  The following attributes can
 be retrieved from it:
 
@@ -163,7 +158,7 @@ class Formatter:
     style is '{'
     """
 
-    def __init__(  # pylint: disable=too-many-arguments
+    def __init__(
         self,
         fmt: Optional[str] = None,
         datefmt: Optional[str] = None,
@@ -174,10 +169,8 @@ def __init__(  # pylint: disable=too-many-arguments
         self.fmt = fmt
         self.datefmt = datefmt
         self.style = style
-        if self.style not in ("{", "%"):
-            raise ValueError(
-                "Only '%' and '{' formatting style are supported at this time."
-            )
+        if self.style not in {"{", "%"}:
+            raise ValueError("Only '%' and '{' formatting style are supported at this time.")
 
         self.validate = validate
         self.defaults = defaults
@@ -199,20 +192,17 @@ def format(self, record: LogRecord) -> str:
         }
         if "{asctime}" in self.fmt or "%(asctime)s" in self.fmt:
             now = time.localtime()
-            # pylint: disable=line-too-long
-            vals[
-                "asctime"
-            ] = f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} {now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}"
+            vals["asctime"] = (
+                f"{now.tm_year}-{now.tm_mon:02d}-{now.tm_mday:02d} {now.tm_hour:02d}:{now.tm_min:02d}:{now.tm_sec:02d}"  # noqa: E501
+            )
 
         if self.defaults:
             for key, val in self.defaults.items():
                 if key not in vals:
                     vals[key] = val
 
-        if self.style not in ("{", "%"):
-            raise ValueError(
-                "Only '%' and '{' formatting style are supported at this time."
-            )
+        if self.style not in {"{", "%"}:
+            raise ValueError("Only '%' and '{' formatting style are supported at this time.")
 
         if self.style == "%":
             return self.fmt % vals
@@ -234,7 +224,6 @@ def setLevel(self, level: int) -> None:
         """
         self.level = level
 
-    # pylint: disable=no-self-use
     def format(self, record: LogRecord) -> str:
         """Generate a timestamped message.
 
@@ -263,7 +252,6 @@ def setFormatter(self, formatter: Formatter) -> None:
         self.formatter = formatter
 
 
-#  pylint: disable=too-few-public-methods
 class StreamHandler(Handler):
     """Send logging messages to a stream, `sys.stderr` (typically
     the serial console) by default.
@@ -316,7 +304,6 @@ class FileHandler(StreamHandler):
     terminator = "\r\n"
 
     def __init__(self, filename: str, mode: str = "a") -> None:
-        # pylint: disable=consider-using-with
         if mode == "r":
             raise ValueError("Can't write to a read only file")
         super().__init__(open(filename, mode=mode))
@@ -404,7 +391,6 @@ def doRollover(self) -> None:
         os.rename(self._LogFileName, CurrentFileName)
 
         # Reopen the file.
-        # pylint: disable=consider-using-with
         self.stream = open(self._LogFileName, mode=self._WriteMode)
 
     def GetLogSize(self) -> int:
@@ -522,24 +508,16 @@ def hasHandlers(self) -> bool:
         return len(self._handlers) > 0
 
     def _log(self, level: int, msg: str, *args) -> None:
-        record = _logRecordFactory(
-            self.name, level, (msg % args) if args else msg, args
-        )
+        record = _logRecordFactory(self.name, level, (msg % args) if args else msg, args)
         self.handle(record)
 
     def handle(self, record: LogRecord) -> None:
         """Pass the record to all handlers registered with this logger.
 
         :param LogRecord record: log record
         """
-        if (
-            _default_handler is None
-            and not self.hasHandlers()
-            and not self.emittedNoHandlerWarning
-        ):
-            sys.stderr.write(
-                f"Logger '{self.name}' has no handlers and default handler is None\n"
-            )
+        if _default_handler is None and not self.hasHandlers() and not self.emittedNoHandlerWarning:
+            sys.stderr.write(f"Logger '{self.name}' has no handlers and default handler is None\n")
             self.emittedNoHandlerWarning = True
             return
 
@@ -550,11 +528,7 @@ def handle(self, record: LogRecord) -> None:
                     handler.emit(record)
                     emitted = True
 
-            if (
-                not emitted
-                and _default_handler
-                and record.levelno >= _default_handler.level
-            ):
+            if not emitted and _default_handler and record.levelno >= _default_handler.level:
                 _default_handler.emit(record)
 
     def log(self, level: int, msg: str, *args) -> None:
@@ -622,14 +596,12 @@ def critical(self, msg: str, *args) -> None:
         """
         self._log(CRITICAL, msg, *args)
 
-    # pylint: disable=no-value-for-parameter; value and tb are optional for traceback
     def exception(self, err: Exception) -> None:
         """Convenience method for logging an ERROR with exception information.
 
         :param Exception err: the exception to be logged
         """
         try:
-            # pylint: disable=import-outside-toplevel; not available on all boards
             import traceback
         except ImportError:
             self._log(

adafruit_logging.py

@@ -4,5 +4,8 @@
 .. 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_logging
    :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(".."))
 
@@ -48,9 +46,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

@@ -1,11 +1,12 @@
 # SPDX-FileCopyrightText: 2021 Alec Delaney
 # SPDX-License-Identifier: MIT
 
+import adafruit_sdcard
 import board
 import busio
-from digitalio import DigitalInOut
 import storage
-import adafruit_sdcard
+from digitalio import DigitalInOut
+
 import adafruit_logging as logging
 from adafruit_logging import FileHandler
 

examples/logging_filehandler.py

@@ -34,9 +34,7 @@
 logger.info("Custom formatter example")
 
 
-bracket_timestamp_formatter = logging.Formatter(
-    fmt="{asctime} {levelname}: {message}", style="{"
-)
+bracket_timestamp_formatter = logging.Formatter(fmt="{asctime} {levelname}: {message}", style="{")
 print_handler.setFormatter(bracket_timestamp_formatter)
 logger.info("Timestamp formatter bracket style example")
 

examples/logging_formatter_example.py

@@ -14,7 +14,6 @@
 import adafruit_logging as logging
 
 # adafruit_logging defines log levels dynamically.
-# pylint: disable=no-name-in-module
 from adafruit_logging import NOTSET, Handler, LogRecord
 
 

examples/logging_mqtt_handler.py

@@ -1,9 +1,6 @@
 # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
 # SPDX-License-Identifier: MIT
 
-# pylint:disable=undefined-variable,wildcard-import,no-name-in-module
-# pylint:disable=no-member,invalid-name
-
 """Briefly exercise the logger and null logger."""
 
 import adafruit_logging as logging

examples/logging_simpletest.py

@@ -0,0 +1,108 @@
+# 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
+]
+
+[format]
+line-ending = "lf"