Ruff formatter and Pre commit

.circleci/config.yml

@@ -14,6 +14,9 @@ jobs:
       - run:
           name: Install deps
           command: make install
+      - run:
+          name: Pre-commit checks
+          command: SKIP=ruff-format uv run pre-commit run --all-files --show-diff-on-failure
       - run:
           name: Format Check
           command: make format-check

.dockerignore

@@ -27,4 +27,4 @@ docker-compose*
 target
 data/v2/cries
 data/v2/csv
-data/v2/sprites
+data/v2/sprites

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,7 +7,7 @@ about: Create a report to help us improve
 Thanks for contributing to the PokéAPI project. To make sure we're effective, please check the following:
 
 - Make sure your issue hasn't already been submitted on the issues tab. (It has search functionality!)
-- If your issue is one of outdated API data, please note that we get our data from [veekun](https://github.com/veekun/pokedex/). If they are not up to date either, please look for or create an issue there. Otherwise, feel free to create an issue here. 
+- If your issue is one of outdated API data, please note that we get our data from [veekun](https://github.com/veekun/pokedex/). If they are not up to date either, please look for or create an issue there. Otherwise, feel free to create an issue here.
 - Provide a clear description of the issue.
 - Provide a clear description of the steps to reproduce.
 - Provide a clear description of the expected behavior.

.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,4 @@
-  
+
 blank_issues_enabled: false
 contact_links:
   - name: Question

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,7 +7,7 @@ about: Suggest an idea for this project
 <!--
 Please search existing issues to avoid creating duplicates.
 
-Describe the feature you'd like. 
+Describe the feature you'd like.
 
 Thank you!
 -->

.github/dependabot.yml

@@ -7,4 +7,4 @@ updates:
   - package-ecosystem: "docker"
     directory: "/Resources/docker/app"
     schedule:
-      interval: "monthly"
+      interval: "monthly"

.github/pull_request_template.md

@@ -1,4 +1,4 @@
-<!-- Thank you for submitting a Pull Request. Please: 
+<!-- Thank you for submitting a Pull Request. Please:
 * Ensure that the code is up-to-date with the `master` branch.
 * Include a description of the proposed changes and how to test them.
 * Consider adding the `no-deploy` label if this PR shouldn't be deployed and does not alter the data served by the API.

.github/workflows/docker-k8s.yml

@@ -112,4 +112,4 @@ jobs:
       - name: Assert containers running
         run: |
           last_command=$(docker ps | grep 'pokeapi-' | wc -l)
-          test "$last_command" -eq 5
+          test "$last_command" -eq 5

.pre-commit-config.yaml

@@ -0,0 +1,60 @@
+repos:
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: check-ast
+      - id: check-json
+      - id: check-toml
+      - id: check-yaml
+        args:
+          - --allow-multiple-documents
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: pretty-format-json
+        args:
+          - --no-sort-keys
+          - --no-ensure-ascii
+      - id: sort-simple-yaml
+      - id: trailing-whitespace
+        args:
+          - --markdown-linebreak-ext=md
+
+  # TODO: Enable in the future when adding the ruff linter
+  # - repo: https://github.com/pre-commit/pygrep-hooks
+  #   rev: v1.9.0
+  #   hooks:
+  #     - id: python-check-blanket-noqa
+  #     - id: python-check-blanket-type-ignore
+  #     - id: python-use-type-annotations
+
+  - repo: local
+    hooks:
+      - id: check-csv
+        name: Check CSV
+        entry: uv run ./Resources/scripts/check_csv.py
+        language: system
+        args: [--encoding, utf-8]
+        files: \.csv$
+
+      - id: ruff-format
+        name: Ruff Format
+        entry: uv run ruff format .
+        language: system
+        types_or: [python, pyi]
+        pass_filenames: false
+
+      - id: build-and-test
+        name: Build and Test
+        entry: >-
+          python -c "
+          import subprocess, sys;
+          run = lambda cmd, inp=None: subprocess.run(cmd, input=inp, text=True).returncode == 0 or sys.exit(1);
+          run(['uv', 'run', 'manage.py', 'migrate', '--settings=config.local']);
+          run(['uv', 'run', 'manage.py', 'shell', '--settings=config.local'], inp='from data.v2.build import build_all; build_all()\n');
+          run(['uv', 'run', 'manage.py', 'test', '--settings=config.local'])
+          "
+        language: system
+        pass_filenames: false
+        always_run: true
+        stages: [manual]

CONTRIBUTING.md

@@ -18,6 +18,13 @@ git checkout -b my_new_branch
 ```
 - Write some code, fix something, and add a test to prove that it works. **No pull request will be accepted without tests passing, or without new tests if new features are added.**
 
+- Make sure your code passes the pre-commit hooks, if you have the hooks installed it should run automatically on commit. You can run them manually with:
+```bash
+make pre-commit  
+# or
+uv run pre-commit run --all-files
+```
+
 - Commit your code and push it to GitHub
 
 - [Open a new pull request](https://help.github.com/articles/creating-a-pull-request/) and describe the changes you have made.

CONTRIBUTORS.txt

@@ -2,4 +2,4 @@ Paul Hallett paulandrewhallett@gmail.com
 Zane Adickes zaneadix@gmail.com
 Charles Marttinen charlesmarttinen.ca
 Sargun Vohra sargun.vohra@gmail.com
-Alessandro Pezzè igougi.ui@gmail.com
+Alessandro Pezzè igougi.ui@gmail.com

Makefile

@@ -22,6 +22,12 @@ install: check-uv  # Install requirements for local development
 install-base: check-uv  # Install minimal requirements for runtime/pipeline environments
 	uv sync --locked --no-dev
 
+pre-commit-install: check-uv  # Install pre-commit hooks
+	uv run pre-commit install
+
+pre-commit: check-uv  # Run pre-commit hooks
+	uv run pre-commit run --all-files
+
 setup: check-uv   # Set up the project database
 	uv run manage.py migrate ${local_config}
 
@@ -89,10 +95,10 @@ docker-prod:
 docker-setup: docker-up docker-migrate docker-build-db  # (Docker) Start services, prepare the latest DB schema, populate the DB
 
 format: check-uv   # Format the source code
-	uv run black . --extend-exclude '.+/scripts/.+'
+	uv run ruff format .
 
 format-check: check-uv  # Check the source code has been formatted
-	uv run black . --check --extend-exclude '.+/scripts/.+'
+	uv run ruff format . --check
 
 pull:
 	git checkout master

README.md

@@ -38,14 +38,20 @@ A RESTful API for Pokémon - [pokeapi.co](https://pokeapi.co)
 - Download this source code into a working directory, be sure to use the flag `--recurse-submodules` to clone also our submodules.
 
 - Install [uv](https://docs.astral.sh/uv/getting-started/installation/) for Python environment management.
-  
+
 - Install the requirements using the Makefile commands:
-  
+
     ```sh
     make install
     # This will install all the required packages and libraries for using PokeAPI
     ```
 
+- Install the pre-commit hooks using the Makefile commands:
+
+    ```sh
+    make pre-commit-install
+    ```
+
 - Set up the local development environment using the following command:
 
     ```sh

Resources/gcp/api_v2_slo.sh

@@ -19,4 +19,4 @@ CREATE_SLO_POST_BODY=$(cat <<EOF
 EOF
 )
 
-curl  --http1.1 --header "Authorization: Bearer $ACCESS_TOKEN" --header "Content-Type: application/json" -X POST -d "$CREATE_SLO_POST_BODY" "https://monitoring.googleapis.com/v3/projects/$GOOGLE_CLOUD_PROJECT/services/_1QdRovaRBGqDhnMI8i2Yw/serviceLevelObjectives"
+curl  --http1.1 --header "Authorization: Bearer $ACCESS_TOKEN" --header "Content-Type: application/json" -X POST -d "$CREATE_SLO_POST_BODY" "https://monitoring.googleapis.com/v3/projects/$GOOGLE_CLOUD_PROJECT/services/_1QdRovaRBGqDhnMI8i2Yw/serviceLevelObjectives"

Resources/k8s/kustomize/base/config/pokeapi.env.sample

@@ -1,3 +1,3 @@
 ADMINS=PokeAPI,change.me@pokeapi.co
 BASE_URL=http://localhost/
-POKEAPI_CHECKOUT_REF=master
+POKEAPI_CHECKOUT_REF=master

Resources/k8s/kustomize/base/secrets/graphql.env.sample

@@ -1 +1 @@
-HASURA_GRAPHQL_ADMIN_SECRET=pokeapi-change-me
+HASURA_GRAPHQL_ADMIN_SECRET=pokeapi-change-me

Resources/k8s/kustomize/base/secrets/postgres.env.sample

@@ -1 +1 @@
-POSTGRES_PASSWORD=pokeapi-change-me
+POSTGRES_PASSWORD=pokeapi-change-me

Resources/kind/config-ga.yaml

@@ -4,4 +4,4 @@ nodes:
   - role: control-plane
     extraMounts:
       - hostPath: /home/runner/work/pokeapi/pokeapi/data/v2/
-        containerPath: /code/pokeapi/data/v2/
+        containerPath: /code/pokeapi/data/v2/

Resources/nginx/ssl/ssl.sample.conf

@@ -12,4 +12,4 @@ ssl_session_tickets off;
 
 ssl_protocols TLSv1.2 TLSv1.3;
 ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
-ssl_prefer_server_ciphers off;
+ssl_prefer_server_ciphers off;

Resources/scripts/check_csv.py

@@ -0,0 +1,51 @@
+import argparse
+import csv
+import locale
+import typing
+from concurrent.futures import ThreadPoolExecutor, as_completed
+
+
+def check_csv(filename: str, encoding: str, delimiter: str) -> tuple[str, bool, str]:
+    try:
+        with open(filename, encoding=encoding, newline='') as f:
+            reader = csv.reader(f, delimiter=delimiter)
+            first_len = None
+            for line_no, row in enumerate(reader, start=1):
+                if first_len is None:
+                    first_len = len(row)
+                elif len(row) != first_len:
+                    message = f'line {line_no}: contains inconsistent columns (expected {first_len}, got {len(row)})'
+                    return filename, False, message
+    except UnicodeDecodeError:
+        return filename, False, f'failed to decode csv text file using {encoding!r}'
+
+    return filename, True, ''
+
+
+def main(argv: typing.Sequence[str] | None = None) -> int:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-e', '--encoding', dest='encoding', default=locale.getpreferredencoding())
+    parser.add_argument('-d', '--delimiter', dest='delimiter', default=',')
+    parser.add_argument('-j', '--jobs', dest='jobs', type=int, default=8)
+    parser.add_argument('filenames', nargs='*', help='Filenames to check.')
+    args = parser.parse_args(argv)
+
+    print(f'Checking CSV files using encoding {args.encoding!r} and delimiter {args.delimiter!r}...')
+    print(f'Checking {len(args.filenames)} files with {args.jobs} workers...')
+
+    retval = 0
+    with ThreadPoolExecutor(max_workers=args.jobs) as executor:
+        futures = {
+            executor.submit(check_csv, filename, args.encoding, args.delimiter): filename
+            for filename in args.filenames
+        }
+        for future in as_completed(futures):
+            filename, ok, msg = future.result()
+            if not ok:
+                print(f'{filename}: {msg}')
+                retval = 1
+    return retval
+
+
+if __name__ == '__main__':
+    raise SystemExit(main())

Resources/scripts/data/gen8/read_swsh.py

@@ -189,7 +189,7 @@ def __OpenTbl(this, path):
 		with open(path, "rb") as f:
 			try:
 				# First four bytes is "magic"; needs to be 0x42544841
-				testMagic = struct.unpack("<I", f.read(4))[0]	
+				testMagic = struct.unpack("<I", f.read(4))[0]
 				if (testMagic == this.__magic):
 					# Next four bytes is the number of entries to read
 					count = struct.unpack("<I", f.read(4))[0]
@@ -211,4 +211,4 @@ def __ReadUntil(this, f, value):
 			string += c.decode("utf-8")
 			c = f.read(1)
 
-		return string
+		return string

Resources/scripts/data/gen8/to_csv.py

@@ -89,4 +89,4 @@
 		writer.writerow(header)
 		entriesList.sort()
 		writer.writerows(entriesList)
-		print("Done")
+		print("Done")

Resources/scripts/data/scraper_go/data/new_abilities.txt

@@ -26,4 +26,4 @@ Steam Engine (Ability)
 Steely Spirit (Ability)
 Transistor (Ability)
 Unseen Fist (Ability)
-Wandering Spirit (Ability)
+Wandering Spirit (Ability)

Resources/scripts/data/scraper_go/data/new_moves.txt

@@ -111,4 +111,4 @@ Terrain Pulse (move)
 Thunder Cage (move)
 Thunderous Kick (move)
 Triple Axel (move)
-Wicked Blow (move)
+Wicked Blow (move)

Resources/scripts/data/scraper_go/data/new_pokemon.txt

@@ -84,4 +84,4 @@ Wooloo_(Pok%C3%A9mon)
 Yamper_(Pok%C3%A9mon)
 Zacian_(Pok%C3%A9mon)
 Zamazenta_(Pok%C3%A9mon)
-Zarude_(Pok%C3%A9mon)
+Zarude_(Pok%C3%A9mon)

Resources/scripts/data/scraper_node/new_pokemons.js

@@ -86,4 +86,4 @@ module.exports.new_pokemons = [
     "Zacian",
     "Zamazenta",
     "Zarude"
-]
+]

Resources/scripts/wait.sh

@@ -20,4 +20,4 @@ wait_for_http() {
     fi
 }
 
-wait_for_http "${1:-http://localhost/api/v2/}"
+wait_for_http "${1:-http://localhost/api/v2/}"

config/settings.py

@@ -77,9 +77,7 @@
     }
 }
 
-SECRET_KEY = os.environ.get(
-    "SECRET_KEY", "django-insecure-a(!_5+l3$#l1f4n!x+&ns_+8$4q@df*3rh$n#2h@l$2gti7!7-"
-)
+SECRET_KEY = os.environ.get("SECRET_KEY", "django-insecure-a(!_5+l3$#l1f4n!x+&ns_+8$4q@df*3rh$n#2h@l$2gti7!7-")
 
 CUSTOM_APPS = ("pokemon_v2",)