Broaden cygpath parameter annotation

EliahKagan · EliahKagan · commit e133018954cc · 2024-03-07T21:20:04.000-05:00
To fix a mypy error in Repo.__init__ where the epath variable,
which can sometimes be a os.PathLike[str], does not match the str
annotation for cygpath's path parameter, even though cygwin
immediately calls str on that parameter.

Pulling most of cygpath out into a new helper function is to help
mypy correctly infer that the type of path is still compatible with
the return type of str, when it is used in the return statement.

I'm not sure this change is really the best solution at this time,
because while it fixes the mypy error (without creating a new one),
and cygpath is not listed in __all__, the docstring of advises to
call Git.polish_url instead of cygpath. That method is public,
annotates its parameter as str, and should not have its annotation
broadened without considernig if it makes sense to do so or if its
docstring needs to be updated.

So either the cygpath docstring should be updated or this change
should be undone and a different approach used to fix the type
error in Repo.__init__.
diff --git a/git/util.py b/git/util.py
@@ -404,9 +404,7 @@ def _cygexpath(drive: Optional[str], path: str) -> str:
 )
 
 
-def cygpath(path: str) -> str:
-    """Use :meth:`git.cmd.Git.polish_url` instead, that works on any environment."""
-    path = str(path)  # Ensure is str and not AnyPath.
+def _cygpath(path: str) -> str:
     # Fix to use Paths when 3.5 dropped. Or to be just str if only for URLs?
     if not path.startswith(("/cygdrive", "//", "/proc/cygdrive")):
         for regex, parser, recurse in _cygpath_parsers:
@@ -422,6 +420,11 @@ def cygpath(path: str) -> str:
     return path
 
 
+def cygpath(path: PathLike) -> str:
+    """Use :meth:`git.cmd.Git.polish_url` instead, that works on any environment."""
+    return _cygpath(str(path))  # Ensure is str and not AnyPath.
+
+
 _decygpath_regex = re.compile(r"(?:/proc)?/cygdrive/(\w)(/.*)?")
 
 
