changeset:   99785:408f8b255b56
branch:      3.5
parent:      99782:9c49c417a68a
parent:      99784:2e3c31ab586a
user:        Guido van Rossum <guido@python.org>
date:        Wed Jan 06 11:16:28 2016 -0800
files:       Doc/library/pathlib.rst
description:
Docs for issue #22570. (Merge 3.4->3.5)


diff -r 9c49c417a68a -r 408f8b255b56 Doc/library/pathlib.rst
--- a/Doc/library/pathlib.rst	Wed Jan 06 11:03:15 2016 -0800
+++ b/Doc/library/pathlib.rst	Wed Jan 06 11:16:28 2016 -0800
@@ -365,6 +365,23 @@
       ''
 
 
+.. data:: PurePath.path
+
+   A string representing the full path::
+
+      >>> PurePosixPath('my/library/setup.py').path
+      'my/library/setup.py'
+
+   This always returns the same value as ``str(p)``; it is included to
+   serve as a one-off protocol.  Code that wants to support both
+   strings and ``pathlib.Path`` objects as filenames can write
+   ``arg = getattr(arg, 'path', arg)`` to get the path as a string.
+   This can then be passed to various system calls or library
+   functions that expect a string.  Unlike the alternative
+   ``arg = str(arg)``, this will still raise an exception if an object
+   of some other type is given by accident.
+
+
 .. data:: PurePath.suffix
 
    The file extension of the final component, if any::