Enable 'strict' Mypy linting #1527

danieleades · 2024-02-23T07:15:51Z

enables strict mypy linting

note that i've suppressed and allow-listed some existing errors.
This allow-list should not be allowed to grow over time, and ideally would be incrementally shrunk until it can be removed entirely.

The error suppressions can be resolved by refactoring, and by creating upstream type stubs for third-party libraries that are untyped in typeshed (out of scope of this PR!)

danieleades · 2024-03-04T18:53:05Z

~~"just" 49 errors to go!~~
38 errors remaining

danieleades · 2024-03-04T19:34:31Z

remaining errors:

copier/tools.py:192: error: Missing type parameters for generic type "Match"  [type-arg]
copier/template.py:385: error: Missing type parameters for generic type "dict"  [type-arg]
copier/main.py:866: error: Item "None" of "Template | None" has no attribute "url"  [union-attr]
copier/main.py:867: error: Item "None" of "Template | None" has no attribute "commit"  [union-attr]
copier/main.py:889: error: Argument 2 to "migration_tasks" of "Template" has incompatible type "Template | None"; expected "Template"  [arg-type]
copier/main.py:911: error: Argument "data" to "replace" of "Worker" has incompatible type "Mapping[str, Any]"; expected "dict[str, Any]"  [arg-type]
copier/main.py:914: error: Item "None" of "Template | None" has no attribute "url"  [union-attr]
copier/main.py:993: error: Argument 2 to "migration_tasks" of "Template" has incompatible type "Template | None"; expected "Template"  [arg-type]
copier/cli.py:83: error: Class cannot subclass "Application" (has type "Any")  [misc]
copier/cli.py:105: error: Class cannot subclass "Application" (has type "Any")  [misc]
copier/cli.py:158: error: Untyped decorator makes function "data_switch" untyped  [misc]
copier/cli.py:176: error: Untyped decorator makes function "data_file_switch" untyped  [misc]
tests/test_dirty_local.py:7: error: Module "pytest_gitconfig" does not explicitly export attribute "GitConfig"  [attr-defined]
tests/conftest.py:11: error: Module "pytest_gitconfig" does not explicitly export attribute "GitConfig"  [attr-defined]
Found 14 errors in 6 files (checked 46 source files)

codecov · 2024-03-14T08:03:52Z

Codecov Report

Attention: Patch coverage is 94.38202% with 5 lines in your changes are missing coverage. Please review.

Project coverage is 97.47%. Comparing base (4831baf) to head (6dd91f1).
Report is 2 commits behind head on master.

Files	Patch %	Lines
devtasks.py	0.00%	3 Missing ⚠️
copier/subproject.py	50.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1527      +/-   ##
==========================================
+ Coverage   97.30%   97.47%   +0.17%     
==========================================
  Files          48       48              
  Lines        4594     4603       +9     
==========================================
+ Hits         4470     4487      +17     
+ Misses        124      116       -8

Flag	Coverage Δ
unittests	`97.47% <94.38%> (+0.17%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

danieleades · 2024-03-14T08:27:04Z

@sisp, @yajo this is now ready for review

pyproject.toml

copier/cli.py

copier/main.py

Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>

tests/test_dirty_local.py

danieleades · 2024-03-18T07:09:03Z

@pawamoy i could probably just keep tinkering with this for ever, but i think this is a place where I can draw a line under it. This is now ready for review

danieleades · 2024-03-23T08:22:01Z

@sisp, @yajo this is now ready for review

ping!

pawamoy

IMO it looks good, except for the style changes in cli.py. I'll revert them and push a fixup.

sisp

Fantastic work, @danieleades! 👌 Just a few minor remarks from my side.

sisp · 2024-03-23T09:47:59Z

copier/main.py

@@ -1,4 +1,5 @@
 """Main functions and classes, used to generate or update projects."""
+


Those empty lines were introduced by Ruff v0.3.0 (IIRC). Would you mind reverting those (and the other occurences), too? They aren't related to this PR.

pyproject.toml

poetry.lock

danieleades · 2024-03-23T10:56:19Z

what's causing those test failures?

sisp

The style changes in cli.py are still present (cc @pawamoy) and also the introduced empty line between a module doctstring and the first import, which is not needed by the Ruff version locked via Nix (IIRC).

pawamoy · 2024-03-23T11:01:35Z

Reverted style changes in cli.py. Will now revert blank lines at the top of modules. Race to the finish!

pawamoy · 2024-03-23T11:05:08Z

Done.

sisp · 2024-03-23T11:05:51Z

what's causing those test failures?

I suspect that postponed annotations don't play well with Plumbum in cli.py. Could you try reverting back to classical type annotations and see whether tests pass again?

danieleades · 2024-03-23T11:26:55Z

what's causing those test failures?

I suspect that postponed annotations don't play well with Plumbum in cli.py. Could you try reverting back to classical type annotations and see whether tests pass again?

strange. i've not made any changes since these tests were last passing

copier/cli.py

pawamoy

LGTM

sisp

LGTM, too! 🎉 Thanks for the fantastic work, @danieleades and @pawamoy! 🙏

sisp · 2024-04-07T05:37:04Z

Resolves #1441.

danieleades force-pushed the mypy-strict branch from c18307e to 25dd405 Compare March 4, 2024 17:49

danieleades marked this pull request as ready for review March 14, 2024 07:58

danieleades changed the title ~~[WIP] Enable 'strict' Mypy linting~~ Enable 'strict' Mypy linting Mar 14, 2024

danieleades added 9 commits March 17, 2024 16:06

apply strict mypy config

53486a8

address some errors

be63dd6

address some errors

4903582

address some errors

e7d2c86

suppress some remaining errors

52a6b95

fixup

c7b3c4f

suppress remaining errors

832ee0a

fixup

86f3ce7

fixup

8954196

danieleades force-pushed the mypy-strict branch from e700f44 to 8954196 Compare March 17, 2024 16:08

danieleades added 3 commits March 17, 2024 16:23

stricter config

830047b

fixup

e75c47b

fixup

5da66c0

danieleades force-pushed the mypy-strict branch from 1acf0c4 to 5da66c0 Compare March 17, 2024 16:50

remove some 'OptStr' references

faf4edb

pawamoy reviewed Mar 17, 2024

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

pawamoy reviewed Mar 17, 2024

View reviewed changes

copier/cli.py Outdated Show resolved Hide resolved

danieleades marked this pull request as draft March 17, 2024 17:06

pawamoy reviewed Mar 17, 2024

View reviewed changes

copier/main.py Show resolved Hide resolved

danieleades and others added 3 commits March 17, 2024 17:09

remove more type errors

8b89003

Update pyproject.toml

a99887e

Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>

fixup

c4085a4

pawamoy reviewed Mar 17, 2024

View reviewed changes

tests/test_dirty_local.py Show resolved Hide resolved

remove unneeded type aliases

4bb60cc

danieleades force-pushed the mypy-strict branch from 4bb60cc to c4085a4 Compare March 18, 2024 07:08

danieleades marked this pull request as ready for review March 18, 2024 07:08

danieleades requested a review from pawamoy March 18, 2024 07:09

pawamoy reviewed Mar 23, 2024

View reviewed changes

sisp requested changes Mar 23, 2024

View reviewed changes

fixup

788017a

danieleades requested a review from sisp March 23, 2024 10:33

chore: poetry lock --no-update

7a34d3d

sisp requested changes Mar 23, 2024

View reviewed changes

style: revert style changes

429e66c

chore: Revert blank lines

4dd6583

pawamoy added 2 commits March 23, 2024 12:16

chore: Try fixing Plumbum evaluation of annotations

eaf7c3e

chore: Type fix again

6dd91f1

danieleades commented Mar 23, 2024

View reviewed changes

copier/cli.py Show resolved Hide resolved

sisp reviewed Mar 23, 2024

View reviewed changes

copier/cli.py Show resolved Hide resolved

pawamoy approved these changes Mar 23, 2024

View reviewed changes

sisp approved these changes Mar 23, 2024

View reviewed changes

sisp merged commit 0c6b0b9 into copier-org:master Mar 23, 2024
20 of 21 checks passed

danieleades deleted the mypy-strict branch March 23, 2024 12:34

sisp mentioned this pull request Apr 7, 2024

Make mypy copier --strict pass #1441

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable 'strict' Mypy linting #1527

Enable 'strict' Mypy linting #1527

danieleades commented Feb 23, 2024 •

edited

Loading

danieleades commented Mar 4, 2024 •

edited

Loading

danieleades commented Mar 4, 2024

codecov bot commented Mar 14, 2024 •

edited

Loading

danieleades commented Mar 14, 2024

danieleades commented Mar 18, 2024

danieleades commented Mar 23, 2024

pawamoy left a comment

sisp left a comment

sisp Mar 23, 2024

danieleades commented Mar 23, 2024

sisp left a comment

pawamoy commented Mar 23, 2024

pawamoy commented Mar 23, 2024

sisp commented Mar 23, 2024

danieleades commented Mar 23, 2024

pawamoy left a comment

sisp left a comment

sisp commented Apr 7, 2024

		@@ -1,4 +1,5 @@
		"""Main functions and classes, used to generate or update projects."""

Enable 'strict' Mypy linting #1527

Enable 'strict' Mypy linting #1527

Conversation

danieleades commented Feb 23, 2024 • edited Loading

danieleades commented Mar 4, 2024 • edited Loading

danieleades commented Mar 4, 2024

codecov bot commented Mar 14, 2024 • edited Loading

Codecov Report

danieleades commented Mar 14, 2024

danieleades commented Mar 18, 2024

danieleades commented Mar 23, 2024

pawamoy left a comment

Choose a reason for hiding this comment

sisp left a comment

Choose a reason for hiding this comment

sisp Mar 23, 2024

Choose a reason for hiding this comment

danieleades commented Mar 23, 2024

sisp left a comment

Choose a reason for hiding this comment

pawamoy commented Mar 23, 2024

pawamoy commented Mar 23, 2024

sisp commented Mar 23, 2024

danieleades commented Mar 23, 2024

pawamoy left a comment

Choose a reason for hiding this comment

sisp left a comment

Choose a reason for hiding this comment

sisp commented Apr 7, 2024

danieleades commented Feb 23, 2024 •

edited

Loading

danieleades commented Mar 4, 2024 •

edited

Loading

codecov bot commented Mar 14, 2024 •

edited

Loading