Update

Author: marvinfriede

.github/workflows/test.yml

@@ -22,7 +22,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: ["3.10"] # ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
 
     runs-on: ${{ matrix.os }}
 
@@ -38,11 +38,11 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install codecov tox tox-gh-actions
+          pip install codecov tox
 
       # with "-e py" tox runs the python version of the current environment
       - name: Unittests with tox
-        run: tox # -e py
+        run: tox -e py
 
       # Coverage does not work for private repos
       - name: Upload coverage to Codecov

.pre-commit-config.yaml

@@ -33,3 +33,9 @@ repos:
     rev: 22.10.0
     hooks:
       - id: black
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.991
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-all]

README.md

@@ -15,10 +15,11 @@ I tried to incorporate most "best practices" but in the end, most of the design
 
 ## Source code
 
-All of the source code goes into the [src/\<project-name\>](src/squarer) directory. Here, some *dunder* files can be found:
- - [\_\_version\_\_.py](src/squarer/__version__.py): just the version number as string, used by config files
- - [\_\_init\_\_.py](src/squarer/__init__.py): entry point for the command line interface
- - [\_\_main\_\_.py](src/squarer/__main__.py): same as `__init__.py` allowing calls via `python -m <prog>`
+All of the source code goes into the [src/\<project-name\>](src/squarer) directory. Here, some _dunder_ files can be found:
+
+- [\_\_version\_\_.py](src/squarer/__version__.py): just the version number as string, used by config files
+- [\_\_init\_\_.py](src/squarer/__init__.py): entry point for program/library
+- [\_\_main\_\_.py](src/squarer/__main__.py): same as `__init__.py` allowing calls via `python -m <prog>`
 
 <br>
 
@@ -37,7 +38,7 @@ section must be given. Here, additional options for the code coverage report fro
 
 <br>
 
-*When to use pytest, coverage and tox?*
+_When to use pytest, coverage and tox?_
 
 Personally, I mostly use just pytest without coverage to test in my working environment with `pytest -svv test` or a specific
 test module. Before committing, however, it is a good idea to check if your code also runs in different environments, which is where
@@ -60,11 +61,18 @@ ln -s /opt/miniforge3/envs/py311/bin/python3.11 ~/bin/python3.11
 <br>
 
 Finally, some handy features of pytest you should be aware of:
- - fixtures: common setup for multiple tests (e.g., reading file or database connection)
- - parametrize: multiple test cases for single function
- - expected fails: testing if the code handles wrong inputs (`pytest.raises(Exception)` or `@pytest.mark.xfail`)
 
- <br>
+- fixtures: common setup for multiple tests (e.g., reading file or database connection)
+- parametrize: multiple test cases for single function
+- expected fails: testing if the code handles wrong inputs (`pytest.raises(Exception)` or `@pytest.mark.xfail`)
+
+<br>
+
+Further links:
+
+- check for [test pollution](https://github.com/asottile/detect-test-pollution) by randomizing the order of tests ([pytest-plugin](https://pypi.org/project/pytest-random-order/))
+
+<br>
 
 ## Setup files and Packaging
 
@@ -82,7 +90,6 @@ Additional points:
 
 ...
 
-
 <br>
 
 ## Additional tools

pyproject.toml

@@ -7,3 +7,13 @@ build-backend = "setuptools.build_meta"
 [tool.pytest.ini_options]
 testpaths = ["test"]
 pythonpath = ["src"]
+
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+warn_redundant_casts = true
+warn_unreachable = true
+warn_unused_ignores = true

setup.cfg

@@ -8,9 +8,11 @@ license = MIT
 license_file = LICENSE.md
 classifiers =
     License :: OSI Approved :: MIT License
+    Programming Language :: Python
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3 :: Only
-    Programming Language :: Python :: Implementation :: CPython
+    Topic :: Scientific/Engineering
+    Typing :: Typed
 
 [options]
 packages = find:
@@ -22,6 +24,7 @@ package_dir =
 
 [options.packages.find]
 where = src
+exclude = test
 
 [options.entry_points]
 console_scripts =

src/squarer/__init__.py

@@ -14,7 +14,7 @@
 __all__ = ["__version__", "maths", "square"]
 
 
-def main(argv: Sequence | None = None) -> int:
+def main(argv: Sequence[str] | None = None) -> int:
     # get command line argument
     parser = argparse.ArgumentParser()
     parser.add_argument("number", type=float, help="Number to square.")

tox-old.ini

@@ -0,0 +1,38 @@
+[tox]
+envlist = py310-torch{1110,1121,1130}
+
+
+[gh-actions]
+python =
+  3.7: py37
+  3.8: py38
+  3.9: py39
+  3.10: py310
+  3.11: py311
+
+
+[testenv]
+deps = -r test/requirements-tests.txt
+commands =
+  pytest -svv --cov=./src --cov-report=term-missing {posargs:test}
+
+[testenv:py310-torch1110]
+deps =
+  {[testenv]deps}
+commands =
+  pip install torch==1.11.0+cpu -f https://download.pytorch.org/whl/torch_stable.html
+  {[testenv]commands}
+
+[testenv:py310-torch1121]
+deps =
+  {[testenv]deps}
+commands =
+  pip install torch==1.12.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
+  {[testenv]commands}
+
+[testenv:py310-torch1130]
+deps =
+  {[testenv]deps}
+commands =
+  pip install torch==1.13.0+cpu -f https://download.pytorch.org/whl/torch_stable.html
+  {[testenv]commands}

tox-torch.ini

@@ -1,37 +1,10 @@
 [tox]
-envlist = py310-{linux,windows}-torch{1110,1121}
-
-
-[gh-actions]
-python =
-  3.7: py37
-  3.8: py38
-  3.9: py39
-  3.10: py310
-  3.11: py311
-
-[gh-actions:env]
-PLATFORM =
-    ubuntu-latest: linux
-    macos-latest: macos
-    windows-latest: windows
-
+envlist = py{37,39,310,311}
 
 [testenv]
-deps = -r test/requirements-tests.txt
-commands =
-  pytest -svv --cov=./src --cov-report=term-missing {posargs:test}
-
-[testenv:py310-{linux,windows}-torch1110]
-deps =
-  {[testenv]deps}
-commands =
-  pip install torch==1.11.0+cpu -f https://download.pytorch.org/whl/torch_stable.html
-  {[testenv]commands}
-
-[testenv:py310-{linux,windows}-torch1121]
 deps =
-  {[testenv]deps}
+    pytest
+    pytest-cov
+    coverage
 commands =
-  pip install torch==1.12.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
-  {[testenv]commands}
+    pytest -svv --cov=./src --cov-report=term-missing {posargs:test}