Merge pull request #8 from pybamm-team/mypy-for-template

feat: enable mypy for the template

Author: Saransh-cpp

.gitignore

@@ -129,3 +129,6 @@ cython_debug/
 
 # hatch-vcs
 src/pybamm_cookiecutter/_version.py
+
+# ruff
+.ruff_cache/

.pre-commit-config.yaml

@@ -15,6 +15,7 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-yaml
+        files: "^(src/pybamm_cookiecutter|tests$)"
       - id: check-added-large-files
       - id: mixed-line-ending
 

cookiecutter.json

@@ -17,6 +17,7 @@
     "backend": [
         "hatch"
     ],
+    "mypy": false,
     "__year": "{% now 'utc', '%Y' %}",
     "__project_slug": "{{ cookiecutter.project_name | lower | replace('-', '_') | replace('.', '_') }}",
     "__type": "{{ 'pure' }}",
@@ -38,6 +39,7 @@
         "backend": {
             "__prompt__": "Choose a build backend",
             "hatch": "Hatchling (recommended for pure Python projects)"
-        }
+        },
+        "mypy": "Use mypy and static types"
     }
 }

pyproject.toml

@@ -27,6 +27,7 @@ classifiers = [
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",  # PyBaMM supports >=3.8,<3.12
   "Topic :: Scientific/Engineering",
+  "Typing :: Typed",
 ]
 dynamic = ["version"]
 dependencies = ["pybamm"]

{{cookiecutter.project_name}}/.gitignore

@@ -122,3 +122,8 @@ Thumbs.db
 
 # hatch-vcs
 */_version.py
+
+# mypy
+.mypy_cache
+.dmypy.json
+dmypy.json

{{cookiecutter.project_name}}/.pre-commit-config.yaml

@@ -55,3 +55,13 @@ repos:
         language: pygrep
         entry: PyBind|Numpy|Scipy|Cmake|CCache|Github|Pybamm
         exclude: .pre-commit-config.yaml
+{# keep this line here for newline #}
+{%- if cookiecutter.mypy %}
+  # mypy
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.4.1
+    hooks:
+      - id: mypy
+        files: "^(src/{{ cookiecutter.__project_slug }}|tests$)"
+{%- endif %}

{{cookiecutter.project_name}}/docs/conf.py

@@ -14,10 +14,9 @@
 # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/index.html
 
 
-import os
-import sys
 import importlib.metadata
-
+import sys
+from pathlib import Path
 
 # ---- Project information ------------------------------------------------------------
 
@@ -29,10 +28,10 @@
 # ---- Path configuration -------------------------------------------------------------
 
 # Path for repository root
-sys.path.insert(0, os.path.abspath("../"))
+sys.path.insert(0, Path("../").resolve())
 
 # Path for local Sphinx extensions
-sys.path.append(os.path.abspath("./sphinxext/"))
+sys.path.append(Path("./sphinxext/").resolve())
 
 # ---- General configuration ----------------------------------------------------------
 
@@ -55,7 +54,7 @@
 ]
 
 html_theme = "pydata_sphinx_theme"
-html_title = "%s v%s Manual" % (project, version)
+html_title = f"{project} v{version} Manual"
 html_last_updated_fmt = "%Y-%m-%d"
 html_static_path = ["_static"]
 html_file_suffix = ".html"

{{cookiecutter.project_name}}/pyproject.toml

@@ -40,6 +40,9 @@ classifiers = [
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",  # PyBaMM supports >=3.8,<3.12
   "Topic :: Scientific/Engineering",
+{%- if cookiecutter.mypy %}
+  "Typing :: Typed",
+{%- endif %}
 ]
 {%- if cookiecutter.backend == "hatch" %}
 dynamic = ["version"]
@@ -73,7 +76,7 @@ Homepage = "{{ cookiecutter.url }}"
 "Bug Tracker" = "{{ cookiecutter.url }}/issues"
 Discussions = "{{ cookiecutter.url }}/discussions"
 Changelog = "{{ cookiecutter.url }}/releases"
-
+{# keep this line here for newline #}
 {%- if cookiecutter.backend == "hatch" %}
 [tool.hatch]
 version.source = "vcs"
@@ -82,6 +85,21 @@ envs.default.dependencies = [
   "pybamm",
 ]
 {%- endif %}
+{# keep this line here for newline #}
+{%- if cookiecutter.mypy %}
+[tool.mypy]
+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
+{%- endif %}
 
 [tool.coverage]
 run.source = ["{{ cookiecutter.__project_slug }}"]
@@ -120,5 +138,6 @@ unfixable = [
   "T20",  # Removes print statements
   "F841", # Removes unused variables
 ]
+line-length = 100
 exclude = []
 flake8-unused-arguments.ignore-variadic-names = true

{{cookiecutter.project_name}}/src/{{cookiecutter.__project_slug}}/__init__.py

@@ -3,7 +3,14 @@
 
 {{ cookiecutter.project_name }}: {{ cookiecutter.project_short_description }}
 """
-from ._version import version as __version__
-
+{%- if cookiecutter.mypy %}
+from __future__ import annotations
+{%- endif %}
 
+from ._version import version as __version__
+{# keep this line here for newline #}
+{%- if cookiecutter.mypy %}
+__all__: tuple[str] = ("__version__",)
+{%- else %}
 __all__ = ("__version__",)
+{%- endif %}