Convert type hint comments into annotations #10018

DiddiLeija · 2021-05-26T16:50:44Z

As I said on the pypa/pip PR #10004, it is necessary to remove the comments and use the typing annotations instead.

As I said on the pypa/pip PR pypa#10004, it is necessary to remove the comments and use the `typing` annotations instead.

This will help to build the documentation.

src/pip/__init__.py

I propose to change all the files that used the `typing` module. On this file, I found a way to improve that topic.

Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>

DiddiLeija · 2021-05-26T17:02:00Z

If I can help with something else, I offer to take care of the issue. Just tell me.

I deleted the comments and replaced them with proper annotations.

Remove (most) of the annotation commentaries and use proper annotations.

DiddiLeija · 2021-05-26T17:23:24Z

Sorry, I have a question: Why does the CI / pre-commit (pull request) check is failing?

Using `List(Any)` is wrong, so I must use `List[Any]`.

DiddiLeija · 2021-05-26T17:37:27Z

I would like to know why does the check fails. Am I doing something wrong?

Fix cmdoptions.py by removing the comments on the functions and using proper annotations.

pradyunsg · 2021-05-26T18:53:18Z

I would like to know why does the check fails. Am I doing something wrong?

The check is making sure that the annotations and code formatting are correct. If you click on details, it will show you what's wrong and possibly, what the fix for it is.

DiddiLeija · 2021-05-27T13:00:01Z

If you click on details, it will show you what's wrong and possibly, what the fix for it is.

Ok, I will try it, thank you.

The object type "None" cannot be annotated. I had to remove them.

DiddiLeija · 2021-05-27T13:18:39Z

Sorry, I just can't find mymistakes. I looked for the CI report. It gave me this message:

diff --git a/src/pip/_internal/cli/cmdoptions.py b/src/pip/_internal/cli/cmdoptions.py
index c07285a..9cce988 100644
--- a/src/pip/_internal/cli/cmdoptions.py
+++ b/src/pip/_internal/cli/cmdoptions.py
@@ -554,7 +554,9 @@ def _convert_python_version(value: str) -> Tuple[Tuple[int, ...], Optional[str]]
     return (version_info, None)
 
 
-def _handle_python_version(option: Option, opt_str: str, value: str, parser: OptionParser):
+def _handle_python_version(
+    option: Option, opt_str: str, value: str, parser: OptionParser
+):
     """
     Handle a provided --python-version value.
     """
Error: The process '/opt/hostedtoolcache/Python/3.9.5/x64/bin/pre-commit' failed with exit code 1

Everything seems fine for me. What am I doing wrong?

DiddiLeija · 2021-05-27T17:39:42Z

I've been trying to find my mistake on the check details, but I haven't found anything or, I don't understand where the problem is. That is confusing for me.

Can somebody help me, please?

uranusjr · 2021-05-27T18:24:51Z

It means your line is too long and need to be broken into like the + lines are showing.

DiddiLeija · 2021-05-27T18:26:36Z

Oh, got it. I will fix that as soon as I can. Thank you, @uranusjr and @pradyunsg .

Break long annotation lines into short lines.

Fix long/short annotations at function definitions

Break long annotations into short annotations

Some of them were too large, others were too long.

DiddiLeija · 2021-05-27T19:27:42Z

I fixed most of the errors. But I'm still having this message:

Check builtin type constructor use.......................................Passed
Check for added large files..............................................Passed
Check for case conflicts.................................................Passed
Check Toml...............................................................Passed
Check Yaml...............................................................Passed
Debug Statements (Python)................................................Passed
Fix End of Files.........................................................Passed
Forbid new submodules....................................................Passed
Trim Trailing Whitespace.................................................Passed
black....................................................................Passed
flake8...................................................................Passed
isort....................................................................Passed
mypy.....................................................................Failed
- hook id: mypy
- exit code: 1

src/pip/_internal/cli/cmdoptions.py:34: error: Function is missing a return
type annotation
    def raise_option_error(parser: OptionParser, option: Option, msg: str)...
    ^
src/pip/_internal/cli/cmdoptions.py:60: error: Function is missing a return
type annotation
    def check_install_build_global(options: Values, check_options: Optiona...
    ^
src/pip/_internal/cli/cmdoptions.py:84: error: Function is missing a return
type annotation
    def check_dist_restriction(options: Values, check_target: bool = False...
    ^
src/pip/_internal/cli/cmdoptions.py:430: error: Function is missing a return
type annotation
    def _handle_src(option: Option, opt_str: str, value: str, parser: Opti...
    ^
src/pip/_internal/cli/cmdoptions.py:458: error: Function is missing a return
type annotation
    def _handle_no_binary(option: Option, opt_str: str, value: str, parser...
    ^
src/pip/_internal/cli/cmdoptions.py:467: error: Function is missing a return
type annotation
    def _handle_only_binary(option: Option, opt_str: str, value: str, pars...
    ^
src/pip/_internal/cli/cmdoptions.py:557: error: Function is missing a return
type annotation
    def _handle_python_version(
    ^
src/pip/_internal/cli/cmdoptions.py:629: error: Function is missing a return
type annotation
    def add_target_python_options(cmd_opts: OptionGroup):
    ^
src/pip/_internal/cli/cmdoptions.py:668: error: Function is missing a return
type annotation
    def _handle_no_cache_dir(option: Option, opt: str, value: str, parser:...
    ^
src/pip/_internal/cli/cmdoptions.py:746: error: Function is missing a return
type annotation
    def _handle_no_use_pep517(option: Option, opt: str, value: str, parser...
    ^
src/pip/_internal/cli/cmdoptions.py:849: error: Function is missing a return
type annotation
    def _handle_merge_hash(option: Option, opt_str: str, value: str, parse...
    ^
src/pip/_internal/cli/cmdoptions.py:908: error: Function is missing a return
type annotation
    def check_list_path_option(options: Values):
    ^
src/pip/_internal/cli/base_command.py:76: error: Function is missing a return
type annotation
        def add_options(self):
        ^
src/pip/_internal/cli/base_command.py:76: note: Use "-> None" if function does not return a value
src/pip/_internal/cli/base_command.py:79: error: Function is missing a return
type annotation
        def handle_pip_version_check(self, options: Values):
        ^
src/pip/_internal/cli/autocompletion.py:15: error: Function is missing a return
type annotation
    def autocomplete():
    ^
src/pip/_internal/cli/autocompletion.py:15: note: Use "-> None" if function does not return a value
Found 15 errors in 3 files (checked 148 source files)

What am I missing?

uranusjr · 2021-05-28T06:50:12Z

A Python function returning nothing is implicitly returning None, and need to be annotated as

def function_name(...) -> None:
    ...

DiddiLeija · 2021-05-28T12:52:10Z

A Python function returning nothing is implicitly returning None, and need to be annotated as
def function_name(...) -> None:
    ...

Understood. I will work on it today. Thank you.

When a function returns nothing, it must be annotated, too.

Use proper annotations instead of commentaries.

Use anotations instead of commentaries.

Some of them were not correct.

Some of them were not annotated correctly.

DiddiLeija · 2021-05-28T15:26:17Z

I've been fixing these files:

pip/src/pip/_internal/cli/command_context.py
pip/src/pip/_internal/cli/main.py
pip/src/pip/_internal/cli/main_parser.py
pip/src/pip/_internal/cli/parser.py

Is anything ok?

One of those annotations was too long.

DiddiLeija · 2021-05-28T15:49:00Z

NOTE: On my latest commit, I wanted to say "Fix the annotation length". Sorry 😅

uranusjr · 2021-05-28T15:51:31Z

This will likely be squashed into one commit when merging, so that’s fine.

uranusjr · 2021-05-28T15:52:48Z

I would suggest finding a place to stop and call for a merge. Pip has a lot of files, and if you do them all at once this will take forever.

DiddiLeija · 2021-05-28T15:54:30Z

It's true. Maybe we can stop here, when the CI checks get completed.

DiddiLeija · 2021-05-28T16:20:03Z

Everything is done. You can merge, if you want.

Thank you very much for your time 😄 .

src/pip/_internal/cli/base_command.py

Add a return value annotation. Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>

DiddiLeija · 2021-05-30T01:36:51Z

I think everything is done. You can merge this branch, if you want.

Thanks, @pradyunsg and @uranusjr for all your help.

DiddiLeija · 2021-06-02T15:36:30Z

I think there is nothing to modify on the files I changed. I can't merge, but you can do it.

(And sorry, @pradyunsg . I requested yor review accidentally 😬 )

This is the second part of my job made on pypa#10018, where I must complete all the annotations from `pip/_internal/cli`.

DiddiLeija added 2 commits May 26, 2021 11:44

Convert commentaries into annotations

2d19102

As I said on the pypa/pip PR pypa#10004, it is necessary to remove the comments and use the `typing` annotations instead.

Create 10018.trivial.rst

1753788

This will help to build the documentation.

pradyunsg reviewed May 26, 2021

View reviewed changes

src/pip/__init__.py Outdated Show resolved Hide resolved

DiddiLeija and others added 2 commits May 26, 2021 11:57

Fix the annotations

65b4dbc

I propose to change all the files that used the `typing` module. On this file, I found a way to improve that topic.

Update src/pip/__init__.py

2dc2e62

Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>

DiddiLeija added 2 commits May 26, 2021 12:07

Fix the annotations

0c5d9e8

I deleted the comments and replaced them with proper annotations.

Fix the annotations on base_command.py

acfeaba

Remove (most) of the annotation commentaries and use proper annotations.

Fix an annotation mistake.

234a9ed

Using `List(Any)` is wrong, so I must use `List[Any]`.

Fix the annotations

a049283

Fix cmdoptions.py by removing the comments on the functions and using proper annotations.

Fix an annotation mistake

773aa7d

The object type "None" cannot be annotated. I had to remove them.

DiddiLeija added 6 commits May 27, 2021 13:29

Update the annotations

5d405cd

Break long annotation lines into short lines.

Format some annotations

338d1d7

Fix long/short annotations at function definitions

Update annotations on cmdoptions.py

ee5bf42

Break long annotations into short annotations

Fix the cmdoptions.py annotations

5079aa8

Some of them were too large, others were too long.

Fix the annotations length

423cdff

Fix the annotations length

6319660

DiddiLeija added 2 commits May 28, 2021 07:57

Merge branch 'pypa:main' into annotations-fixes-1

ee89922

Fix the cmdoptions.py return values

e62a77b

When a function returns nothing, it must be annotated, too.

DiddiLeija added 4 commits May 28, 2021 10:07

Convert commentaries into annotations

731f0b0

Use proper annotations instead of commentaries.

Use proper annotations

2d37947

Use anotations instead of commentaries.

Fix some annotations

1d317bb

Some of them were not correct.

Fix some annotations

969018b

Some of them were not annotated correctly.

Fix theannotation length

d9aa531

One of those annotations was too long.

uranusjr reviewed May 28, 2021

View reviewed changes

src/pip/_internal/cli/base_command.py Outdated Show resolved Hide resolved

Update src/pip/_internal/cli/base_command.py

691da80

Add a return value annotation. Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>

uranusjr approved these changes May 28, 2021

View reviewed changes

DiddiLeija requested a review from pradyunsg May 31, 2021 13:07

DiddiLeija added 2 commits May 31, 2021 08:08

Merge branch 'pypa:main' into annotations-fixes-1

f311646

Merge branch 'pypa:main' into annotations-fixes-1

0f0a1ac

DiddiLeija added 3 commits June 3, 2021 09:46

Merge branch 'pypa:main' into annotations-fixes-1

8159398

Merge branch 'pypa:main' into annotations-fixes-1

eba22d6

Merge branch 'pypa:main' into annotations-fixes-1

b026568

uranusjr changed the title ~~Convert commentaries into annotations~~ Convert type hint comments into annotations Jun 7, 2021

uranusjr merged commit 1e016d2 into pypa:main Jun 7, 2021

DiddiLeija mentioned this pull request Jun 8, 2021

Make proper annotations in noxfile.py #10047

Merged

DiddiLeija added a commit to DiddiLeija/pip that referenced this pull request Jun 14, 2021

Complete the annotations in pip/_internal/cli

ff6b13a

This is the second part of my job made on pypa#10018, where I must complete all the annotations from `pip/_internal/cli`.

This was referenced Jun 14, 2021

Complete the annotations in pip/_internal/cli DiddiLeija/pip#4

Closed

Complete type annotations in pip/_internal/cli #10065

Merged

Adding the --strict option to mypy #10076

Open

github-actions bot locked as resolved and limited conversation to collaborators Sep 28, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert type hint comments into annotations #10018

Convert type hint comments into annotations #10018

DiddiLeija commented May 26, 2021

DiddiLeija commented May 26, 2021

DiddiLeija commented May 26, 2021

DiddiLeija commented May 26, 2021

pradyunsg commented May 26, 2021

DiddiLeija commented May 27, 2021

DiddiLeija commented May 27, 2021

DiddiLeija commented May 27, 2021

uranusjr commented May 27, 2021

DiddiLeija commented May 27, 2021

DiddiLeija commented May 27, 2021

uranusjr commented May 28, 2021

DiddiLeija commented May 28, 2021

DiddiLeija commented May 28, 2021

DiddiLeija commented May 28, 2021

uranusjr commented May 28, 2021

uranusjr commented May 28, 2021

DiddiLeija commented May 28, 2021

DiddiLeija commented May 28, 2021

DiddiLeija commented May 30, 2021

DiddiLeija commented Jun 2, 2021

Convert type hint comments into annotations #10018

Convert type hint comments into annotations #10018

Conversation

DiddiLeija commented May 26, 2021

DiddiLeija commented May 26, 2021

DiddiLeija commented May 26, 2021

DiddiLeija commented May 26, 2021

pradyunsg commented May 26, 2021

DiddiLeija commented May 27, 2021

DiddiLeija commented May 27, 2021

DiddiLeija commented May 27, 2021

uranusjr commented May 27, 2021

DiddiLeija commented May 27, 2021

DiddiLeija commented May 27, 2021

uranusjr commented May 28, 2021

DiddiLeija commented May 28, 2021

DiddiLeija commented May 28, 2021

DiddiLeija commented May 28, 2021

uranusjr commented May 28, 2021

uranusjr commented May 28, 2021

DiddiLeija commented May 28, 2021

DiddiLeija commented May 28, 2021

DiddiLeija commented May 30, 2021

DiddiLeija commented Jun 2, 2021