Add type annotations #603

mthuurne · 2024-03-26T10:45:05Z

This implements the bulk of the changes required for #558. The annotations are still a bit rough, but they have reached a stage where testing with third party code would be useful.

codecov · 2024-03-26T10:47:43Z

Codecov Report

Attention: Patch coverage is 74.76038% with 79 lines in your changes missing coverage. Please review.

Project coverage is 89.98%. Comparing base (4275f84) to head (fb2fc5a).
Report is 3 commits behind head on master.

❗ Current head fb2fc5a differs from pull request most recent head 9dc2247

Please upload reports for the commit 9dc2247 to get more accurate results.

Files	Patch %	Lines
model_utils/managers.py	63.15%	49 Missing ⚠️
model_utils/choices.py	76.19%	10 Missing ⚠️
model_utils/models.py	64.00%	9 Missing ⚠️
model_utils/tracker.py	86.95%	9 Missing ⚠️
model_utils/fields.py	95.45%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #603      +/-   ##
==========================================
- Coverage   98.92%   89.98%   -8.94%     
==========================================
  Files           6        6              
  Lines         743      869     +126     
==========================================
+ Hits          735      782      +47     
- Misses          8       87      +79

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

foarsitter · 2024-05-28T06:34:39Z

@mthuurne time to merge this and release it as beta?

mthuurne · 2024-05-28T15:20:32Z

@mthuurne time to merge this and release it as beta?

Ah sorry, I've been pretty busy lately organizing a conference (shameless plug: T-DOSE) and this escaped my attention.

I agree that doing a beta is a good idea. However, please let me do one more pass, to at least remove the "WIP:" prefixes from the commit messages.

foarsitter · 2024-05-29T06:53:08Z

Sure @mthuurne, take your time :)

mthuurne · 2024-06-12T16:04:52Z

~~This PR currently includes the commits from #614 and #624 as well. The history would be clearer if those were merged separately before merging this PR.~~

Other than that, I think this PR is ready for merging and beta testing.

We can call the inherited public method using `super()` instead of calling the private method directly.

The `Choices` constructor actually only accepts lists and tuples, not arbitrary sequences. However, using `list` in the annotation opens a can of worms related to type variance.

This allows using the latest annotation syntax supported by the type checker regardless of the runtime Python version.

These annotations are sufficient to pass mypy inspection if mypy is configured to allow unannotated functions.

This required a bit of refactoring to get the type of `STATUS` correct for each suite. There are two cases which I decided not to support in the type system: - passing a list instead of a tuple when defining an option group - `in` checks using a data type that doesn't match the choices

We also type check the unit tests and the unit tests now import functionality from pytest.

The `JoinManager` class is deprecated and not annotated.

I can't find a way to inform mypy of the actual types without duplicating a lot of test code.

This preserves the type of the wrapped descriptor (usually a field). Maybe this is overkill, as `DescriptorWrapper` seems to only be used as part of the `FieldTracker` implementation and is not documented and barely tested. But technically, it is public API.

In particular, `if TYPE_CHECKING:` blocks and `...` in bodies of overloaded method definitions.

mthuurne · 2024-06-14T10:05:21Z

I updated the coverage configuration to exclude lines that are only processed by mypy from the coverage measurement. However, rate limiting prevented the coverage upload from being accepted, so the shown coverage stats don't reflect the latest state.

mthuurne · 2024-06-14T10:09:36Z

Actually, it's a bit weird that a project with as little activity as this one is running into rate limiting. Is it possible that the token we're using is old and doesn't specify that this is an open source project rather than a private evaluation?

foarsitter · 2024-06-18T10:34:13Z

If the rate limiting is an issue we should open an dedicated issue to track it. I don't have the permissions to access the settings so I cannot be of any help.

Final confirmation: ready for merge?

mthuurne · 2024-06-18T20:49:08Z

If the rate limiting is an issue we should open an dedicated issue to track it. I don't have the permissions to access the settings so I cannot be of any help.

Final confirmation: ready for merge?

Yes, it's ready.

The last change should make the coverage numbers more realistic by excluding lines that aren't expected to execute, but it doesn't change any functionality. So even if the change isn't correct, it won't negatively affect a preview release.

foarsitter · 2024-06-19T15:25:37Z

@mthuurne thanks for all the effort you have put into this! Great job!

mthuurne marked this pull request as draft March 26, 2024 10:45

mthuurne changed the title ~~Draft: Add type annotations~~ Add type annotations Mar 26, 2024

mthuurne force-pushed the type-annotations branch 2 times, most recently from e0bda54 to 87dfa2e Compare March 29, 2024 16:16

foarsitter mentioned this pull request Apr 3, 2024

Add type hints and the py.typed stub #551

Closed

2 tasks

mthuurne force-pushed the type-annotations branch 4 times, most recently from a80bea3 to 98aa1ac Compare April 10, 2024 16:32

mthuurne force-pushed the type-annotations branch 4 times, most recently from 08a02e4 to d0b821a Compare April 16, 2024 13:03

mthuurne mentioned this pull request Apr 16, 2024

Add type annotations #558

Open

mthuurne force-pushed the type-annotations branch 2 times, most recently from 402da6c to cd2fcde Compare April 19, 2024 14:10

mthuurne force-pushed the type-annotations branch 2 times, most recently from 4ee284d to aaa645b Compare May 7, 2024 08:42

mthuurne force-pushed the type-annotations branch 2 times, most recently from 8fe4407 to 0b5eec7 Compare June 12, 2024 15:45

mthuurne marked this pull request as ready for review June 12, 2024 16:04

mthuurne force-pushed the type-annotations branch from 0b5eec7 to 16555a7 Compare June 13, 2024 08:28

mthuurne added 3 commits June 13, 2024 12:02

Do not assume that default manager is named objects in join()

04e152f

Call Field.get_default() instead of _get_default()

db93360

We can call the inherited public method using `super()` instead of calling the private method directly.

Upgrade mypy and django-stubs

885da69

mthuurne added 21 commits June 13, 2024 12:02

Annotate the managers module

bde2d8f

Annotate the models module

172cc72

Annotate the fields module

ebfb345

Annotate the choices module

2b0b482

The `Choices` constructor actually only accepts lists and tuples, not arbitrary sequences. However, using `list` in the annotation opens a can of worms related to type variance.

Make type aliases compatible with old Python versions

713a3fe

Enable postponed evaluation of annotations for all test modules

aeeb69a

This allows using the latest annotation syntax supported by the type checker regardless of the runtime Python version.

Add minimal annotations to unit tests

218843d

These annotations are sufficient to pass mypy inspection if mypy is configured to allow unannotated functions.

Annotate return type of test methods

23f1811

Annotate test helpers

c83ef89

Add pytest to type check dependencies

e4c8810

We also type check the unit tests and the unit tests now import functionality from pytest.

Annotate the test_models package

949d110

Annotate test_field_tracker module

7d6cad0

Override signature of query-returning methods in InheritanceManager

ecc7312

Drop uses of JoinManager from the tests

3c31423

The `JoinManager` class is deprecated and not annotated.

Suppress mypy errors in field tracker tests

8f0b4ee

I can't find a way to inform mypy of the actual types without duplicating a lot of test code.

Annotate test_fields package

23a756e

Preserve tracked function's return type in FieldTracker

f4653f0

Fix type generics in InheritanceIterable

1db7d6b

Provide type arguments to field base classes

5fc37eb

mthuurne force-pushed the type-annotations branch from 16555a7 to 5fc37eb Compare June 13, 2024 10:02

Tell coverage tool to ignore lines intended for mypy only

9dc2247

In particular, `if TYPE_CHECKING:` blocks and `...` in bodies of overloaded method definitions.

foarsitter merged commit 731ed80 into jazzband:master Jun 19, 2024
7 checks passed

mthuurne deleted the type-annotations branch June 19, 2024 20:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add type annotations #603

Add type annotations #603

mthuurne commented Mar 26, 2024 •

edited

Loading

codecov bot commented Mar 26, 2024 •

edited

Loading

foarsitter commented May 28, 2024

mthuurne commented May 28, 2024

foarsitter commented May 29, 2024

mthuurne commented Jun 12, 2024 •

edited

Loading

mthuurne commented Jun 14, 2024

mthuurne commented Jun 14, 2024

foarsitter commented Jun 18, 2024

mthuurne commented Jun 18, 2024

foarsitter commented Jun 19, 2024

Add type annotations #603

Add type annotations #603

Conversation

mthuurne commented Mar 26, 2024 • edited Loading

codecov bot commented Mar 26, 2024 • edited Loading

Codecov Report

foarsitter commented May 28, 2024

mthuurne commented May 28, 2024

foarsitter commented May 29, 2024

mthuurne commented Jun 12, 2024 • edited Loading

mthuurne commented Jun 14, 2024

mthuurne commented Jun 14, 2024

foarsitter commented Jun 18, 2024

mthuurne commented Jun 18, 2024

foarsitter commented Jun 19, 2024

mthuurne commented Mar 26, 2024 •

edited

Loading

codecov bot commented Mar 26, 2024 •

edited

Loading

mthuurne commented Jun 12, 2024 •

edited

Loading