Merge pull request #5 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,duplicate-code
-        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

@@ -17,9 +17,9 @@ Introduction
     :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 library for interacting with online pastebin services
 

README.rst

@@ -24,14 +24,14 @@
 
 try:
     from typing import List
-    from typing_extensions import Protocol
+
     from adafruit_requests import Session
+    from typing_extensions import Protocol
 
     class SupportsStr(Protocol):
         """Protocol type for anything that supports the :py:meth:`str()` method"""
 
-        def __str__(self) -> str:  # pylint: disable=invalid-str-returned
-            ...
+        def __str__(self) -> str: ...
 
 except ImportError:
     pass
@@ -40,7 +40,6 @@ def __str__(self) -> str:  # pylint: disable=invalid-str-returned
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Pastebin.git"
 
 
-# pylint: disable=too-few-public-methods
 class _Pastebin:
     """
     Generic paste bin class

adafruit_pastebin/__init__.py

@@ -14,12 +14,15 @@
 """
 
 import json
+
 from adafruit_pastebin import _Pastebin
 
 try:
-    import typing  # pylint: disable=unused-import
-    from adafruit_pastebin import SupportsStr
+    import typing
+
     from adafruit_requests import Session
+
+    from adafruit_pastebin import SupportsStr
 except ImportError:
     pass
 
@@ -37,15 +40,11 @@ class AIOPastebin(_Pastebin):
     :param str feed_key: The feed key of the feed to use for pasting
     """
 
-    def __init__(
-        self, session: Session, auth_key: str, *, username: str, feed_key: str
-    ) -> None:
+    def __init__(self, session: Session, auth_key: str, *, username: str, feed_key: str) -> None:
         super().__init__(session, auth_key)
         self._username = username
         self._feed_key = feed_key
-        self._post_url = (
-            f"https://io.adafruit.com/api/v2/{username}/feeds/{feed_key}/data"
-        )
+        self._post_url = f"https://io.adafruit.com/api/v2/{username}/feeds/{feed_key}/data"
 
     def paste(
         self,

adafruit_pastebin/adafruit_io.py

@@ -14,10 +14,12 @@
 """
 
 import json
+
 from adafruit_pastebin import _Pastebin
 
 try:
     from typing import Optional
+
     from adafruit_pastebin import SupportsStr
 except ImportError:
     pass

adafruit_pastebin/gist.py

@@ -17,15 +17,15 @@
 
 try:
     from typing import Optional
-    from adafruit_pastebin import SupportsStr  # pylint: disable=ungrouped-imports
+
+    from adafruit_pastebin import SupportsStr
 except ImportError:
     pass
 
 
 POST_URL = "http://pastebin.com/api/api_post.php"
 
 
-# pylint: disable=too-few-public-methods
 class PrivacySetting:
     """
     Enum-like class for privacy settings.
@@ -43,7 +43,6 @@ class PrivacySetting:
     PRIVATE = "2"
 
 
-# pylint: disable=too-few-public-methods
 class ExpirationSetting:
     """
     Enum-like class for expiration settings.

adafruit_pastebin/pastebin.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_pastebin.pastebin
     :members:
 

docs/api.rst

@@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
+import datetime
 import os
 import sys
-import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -51,9 +49,7 @@
 creation_year = "2022"
 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 + " Alec Delaney"
 author = "Alec Delaney"

docs/conf.py

@@ -2,20 +2,20 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-from os import getenv
-import ssl
 import socket
+import ssl
+from os import getenv
+
 import adafruit_requests as requests
+
 from adafruit_pastebin.adafruit_io import AIOPastebin
 
 # Get PasteBin keys, ensure these are setup in your environment
 auth_key = getenv("auth_key")
 
 session = requests.Session(socket, ssl_context=ssl.create_default_context())
 
-pastebin = AIOPastebin(
-    session, auth_key, username="username", feed_key="existing_feedkey"
-)
+pastebin = AIOPastebin(session, auth_key, username="username", feed_key="existing_feedkey")
 paste_url = pastebin.paste(
     "This is a test paste!",
 )

examples/pastebin_aio_cpython.py

@@ -2,10 +2,12 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-from os import getenv
-import ssl
 import socket
+import ssl
+from os import getenv
+
 import adafruit_requests as requests
+
 from adafruit_pastebin.gist import Gist
 
 # Get PasteBin keys, ensure these are setup in your environment

examples/pastebin_gist_cpython.py

@@ -2,12 +2,14 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-from os import getenv
 import ssl
-import wifi
-import socketpool
+from os import getenv
+
 import adafruit_requests as requests
-from adafruit_pastebin.pastebin import PasteBin, ExpirationSetting, PrivacySetting
+import socketpool
+import wifi
+
+from adafruit_pastebin.pastebin import ExpirationSetting, PasteBin, PrivacySetting
 
 # Get WiFi details and PasteBin keys, ensure these are setup in settings.toml
 ssid = getenv("CIRCUITPY_WIFI_SSID")

examples/pastebin_simpletest.py

@@ -2,11 +2,13 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-from os import getenv
-import ssl
 import socket
+import ssl
+from os import getenv
+
 import adafruit_requests as requests
-from adafruit_pastebin.pastebin import PasteBin, ExpirationSetting, PrivacySetting
+
+from adafruit_pastebin.pastebin import ExpirationSetting, PasteBin, PrivacySetting
 
 # Get PasteBin keys, ensure these are setup in your environment
 auth_key = getenv("auth_key")

examples/pastebin_simpletest_cpython.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"