RagnarGrootKoerkamp#490 Move mypy config to pyproject.toml and run outside of pre-commit environment (RagnarGrootKoerkamp#493)

* Install mypy environment externally

* readme.md: Add instructions to install development dependencies in venv

* pyproject.toml: By default, run mypy only on the `bapctools` package

---------

Co-authored-by: Maarten Sijm <[email protected]>

Author: niklasmohrin

.github/workflows/ci.yaml

@@ -9,6 +9,7 @@ jobs:
       - uses: actions/setup-python@v3
         with:
           python-version: '3.10'
+      - run: python3 -m pip install --editable .[types]
       - uses: pre-commit/[email protected]
 
   test:

.pre-commit-config.yaml

@@ -12,27 +12,12 @@ repos:
     -   id: ruff
         args: [ --fix ]
     -   id: ruff-format
--   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.15.0
+-   repo: local
     hooks:
     -   id: mypy
-        additional_dependencies:
-        -   argcomplete==3.4.0
-        -   matplotlib==3.9.1
-        -   ruamel.yaml==0.18.6
-        -   questionary==2.0.1
-        -   types-colorama==0.4.15.20240311
-        -   types-Pygments==2.18.0.20240506
-        -   types-python-dateutil==2.9.0.20241003
-        -   types-PyYAML==6.0.12.20240311
-        -   types-requests==2.32.0.20240712
-        args:
-        -   --check-untyped-defs
-        -   --exclude=test
-        -   --enable-error-code=truthy-bool
-        -   --enable-error-code=truthy-iterable
-        -   --no-incremental  # Fixes ruamel.yaml, see https://stackoverflow.com/a/65223004
-        -   --python-version=3.10
-        -   --scripts-are-modules
-        -   --strict
+        name: mypy
+        entry: mypy
+        pass_filenames: false
+        language: system
+        require_serial: true # don't split filenames into multiple processes
         exclude: ^(bapctools/resources|bin/misc|test)/

pyproject.toml

@@ -15,7 +15,17 @@ requires-python = ">=3.10"
 
 [project.optional-dependencies]
 dev = [
+    "pre-commit~=4.5.1",
     "pytest~=9.0.1",
+    "bapctools[types]",
+]
+types = [
+    "mypy~=1.19",
+    "types-colorama~=0.4.15",
+    "types-Pygments~=2.18.0",
+    "types-python-dateutil~=2.9.0",
+    "types-PyYAML~=6.0.12",
+    "types-requests~=2.32.0",
 ]
 
 [project.scripts]
@@ -39,3 +49,11 @@ order-by-type = false
 [tool.pyright]
 include = ["bapctools"]
 exclude = ["bapctools/resources"]
+
+[tool.mypy]
+python_version = "3.10"
+packages = "bapctools"
+exclude = ["^bapctools/resources/"]
+check_untyped_defs = true
+enable_error_code="truthy-bool,truthy-iterable"
+strict = true

readme.md

@@ -25,6 +25,7 @@ time since I'm not aware of usage outside of BAPC yet.
 You can install the [bapctools-git AUR package](https://aur.archlinux.org/packages/bapctools-git/),
 mirrored [here](https://github.com/RagnarGrootKoerkamp/bapctools-git).
 You can also use the [Docker image](#Docker) or install [via Pip (experimental)](#Experimental-Pip-installation).
+If you're interested in developing BAPCtools itself, see the installation instructions [at the end of this file](#Developing--Contributing-to-BAPCtools).
 
 Otherwise, clone this repository and install the required dependencies manually.
 (If you know how to make a Debian package, feel free to help out.)
@@ -227,17 +228,18 @@ and any hyphens should be replaced with an underscore (e.g., `no_bar: True` rath
 These personal config files also allow to set the key `local_time_multiplier` to adjust hardcoded time limits intended for different hardware.
 This might be useful for the CI or if your hadware is much faster or slower than the contest hardware.
 
-## Contributing / Style guide
+## Developing / Contributing to BAPCtools
 
-- The python code in the repository is formatted using [Ruff](https://github.com/astral-sh/ruff)
-  and type-checked using [mypy](https://mypy-lang.org/).
-  To enable the pre-commit hook, install [pre-commit](https://pre-commit.com/)
-  with `pip` or your package manager (Arch: `python-pre-commit`) and run
-  `pre-commit install` from the repository root.
-  All python code will now automatically be formatted on each commit.
-  If you want to run the hooks before creating a commit,
-  use `pre-commit run` (only staged files) or `pre-commit run -a` (all files).
+The recommended way to install all development dependencies is in a virtual environment,
+created with `python3 -m venv venv` and activated with `. venv/bin/activate`.<br />
+Install the development dependencies with `pip install --editable .[dev]`.
 
-- Imports are usually ordered with system libraries first, followed by a
-  newline, followed by local includes. Both groups are sorted alphabetically,
-  and `import` comes before `from ... import`.
+If you want to use your local development version of BAPCtools anywhere, you can create a symlink from any `bin` directory on your `$PATH` to the virtual environment, for example: `ln -s /path/to/BAPCtools/venv/bin/bt ~/bin/bt`
+
+The Python code in the repository is formatted using [Ruff](https://github.com/astral-sh/ruff)
+and type-checked using [mypy](https://mypy-lang.org/).
+To enable the pre-commit hook,
+run `pre-commit install` from the repository root.
+All Python code will now automatically be formatted and type-checked on each commit.
+If you want to run the hooks before creating a commit,
+use `pre-commit run` (only staged files) or `pre-commit run -a` (all files).