changeset:   101833:cec1f00c538d
parent:      101829:6239673d5e1d
user:        Brett Cannon <brett@python.org>
date:        Thu Jun 09 16:58:38 2016 -0700
files:       Doc/c-api/sys.rst Doc/data/refcounts.dat
description:
Issue #27186: Document PyOS_FSPath().


diff -r 6239673d5e1d -r cec1f00c538d Doc/c-api/sys.rst
--- a/Doc/c-api/sys.rst	Thu Jun 09 15:58:06 2016 -0700
+++ b/Doc/c-api/sys.rst	Thu Jun 09 16:58:38 2016 -0700
@@ -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 -r 6239673d5e1d -r cec1f00c538d Doc/data/refcounts.dat
--- a/Doc/data/refcounts.dat	Thu Jun 09 15:58:06 2016 -0700
+++ b/Doc/data/refcounts.dat	Thu Jun 09 16:58:38 2016 -0700
@@ -921,6 +921,9 @@
 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: