feat: VCS versioning and mypy

Author: Saransh-cpp

.gitignore

@@ -126,3 +126,6 @@ cython_debug/
 
 # Code editor files and folders
 .vscode/
+
+# hatch-vcs
+src/pybamm_cookiecutter/_version.py

.pre-commit-config.yaml

@@ -37,6 +37,7 @@ repos:
     rev: v0.0.281
     hooks:
       - id: ruff
+        files: "^(src/pybamm_cookiecutter|tests$)"
         args: ["--fix", "--show-fixes"]
 
   # Documentation files
@@ -61,3 +62,11 @@ repos:
     hooks:
       - id: nbqa-ruff
         additional_dependencies: [ruff==0.0.281]
+
+  # mypy
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.4.1
+    hooks:
+      - id: mypy
+        files: "^(src/pybamm_cookiecutter|tests$)"

noxfile.py

@@ -4,7 +4,7 @@
 nox.options.reuse_existing_virtualenvs = True
 
 @nox.session(name="docs")
-def build_docs(session):
+def build_docs(session: nox.Session) -> None:
     """Build the documentation and load it in a browser tab, rebuilding on changes."""
     envbindir = session.bin
     session.install("-e", ".[docs]")

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"
 
 [project]
@@ -60,11 +60,29 @@ Discussions = "https://github.com/pybamm-team/pybamm-cookiecutter/discussions"
 Changelog = "https://github.com/pybamm-team/pybamm-cookiecutter/releases"
 
 [tool.hatch]
-version.path = "src/pybamm_cookiecutter/__init__.py"
+version.source = "vcs"
+build.hooks.vcs.version-file = "src/pybamm_cookiecutter/_version.py"
 envs.default.dependencies = [
   "pybamm",
 ]
 
+[tool.mypy]
+packages = [
+  "src/pybamm_cookiecutter",
+  "tests"
+]
+python_version = "3.8"
+strict = true
+warn_return_any = false
+show_error_codes = true
+enable_error_code = [
+  "ignore-without-code",
+  "truthy-bool",
+  "redundant-expr",
+]
+disallow_untyped_defs = false
+disallow_untyped_calls = false
+
 [tool.coverage]
 run.source = ["pybamm_cookiecutter"]
 port.exclude_lines = [
@@ -97,18 +115,7 @@ select = [
   "NPY",         # NumPy specific rules
   "PD",          # pandas-vet
 ]
-extend-ignore = [
-  "PLR",    # Design related pylint codes
-  "E501",   # Line too long
-]
 src = ["src"]
-unfixable = [
-  "T20",  # Removes print statements
-  "F841", # Removes unused variables
-]
 exclude = []
+isort.required-imports = ["from __future__ import annotations"]
 flake8-unused-arguments.ignore-variadic-names = true
-
-[tool.ruff.per-file-ignores]
-"tests/**" = ["T20"]
-"noxfile.py" = ["T20"]

src/pybamm_cookiecutter/__init__.py

@@ -3,8 +3,8 @@
 
 pybamm-cookiecutter: A template for creating battery modeling projects based on PyBaMM
 """
+from __future__ import annotations
 
+from ._version import version as __version__
 
-__version__ = "0.0.1"
-
-__all__ = ("__version__",)
+__all__ : tuple[str] = ("__version__",)

src/pybamm_cookiecutter/py.typed

@@ -0,0 +1,4 @@
+from __future__ import annotations
+
+version: str
+version_tuple: tuple[int, int, int] | tuple[int, int, int, str, str]

src/pybamm_cookiecutter/version.pyi

@@ -1,5 +1,5 @@
 import pybamm_cookiecutter as m
 
 
-def test_version():
+def test_version() -> None:
     assert m.__version__

tests/test_package.py

@@ -119,3 +119,6 @@ Thumbs.db
 # Common editor files
 *~
 *.swp
+
+# hatch-vcs
+src/pybamm_cookiecutter/_version.py

{{cookiecutter.project_name}}/.gitignore

@@ -1,6 +1,9 @@
 [build-system]
 {%- if cookiecutter.backend == "hatch" %}
-requires = ["hatchling"]
+requires = [
+  "hatchling",
+  "hatch-vcs"
+]
 build-backend = "hatchling.build"
 {%- endif %}
 
@@ -73,7 +76,8 @@ Changelog = "{{ cookiecutter.url }}/releases"
 
 {%- if cookiecutter.backend == "hatch" %}
 [tool.hatch]
-version.path = "src/{{ cookiecutter.__project_slug }}/__init__.py"
+version.source = "vcs"
+build.hooks.vcs.version-file = "src/{{ cookiecutter.__project_slug }}/_version.py"
 envs.default.dependencies = [
   "pybamm",
 ]
@@ -111,18 +115,10 @@ select = [
   "NPY",         # NumPy specific rules
   "PD",          # pandas-vet
 ]
-extend-ignore = [
-  "PLR",    # Design related pylint codes
-  "E501",   # Line too long
-]
 src = ["src"]
 unfixable = [
   "T20",  # Removes print statements
   "F841", # Removes unused variables
 ]
 exclude = []
 flake8-unused-arguments.ignore-variadic-names = true
-
-[tool.ruff.per-file-ignores]
-"tests/**" = ["T20"]
-"noxfile.py" = ["T20"]