[typehints] tests: enable mypy for linkcheck builder tests.

[jayaddison]

Feature or Bugfix

• Refactoring

Purpose

• Improve coverage of typechecking through the codebase.

Detail

• Enable mypy typechecking for the tests/test_builders/test_build_linkcheck.py file.

Relates

• Indirectly supports [tests] linkcheck: bind each test HTTP server to a unique port per-testcase. #12126.

[danieleades]

two more comments:

1. should this wait until after use 'types-docutils' instead of 'docutils-stubs' for docutils type annotations #12012 is merged?
2. can you modify the mypy config so that these files are not whitelisted?

[jayaddison]

Thanks @danieleades for the review! I'll respond to the other questions soon; for now:

two more comments:

1. should this wait until after [use 'types-docutils' instead of 'docutils-stubs' for docutils type annotations #12012](https://github.com/sphinx-doc/sphinx/pull/12012) is merged?

Yep, I'm OK to wait for that 👍

2. can you modify the mypy config so that these files are not whitelisted?

Odd, I thought I had done that. But I will push that change, thanks!

[jayaddison]

2. can you modify the mypy config so that these files are not whitelisted?

Odd, I thought I had done that. But I will push that change, thanks!

Ah. I did do that in commit 56ef23b - but then fumbled it by accidentally including a removal of that change in 5fed4b3.

Re-applying 56ef23b ...

[jayaddison]

two more comments:

1. should this wait until after [use 'types-docutils' instead of 'docutils-stubs' for docutils type annotations #12012](https://github.com/sphinx-doc/sphinx/pull/12012) is merged?

With that merged, I'm going to merge mainline again into this branch (mypy linting looks good after a fresh install of the lint+test dependencies here).

2. can you modify the mypy config so that these files are not whitelisted?

Also resolved - thanks again!

[picnixz]

Could I ask you some insights on #12198? because depending on the direction, we could just have a smaller diff (at the cost of the mypy plugin). Mypy plugins do not give me the possibility to annotate an un-annotated function after :(

In addition, I'm considering merging #12199 today as well (see the rationale in the PR).

[jayaddison]

Could I ask you some insights on #12198? because depending on the direction, we could just have a smaller diff (at the cost of the mypy plugin). Mypy plugins do not give me the possibility to annotate an un-annotated function after :(

In addition, I'm considering merging #12199 today as well (see the rationale in the PR).

Ok, thanks @picnixz. Since this affects other branches, my preferred order to merge would be:

1. [mypy] explicitly exclude files instead of ignoring errors by modules #12199 (adjust the config exclude list style)
2. [typehints] tests: enable mypy for linkcheck builder tests. #12160 (this PR - enable typehinting for the linkcheck tests)
3. [tests] linkcheck: bind each test HTTP server to a unique port per-testcase. #12126 (resolve some conflicts, and then land the port-isolation with type-hinting also)

(and oops, I missed your edit before commenting on that PR - but I could help out with attempting the copyright method refactor if that'd be useful)

[picnixz]

I'll wait for the opinion of others for the mypy exclusion

[danieleades]

there's a significant downside to this approach compared to the [[tool.mypy.overrides]] approach, which is that for the [[tool.mypy.overrides]] approach you can shrink the whitelist not just be removing files from the whitelist, but also by making the ignored errors more fine-grained (for example by changing it from ignoring all errors to only ignoring some classes of errors)

[picnixz]

(for example by changing it from ignoring all errors to only ignoring some classes of errors)

For this one, I would suggest (since we are in a test-file) using a top-file comment.