Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 1 | |
| 2 | :mod:`pathlib` --- Object-oriented filesystem paths |
| 3 | =================================================== |
| 4 | |
| 5 | .. module:: pathlib |
| 6 | :synopsis: Object-oriented filesystem paths |
| 7 | |
| 8 | .. index:: single: path; operations |
| 9 | |
| 10 | .. versionadded:: 3.4 |
| 11 | |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 12 | This module offers classes representing filesystem paths with semantics |
| 13 | appropriate for different operating systems. Path classes are divided |
| 14 | between :ref:`pure paths <pure-paths>`, which provide purely computational |
| 15 | operations without I/O, and :ref:`concrete paths <concrete-paths>`, which |
| 16 | inherit from pure paths but also provide I/O operations. |
| 17 | |
Eli Bendersky | b6e66eb | 2013-11-28 06:53:05 -0800 | [diff] [blame] | 18 | .. image:: pathlib-inheritance.png |
| 19 | :align: center |
| 20 | |
| 21 | If you've never used this module before or just aren't sure which class is |
| 22 | right for your task, :class:`Path` is most likely what you need. It instantiates |
| 23 | a :ref:`concrete path <concrete-paths>` for the platform the code is running on. |
| 24 | |
| 25 | Pure paths are useful in some special cases; for example: |
| 26 | |
| 27 | #. If you want to manipulate Windows paths on a Unix machine (or vice versa). |
| 28 | You cannot instantiate a :class:`WindowsPath` when running on Unix, but you |
| 29 | can instantiate :class:`PureWindowsPath`. |
| 30 | #. You want to make sure that your code only manipulates paths without actually |
| 31 | accessing the OS. In this case, instantiating one of the pure classes may be |
| 32 | useful since those simply don't have any OS-accessing operations. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 33 | |
| 34 | .. note:: |
Andrew Kuchling | 7a4e2d1 | 2013-11-22 15:45:02 -0500 | [diff] [blame] | 35 | This module has been included in the standard library on a |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 36 | :term:`provisional basis <provisional package>`. Backwards incompatible |
| 37 | changes (up to and including removal of the package) may occur if deemed |
| 38 | necessary by the core developers. |
| 39 | |
| 40 | .. seealso:: |
| 41 | :pep:`428`: The pathlib module -- object-oriented filesystem paths. |
| 42 | |
| 43 | .. seealso:: |
| 44 | For low-level path manipulation on strings, you can also use the |
| 45 | :mod:`os.path` module. |
| 46 | |
| 47 | |
| 48 | Basic use |
| 49 | --------- |
| 50 | |
| 51 | Importing the main class:: |
| 52 | |
| 53 | >>> from pathlib import Path |
| 54 | |
| 55 | Listing subdirectories:: |
| 56 | |
| 57 | >>> p = Path('.') |
| 58 | >>> [x for x in p.iterdir() if x.is_dir()] |
| 59 | [PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'), |
| 60 | PosixPath('__pycache__'), PosixPath('build')] |
| 61 | |
| 62 | Listing Python source files in this directory tree:: |
| 63 | |
| 64 | >>> list(p.glob('**/*.py')) |
| 65 | [PosixPath('test_pathlib.py'), PosixPath('setup.py'), |
| 66 | PosixPath('pathlib.py'), PosixPath('docs/conf.py'), |
| 67 | PosixPath('build/lib/pathlib.py')] |
| 68 | |
| 69 | Navigating inside a directory tree:: |
| 70 | |
| 71 | >>> p = Path('/etc') |
| 72 | >>> q = p / 'init.d' / 'reboot' |
| 73 | >>> q |
| 74 | PosixPath('/etc/init.d/reboot') |
| 75 | >>> q.resolve() |
| 76 | PosixPath('/etc/rc.d/init.d/halt') |
| 77 | |
| 78 | Querying path properties:: |
| 79 | |
| 80 | >>> q.exists() |
| 81 | True |
| 82 | >>> q.is_dir() |
| 83 | False |
| 84 | |
| 85 | Opening a file:: |
| 86 | |
| 87 | >>> with q.open() as f: f.readline() |
| 88 | ... |
| 89 | '#!/bin/bash\n' |
| 90 | |
| 91 | |
| 92 | .. _pure-paths: |
| 93 | |
| 94 | Pure paths |
| 95 | ---------- |
| 96 | |
| 97 | Pure path objects provide path-handling operations which don't actually |
| 98 | access a filesystem. There are three ways to access these classes, which |
| 99 | we also call *flavours*: |
| 100 | |
Eli Bendersky | b6e66eb | 2013-11-28 06:53:05 -0800 | [diff] [blame] | 101 | .. class:: PurePath(*pathsegments) |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 102 | |
Eli Bendersky | b6e66eb | 2013-11-28 06:53:05 -0800 | [diff] [blame] | 103 | A generic class that represents the system's path flavour (instantiating |
| 104 | it creates either a :class:`PurePosixPath` or a :class:`PureWindowsPath`):: |
| 105 | |
| 106 | >>> PurePath('setup.py') # Running on a Unix machine |
| 107 | PurePosixPath('setup.py') |
| 108 | |
Antoine Pitrou | 8ad751e | 2015-04-12 00:08:02 +0200 | [diff] [blame] | 109 | Each element of *pathsegments* can be either a string representing a |
| 110 | path segment, or another path object:: |
Eli Bendersky | b6e66eb | 2013-11-28 06:53:05 -0800 | [diff] [blame] | 111 | |
| 112 | >>> PurePath('foo', 'some/path', 'bar') |
| 113 | PurePosixPath('foo/some/path/bar') |
| 114 | >>> PurePath(Path('foo'), Path('bar')) |
| 115 | PurePosixPath('foo/bar') |
| 116 | |
| 117 | When *pathsegments* is empty, the current directory is assumed:: |
| 118 | |
| 119 | >>> PurePath() |
| 120 | PurePosixPath('.') |
| 121 | |
| 122 | When several absolute paths are given, the last is taken as an anchor |
| 123 | (mimicking :func:`os.path.join`'s behaviour):: |
| 124 | |
| 125 | >>> PurePath('/etc', '/usr', 'lib64') |
| 126 | PurePosixPath('/usr/lib64') |
| 127 | >>> PureWindowsPath('c:/Windows', 'd:bar') |
| 128 | PureWindowsPath('d:bar') |
| 129 | |
| 130 | However, in a Windows path, changing the local root doesn't discard the |
| 131 | previous drive setting:: |
| 132 | |
| 133 | >>> PureWindowsPath('c:/Windows', '/Program Files') |
| 134 | PureWindowsPath('c:/Program Files') |
| 135 | |
| 136 | Spurious slashes and single dots are collapsed, but double dots (``'..'``) |
| 137 | are not, since this would change the meaning of a path in the face of |
| 138 | symbolic links:: |
| 139 | |
| 140 | >>> PurePath('foo//bar') |
| 141 | PurePosixPath('foo/bar') |
| 142 | >>> PurePath('foo/./bar') |
| 143 | PurePosixPath('foo/bar') |
| 144 | >>> PurePath('foo/../bar') |
| 145 | PurePosixPath('foo/../bar') |
| 146 | |
| 147 | (a naïve approach would make ``PurePosixPath('foo/../bar')`` equivalent |
| 148 | to ``PurePosixPath('bar')``, which is wrong if ``foo`` is a symbolic link |
| 149 | to another directory) |
| 150 | |
| 151 | .. class:: PurePosixPath(*pathsegments) |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 152 | |
| 153 | A subclass of :class:`PurePath`, this path flavour represents non-Windows |
| 154 | filesystem paths:: |
| 155 | |
| 156 | >>> PurePosixPath('/etc') |
| 157 | PurePosixPath('/etc') |
| 158 | |
Eli Bendersky | b6e66eb | 2013-11-28 06:53:05 -0800 | [diff] [blame] | 159 | *pathsegments* is specified similarly to :class:`PurePath`. |
| 160 | |
| 161 | .. class:: PureWindowsPath(*pathsegments) |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 162 | |
| 163 | A subclass of :class:`PurePath`, this path flavour represents Windows |
| 164 | filesystem paths:: |
| 165 | |
| 166 | >>> PureWindowsPath('c:/Program Files/') |
| 167 | PureWindowsPath('c:/Program Files') |
| 168 | |
Eli Bendersky | b6e66eb | 2013-11-28 06:53:05 -0800 | [diff] [blame] | 169 | *pathsegments* is specified similarly to :class:`PurePath`. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 170 | |
| 171 | Regardless of the system you're running on, you can instantiate all of |
| 172 | these classes, since they don't provide any operation that does system calls. |
| 173 | |
| 174 | |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 175 | General properties |
| 176 | ^^^^^^^^^^^^^^^^^^ |
| 177 | |
| 178 | Paths are immutable and hashable. Paths of a same flavour are comparable |
| 179 | and orderable. These properties respect the flavour's case-folding |
| 180 | semantics:: |
| 181 | |
| 182 | >>> PurePosixPath('foo') == PurePosixPath('FOO') |
| 183 | False |
| 184 | >>> PureWindowsPath('foo') == PureWindowsPath('FOO') |
| 185 | True |
| 186 | >>> PureWindowsPath('FOO') in { PureWindowsPath('foo') } |
| 187 | True |
| 188 | >>> PureWindowsPath('C:') < PureWindowsPath('d:') |
| 189 | True |
| 190 | |
| 191 | Paths of a different flavour compare unequal and cannot be ordered:: |
| 192 | |
| 193 | >>> PureWindowsPath('foo') == PurePosixPath('foo') |
| 194 | False |
| 195 | >>> PureWindowsPath('foo') < PurePosixPath('foo') |
| 196 | Traceback (most recent call last): |
| 197 | File "<stdin>", line 1, in <module> |
| 198 | TypeError: unorderable types: PureWindowsPath() < PurePosixPath() |
| 199 | |
| 200 | |
| 201 | Operators |
| 202 | ^^^^^^^^^ |
| 203 | |
| 204 | The slash operator helps create child paths, similarly to :func:`os.path.join`:: |
| 205 | |
| 206 | >>> p = PurePath('/etc') |
| 207 | >>> p |
| 208 | PurePosixPath('/etc') |
| 209 | >>> p / 'init.d' / 'apache2' |
| 210 | PurePosixPath('/etc/init.d/apache2') |
| 211 | >>> q = PurePath('bin') |
| 212 | >>> '/usr' / q |
| 213 | PurePosixPath('/usr/bin') |
| 214 | |
| 215 | The string representation of a path is the raw filesystem path itself |
| 216 | (in native form, e.g. with backslashes under Windows), which you can |
| 217 | pass to any function taking a file path as a string:: |
| 218 | |
| 219 | >>> p = PurePath('/etc') |
| 220 | >>> str(p) |
| 221 | '/etc' |
| 222 | >>> p = PureWindowsPath('c:/Program Files') |
| 223 | >>> str(p) |
| 224 | 'c:\\Program Files' |
| 225 | |
| 226 | Similarly, calling :class:`bytes` on a path gives the raw filesystem path as a |
| 227 | bytes object, as encoded by :func:`os.fsencode`:: |
| 228 | |
| 229 | >>> bytes(p) |
| 230 | b'/etc' |
| 231 | |
| 232 | .. note:: |
| 233 | Calling :class:`bytes` is only recommended under Unix. Under Windows, |
| 234 | the unicode form is the canonical representation of filesystem paths. |
| 235 | |
| 236 | |
| 237 | Accessing individual parts |
| 238 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 239 | |
| 240 | To access the individual "parts" (components) of a path, use the following |
| 241 | property: |
| 242 | |
| 243 | .. data:: PurePath.parts |
| 244 | |
| 245 | A tuple giving access to the path's various components:: |
| 246 | |
| 247 | >>> p = PurePath('/usr/bin/python3') |
| 248 | >>> p.parts |
| 249 | ('/', 'usr', 'bin', 'python3') |
| 250 | |
| 251 | >>> p = PureWindowsPath('c:/Program Files/PSF') |
| 252 | >>> p.parts |
| 253 | ('c:\\', 'Program Files', 'PSF') |
| 254 | |
| 255 | (note how the drive and local root are regrouped in a single part) |
| 256 | |
| 257 | |
| 258 | Methods and properties |
| 259 | ^^^^^^^^^^^^^^^^^^^^^^ |
| 260 | |
Andrew Kuchling | 7a4e2d1 | 2013-11-22 15:45:02 -0500 | [diff] [blame] | 261 | Pure paths provide the following methods and properties: |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 262 | |
| 263 | .. data:: PurePath.drive |
| 264 | |
| 265 | A string representing the drive letter or name, if any:: |
| 266 | |
| 267 | >>> PureWindowsPath('c:/Program Files/').drive |
| 268 | 'c:' |
| 269 | >>> PureWindowsPath('/Program Files/').drive |
| 270 | '' |
| 271 | >>> PurePosixPath('/etc').drive |
| 272 | '' |
| 273 | |
| 274 | UNC shares are also considered drives:: |
| 275 | |
| 276 | >>> PureWindowsPath('//host/share/foo.txt').drive |
| 277 | '\\\\host\\share' |
| 278 | |
| 279 | .. data:: PurePath.root |
| 280 | |
| 281 | A string representing the (local or global) root, if any:: |
| 282 | |
| 283 | >>> PureWindowsPath('c:/Program Files/').root |
| 284 | '\\' |
| 285 | >>> PureWindowsPath('c:Program Files/').root |
| 286 | '' |
| 287 | >>> PurePosixPath('/etc').root |
| 288 | '/' |
| 289 | |
| 290 | UNC shares always have a root:: |
| 291 | |
| 292 | >>> PureWindowsPath('//host/share').root |
| 293 | '\\' |
| 294 | |
| 295 | .. data:: PurePath.anchor |
| 296 | |
| 297 | The concatenation of the drive and root:: |
| 298 | |
| 299 | >>> PureWindowsPath('c:/Program Files/').anchor |
| 300 | 'c:\\' |
| 301 | >>> PureWindowsPath('c:Program Files/').anchor |
| 302 | 'c:' |
| 303 | >>> PurePosixPath('/etc').anchor |
| 304 | '/' |
| 305 | >>> PureWindowsPath('//host/share').anchor |
| 306 | '\\\\host\\share\\' |
| 307 | |
| 308 | |
| 309 | .. data:: PurePath.parents |
| 310 | |
| 311 | An immutable sequence providing access to the logical ancestors of |
| 312 | the path:: |
| 313 | |
| 314 | >>> p = PureWindowsPath('c:/foo/bar/setup.py') |
| 315 | >>> p.parents[0] |
| 316 | PureWindowsPath('c:/foo/bar') |
| 317 | >>> p.parents[1] |
| 318 | PureWindowsPath('c:/foo') |
| 319 | >>> p.parents[2] |
| 320 | PureWindowsPath('c:/') |
| 321 | |
| 322 | |
| 323 | .. data:: PurePath.parent |
| 324 | |
| 325 | The logical parent of the path:: |
| 326 | |
| 327 | >>> p = PurePosixPath('/a/b/c/d') |
| 328 | >>> p.parent |
| 329 | PurePosixPath('/a/b/c') |
| 330 | |
| 331 | You cannot go past an anchor, or empty path:: |
| 332 | |
| 333 | >>> p = PurePosixPath('/') |
| 334 | >>> p.parent |
| 335 | PurePosixPath('/') |
| 336 | >>> p = PurePosixPath('.') |
| 337 | >>> p.parent |
| 338 | PurePosixPath('.') |
| 339 | |
| 340 | .. note:: |
| 341 | This is a purely lexical operation, hence the following behaviour:: |
| 342 | |
| 343 | >>> p = PurePosixPath('foo/..') |
| 344 | >>> p.parent |
| 345 | PurePosixPath('foo') |
| 346 | |
| 347 | If you want to walk an arbitrary filesystem path upwards, it is |
| 348 | recommended to first call :meth:`Path.resolve` so as to resolve |
| 349 | symlinks and eliminate `".."` components. |
| 350 | |
| 351 | |
| 352 | .. data:: PurePath.name |
| 353 | |
| 354 | A string representing the final path component, excluding the drive and |
| 355 | root, if any:: |
| 356 | |
| 357 | >>> PurePosixPath('my/library/setup.py').name |
| 358 | 'setup.py' |
| 359 | |
| 360 | UNC drive names are not considered:: |
| 361 | |
| 362 | >>> PureWindowsPath('//some/share/setup.py').name |
| 363 | 'setup.py' |
| 364 | >>> PureWindowsPath('//some/share').name |
| 365 | '' |
| 366 | |
| 367 | |
| 368 | .. data:: PurePath.suffix |
| 369 | |
| 370 | The file extension of the final component, if any:: |
| 371 | |
| 372 | >>> PurePosixPath('my/library/setup.py').suffix |
| 373 | '.py' |
| 374 | >>> PurePosixPath('my/library.tar.gz').suffix |
| 375 | '.gz' |
| 376 | >>> PurePosixPath('my/library').suffix |
| 377 | '' |
| 378 | |
| 379 | |
| 380 | .. data:: PurePath.suffixes |
| 381 | |
| 382 | A list of the path's file extensions:: |
| 383 | |
| 384 | >>> PurePosixPath('my/library.tar.gar').suffixes |
| 385 | ['.tar', '.gar'] |
| 386 | >>> PurePosixPath('my/library.tar.gz').suffixes |
| 387 | ['.tar', '.gz'] |
| 388 | >>> PurePosixPath('my/library').suffixes |
| 389 | [] |
| 390 | |
| 391 | |
| 392 | .. data:: PurePath.stem |
| 393 | |
| 394 | The final path component, without its suffix:: |
| 395 | |
| 396 | >>> PurePosixPath('my/library.tar.gz').stem |
| 397 | 'library.tar' |
| 398 | >>> PurePosixPath('my/library.tar').stem |
| 399 | 'library' |
| 400 | >>> PurePosixPath('my/library').stem |
| 401 | 'library' |
| 402 | |
| 403 | |
| 404 | .. method:: PurePath.as_posix() |
| 405 | |
| 406 | Return a string representation of the path with forward slashes (``/``):: |
| 407 | |
| 408 | >>> p = PureWindowsPath('c:\\windows') |
| 409 | >>> str(p) |
| 410 | 'c:\\windows' |
| 411 | >>> p.as_posix() |
| 412 | 'c:/windows' |
| 413 | |
| 414 | |
| 415 | .. method:: PurePath.as_uri() |
| 416 | |
| 417 | Represent the path as a ``file`` URI. :exc:`ValueError` is raised if |
| 418 | the path isn't absolute. |
| 419 | |
| 420 | >>> p = PurePosixPath('/etc/passwd') |
| 421 | >>> p.as_uri() |
| 422 | 'file:///etc/passwd' |
| 423 | >>> p = PureWindowsPath('c:/Windows') |
| 424 | >>> p.as_uri() |
| 425 | 'file:///c:/Windows' |
| 426 | |
| 427 | |
| 428 | .. method:: PurePath.is_absolute() |
| 429 | |
| 430 | Return whether the path is absolute or not. A path is considered absolute |
| 431 | if it has both a root and (if the flavour allows) a drive:: |
| 432 | |
| 433 | >>> PurePosixPath('/a/b').is_absolute() |
| 434 | True |
| 435 | >>> PurePosixPath('a/b').is_absolute() |
| 436 | False |
| 437 | |
| 438 | >>> PureWindowsPath('c:/a/b').is_absolute() |
| 439 | True |
| 440 | >>> PureWindowsPath('/a/b').is_absolute() |
| 441 | False |
| 442 | >>> PureWindowsPath('c:').is_absolute() |
| 443 | False |
| 444 | >>> PureWindowsPath('//some/share').is_absolute() |
| 445 | True |
| 446 | |
| 447 | |
| 448 | .. method:: PurePath.is_reserved() |
| 449 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 450 | With :class:`PureWindowsPath`, return ``True`` if the path is considered |
| 451 | reserved under Windows, ``False`` otherwise. With :class:`PurePosixPath`, |
| 452 | ``False`` is always returned. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 453 | |
| 454 | >>> PureWindowsPath('nul').is_reserved() |
| 455 | True |
| 456 | >>> PurePosixPath('nul').is_reserved() |
| 457 | False |
| 458 | |
| 459 | File system calls on reserved paths can fail mysteriously or have |
| 460 | unintended effects. |
| 461 | |
| 462 | |
| 463 | .. method:: PurePath.joinpath(*other) |
| 464 | |
Andrew Kuchling | 7a4e2d1 | 2013-11-22 15:45:02 -0500 | [diff] [blame] | 465 | Calling this method is equivalent to combining the path with each of |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 466 | the *other* arguments in turn:: |
| 467 | |
| 468 | >>> PurePosixPath('/etc').joinpath('passwd') |
| 469 | PurePosixPath('/etc/passwd') |
| 470 | >>> PurePosixPath('/etc').joinpath(PurePosixPath('passwd')) |
| 471 | PurePosixPath('/etc/passwd') |
| 472 | >>> PurePosixPath('/etc').joinpath('init.d', 'apache2') |
| 473 | PurePosixPath('/etc/init.d/apache2') |
| 474 | >>> PureWindowsPath('c:').joinpath('/Program Files') |
| 475 | PureWindowsPath('c:/Program Files') |
| 476 | |
| 477 | |
| 478 | .. method:: PurePath.match(pattern) |
| 479 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 480 | Match this path against the provided glob-style pattern. Return ``True`` |
| 481 | if matching is successful, ``False`` otherwise. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 482 | |
| 483 | If *pattern* is relative, the path can be either relative or absolute, |
| 484 | and matching is done from the right:: |
| 485 | |
| 486 | >>> PurePath('a/b.py').match('*.py') |
| 487 | True |
| 488 | >>> PurePath('/a/b/c.py').match('b/*.py') |
| 489 | True |
| 490 | >>> PurePath('/a/b/c.py').match('a/*.py') |
| 491 | False |
| 492 | |
| 493 | If *pattern* is absolute, the path must be absolute, and the whole path |
| 494 | must match:: |
| 495 | |
| 496 | >>> PurePath('/a.py').match('/*.py') |
| 497 | True |
| 498 | >>> PurePath('a/b.py').match('/*.py') |
| 499 | False |
| 500 | |
| 501 | As with other methods, case-sensitivity is observed:: |
| 502 | |
| 503 | >>> PureWindowsPath('b.py').match('*.PY') |
| 504 | True |
| 505 | |
| 506 | |
| 507 | .. method:: PurePath.relative_to(*other) |
| 508 | |
| 509 | Compute a version of this path relative to the path represented by |
| 510 | *other*. If it's impossible, ValueError is raised:: |
| 511 | |
| 512 | >>> p = PurePosixPath('/etc/passwd') |
| 513 | >>> p.relative_to('/') |
| 514 | PurePosixPath('etc/passwd') |
| 515 | >>> p.relative_to('/etc') |
| 516 | PurePosixPath('passwd') |
| 517 | >>> p.relative_to('/usr') |
| 518 | Traceback (most recent call last): |
| 519 | File "<stdin>", line 1, in <module> |
| 520 | File "pathlib.py", line 694, in relative_to |
| 521 | .format(str(self), str(formatted))) |
| 522 | ValueError: '/etc/passwd' does not start with '/usr' |
| 523 | |
| 524 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 525 | .. method:: PurePath.with_name(name) |
| 526 | |
| 527 | Return a new path with the :attr:`name` changed. If the original path |
| 528 | doesn't have a name, ValueError is raised:: |
| 529 | |
| 530 | >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz') |
| 531 | >>> p.with_name('setup.py') |
| 532 | PureWindowsPath('c:/Downloads/setup.py') |
| 533 | >>> p = PureWindowsPath('c:/') |
| 534 | >>> p.with_name('setup.py') |
| 535 | Traceback (most recent call last): |
| 536 | File "<stdin>", line 1, in <module> |
| 537 | File "/home/antoine/cpython/default/Lib/pathlib.py", line 751, in with_name |
| 538 | raise ValueError("%r has an empty name" % (self,)) |
| 539 | ValueError: PureWindowsPath('c:/') has an empty name |
| 540 | |
| 541 | |
| 542 | .. method:: PurePath.with_suffix(suffix) |
| 543 | |
| 544 | Return a new path with the :attr:`suffix` changed. If the original path |
| 545 | doesn't have a suffix, the new *suffix* is appended instead:: |
| 546 | |
| 547 | >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz') |
| 548 | >>> p.with_suffix('.bz2') |
| 549 | PureWindowsPath('c:/Downloads/pathlib.tar.bz2') |
| 550 | >>> p = PureWindowsPath('README') |
| 551 | >>> p.with_suffix('.txt') |
| 552 | PureWindowsPath('README.txt') |
| 553 | |
| 554 | |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 555 | .. _concrete-paths: |
| 556 | |
| 557 | |
| 558 | Concrete paths |
| 559 | -------------- |
| 560 | |
| 561 | Concrete paths are subclasses of the pure path classes. In addition to |
| 562 | operations provided by the latter, they also provide methods to do system |
| 563 | calls on path objects. There are three ways to instantiate concrete paths: |
| 564 | |
Eli Bendersky | b6e66eb | 2013-11-28 06:53:05 -0800 | [diff] [blame] | 565 | .. class:: Path(*pathsegments) |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 566 | |
| 567 | A subclass of :class:`PurePath`, this class represents concrete paths of |
| 568 | the system's path flavour (instantiating it creates either a |
| 569 | :class:`PosixPath` or a :class:`WindowsPath`):: |
| 570 | |
| 571 | >>> Path('setup.py') |
| 572 | PosixPath('setup.py') |
| 573 | |
Eli Bendersky | b6e66eb | 2013-11-28 06:53:05 -0800 | [diff] [blame] | 574 | *pathsegments* is specified similarly to :class:`PurePath`. |
| 575 | |
| 576 | .. class:: PosixPath(*pathsegments) |
| 577 | |
| 578 | A subclass of :class:`Path` and :class:`PurePosixPath`, this class |
| 579 | represents concrete non-Windows filesystem paths:: |
| 580 | |
| 581 | >>> PosixPath('/etc') |
| 582 | PosixPath('/etc') |
| 583 | |
| 584 | *pathsegments* is specified similarly to :class:`PurePath`. |
| 585 | |
| 586 | .. class:: WindowsPath(*pathsegments) |
| 587 | |
| 588 | A subclass of :class:`Path` and :class:`PureWindowsPath`, this class |
| 589 | represents concrete Windows filesystem paths:: |
| 590 | |
| 591 | >>> WindowsPath('c:/Program Files/') |
| 592 | WindowsPath('c:/Program Files') |
| 593 | |
| 594 | *pathsegments* is specified similarly to :class:`PurePath`. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 595 | |
| 596 | You can only instantiate the class flavour that corresponds to your system |
| 597 | (allowing system calls on non-compatible path flavours could lead to |
| 598 | bugs or failures in your application):: |
| 599 | |
| 600 | >>> import os |
| 601 | >>> os.name |
| 602 | 'posix' |
| 603 | >>> Path('setup.py') |
| 604 | PosixPath('setup.py') |
| 605 | >>> PosixPath('setup.py') |
| 606 | PosixPath('setup.py') |
| 607 | >>> WindowsPath('setup.py') |
| 608 | Traceback (most recent call last): |
| 609 | File "<stdin>", line 1, in <module> |
| 610 | File "pathlib.py", line 798, in __new__ |
| 611 | % (cls.__name__,)) |
| 612 | NotImplementedError: cannot instantiate 'WindowsPath' on your system |
| 613 | |
| 614 | |
| 615 | Methods |
| 616 | ^^^^^^^ |
| 617 | |
| 618 | Concrete paths provide the following methods in addition to pure paths |
| 619 | methods. Many of these methods can raise an :exc:`OSError` if a system |
| 620 | call fails (for example because the path doesn't exist): |
| 621 | |
| 622 | .. classmethod:: Path.cwd() |
| 623 | |
| 624 | Return a new path object representing the current directory (as returned |
| 625 | by :func:`os.getcwd`):: |
| 626 | |
| 627 | >>> Path.cwd() |
| 628 | PosixPath('/home/antoine/pathlib') |
| 629 | |
| 630 | |
| 631 | .. method:: Path.stat() |
| 632 | |
| 633 | Return information about this path (similarly to :func:`os.stat`). |
| 634 | The result is looked up at each call to this method. |
| 635 | |
| 636 | >>> p = Path('setup.py') |
| 637 | >>> p.stat().st_size |
| 638 | 956 |
| 639 | >>> p.stat().st_mtime |
| 640 | 1327883547.852554 |
| 641 | |
| 642 | |
| 643 | .. method:: Path.chmod(mode) |
| 644 | |
| 645 | Change the file mode and permissions, like :func:`os.chmod`:: |
| 646 | |
| 647 | >>> p = Path('setup.py') |
| 648 | >>> p.stat().st_mode |
| 649 | 33277 |
| 650 | >>> p.chmod(0o444) |
| 651 | >>> p.stat().st_mode |
| 652 | 33060 |
| 653 | |
| 654 | |
| 655 | .. method:: Path.exists() |
| 656 | |
| 657 | Whether the path points to an existing file or directory:: |
| 658 | |
| 659 | >>> Path('.').exists() |
| 660 | True |
| 661 | >>> Path('setup.py').exists() |
| 662 | True |
| 663 | >>> Path('/etc').exists() |
| 664 | True |
| 665 | >>> Path('nonexistentfile').exists() |
| 666 | False |
| 667 | |
| 668 | .. note:: |
| 669 | If the path points to a symlink, :meth:`exists` returns whether the |
| 670 | symlink *points to* an existing file or directory. |
| 671 | |
| 672 | |
| 673 | .. method:: Path.glob(pattern) |
| 674 | |
| 675 | Glob the given *pattern* in the directory represented by this path, |
| 676 | yielding all matching files (of any kind):: |
| 677 | |
| 678 | >>> sorted(Path('.').glob('*.py')) |
| 679 | [PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')] |
| 680 | >>> sorted(Path('.').glob('*/*.py')) |
| 681 | [PosixPath('docs/conf.py')] |
| 682 | |
| 683 | The "``**``" pattern means "this directory and all subdirectories, |
| 684 | recursively". In other words, it enables recursive globbing:: |
| 685 | |
| 686 | >>> sorted(Path('.').glob('**/*.py')) |
| 687 | [PosixPath('build/lib/pathlib.py'), |
| 688 | PosixPath('docs/conf.py'), |
| 689 | PosixPath('pathlib.py'), |
| 690 | PosixPath('setup.py'), |
| 691 | PosixPath('test_pathlib.py')] |
| 692 | |
| 693 | .. note:: |
| 694 | Using the "``**``" pattern in large directory trees may consume |
| 695 | an inordinate amount of time. |
| 696 | |
| 697 | |
| 698 | .. method:: Path.group() |
| 699 | |
Ned Deily | c034156 | 2013-11-27 14:42:55 -0800 | [diff] [blame] | 700 | Return the name of the group owning the file. :exc:`KeyError` is raised |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 701 | if the file's gid isn't found in the system database. |
| 702 | |
| 703 | |
| 704 | .. method:: Path.is_dir() |
| 705 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 706 | Return ``True`` if the path points to a directory (or a symbolic link |
| 707 | pointing to a directory), ``False`` if it points to another kind of file. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 708 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 709 | ``False`` is also returned if the path doesn't exist or is a broken symlink; |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 710 | other errors (such as permission errors) are propagated. |
| 711 | |
| 712 | |
| 713 | .. method:: Path.is_file() |
| 714 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 715 | Return ``True`` if the path points to a regular file (or a symbolic link |
| 716 | pointing to a regular file), ``False`` if it points to another kind of file. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 717 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 718 | ``False`` is also returned if the path doesn't exist or is a broken symlink; |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 719 | other errors (such as permission errors) are propagated. |
| 720 | |
| 721 | |
| 722 | .. method:: Path.is_symlink() |
| 723 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 724 | Return ``True`` if the path points to a symbolic link, ``False`` otherwise. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 725 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 726 | ``False`` is also returned if the path doesn't exist; other errors (such |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 727 | as permission errors) are propagated. |
| 728 | |
| 729 | |
| 730 | .. method:: Path.is_socket() |
| 731 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 732 | Return ``True`` if the path points to a Unix socket (or a symbolic link |
| 733 | pointing to a Unix socket), ``False`` if it points to another kind of file. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 734 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 735 | ``False`` is also returned if the path doesn't exist or is a broken symlink; |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 736 | other errors (such as permission errors) are propagated. |
| 737 | |
| 738 | |
| 739 | .. method:: Path.is_fifo() |
| 740 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 741 | Return ``True`` if the path points to a FIFO (or a symbolic link |
| 742 | pointing to a FIFO), ``False`` if it points to another kind of file. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 743 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 744 | ``False`` is also returned if the path doesn't exist or is a broken symlink; |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 745 | other errors (such as permission errors) are propagated. |
| 746 | |
| 747 | |
| 748 | .. method:: Path.is_block_device() |
| 749 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 750 | Return ``True`` if the path points to a block device (or a symbolic link |
| 751 | pointing to a block device), ``False`` if it points to another kind of file. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 752 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 753 | ``False`` is also returned if the path doesn't exist or is a broken symlink; |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 754 | other errors (such as permission errors) are propagated. |
| 755 | |
| 756 | |
| 757 | .. method:: Path.is_char_device() |
| 758 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 759 | Return ``True`` if the path points to a character device (or a symbolic link |
| 760 | pointing to a character device), ``False`` if it points to another kind of file. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 761 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 762 | ``False`` is also returned if the path doesn't exist or is a broken symlink; |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 763 | other errors (such as permission errors) are propagated. |
| 764 | |
| 765 | |
| 766 | .. method:: Path.iterdir() |
| 767 | |
| 768 | When the path points to a directory, yield path objects of the directory |
| 769 | contents:: |
| 770 | |
| 771 | >>> p = Path('docs') |
| 772 | >>> for child in p.iterdir(): child |
| 773 | ... |
| 774 | PosixPath('docs/conf.py') |
| 775 | PosixPath('docs/_templates') |
| 776 | PosixPath('docs/make.bat') |
| 777 | PosixPath('docs/index.rst') |
| 778 | PosixPath('docs/_build') |
| 779 | PosixPath('docs/_static') |
| 780 | PosixPath('docs/Makefile') |
| 781 | |
| 782 | .. method:: Path.lchmod(mode) |
| 783 | |
| 784 | Like :meth:`Path.chmod` but, if the path points to a symbolic link, the |
| 785 | symbolic link's mode is changed rather than its target's. |
| 786 | |
| 787 | |
| 788 | .. method:: Path.lstat() |
| 789 | |
| 790 | Like :meth:`Path.stat` but, if the path points to a symbolic link, return |
| 791 | the symbolic link's information rather than its target's. |
| 792 | |
| 793 | |
| 794 | .. method:: Path.mkdir(mode=0o777, parents=False) |
| 795 | |
| 796 | Create a new directory at this given path. If *mode* is given, it is |
| 797 | combined with the process' ``umask`` value to determine the file mode |
Antoine Pitrou | f6abb70 | 2013-12-16 21:00:53 +0100 | [diff] [blame] | 798 | and access flags. If the path already exists, :exc:`FileExistsError` |
| 799 | is raised. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 800 | |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 801 | If *parents* is true, any missing parents of this path are created |
Antoine Pitrou | 0048c98 | 2013-12-16 20:22:37 +0100 | [diff] [blame] | 802 | as needed; they are created with the default permissions without taking |
| 803 | *mode* into account (mimicking the POSIX ``mkdir -p`` command). |
| 804 | |
| 805 | If *parents* is false (the default), a missing parent raises |
Antoine Pitrou | f6abb70 | 2013-12-16 21:00:53 +0100 | [diff] [blame] | 806 | :exc:`FileNotFoundError`. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 807 | |
| 808 | |
| 809 | .. method:: Path.open(mode='r', buffering=-1, encoding=None, errors=None, newline=None) |
| 810 | |
| 811 | Open the file pointed to by the path, like the built-in :func:`open` |
| 812 | function does:: |
| 813 | |
| 814 | >>> p = Path('setup.py') |
| 815 | >>> with p.open() as f: |
| 816 | ... f.readline() |
| 817 | ... |
| 818 | '#!/usr/bin/env python3\n' |
| 819 | |
| 820 | |
| 821 | .. method:: Path.owner() |
| 822 | |
Ned Deily | c034156 | 2013-11-27 14:42:55 -0800 | [diff] [blame] | 823 | Return the name of the user owning the file. :exc:`KeyError` is raised |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 824 | if the file's uid isn't found in the system database. |
| 825 | |
| 826 | |
| 827 | .. method:: Path.rename(target) |
| 828 | |
| 829 | Rename this file or directory to the given *target*. *target* can be |
| 830 | either a string or another path object:: |
| 831 | |
| 832 | >>> p = Path('foo') |
| 833 | >>> p.open('w').write('some text') |
| 834 | 9 |
| 835 | >>> target = Path('bar') |
| 836 | >>> p.rename(target) |
| 837 | >>> target.open().read() |
| 838 | 'some text' |
| 839 | |
| 840 | |
| 841 | .. method:: Path.replace(target) |
| 842 | |
| 843 | Rename this file or directory to the given *target*. If *target* points |
| 844 | to an existing file or directory, it will be unconditionally replaced. |
| 845 | |
| 846 | |
| 847 | .. method:: Path.resolve() |
| 848 | |
| 849 | Make the path absolute, resolving any symlinks. A new path object is |
| 850 | returned:: |
| 851 | |
| 852 | >>> p = Path() |
| 853 | >>> p |
| 854 | PosixPath('.') |
| 855 | >>> p.resolve() |
| 856 | PosixPath('/home/antoine/pathlib') |
| 857 | |
| 858 | `".."` components are also eliminated (this is the only method to do so):: |
| 859 | |
| 860 | >>> p = Path('docs/../setup.py') |
| 861 | >>> p.resolve() |
| 862 | PosixPath('/home/antoine/pathlib/setup.py') |
| 863 | |
| 864 | If the path doesn't exist, :exc:`FileNotFoundError` is raised. If an |
| 865 | infinite loop is encountered along the resolution path, |
| 866 | :exc:`RuntimeError` is raised. |
| 867 | |
| 868 | |
| 869 | .. method:: Path.rglob(pattern) |
| 870 | |
| 871 | This is like calling :meth:`glob` with "``**``" added in front of the |
| 872 | given *pattern*: |
| 873 | |
| 874 | >>> sorted(Path().rglob("*.py")) |
| 875 | [PosixPath('build/lib/pathlib.py'), |
| 876 | PosixPath('docs/conf.py'), |
| 877 | PosixPath('pathlib.py'), |
| 878 | PosixPath('setup.py'), |
| 879 | PosixPath('test_pathlib.py')] |
| 880 | |
| 881 | |
| 882 | .. method:: Path.rmdir() |
| 883 | |
| 884 | Remove this directory. The directory must be empty. |
| 885 | |
| 886 | |
| 887 | .. method:: Path.symlink_to(target, target_is_directory=False) |
| 888 | |
| 889 | Make this path a symbolic link to *target*. Under Windows, |
Serhiy Storchaka | 03cc565 | 2013-11-26 21:37:12 +0200 | [diff] [blame] | 890 | *target_is_directory* must be true (default ``False``) if the link's target |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 891 | is a directory. Under POSIX, *target_is_directory*'s value is ignored. |
| 892 | |
| 893 | >>> p = Path('mylink') |
| 894 | >>> p.symlink_to('setup.py') |
| 895 | >>> p.resolve() |
| 896 | PosixPath('/home/antoine/pathlib/setup.py') |
| 897 | >>> p.stat().st_size |
| 898 | 956 |
| 899 | >>> p.lstat().st_size |
| 900 | 8 |
| 901 | |
| 902 | .. note:: |
| 903 | The order of arguments (link, target) is the reverse |
| 904 | of :func:`os.symlink`'s. |
| 905 | |
| 906 | |
| 907 | .. method:: Path.touch(mode=0o777, exist_ok=True) |
| 908 | |
| 909 | Create a file at this given path. If *mode* is given, it is combined |
| 910 | with the process' ``umask`` value to determine the file mode and access |
| 911 | flags. If the file already exists, the function succeeds if *exist_ok* |
| 912 | is true (and its modification time is updated to the current time), |
Antoine Pitrou | f6abb70 | 2013-12-16 21:00:53 +0100 | [diff] [blame] | 913 | otherwise :exc:`FileExistsError` is raised. |
Antoine Pitrou | 31119e4 | 2013-11-22 17:38:12 +0100 | [diff] [blame] | 914 | |
| 915 | |
| 916 | .. method:: Path.unlink() |
| 917 | |
| 918 | Remove this file or symbolic link. If the path points to a directory, |
| 919 | use :func:`Path.rmdir` instead. |