Merge pull request #3086 from aatle/change-pathlike

Make `pygame.typing.PathLike` internal/private

Author: damusss

buildconfig/stubs/pygame/rwobject.pyi

@@ -1,16 +1,16 @@
 from typing import Any, Optional, overload, Type
 
-from pygame.typing import PathLike
+from pygame.typing import _PathLike
 
 def encode_string(
-    obj: Optional[PathLike],
+    obj: Optional[_PathLike],
     encoding: Optional[str] = "unicode_escape",
     errors: Optional[str] = "backslashreplace",
     etype: Optional[Type[Exception]] = UnicodeEncodeError,
 ) -> bytes: ...
 @overload
 def encode_file_path(
-    obj: Optional[PathLike], etype: Optional[Type[Exception]] = UnicodeEncodeError
+    obj: Optional[_PathLike], etype: Optional[Type[Exception]] = UnicodeEncodeError
 ) -> bytes: ...
 @overload
 def encode_file_path(

buildconfig/stubs/pygame/typing.pyi

@@ -7,7 +7,6 @@ __all__ = [
     "RectLike",
     "SequenceLike",
     "FileLike",
-    "PathLike",
     "ColorLike",
     "RGBATuple",
     "Coordinate",
@@ -29,9 +28,9 @@ else:
 
 
 # For functions that take a file name
-PathLike = Union[str, bytes, _PathProtocol[str], _PathProtocol[bytes]]
+_PathLike = Union[str, bytes, _PathProtocol[str], _PathProtocol[bytes]]
 # Most pygame functions that take a file argument should be able to handle a FileLike type
-FileLike = Union[PathLike, IO[bytes], IO[str]]
+FileLike = Union[_PathLike, IO[bytes], IO[str]]
 
 _T_co = TypeVar("_T_co", covariant=True)
 

buildconfig/stubs/typing_sample_app.py

@@ -44,12 +44,12 @@ def validator_SequenceLikeTypes(
 )
 
 
-# validate PathLike
+# validate _PathLike
 class MyPath:
     def __fspath__(self) -> str:
         return "file.py"
 
-def validator_PathLike(path: typing.PathLike) -> int:
+def validator_PathLike(path: typing._PathLike) -> int:
     return 0
 
 # must pass

docs/reST/ref/typing.rst

@@ -14,20 +14,17 @@ A lot of pygame functions and methods allow the user to provide different types
 for the same value like colors or coordinates. This module exports the most common
 type aliases for proper typehint annotations.
 
-   .. data:: PathLike
+   .. data:: FileLike
 
-      An object representing a file path, i.e.:
+      An object representing a file. This includes both path-like
+      objects and file-like objects, i.e.:
 
         * ``"my/string/path.txt"``
+        * ``open("my/file/path.txt")``
         * ``pathlib.Path("my/pathlib/path.txt")``
+        * ``io.BytesIO(b"my data: \x00\x01")``
         * ``b"my/bytes/path.txt"``
-        * Any object implementing the path protocol (with a ``__fspath__`` magic method)
-
-   .. data:: FileLike
-
-      An object representing a file. Same as :mod:`pygame.typing.PathLike` with
-      the addition of file buffers (``IO`` of strings or bytes) such as the
-      return value of ``open()``.
+        * Any object implementing the path protocol or file protocol.
 
    .. data:: SequenceLike
 

src_c/doc/typing_doc.h

@@ -1,6 +1,5 @@
 /* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_TYPING "pygame module providing common typehints"
-#define DOC_TYPING_PATHLIKE ""
 #define DOC_TYPING_FILELIKE ""
 #define DOC_TYPING_SEQUENCELIKE ""
 #define DOC_TYPING_COORDINATE ""

src_py/typing.py

@@ -7,7 +7,6 @@
     "RectLike",
     "SequenceLike",
     "FileLike",
-    "PathLike",
     "ColorLike",
     "RGBATuple",
     "Coordinate",
@@ -29,9 +28,9 @@ def __fspath__(self) -> _AnyStr_co: ...
 
 
 # For functions that take a file name
-PathLike = Union[str, bytes, _PathProtocol[str], _PathProtocol[bytes]]
+_PathLike = Union[str, bytes, _PathProtocol[str], _PathProtocol[bytes]]
 # Most pygame functions that take a file argument should be able to handle a FileLike type
-FileLike = Union[PathLike, IO[bytes], IO[str]]
+FileLike = Union[_PathLike, IO[bytes], IO[str]]
 
 _T_co = TypeVar("_T_co", covariant=True)