From: Brett Cannon <brett@python.org>
Date: Thu, 9 Jun 2016 23:58:38 +0000 (-0700)
Subject: Issue #27186: Document PyOS_FSPath().
X-Git-Tag: v3.6.0a2~71
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=746102bd238f414ba65b336d600eade06b99c440;p=thirdparty%2FPython%2Fcpython.git

Issue #27186: Document PyOS_FSPath().
---

diff --git a/Doc/c-api/sys.rst b/Doc/c-api/sys.rst
index 9ba649624797..f3cde8c573ae 100644
--- a/Doc/c-api/sys.rst
+++ b/Doc/c-api/sys.rst
@@ -5,6 +5,16 @@
 Operating System Utilities
 ==========================
 
+.. c:function:: PyObject* PyOS_FSPath(PyObject *path)
+
+   Return the file system representation for *path*. If the object is a
+   :class:`str` or :class:`bytes` object, then its reference count is
+   incremented. If the object implements the :class:`os.PathLike` interface,
+   then ``type(path).__fspath__()`` is returned. Otherwise :exc:`TypeError` is
+   raised and ``NULL`` is returned.
+
+   .. versionadded:: 3.6
+
 
 .. c:function:: int Py_FdIsInteractive(FILE *fp, const char *filename)
 
diff --git a/Doc/data/refcounts.dat b/Doc/data/refcounts.dat
index e38819575794..8b469f4aac9a 100644
--- a/Doc/data/refcounts.dat
+++ b/Doc/data/refcounts.dat
@@ -921,6 +921,9 @@ PyNumber_Xor:PyObject*:o2:0:
 PyObject_AsFileDescriptor:int:::
 PyObject_AsFileDescriptor:PyObject*:o:0:
 
+PyOS_FSPath:PyObject*::+1:
+PyOS_FSPath:PyObject*:path:0:
+
 PyObject_Call:PyObject*::+1:
 PyObject_Call:PyObject*:callable_object:0:
 PyObject_Call:PyObject*:args:0: