Move mypy config to pyproject.toml , update action file for mypy step & file versions (#53)

* Move mypy config to pyproject.toml

* Remove mypy config file flag from action step

* Update config file and action file version

* Cosmetic change

* Update README.md

* Temp fix test

* add python version

* ddrop explicit pointing to toml

* add init files so mypy finds what's needed

* try mypy

* fix intentional mypy error

Co-authored-by: Timothy Chklovski <[email protected]>

Author: abhishekmishragithub

.github/workflows/pm-gh-actions.yml

@@ -2,7 +2,7 @@
 # Copyright (C) 2021 Prediction Machine Advisers, LLC
 # This file is available under MIT license
 # based on https://github.com/predictionmachine/pm-github-actions/blob/main/.github/workflows/pm-gh-actions.yml
-# pm-version 0.3.8
+# pm-version 0.3.9
 ############################################################################################
 
 name: PM CI workflow
@@ -161,6 +161,7 @@ jobs:
           flake8_args: '--config=setup.cfg'
           reporter: github-pr-review
           fail_on_error: true
+
   interrogate:
     name: 'Docstrings coverage check (interrogate)'
     runs-on: ubuntu-latest
@@ -238,11 +239,12 @@ jobs:
           if [ requirements.txt ]; then pip install -r requirements.txt; fi
           if [ requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
       - name: mypy type check
-        uses: tsuyoshicho/action-mypy@v3.0.1
+        uses: tsuyoshicho/action-mypy@v3
         with:
           github_token: '${{ secrets.GITHUB_TOKEN }}'
+          level: info
           reporter: github-pr-review
-          mypy_flags: '--config-file=setup.cfg'
+          # mypy_flags: '--config-file=pyproject.toml'
           fail_on_error: true
 
   test-and-coverage:

README.md

@@ -40,7 +40,7 @@ The expected layout is:
 │   └── example.py
 ├── .codeclimate.yml           # Configuration file for codeclimate analysis
 ├── .pre-commit-config.yaml    # pre-commit configuration file, see https://pre-commit.com
-├── pyproject.toml             # Configuration file for black, interrogate & pytest
+├── pyproject.toml             # Configuration file for black, interrogate, mypy & pytest
 ├── requirements-dev.txt       # Development requirements file
 ├── requirements.txt           # Requirements file
 ├── setup.cfg                  # Configuration file for flake8, mypy
@@ -73,14 +73,14 @@ The expected layout is:
   Copy [.pre-commit-config.yaml](.pre-commit-config.yaml) to the root directory of your repo and follow the [installation](https://pre-commit.com/#installation) instructions to run it.
 
 Take the workflow for a spin by making a PR in your repo.
-  - `black`, `flake8`, and `mypy` configurations are in [setup.cfg](setup.cfg); `interrogate`, and `pytest` are in [pyproject.toml](pyproject.toml); code climate configurations are in [.codeclimate.yml](.codeclimate.yml), update as needed.
-  - **UPDATE** in [setup.cfg](setup.cfg), in `[mypy]` section, `files = ./tests,./projectname`
+  - `black` and `flake8` configurations are in [setup.cfg](setup.cfg); `interrogate`, `mypy` and `pytest` are in [pyproject.toml](pyproject.toml); code climate configurations are in [.codeclimate.yml](.codeclimate.yml), update as needed.
+  - **UPDATE** in [pyproject.toml](pyproject.toml), added `[tool.mypy]` and `[[tool.mypy.overrides]]` section.
   - For more config tips see the FAQ below or raise an issue labeled "question".
 
 - - -
 ### How it works:
 
-- This workflow uses the configuration files for black, flake8, mypy from the [setup.cfg](setup.cfg); interrogate and pytest from [pyproject.toml](pyproject.toml) and for code analysis from [.codeclimate.yml](.codeclimate.yml) respectively.
+- This workflow uses the configuration files for black and flake8 from the [setup.cfg](setup.cfg); interrogate, mypy and pytest from [pyproject.toml](pyproject.toml) and for code analysis from [.codeclimate.yml](.codeclimate.yml) respectively.
 - This workflow also creates intermediate output files during the CI build, under `output/` folder, mentioned below:
   - `output/coverage.xml` - contains the coverage report - generated by coverage.py.
   - `output/docstring_report.txt` - contains the docstring report - generated by interrogate.

projectname/__init__.py

@@ -1,5 +1,5 @@
 # based on https://github.com/predictionmachine/pm-gh-actions/blob/main/pyproject.toml
-# pm-version 0.1.3
+# pm-version 0.1.4
 
 [tool.black]
 # see https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-format
@@ -21,6 +21,22 @@ quiet = false
 color = true
 ignore-nested-functions = true
 
+[tool.mypy]
+python_version = "3.8"
+# see https://mypy.readthedocs.io/en/stable/config_file.html#using-a-pyproject-toml-file
+files = ['.']
+disallow_untyped_defs = true
+no_implicit_optional = true
+warn_return_any = true
+warn_unused_configs = true
+warn_unused_ignores = true
+pretty = false
+
+# mypy per-module options:
+[[tool.mypy.overrides]]
+module = ['numpy', 'pandas.*', 'pyarrow.*', 'pytest.*', 'pytest_mock', 'setuptools']
+ignore_missing_imports = true
+
 [tool.pytest.ini_options]
 # see https://docs.pytest.org/en/6.2.x/customize.html#pyproject-toml
 addopts = "-n2 --strict-markers -vv"

pyproject.toml

@@ -1,4 +1,4 @@
-# pm-version 0.1.4
+# pm-version 0.1.5
 [coverage:run]
 # https://coverage.readthedocs.io/en/latest/config.html
 omit = tests/*
@@ -14,16 +14,3 @@ ignore = E731,W503,E501
 count = True
 statistics = True
 max-line-length = 120
-
-[mypy]
-# see https://mypy.readthedocs.io/en/stable/config_file.html#config-file-format
-files = ./tests,./projectname
-disallow_untyped_defs = True
-no_implicit_optional = True
-warn_return_any = True
-warn_unused_configs = True
-warn_unused_ignores = True
-pretty = True
-
-[mypy-numpy,pandas.*,pyarrow.*,pytest.*,pytest_mock,setuptools]
-ignore_missing_imports = True