]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-35089: Don't mention typing.io and typing.re (GH-10173)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 28 Oct 2018 16:17:07 +0000 (09:17 -0700)
committerGitHub <noreply@github.com>
Sun, 28 Oct 2018 16:17:07 +0000 (09:17 -0700)
https://bugs.python.org/issue35089
(cherry picked from commit c8a8d6b347d5a6899feb7c810d28f22f3cb151b8)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
Doc/library/typing.rst
Misc/NEWS.d/next/Documentation/2018-10-28-16-51-31.bpo-35089._stCpS.rst [new file with mode: 0644]

index e80cd3f2d75cea955c47eb81df1435929763c1d1..915c3da3351c80ea7c997cf1897bf272a27efed2 100644 (file)
@@ -780,32 +780,25 @@ The module defines the following classes, functions and decorators:
 
    .. versionadded:: 3.5.2
 
-.. class:: io
+.. class:: IO
+           TextIO
+           BinaryIO
 
-   Wrapper namespace for I/O stream types.
-
-   This defines the generic type ``IO[AnyStr]`` and subclasses ``TextIO``
-   and ``BinaryIO``, deriving from ``IO[str]`` and ``IO[bytes]``,
-   respectively. These represent the types of I/O streams such as returned by
+   Generic type ``IO[AnyStr]`` and its subclasses ``TextIO(IO[str])``
+   and ``BinaryIO(IO[bytes])``
+   represent the types of I/O streams such as returned by
    :func:`open`.
 
-   These types are also accessible directly as ``typing.IO``,
-   ``typing.TextIO``, and ``typing.BinaryIO``.
-
-.. class:: re
+.. class:: Pattern
+           Match
 
-   Wrapper namespace for regular expression matching types.
-
-   This defines the type aliases ``Pattern`` and ``Match`` which
+   These type aliases
    correspond to the return types from :func:`re.compile` and
    :func:`re.match`.  These types (and the corresponding functions)
    are generic in ``AnyStr`` and can be made specific by writing
    ``Pattern[str]``, ``Pattern[bytes]``, ``Match[str]``, or
    ``Match[bytes]``.
 
-   These types are also accessible directly as ``typing.Pattern``
-   and ``typing.Match``.
-
 .. class:: NamedTuple
 
    Typed version of namedtuple.
diff --git a/Misc/NEWS.d/next/Documentation/2018-10-28-16-51-31.bpo-35089._stCpS.rst b/Misc/NEWS.d/next/Documentation/2018-10-28-16-51-31.bpo-35089._stCpS.rst
new file mode 100644 (file)
index 0000000..4a46929
--- /dev/null
@@ -0,0 +1,2 @@
+Remove mention of ``typing.io`` and ``typing.re``. Their types should be
+imported from ``typing`` directly.