Issue #27182: Document os.PathLike.

Part of PEP 519.
This commit is contained in:
Brett Cannon 2016-06-09 15:58:06 -07:00
parent 516f5461b0
commit b08388d5f2
2 changed files with 24 additions and 0 deletions

View File

@ -1077,6 +1077,9 @@ are always available. They are listed here in alphabetical order.
.. versionchanged:: 3.5
The ``'namereplace'`` error handler was added.
.. versionchanged:: 3.6
Support added to accept objects implementing :class:`os.PathLike`.
.. function:: ord(c)
Given a string representing one Unicode character, return an integer

View File

@ -175,6 +175,9 @@ process and user.
.. versionadded:: 3.2
.. versionchanged:: 3.6
Support added to accept objects implementing :class:`os.PathLike`.
.. function:: fsdecode(filename)
@ -185,6 +188,9 @@ process and user.
.. versionadded:: 3.2
.. versionchanged:: 3.6
Support added to accept objects implementing :class:`os.PathLike`.
.. function:: fspath(path)
@ -195,6 +201,21 @@ process and user.
(which is represented by :class:`os.PathLike`). All other types raise a
:exc:`TypeError`.
.. versionadded:: 3.6
.. class:: PathLike
An :term:`abstract base class` for objects representing a file system path,
e.g. :class:`pathlib.PurePath`.
.. abstractmethod:: __fspath__()
Return the file system path representation of the object.
The method should only return a :class:`str` or :class:`bytes` object,
with the preference being for :class:`str`.
.. function:: getenv(key, default=None)