new infrastructure files. use 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

@@ -1,7 +1,22 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+# SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense
 
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "3"
+
 python:
-    version: 3
-requirements_file: requirements.txt
+  install:
+    - requirements: docs/requirements.txt
+    - requirements: requirements.txt

.readthedocs.yml

@@ -21,12 +21,11 @@
 
 """
 
-# pylint: disable=too-many-arguments, too-many-locals, unused-argument, too-few-public-methods
 
-from terminalio import FONT
-from adafruit_display_text import bitmap_label
 from adafruit_display_shapes.line import Line
+from adafruit_display_text import bitmap_label
 from adafruit_displayio_layout.widgets.widget import Widget
+from terminalio import FONT
 
 
 class Annotation(Widget):
@@ -96,7 +95,7 @@ class Annotation(Widget):
       File location: *examples/displayio_annotation_simpletest.py*
     """
 
-    def __init__(
+    def __init__(  # noqa: PLR0913, PLR0917, too many args, too many positional args
         self,
         x=None,
         y=None,
@@ -123,16 +122,8 @@ def __init__(
             widget_width = widget.bounding_box[2]
             widget_height = widget.bounding_box[3]
             if anchor_point is not None:
-                line_x0 = (
-                    widget.x
-                    + round(widget_width * anchor_point[0])
-                    + position_offset[0]
-                )
-                line_y0 = (
-                    widget.y
-                    + round(widget_height * anchor_point[1])
-                    + position_offset[1]
-                )
+                line_x0 = widget.x + round(widget_width * anchor_point[0]) + position_offset[0]
+                line_y0 = widget.y + round(widget_height * anchor_point[1]) + position_offset[1]
             elif anchored_position is not None:
                 line_x0 = widget.x + anchored_position[0] + position_offset[0]
                 line_y0 = widget.y + anchored_position[1] + position_offset[1]
@@ -156,9 +147,7 @@ def __init__(
             text_anchor_point = (1.0, 1.0)
             underline_x_multiplier = -1
 
-        if (
-            text_under
-        ):  # if text is under the line, set to text_anchor_point to upper edge
+        if text_under:  # if text is under the line, set to text_anchor_point to upper edge
             text_anchor_point = (text_anchor_point[0], 0.0)
 
         if text_color is None:

displayio_annotation.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:: displayio_annotation
     :members:
     :member-order: bysource

docs/api.rst

@@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
-
-# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+# 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(".."))
 
@@ -29,12 +27,16 @@
 # autodoc module docs will fail to generate with a warning.
 autodoc_mock_imports = ["terminalio", "vectorio", "bitmaptools"]
 
+autodoc_preserve_defaults = True
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
 }
 
+# Show the docstring from both the class and its __init__() method.
+autoclass_content = "both"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -44,8 +46,13 @@
 master_doc = "index"
 
 # General information about the project.
-project = " CircuitPython DisplayIO_Annotation Library"
-copyright = "2021 Kevin Matocha"
+project = "CircuitPython DisplayIO_Annotation Library"
+creation_year = "2021"
+current_year = str(datetime.datetime.now().year)
+year_duration = (
+    current_year if current_year == creation_year else creation_year + " - " + current_year
+)
+copyright = year_duration + " Kevin Matocha"
 author = "Kevin Matocha"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -67,7 +74,13 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    ".env",
+    "CODE_OF_CONDUCT.md",
+]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -97,7 +110,6 @@
 import sphinx_rtd_theme
 
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -111,22 +123,18 @@
 html_favicon = "_static/favicon.ico"
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "CircuitPython_Displayio_annotationLibrarydoc"
+htmlhelp_basename = "CircuitPython_Displayio_annotation_Librarydoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
-    #
     # 'papersize': 'letterpaper',
     # The font size ('10pt', '11pt' or '12pt').
-    #
     # 'pointsize': '10pt',
     # Additional stuff for the LaTeX preamble.
-    #
     # 'preamble': '',
     # Latex figure (float) alignment
-    #
     # 'figure_align': 'htbp',
 }
 
@@ -136,7 +144,7 @@
 latex_documents = [
     (
         master_doc,
-        "CircuitPython_DisplayIO_AnnotationLibrary.tex",
+        "CircuitPython_DisplayIO_Annotation_Library.tex",
         "CircuitPython DisplayIO_Annotation Library Documentation",
         author,
         "manual",
@@ -150,11 +158,11 @@
 man_pages = [
     (
         master_doc,
-        "CircuitPython_DisplayIO_AnnotationLibrary",
+        "CircuitPython_DisplayIO_Annotation_Library",
         "CircuitPython DisplayIO_Annotation Library Documentation",
         [author],
         1,
-    )
+    ),
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -165,10 +173,10 @@
 texinfo_documents = [
     (
         master_doc,
-        "CircuitPython_DisplayIO_AnnotationLibrary",
+        "CircuitPython_DisplayIO_Annotation_Library",
         "CircuitPython DisplayIO_Annotation Library Documentation",
         author,
-        "CircuitPython_DisplayIO_AnnotationLibrary",
+        "CircuitPython_DisplayIO_Annotation_Library",
         "One line description of project.",
         "Miscellaneous",
     ),

docs/conf.py

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+sphinx
+sphinxcontrib-jquery
+sphinx-rtd-theme

docs/requirements.txt

@@ -7,11 +7,12 @@
 """
 
 import time
+
+import adafruit_touchscreen
 import board
 import displayio
-import adafruit_touchscreen
-from adafruit_displayio_layout.widgets.switch_round import SwitchRound as Switch
 from adafruit_displayio_layout.widgets.annotation import Annotation
+from adafruit_displayio_layout.widgets.switch_round import SwitchRound as Switch
 
 display = board.DISPLAY
 

examples/displayio_annotation_simpletest.py

@@ -24,10 +24,11 @@ keywords = [
     "blinka",
     "circuitpython",
     "micropython",
-    "displayio",
     "displayio_annotation",
+    "displayio",
+    "annotation",
     "graphics",
-    "widget"
+    "widget",
 ]
 license = {text = "MIT"}
 classifiers = [

pyproject.toml

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