CI

.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @ekiefl

.github/workflows/ci.yml

@@ -0,0 +1,118 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install -r requirements-dev.txt
+
+    # --- Ruff
+
+    - name: ruff (lint)
+      id: ruff_lint
+      continue-on-error: true
+      run: |
+        ruff --version
+        ruff check . --verbose --diff
+        echo "ruff_lint_failed=$?" >> $GITHUB_ENV
+
+    - name: ruff (format)
+      id: ruff_format
+      continue-on-error: true
+      run: |
+        ruff --version
+        ruff format . --check --verbose --diff
+        echo "ruff_format_failed=$?" >> $GITHUB_ENV
+
+    # --- Pytest
+
+    - name: pytest
+      id: pytest
+      continue-on-error: true
+      run: |
+        pytest --version
+        pytest
+        echo "pytest_failed=$?" >> $GITHUB_ENV
+
+    # --- Pyright
+
+    - name: pyright
+      id: pyright
+      continue-on-error: true
+      run: |
+        pyright --version
+        pyright --project ./pyrightconfig.ci.json
+        echo "pyright_failed=$?" >> $GITHUB_ENV
+
+    # --- Main
+
+    - name: Test results
+      if: always()
+      run: |
+        # Print out test results
+        passed=()
+        failed=()
+
+        if [[ "${{ env.pytest_failed }}" != "0" ]]; then
+          failed+=("pytest")
+        else
+          passed+=("pytest")
+        fi
+
+        if [[ "${{ env.pyright_failed }}" != "0" ]]; then
+          failed+=("pyright")
+        else
+          passed+=("pyright")
+        fi
+
+        if [[ "${{ env.ruff_lint_failed }}" != "0" ]]; then
+          failed+=("ruff_lint")
+        else
+          passed+=("ruff_lint")
+        fi
+
+        if [[ "${{ env.ruff_format_failed }}" != "0" ]]; then
+          failed+=("ruff_format")
+        else
+          passed+=("ruff_format")
+        fi
+
+        if [ ${#passed[@]} -ne 0 ]; then
+          echo "✅ PASSED:"
+          for check in "${passed[@]}"; do
+            echo "    - $check"
+          done
+        fi
+
+        echo ""
+
+        if [ ${#failed[@]} -ne 0 ]; then
+          echo "❌ FAILED:"
+          for check in "${failed[@]}"; do
+            echo "    - $check"
+          done
+        else
+          echo "🚀🚀 ALL TESTS PASSED 🚀🚀"
+        fi
+
+        echo ""
+        echo "Click above jobs for details on each success/failure"
+
+        if [ ${#failed[@]} -ne 0 ]; then
+          exit 1
+        fi

.pre-commit-config.yaml

@@ -1,15 +1,13 @@
 repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.0
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
+
   - repo: local
     hooks:
-      - id: isort
-        name: isort
-        entry: isort
-        language: system
-      - id: black
-        name: black
-        entry: black
-        language: system
-        types_or: [python, pyi]
       - id: pytest
         name: pytest
         entry: pytest

docs/conf.py

@@ -12,7 +12,8 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../'))
+
+sys.path.insert(0, os.path.abspath("../"))
 
 # -- Project information -----------------------------------------------------
 
@@ -46,7 +47,7 @@
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 # NOTE: Don't use this for excluding python files, use `autoapi_ignore` below
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # -- Global options ----------------------------------------------------------
 
@@ -59,7 +60,7 @@
 # a list of builtin themes.
 #
 html_theme = "furo"
-html_logo = '../pooltool/logo/logo_small.png'
+html_logo = "../pooltool/logo/logo_small.png"
 
 # 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,
@@ -85,14 +86,14 @@
 }
 
 # -- copybutton options
-copybutton_exclude = '.linenos, .gp, .go'
+copybutton_exclude = ".linenos, .gp, .go"
 
 # -- myst options
 myst_enable_extensions = ["colon_fence"]
 
 # -- autoapi configuration ---------------------------------------------------
 
-#autodoc_typehints = "signature"  # autoapi respects this
+# autodoc_typehints = "signature"  # autoapi respects this
 autodoc_typehints = "both"  # autoapi respects this
 autodoc_typehints_description_target = "documented_params"  # autoapi respects this
 autodoc_class_signature = "mixed"
@@ -110,29 +111,30 @@
 autoapi_keep_files = True
 
 autoapi_ignore = [
-    '*/test_*.py',
+    "*/test_*.py",
     "*/render.py",
     "*/ai/*",
     "*/user_config.py",
 ]
 # Everything in ani/ except animate.py
-autoapi_ignore.extend([
-    "*/ani/camera/*",
-    "*/ani/fonts/*",
-    "*/ani/image/*",
-    "*/ani/modes/*",
-    "*/ani/__init__.py",
-    "*/ani/action.py",
-    "*/ani/collision.py",
-    "*/ani/environment.py",
-    "*/ani/globals.py",
-    "*/ani/hud.py",
-    "*/ani/menu.py",
-    "*/ani/mouse.py",
-    "*/ani/tasks.py",
-    "*/ani/utils.py",
-])
-
+autoapi_ignore.extend(
+    [
+        "*/ani/camera/*",
+        "*/ani/fonts/*",
+        "*/ani/image/*",
+        "*/ani/modes/*",
+        "*/ani/__init__.py",
+        "*/ani/action.py",
+        "*/ani/collision.py",
+        "*/ani/environment.py",
+        "*/ani/globals.py",
+        "*/ani/hud.py",
+        "*/ani/menu.py",
+        "*/ani/mouse.py",
+        "*/ani/tasks.py",
+        "*/ani/utils.py",
+    ]
+)
 
 
 # -- custom auto_summary() macro ---------------------------------------------

docs/custom_directives.py

@@ -1,6 +1,7 @@
 from docutils import nodes
 from sphinx.util.docutils import SphinxDirective
 
+
 class CachedPropertyDirective(SphinxDirective):
     required_arguments = 0
     optional_arguments = 0
@@ -9,7 +10,7 @@ class CachedPropertyDirective(SphinxDirective):
 
     def run(self):
         targetid = f"cached-property-{self.env.new_serialno('cached-property')}"
-        targetnode = nodes.target('', '', ids=[targetid])
+        targetnode = nodes.target("", "", ids=[targetid])
 
         # Create an admonition node to hold the content
         admonition_node = nodes.admonition()
@@ -23,12 +24,14 @@ def run(self):
         post_text = ", and should be accessed as an attribute, not as a method call."
 
         # Creating the hyperlink
-        uri = "https://docs.python.org/3/library/functools.html#functools.cached_property"
+        uri = (
+            "https://docs.python.org/3/library/functools.html#functools.cached_property"
+        )
         link_text = "cached property"
-        hyperlink = nodes.reference('', '', nodes.Text(link_text), refuri=uri)
+        hyperlink = nodes.reference("", "", nodes.Text(link_text), refuri=uri)
 
         # Creating the paragraph and adding the intro text and hyperlink
-        para = nodes.paragraph('', '')
+        para = nodes.paragraph("", "")
         para += nodes.Text(pre_text, pre_text)
         para += hyperlink
         para += nodes.Text(post_text, post_text)

docs/custom_extensions.py

@@ -1,7 +1,9 @@
-import attr
 import re
+
+import attr
 from sphinx.application import Sphinx
 
+
 def extract_qualified_name(obj):
     repr_str = repr(obj)
     class_or_instance_method_pattern = r"<bound method ([\w\.]+)\.([\w]+) of"
@@ -24,17 +26,17 @@ def extract_qualified_name(obj):
 
 def process_signature(app, what, name, obj, options, signature, return_annotation):
     # Check if the object is a class or a method of an attrs class
-    if attr.has(obj) or (hasattr(obj, '__objclass__') and attr.has(obj.__objclass__)):
+    if attr.has(obj) or (hasattr(obj, "__objclass__") and attr.has(obj.__objclass__)):
         cls = obj if attr.has(obj) else obj.__objclass__
         attrs_fields = attr.fields_dict(cls)
-        
+
         new_signature = signature
         for field_name, attr_obj in attrs_fields.items():
             if isinstance(attr_obj.default, attr.Factory):
                 # Extract full name from the factory's __repr__
                 factory_full_name = extract_qualified_name(attr_obj.default.factory)
                 replacement_str = f"{factory_full_name}"
-                
+
                 # Define a regex pattern to match the parameter, its type, and the default value
                 pattern = re.compile(rf"({field_name}: [^=]+ = )_Nothing.NOTHING")
                 # Replace with the new default value representation
@@ -44,4 +46,4 @@ def process_signature(app, what, name, obj, options, signature, return_annotatio
 
 
 def setup(app: Sphinx):
-    app.connect('autodoc-process-signature', process_signature)
+    app.connect("autodoc-process-signature", process_signature)

docs/custom_skip_members.py

@@ -1,4 +1,4 @@
-#def autoapi_skip_members(app, what, name, obj, skip, options):
+# def autoapi_skip_members(app, what, name, obj, skip, options):
 #    print(what, name, skip)
 #    # skip submodules
 #    if what == "module":
@@ -26,5 +26,5 @@
 #    return skip
 #
 #
-#def setup(app):
+# def setup(app):
 #    app.connect("autoapi-skip-member", autoapi_skip_members)

docs/test_custom_extensions.py

@@ -18,7 +18,7 @@ def just_a_func():
     pass
 
 
-lambda_func = lambda x: x
+lambda_func = lambda x: x  # noqa: E731
 
 
 def test_a_class_method():