Merge pull request #124 from michael-lazar/linters

Upgrade to python 3.10 and add linters/tooling
michael-lazar · Jan 9, 2024 · 52cb737 · 52cb737
2 parents a35f2ba + 7d1c903
commit 52cb737
Show file tree

Hide file tree

Showing 116 changed files with 314 additions and 231 deletions.
diff --git a/.github/workflows/astrobotany.yml b/.github/workflows/astrobotany.yml
@@ -10,19 +10,19 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3.7
-      uses: actions/setup-python@v1
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Install python
+      uses: actions/setup-python@v2
       with:
-        python-version: 3.7
-    - name: Install packages
-      run: |
-        pip install .
-        pip install .[test]
-        sudo apt-get install timidity
-    - name: Lint with mypy
-      run: |
-        mypy --ignore-missing-imports --exclude build .
-    - name: Run tests
-      run: |
-        pytest -v tests/
+        python-version: '3.10'
+    - name: Run pre-commit checks
+      uses: pre-commit/actions@v2.0.3
+    - name: Run bootstrap
+      run: tools/bootstrap
+    - name: Install timidity
+      run: sudo apt-get install timidity
+    - name: Run mypy
+      run: tools/mypy
+    - name: Run pytest
+      run: tools/pytest
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,29 @@
+default_stages: [commit]
+
+default_language_version:
+  python: python3.10
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: file-contents-sorter
+        files: requirements/.*\.in
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.1.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/psf/black
+    rev: 23.10.1
+    hooks:
+      - id: black
+
+ci:
+  autoupdate_schedule: weekly
+  skip: []
+  submodules: false
diff --git a/astrobotany/__init__.py b/astrobotany/__init__.py
@@ -1,4 +1,4 @@
-from .models import init_db
-from .views import app
+from astrobotany.models import init_db
+from astrobotany.views import app
 
 __all__ = ["init_db", "app"]
diff --git a/astrobotany/art.py b/astrobotany/art.py
@@ -2,10 +2,9 @@
 import itertools
 import json
 import os
-import random
-from typing import Dict, List, NamedTuple, Optional, Tuple
+from typing import Dict, List, NamedTuple, Tuple
 
-ColorCode = Optional[int]
+ColorCode = int | None
 
 
 class Tile(NamedTuple):
@@ -77,7 +76,7 @@ class ArtFile:
     # randomness to the order of colors for rainbow plants
     rainbow_generator = itertools.cycle(RAINBOW_COLORS)
 
-    def __init__(self, filename: str, flower_color: Optional[str] = None) -> None:
+    def __init__(self, filename: str, flower_color: str | None = None) -> None:
         self.filename = filename
         self.flower_color = flower_color
         self.character_matrix = self.load_file(filename)
@@ -196,7 +195,5 @@ def merge_tiles(cls, character_matrix: CharacterMatrix) -> CharacterMatrix:
 
 
 @functools.lru_cache(maxsize=1000)
-def render_art(
-    filename: str, flower_color: Optional[str] = None, ansi_enabled: bool = False
-) -> str:
+def render_art(filename: str, flower_color: str | None = None, ansi_enabled: bool = False) -> str:
     return ArtFile(filename, flower_color).render(ansi_enabled)
diff --git a/astrobotany/art/agave1.psci b/astrobotany/art/agave1.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 73,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/agave2.psci b/astrobotany/art/agave2.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 80,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/agave3.psci b/astrobotany/art/agave3.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 122,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/aloe1.psci b/astrobotany/art/aloe1.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 80,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/aloe2.psci b/astrobotany/art/aloe2.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 80,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/aloe3.psci b/astrobotany/art/aloe3.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 199,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/baobab1.psci b/astrobotany/art/baobab1.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 13,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/baobab2.psci b/astrobotany/art/baobab2.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 13,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/baobab3.psci b/astrobotany/art/baobab3.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 199,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/bee.psci b/astrobotany/art/bee.psci
@@ -1684,4 +1684,4 @@
  "selected_fg_color": 65,
  "selected_xform": 0,
  "width": 23
-}
+}
diff --git a/astrobotany/art/brugmansia1.psci b/astrobotany/art/brugmansia1.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 62,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/brugmansia2.psci b/astrobotany/art/brugmansia2.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 62,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/brugmansia3.psci b/astrobotany/art/brugmansia3.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 199,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/cactus1.psci b/astrobotany/art/cactus1.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 14,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/cactus2.psci b/astrobotany/art/cactus2.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 80,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/cactus3.psci b/astrobotany/art/cactus3.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 199,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/christmas.psci b/astrobotany/art/christmas.psci
@@ -6778,4 +6778,4 @@
  "selected_fg_color": 25,
  "selected_xform": 0,
  "width": 45
-}
+}
diff --git a/astrobotany/art/columbine1.psci b/astrobotany/art/columbine1.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 80,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/columbine2.psci b/astrobotany/art/columbine2.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 55,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/columbine3.psci b/astrobotany/art/columbine3.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 199,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/daffodil1.psci b/astrobotany/art/daffodil1.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 80,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/daffodil2.psci b/astrobotany/art/daffodil2.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 14,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/daffodil3.psci b/astrobotany/art/daffodil3.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 133,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/duck.psci b/astrobotany/art/duck.psci
@@ -1163,4 +1163,3 @@
  "selected_xform": 0,
  "width": 27
 }
-
diff --git a/astrobotany/art/epilog1.psci b/astrobotany/art/epilog1.psci
@@ -1150,4 +1150,4 @@
  "selected_fg_color": 19,
  "selected_xform": 0,
  "width": 17
-}
+}
diff --git a/astrobotany/art/epilog2.psci b/astrobotany/art/epilog2.psci
@@ -1546,4 +1546,4 @@
  "selected_fg_color": 216,
  "selected_xform": 0,
  "width": 23
-}
+}
diff --git a/astrobotany/art/epilog3.psci b/astrobotany/art/epilog3.psci
@@ -1612,4 +1612,4 @@
  "selected_fg_color": 216,
  "selected_xform": 0,
  "width": 24
-}
+}
diff --git a/astrobotany/art/epilog4.psci b/astrobotany/art/epilog4.psci
@@ -1150,4 +1150,4 @@
  "selected_fg_color": 19,
  "selected_xform": 0,
  "width": 17
-}
+}
diff --git a/astrobotany/art/fern1.psci b/astrobotany/art/fern1.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 80,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/fern2.psci b/astrobotany/art/fern2.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 80,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/fern3.psci b/astrobotany/art/fern3.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 199,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/ficus1.psci b/astrobotany/art/ficus1.psci
@@ -1588,4 +1588,4 @@
  "selected_fg_color": 94,
  "selected_xform": 0,
  "width": 26
-}
+}
diff --git a/astrobotany/art/ficus2.psci b/astrobotany/art/ficus2.psci
@@ -1948,4 +1948,4 @@
  "selected_fg_color": 94,
  "selected_xform": 0,
  "width": 32
-}
+}
diff --git a/astrobotany/art/ficus3.psci b/astrobotany/art/ficus3.psci
@@ -1948,4 +1948,4 @@
  "selected_fg_color": 94,
  "selected_xform": 0,
  "width": 32
-}
+}
diff --git a/astrobotany/art/hemp1.psci b/astrobotany/art/hemp1.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 20,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/hemp2.psci b/astrobotany/art/hemp2.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 20,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/hemp3.psci b/astrobotany/art/hemp3.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 199,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/iris1.psci b/astrobotany/art/iris1.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 62,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/iris2.psci b/astrobotany/art/iris2.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 80,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/iris3.psci b/astrobotany/art/iris3.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 199,
  "selected_xform": 0,
  "width": 25
-}
+}
diff --git a/astrobotany/art/jackolantern.psci b/astrobotany/art/jackolantern.psci
@@ -1768,4 +1768,4 @@
  "selected_fg_color": 164,
  "selected_xform": 0,
  "width": 29
-}
+}
diff --git a/astrobotany/art/jadeplant1.psci b/astrobotany/art/jadeplant1.psci
@@ -1528,4 +1528,4 @@
  "selected_fg_color": 79,
  "selected_xform": 0,
  "width": 25
-}
+}