Kaydet (Commit) b4f43e90 authored tarafından Brett Cannon's avatar Brett Cannon

Clarify documentation for os.fspath().

üst 5f74ebc2
...@@ -5486,9 +5486,9 @@ PyDoc_STRVAR(os_fspath__doc__, ...@@ -5486,9 +5486,9 @@ PyDoc_STRVAR(os_fspath__doc__,
"\n" "\n"
"Return the file system path representation of the object.\n" "Return the file system path representation of the object.\n"
"\n" "\n"
"If the object is str or bytes, then allow it to pass through with\n" "If the object is str or bytes, then allow it to pass through as-is. If the\n"
"an incremented refcount. If the object defines __fspath__(), then\n" "object defines __fspath__(), then return the result of that method. All other\n"
"return the result of that method. All other types raise a TypeError."); "types raise a TypeError.");
#define OS_FSPATH_METHODDEF \ #define OS_FSPATH_METHODDEF \
{"fspath", (PyCFunction)os_fspath, METH_VARARGS|METH_KEYWORDS, os_fspath__doc__}, {"fspath", (PyCFunction)os_fspath, METH_VARARGS|METH_KEYWORDS, os_fspath__doc__},
...@@ -5984,4 +5984,4 @@ exit: ...@@ -5984,4 +5984,4 @@ exit:
#ifndef OS_SET_HANDLE_INHERITABLE_METHODDEF #ifndef OS_SET_HANDLE_INHERITABLE_METHODDEF
#define OS_SET_HANDLE_INHERITABLE_METHODDEF #define OS_SET_HANDLE_INHERITABLE_METHODDEF
#endif /* !defined(OS_SET_HANDLE_INHERITABLE_METHODDEF) */ #endif /* !defined(OS_SET_HANDLE_INHERITABLE_METHODDEF) */
/*[clinic end generated code: output=31dd4f672c8a6f8c input=a9049054013a1b77]*/ /*[clinic end generated code: output=1b91c3a100e75a4d input=a9049054013a1b77]*/
...@@ -12323,14 +12323,14 @@ os.fspath ...@@ -12323,14 +12323,14 @@ os.fspath
Return the file system path representation of the object. Return the file system path representation of the object.
If the object is str or bytes, then allow it to pass through with If the object is str or bytes, then allow it to pass through as-is. If the
an incremented refcount. If the object defines __fspath__(), then object defines __fspath__(), then return the result of that method. All other
return the result of that method. All other types raise a TypeError. types raise a TypeError.
[clinic start generated code]*/ [clinic start generated code]*/
static PyObject * static PyObject *
os_fspath_impl(PyModuleDef *module, PyObject *path) os_fspath_impl(PyModuleDef *module, PyObject *path)
/*[clinic end generated code: output=51ef0c2772c1932a input=652c7c37e4be1c13]*/ /*[clinic end generated code: output=51ef0c2772c1932a input=e357165f7b22490f]*/
{ {
return PyOS_FSPath(path); return PyOS_FSPath(path);
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment