Merge pull request #10188 from harupy/type-annotations-req

Author: uranusjr

src/pip/_internal/req/__init__.py

@@ -17,36 +17,32 @@
 
 
 class InstallationResult:
-    def __init__(self, name):
-        # type: (str) -> None
+    def __init__(self, name: str) -> None:
         self.name = name
 
-    def __repr__(self):
-        # type: () -> str
+    def __repr__(self) -> str:
         return f"InstallationResult(name={self.name!r})"
 
 
 def _validate_requirements(
-    requirements,  # type: List[InstallRequirement]
-):
-    # type: (...) -> Iterator[Tuple[str, InstallRequirement]]
+    requirements: List[InstallRequirement],
+) -> Iterator[Tuple[str, InstallRequirement]]:
     for req in requirements:
         assert req.name, f"invalid to-be-installed requirement: {req}"
         yield req.name, req
 
 
 def install_given_reqs(
-    requirements,  # type: List[InstallRequirement]
-    install_options,  # type: List[str]
-    global_options,  # type: Sequence[str]
-    root,  # type: Optional[str]
-    home,  # type: Optional[str]
-    prefix,  # type: Optional[str]
-    warn_script_location,  # type: bool
-    use_user_site,  # type: bool
-    pycompile,  # type: bool
-):
-    # type: (...) -> List[InstallationResult]
+    requirements: List[InstallRequirement],
+    install_options: List[str],
+    global_options: Sequence[str],
+    root: Optional[str],
+    home: Optional[str],
+    prefix: Optional[str],
+    warn_script_location: bool,
+    use_user_site: bool,
+    pycompile: bool,
+) -> List[InstallationResult]:
     """
     Install everything in the given list.
 

src/pip/_internal/req/constructors.py

@@ -39,8 +39,7 @@
 operators = Specifier._operators.keys()
 
 
-def _strip_extras(path):
-    # type: (str) -> Tuple[str, Optional[str]]
+def _strip_extras(path: str) -> Tuple[str, Optional[str]]:
     m = re.match(r'^(.+)(\[[^\]]+\])$', path)
     extras = None
     if m:
@@ -52,15 +51,13 @@ def _strip_extras(path):
     return path_no_extras, extras
 
 
-def convert_extras(extras):
-    # type: (Optional[str]) -> Set[str]
+def convert_extras(extras: Optional[str]) -> Set[str]:
     if not extras:
         return set()
     return Requirement("placeholder" + extras.lower()).extras
 
 
-def parse_editable(editable_req):
-    # type: (str) -> Tuple[Optional[str], str, Set[str]]
+def parse_editable(editable_req: str) -> Tuple[Optional[str], str, Set[str]]:
     """Parses an editable requirement into:
         - a requirement name
         - an URL
@@ -131,8 +128,7 @@ def parse_editable(editable_req):
     return package_name, url, set()
 
 
-def deduce_helpful_msg(req):
-    # type: (str) -> str
+def deduce_helpful_msg(req: str) -> str:
     """Returns helpful msg in case requirements file does not exist,
     or cannot be parsed.
 
@@ -165,24 +161,23 @@ def deduce_helpful_msg(req):
 class RequirementParts:
     def __init__(
             self,
-            requirement,  # type: Optional[Requirement]
-            link,         # type: Optional[Link]
-            markers,      # type: Optional[Marker]
-            extras,       # type: Set[str]
+            requirement: Optional[Requirement],
+            link: Optional[Link],
+            markers: Optional[Marker],
+            extras: Set[str],
     ):
         self.requirement = requirement
         self.link = link
         self.markers = markers
         self.extras = extras
 
 
-def parse_req_from_editable(editable_req):
-    # type: (str) -> RequirementParts
+def parse_req_from_editable(editable_req: str) -> RequirementParts:
     name, url, extras_override = parse_editable(editable_req)
 
     if name is not None:
         try:
-            req = Requirement(name)  # type: Optional[Requirement]
+            req: Optional[Requirement] = Requirement(name)
         except InvalidRequirement:
             raise InstallationError(f"Invalid requirement: '{name}'")
     else:
@@ -197,15 +192,14 @@ def parse_req_from_editable(editable_req):
 
 
 def install_req_from_editable(
-    editable_req,  # type: str
-    comes_from=None,  # type: Optional[Union[InstallRequirement, str]]
-    use_pep517=None,  # type: Optional[bool]
-    isolated=False,  # type: bool
-    options=None,  # type: Optional[Dict[str, Any]]
-    constraint=False,  # type: bool
-    user_supplied=False,  # type: bool
-):
-    # type: (...) -> InstallRequirement
+    editable_req: str,
+    comes_from: Optional[Union[InstallRequirement, str]] = None,
+    use_pep517: Optional[bool] = None,
+    isolated: bool = False,
+    options: Optional[Dict[str, Any]] = None,
+    constraint: bool = False,
+    user_supplied: bool = False,
+) -> InstallRequirement:
 
     parts = parse_req_from_editable(editable_req)
 
@@ -225,8 +219,7 @@ def install_req_from_editable(
     )
 
 
-def _looks_like_path(name):
-    # type: (str) -> bool
+def _looks_like_path(name: str) -> bool:
     """Checks whether the string "looks like" a path on the filesystem.
 
     This does not check whether the target actually exists, only judge from the
@@ -245,8 +238,7 @@ def _looks_like_path(name):
     return False
 
 
-def _get_url_from_path(path, name):
-    # type: (str, str) -> Optional[str]
+def _get_url_from_path(path: str, name: str) -> Optional[str]:
     """
     First, it checks whether a provided path is an installable directory. If it
     is, returns the path.
@@ -279,8 +271,7 @@ def _get_url_from_path(path, name):
     return path_to_url(path)
 
 
-def parse_req_from_line(name, line_source):
-    # type: (str, Optional[str]) -> RequirementParts
+def parse_req_from_line(name: str, line_source: Optional[str]) -> RequirementParts:
     if is_url(name):
         marker_sep = '; '
     else:
@@ -329,8 +320,7 @@ def parse_req_from_line(name, line_source):
 
     extras = convert_extras(extras_as_string)
 
-    def with_source(text):
-        # type: (str) -> str
+    def with_source(text: str) -> str:
         if not line_source:
             return text
         return f'{text} (from {line_source})'
@@ -366,24 +356,23 @@ def _parse_req_string(req_as_string: str) -> Requirement:
         return req
 
     if req_as_string is not None:
-        req = _parse_req_string(req_as_string)  # type: Optional[Requirement]
+        req: Optional[Requirement] = _parse_req_string(req_as_string)
     else:
         req = None
 
     return RequirementParts(req, link, markers, extras)
 
 
 def install_req_from_line(
-    name,  # type: str
-    comes_from=None,  # type: Optional[Union[str, InstallRequirement]]
-    use_pep517=None,  # type: Optional[bool]
-    isolated=False,  # type: bool
-    options=None,  # type: Optional[Dict[str, Any]]
-    constraint=False,  # type: bool
-    line_source=None,  # type: Optional[str]
-    user_supplied=False,  # type: bool
-):
-    # type: (...) -> InstallRequirement
+    name: str,
+    comes_from: Optional[Union[str, InstallRequirement]] = None,
+    use_pep517: Optional[bool] = None,
+    isolated: bool = False,
+    options: Optional[Dict[str, Any]] = None,
+    constraint: bool = False,
+    line_source: Optional[str] = None,
+    user_supplied: bool = False,
+) -> InstallRequirement:
     """Creates an InstallRequirement from a name, which might be a
     requirement, directory containing 'setup.py', filename, or URL.
 
@@ -405,13 +394,12 @@ def install_req_from_line(
 
 
 def install_req_from_req_string(
-    req_string,  # type: str
-    comes_from=None,  # type: Optional[InstallRequirement]
-    isolated=False,  # type: bool
-    use_pep517=None,  # type: Optional[bool]
-    user_supplied=False,  # type: bool
-):
-    # type: (...) -> InstallRequirement
+    req_string: str,
+    comes_from: Optional[InstallRequirement] = None,
+    isolated: bool = False,
+    use_pep517: Optional[bool] = None,
+    user_supplied: bool = False,
+) -> InstallRequirement:
     try:
         req = Requirement(req_string)
     except InvalidRequirement:
@@ -440,12 +428,11 @@ def install_req_from_req_string(
 
 
 def install_req_from_parsed_requirement(
-    parsed_req,  # type: ParsedRequirement
-    isolated=False,  # type: bool
-    use_pep517=None,  # type: Optional[bool]
-    user_supplied=False,  # type: bool
-):
-    # type: (...) -> InstallRequirement
+    parsed_req: ParsedRequirement,
+    isolated: bool = False,
+    use_pep517: Optional[bool] = None,
+    user_supplied: bool = False,
+) -> InstallRequirement:
     if parsed_req.is_editable:
         req = install_req_from_editable(
             parsed_req.requirement,
@@ -470,8 +457,9 @@ def install_req_from_parsed_requirement(
     return req
 
 
-def install_req_from_link_and_ireq(link, ireq):
-    # type: (Link, InstallRequirement) -> InstallRequirement
+def install_req_from_link_and_ireq(
+    link: Link, ireq: InstallRequirement
+) -> InstallRequirement:
     return InstallRequirement(
         req=ireq.req,
         comes_from=ireq.comes_from,