From b08388d5f2e62577e1a2379deb1681af4f148811 Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Thu, 9 Jun 2016 15:58:06 -0700 Subject: Issue #27182: Document os.PathLike. Part of PEP 519. --- Doc/library/functions.rst | 3 +++ Doc/library/os.rst | 21 +++++++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 6f7ba1f..5757ca4 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -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 diff --git a/Doc/library/os.rst b/Doc/library/os.rst index 3dca86e..4070bf5 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -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) -- cgit v0.12