Typing

[sverhoeven]

Checklist before requesting a review

• I have read the contribution guidelines
• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• All user facing changes have been added to CHANGELOG.md

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

List of related issues or pull requests**

Refs:

• Type hints support #230

Describe the changes made in this pull request

Adds Typing choice and type checker question:

Instructions to review the pull request

Install the requirements

cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
pip install pipx
pipx install copier

Create a new package using the template

copier copy --vcs-ref typing https://github.com/nlesc/python-template test_package

Create a local git repo to push to GitHub to trigger CI actions

git init
git add --all
git commit -m "First commit"
git remote add origin git@github.com:<YOU>/python-template-test.git
git push -u origin main -f

# Create a local environment to test your generated package locally
python -m venv env
source env/bin/activate
python -m pip install --upgrade pip setuptools
python -m pip install '.[dev,publishing]'

[sjvrijn]

Thanks for the addition!

One inconsistency I noticed: in the README.dev.md you suggest mypy . while in build.yml, it's just mypy (without the .).

I also get different results on my machine between the two:

[sverhoeven]

Thanks for the addition!

One inconsistency I noticed: in the README.dev.md you suggest mypy . while in build.yml, it's just mypy (without the .).

I also get different results on my machine between the two:

Thanks for reviewing.

I added

python-template/template/pyproject.toml.jinja

Line 166 in 602ab8f

files = ["src"]

later, which made mypy work and I forgot to update the docs, so will do that.

You get different answer between mypy and mypy ., because the second also includes the build dir. I can maybe exclude build/.

[sjvrijn]

Thanks for updating, LGTM!