Complete type annotations in pip/_internal/index

[DiddiLeija]

Convert type hint commentaries into annotations, this time for pip/_internal/index.

[DiddiLeija]

The ci / pre-commit check failed with flake8:

flake8...................................................................Failed
- hook id: flake8
- exit code: 1

src/pip/_internal/index/collector.py:269:30: F821 undefined name 'HTMLPage'
src/pip/_internal/index/collector.py:282:19: F821 undefined name 'HTMLPage'
src/pip/_internal/index/collector.py:283:16: F821 undefined name 'HTMLPage'
src/pip/_internal/index/collector.py:304:23: F821 undefined name 'HTMLPage'
src/pip/_internal/index/collector.py:372:89: E501 line too long (91 > 88 characters)
src/pip/_internal/index/collector.py:451:89: E501 line too long (108 > 88 characters)
src/pip/_internal/index/collector.py:451:95: F821 undefined name 'LinkCollector'

Maybe the original annotations were wrong. How can I fix them?

[pradyunsg]

What's happening is that HTMLPage is defined after the function you're annotating.

The comments didn't hit any issue, since they aren't executed by the Python interpreter, so only mypy is doing a lookup. Changing the failing HTMLPage annotations to "HTMLPage" would fix this issue. Same for LinkCollector.

[DiddiLeija]

What's happening is that HTMLPage is defined after the function you're annotating.

The comments didn't hit any issue, since they aren't executed by the Python interpreter, so only mypy is doing a lookup. Changing the failing HTMLPage annotations to "HTML Page" would fix this issue. Same for LinkCollector

Ok. I will take that tomorrow (it's late here). Thanks @pradyunsg!

[uranusjr]

I think the HTMLPage annotations need to use strings (forward reference issues). There are a few other linter errors as well.

https://mypy.readthedocs.io/en/stable/common_issues.html#issues-with-code-at-runtime

[DiddiLeija]

I think the HTMLPage annotations need to use strings (forward reference issues). There are a few other linter errors as well.

https://mypy.readthedocs.io/en/stable/common_issues.html#issues-with-code-at-runtime

Ok, got it. Unfortunately, I think I will be a quite busy for this month (things are getting harder on the real world!). But maybe the next week I can take a look for that (It's Friday here). Thanks @uranusjr!

[harupy]

@DiddiLeija @uranusjr @pradyunsg Can I work on type-comments to type-annotations translation as well?

I have worked on something similar in https://github.com/optuna/optuna and would like to help.

[uranusjr]

Feel free, as long as you don’t step on each other’s toes 🙂

[DiddiLeija]

Hey @harupy. Thanks!

Maybe we can coordinate, to be more accurate on our work. I will work on this folders:

pip/_internal/models
pip/_internal/utils
pip/_internal/vcs

And maybe you can take the rest, or someone else could take them (they are a lot of files, so any kind of help is useful...).

[harupy]

@DiddiLeija Got it!

[harupy]

I'm using this package to automatically translate type comments into type annotations:
https://github.com/ilevkivskyi/com2ann

[DiddiLeija]

I finally fixed the collector.py issues. Thanks @uranusjr and @pradyunsg for your guide.

[DiddiLeija]

Side note: I wanted to say Fix the pip/_internal/index/package_finder.py annotations, but it was too large and I had a mistake.

[DiddiLeija]

Hum... Seems like there is a wrong annotation. Look at this error message:

mypy.....................................................................Failed
- hook id: mypy
- exit code: 1

src/pip/_internal/index/package_finder.py:412: error: Name 'tag' is not defined
            supported_tags: List["tag"],
                                 ^
Found 1 error in 1 file (checked 150 source files)

Even when the annotation is a string, it fails! Maybe the annotation is wrong. Can somebody tell me what's going on here?

[DiddiLeija]

Oh, forget it. It was Tag, not tag 🤦‍♂️.

[DiddiLeija]

I've done the pip/_internal/index annotations (Seems like sources.py was already converted by @uranusjr on commit a912c55). Now it is ready to be reviewed by someone. What do you think about it?