Add type hints to docstrings module

[WhyNotHugo]

No description provided.

[codecov-commenter]

Codecov Report

Merging #46 (5ae6bbc) into main (872cb8d) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main       #46   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          315       317    +2     
=========================================
+ Hits           315       317    +2     

Files Changed	Coverage Δ
sphinxcontrib_django/docstrings/__init__.py	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[timobrembeck]

@WhyNotHugo Thanks a lot for your contribution! 💪

Could you exclude the if TYPE_CHECKING: from the code coverage report as described in nedbat/coveragepy#831? (Just in pyproject.toml instead of .coveragerc)

[WhyNotHugo]

Updated. I've just realised that I've mis-measuring coverage in a bunch of project too, thanks for the pointer.

[WhyNotHugo]

Rebased with pre-commit hooks applied.

[timobrembeck]

Great, thanks! 👍

I had to add the line pragma: no cover to the excluded lines as well, but now the coverage report looks good 👌

If you want to, you can also add type hints for the rest of the package 😁

Also, what do you think about including a tool like Mypy to check the types as part of the GitHub actions workflow?

[WhyNotHugo]

Mypy would help make sure that type hints keep making sense. 👍

Right now sphinxcontrib_django/docstrings/attributes.py is failing due to a quirk in the type system (tuple[X] and tuple[X, X] are different types):

sphinxcontrib_django/docstrings/attributes.py:20: error: Incompatible types in assignment (expression has type "tuple[Any, Any, Any]", variable has type "tuple[Any, Any]")  [assignment]

You might need to use:

FIELD_DESCRIPTORS : tuple[Any,...] = (FileDescriptor, related_descriptors.ForwardManyToOneDescriptor)