pathlib
— Object-oriented filesystem paths¶
Added in version 3.4.
Source code: Lib/pathlib/
Este módulo ofrece clases que representan rutas del sistema de archivos con semántica apropiada para diferentes sistemas operativos. Las clases ruta se dividen entre rutas puras, que proporcionan operaciones puramente computacionales sin E/S; y rutas concretas, que heredan de rutas puras pero también proporcionan operaciones de E/S.
Si nunca has usado este módulo o simplemente no estás seguro de qué clase es la adecuada para tu tarea, Path
es probablemente lo que necesitas. Crea una instancia ruta concreta para la plataforma en la que se ejecuta el código.
Las rutas puras son útiles en algunos casos especiales, por ejemplo:
Si deseas manipular las rutas de Windows en una máquina Unix (o viceversa). No puedes crear una instancia de
WindowsPath
cuando se ejecuta en Unix, pero puedes crear una instancia dePureWindowsPath
.Desea asegurar que su código solo manipule rutas sin acceder realmente al sistema operativo. En este caso, crear instancias de una de las clases puras puede ser útil, ya que simplemente no tienen ninguna operación de acceso al sistema operativo.
Ver también
PEP 428: El módulo pathlib – rutas de sistema orientadas a objetos.
Ver también
Para la manipulación de rutas de bajo nivel en cadenas, también puede usar el módulo os.path
.
Uso básico¶
Importar la clase principal:
>>> from pathlib import Path
Listado de subdirectorios:
>>> p = Path('.')
>>> [x for x in p.iterdir() if x.is_dir()]
[PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'),
PosixPath('__pycache__'), PosixPath('build')]
Listado de archivos fuente de Python en este árbol de directorios:
>>> list(p.glob('**/*.py'))
[PosixPath('test_pathlib.py'), PosixPath('setup.py'),
PosixPath('pathlib.py'), PosixPath('docs/conf.py'),
PosixPath('build/lib/pathlib.py')]
Navegar dentro de un árbol de directorios:
>>> p = Path('/etc')
>>> q = p / 'init.d' / 'reboot'
>>> q
PosixPath('/etc/init.d/reboot')
>>> q.resolve()
PosixPath('/etc/rc.d/init.d/halt')
Consultar propiedades de ruta:
>>> q.exists()
True
>>> q.is_dir()
False
Abrir un archivo:
>>> with q.open() as f: f.readline()
...
'#!/bin/bash\n'
Exceptions¶
- exception pathlib.UnsupportedOperation¶
An exception inheriting
NotImplementedError
that is raised when an unsupported operation is called on a path object.Added in version 3.13.
Rutas puras¶
Los objetos ruta pura proporcionan operaciones de manejo de rutas que en realidad no acceden al sistema de archivos. Hay tres formas de acceder a estas clases, que llamaremos familias:
- class pathlib.PurePath(*pathsegments)¶
Una clase genérica que representa la familia de rutas del sistema (al crear una instancia se crea
PurePosixPath
oPureWindowsPath
):>>> PurePath('setup.py') # Running on a Unix machine PurePosixPath('setup.py')
Each element of pathsegments can be either a string representing a path segment, or an object implementing the
os.PathLike
interface where the__fspath__()
method returns a string, such as another path object:>>> PurePath('foo', 'some/path', 'bar') PurePosixPath('foo/some/path/bar') >>> PurePath(Path('foo'), Path('bar')) PurePosixPath('foo/bar')
Cuando pathsegments está vacío, se asume el directorio actual:
>>> PurePath() PurePosixPath('.')
If a segment is an absolute path, all previous segments are ignored (like
os.path.join()
):>>> PurePath('/etc', '/usr', 'lib64') PurePosixPath('/usr/lib64') >>> PureWindowsPath('c:/Windows', 'd:bar') PureWindowsPath('d:bar')
On Windows, the drive is not reset when a rooted relative path segment (e.g.,
r'\foo'
) is encountered:>>> PureWindowsPath('c:/Windows', '/Program Files') PureWindowsPath('c:/Program Files')
Las barras espurias y los puntos simples se colapsan, pero los puntos dobles (
'..'
) y las barras dobles iniciales ('//'
) no, ya que esto cambiaría el significado de una ruta por varias razones (por ejemplo, enlaces simbólicos, rutas UNC):>>> PurePath('foo//bar') PurePosixPath('foo/bar') >>> PurePath('//foo/bar') PurePosixPath('//foo/bar') >>> PurePath('foo/./bar') PurePosixPath('foo/bar') >>> PurePath('foo/../bar') PurePosixPath('foo/../bar')
(un enfoque naif haría pensar que
PurePosixPath('foo/../bar')
es equivalente aPurePosixPath('bar')
, lo cual es incorrecto sifoo
es un enlace simbólico a otro directorio)Los objetos ruta pura implementan la interfaz
os.PathLike
, lo que permite su uso en cualquier lugar donde se acepte la interfaz.Distinto en la versión 3.6: Se agregó soporte para la interfaz
os.PathLike
.
- class pathlib.PurePosixPath(*pathsegments)¶
Una subclase de
PurePath
, esta familia representa rutas que no son del sistema de archivos de Windows:>>> PurePosixPath('/etc/hosts') PurePosixPath('/etc/hosts')
pathsegments se especifica de manera similar a
PurePath
.
- class pathlib.PureWindowsPath(*pathsegments)¶
Una subclase de
PurePath
, este tipo de ruta representa las rutas del sistema de archivos de Windows, incluido UNC paths:>>> PureWindowsPath('c:/', 'Users', 'Ximénez') PureWindowsPath('c:/Users/Ximénez') >>> PureWindowsPath('//server/share/file') PureWindowsPath('//server/share/file')
pathsegments se especifica de manera similar a
PurePath
.
Independientemente del sistema en el que se encuentre, puede crear instancias de todas estas clases, ya que no proporcionan ninguna operación que llame al sistema operativo.
Propiedades generales¶
Paths are immutable and hashable. Paths of a same flavour are comparable and orderable. These properties respect the flavour’s case-folding semantics:
>>> PurePosixPath('foo') == PurePosixPath('FOO')
False
>>> PureWindowsPath('foo') == PureWindowsPath('FOO')
True
>>> PureWindowsPath('FOO') in { PureWindowsPath('foo') }
True
>>> PureWindowsPath('C:') < PureWindowsPath('d:')
True
Rutas de diferentes familias no son iguales y no se pueden ordenar:
>>> PureWindowsPath('foo') == PurePosixPath('foo')
False
>>> PureWindowsPath('foo') < PurePosixPath('foo')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: '<' not supported between instances of 'PureWindowsPath' and 'PurePosixPath'
Operadores¶
The slash operator helps create child paths, like os.path.join()
.
If the argument is an absolute path, the previous path is ignored.
On Windows, the drive is not reset when the argument is a rooted
relative path (e.g., r'\foo'
):
>>> p = PurePath('/etc')
>>> p
PurePosixPath('/etc')
>>> p / 'init.d' / 'apache2'
PurePosixPath('/etc/init.d/apache2')
>>> q = PurePath('bin')
>>> '/usr' / q
PurePosixPath('/usr/bin')
>>> p / '/an_absolute_path'
PurePosixPath('/an_absolute_path')
>>> PureWindowsPath('c:/Windows', '/Program Files')
PureWindowsPath('c:/Program Files')
Se puede usar un objeto ruta en cualquier lugar donde se acepte un objeto que implemente os.PathLike
:
>>> import os
>>> p = PurePath('/etc')
>>> os.fspath(p)
'/etc'
La representación de una ruta en una cadena de caracteres es la ruta del sistema de archivos sin procesar en sí (en forma nativa, por ejemplo con barras invertidas en Windows), y que puede pasar a cualquier función que tome una ruta como una cadena de caracteres:
>>> p = PurePath('/etc')
>>> str(p)
'/etc'
>>> p = PureWindowsPath('c:/Program Files')
>>> str(p)
'c:\\Program Files'
Del mismo modo, llamar a bytes
en una ruta proporciona la ruta cruda del sistema de archivos como un objeto bytes, codificado por os.fsencode()
:
>>> bytes(p)
b'/etc'
Nota
Llamar a bytes
solo se recomienda en Unix. En Windows, la forma unicode es la representación canónica de las rutas del sistema de archivos.
Acceso a partes individuales¶
Para acceder a las «partes» (componentes) individuales de una ruta, use la siguiente propiedad:
- PurePath.parts¶
Una tupla que da acceso a los diversos componentes de la ruta:
>>> p = PurePath('/usr/bin/python3') >>> p.parts ('/', 'usr', 'bin', 'python3') >>> p = PureWindowsPath('c:/Program Files/PSF') >>> p.parts ('c:\\', 'Program Files', 'PSF')
(obsérvese cómo la unidad y la raíz local se reagrupan en una sola parte)
Métodos y propiedades¶
Las rutas puras proporcionan los siguientes métodos y propiedades:
- PurePath.parser¶
The implementation of the
os.path
module used for low-level path parsing and joining: eitherposixpath
orntpath
.Added in version 3.13.
- PurePath.drive¶
Una cadena que representa la letra o el nombre de la unidad, si corresponde:
>>> PureWindowsPath('c:/Program Files/').drive 'c:' >>> PureWindowsPath('/Program Files/').drive '' >>> PurePosixPath('/etc').drive ''
Las localizaciones UNC también son consideradas como unidades:
>>> PureWindowsPath('//host/share/foo.txt').drive '\\\\host\\share'
- PurePath.root¶
Una cadena que representa la raíz (local o global), si la hay:
>>> PureWindowsPath('c:/Program Files/').root '\\' >>> PureWindowsPath('c:Program Files/').root '' >>> PurePosixPath('/etc').root '/'
Las localizaciones UNC siempre tienen una raíz:
>>> PureWindowsPath('//host/share').root '\\'
Si la ruta comienza con más de dos barras diagonales sucesivas,
PurePosixPath
las contrae:>>> PurePosixPath('//etc').root '//' >>> PurePosixPath('///etc').root '/' >>> PurePosixPath('////etc').root '/'
Nota
Este comportamiento se ajusta a The Open Group Base Specifications Issue 6, párrafo 4.11 Pathname Resolution:
«Un nombre de ruta que comienza con dos barras oblicuas sucesivas se puede interpretar de una manera definida por la implementación, aunque más de dos barras oblicuas iniciales se tratarán como una sola barra oblicua.»
- PurePath.anchor¶
La concatenación de la unidad y la raíz:
>>> PureWindowsPath('c:/Program Files/').anchor 'c:\\' >>> PureWindowsPath('c:Program Files/').anchor 'c:' >>> PurePosixPath('/etc').anchor '/' >>> PureWindowsPath('//host/share').anchor '\\\\host\\share\\'
- PurePath.parents¶
Una secuencia inmutable que proporciona acceso a los ancestros lógicos de la ruta:
>>> p = PureWindowsPath('c:/foo/bar/setup.py') >>> p.parents[0] PureWindowsPath('c:/foo/bar') >>> p.parents[1] PureWindowsPath('c:/foo') >>> p.parents[2] PureWindowsPath('c:/')
Distinto en la versión 3.10: La secuencia de padres ahora admite rebanada y valores de índice negativos.
- PurePath.parent¶
El padre lógico de la ruta
>>> p = PurePosixPath('/a/b/c/d') >>> p.parent PurePosixPath('/a/b/c')
No puede ir más allá de un ancla o una ruta vacía:
>>> p = PurePosixPath('/') >>> p.parent PurePosixPath('/') >>> p = PurePosixPath('.') >>> p.parent PurePosixPath('.')
Nota
Esta es una operación puramente léxica, de ahí el siguiente comportamiento:
>>> p = PurePosixPath('foo/..') >>> p.parent PurePosixPath('foo')
Si desea recorrer una ruta de sistema de archivos arbitraria hacia arriba, se recomienda llamar primero a
Path.resolve()
para resolver los enlaces simbólicos y eliminar los componentes".."
.
- PurePath.name¶
Una cadena que representa el componente final de la ruta, excluyendo la unidad y la raíz, si hay alguna:
>>> PurePosixPath('my/library/setup.py').name 'setup.py'
Los nombres de unidad UNC no se consideran:
>>> PureWindowsPath('//some/share/setup.py').name 'setup.py' >>> PureWindowsPath('//some/share').name ''
- PurePath.suffix¶
The last dot-separated portion of the final component, if any:
>>> PurePosixPath('my/library/setup.py').suffix '.py' >>> PurePosixPath('my/library.tar.gz').suffix '.gz' >>> PurePosixPath('my/library').suffix ''
This is commonly called the file extension.
- PurePath.suffixes¶
A list of the path’s suffixes, often called file extensions:
>>> PurePosixPath('my/library.tar.gar').suffixes ['.tar', '.gar'] >>> PurePosixPath('my/library.tar.gz').suffixes ['.tar', '.gz'] >>> PurePosixPath('my/library').suffixes []
- PurePath.stem¶
El componente final de la ruta, sin su sufijo:
>>> PurePosixPath('my/library.tar.gz').stem 'library.tar' >>> PurePosixPath('my/library.tar').stem 'library' >>> PurePosixPath('my/library').stem 'library'
- PurePath.as_posix()¶
Retorna una cadena que representa la ruta con barras invertidas (
/
):>>> p = PureWindowsPath('c:\\windows') >>> str(p) 'c:\\windows' >>> p.as_posix() 'c:/windows'
- PurePath.is_absolute()¶
Retorna si la ruta es absoluta o no. Una ruta se considera absoluta si tiene una raíz y (si la familia lo permite) una unidad:
>>> PurePosixPath('/a/b').is_absolute() True >>> PurePosixPath('a/b').is_absolute() False >>> PureWindowsPath('c:/a/b').is_absolute() True >>> PureWindowsPath('/a/b').is_absolute() False >>> PureWindowsPath('c:').is_absolute() False >>> PureWindowsPath('//some/share').is_absolute() True
- PurePath.is_relative_to(other)¶
Retorna si esta ruta es relativa o no a la otra ruta.
>>> p = PurePath('/etc/passwd') >>> p.is_relative_to('/etc') True >>> p.is_relative_to('/usr') False
This method is string-based; it neither accesses the filesystem nor treats «
..
» segments specially. The following code is equivalent:>>> u = PurePath('/usr') >>> u == p or u in p.parents False
Added in version 3.9.
Deprecated since version 3.12, will be removed in version 3.14: Passing additional arguments is deprecated; if supplied, they are joined with other.
- PurePath.is_reserved()¶
Con
PureWindowsPath
, retornaTrue
si la ruta se considera reservada en Windows,False
en caso contrario. ConPurePosixPath
, siempre retornaFalse
.Distinto en la versión 3.13: Windows path names that contain a colon, or end with a dot or a space, are considered reserved. UNC paths may be reserved.
Deprecated since version 3.13, will be removed in version 3.15: This method is deprecated; use
os.path.isreserved()
to detect reserved paths on Windows.
- PurePath.joinpath(*pathsegments)¶
Calling this method is equivalent to combining the path with each of the given pathsegments in turn:
>>> PurePosixPath('/etc').joinpath('passwd') PurePosixPath('/etc/passwd') >>> PurePosixPath('/etc').joinpath(PurePosixPath('passwd')) PurePosixPath('/etc/passwd') >>> PurePosixPath('/etc').joinpath('init.d', 'apache2') PurePosixPath('/etc/init.d/apache2') >>> PureWindowsPath('c:').joinpath('/Program Files') PureWindowsPath('c:/Program Files')
- PurePath.full_match(pattern, *, case_sensitive=None)¶
Match this path against the provided glob-style pattern. Return
True
if matching is successful,False
otherwise. For example:>>> PurePath('a/b.py').full_match('a/*.py') True >>> PurePath('a/b.py').full_match('*.py') False >>> PurePath('/a/b/c.py').full_match('/a/**') True >>> PurePath('/a/b/c.py').full_match('**/*.py') True
Ver también
Pattern language documentation.
Al igual que con otros métodos, la distinción entre mayúsculas y minúsculas sigue los valores predeterminados de la plataforma:
>>> PurePosixPath('b.py').full_match('*.PY') False >>> PureWindowsPath('b.py').full_match('*.PY') True
Set case_sensitive to
True
orFalse
to override this behaviour.Added in version 3.13.
- PurePath.match(pattern, *, case_sensitive=None)¶
Match this path against the provided non-recursive glob-style pattern. Return
True
if matching is successful,False
otherwise.This method is similar to
full_match()
, but empty patterns aren’t allowed (ValueError
is raised), the recursive wildcard «**
» isn’t supported (it acts like non-recursive «*
»), and if a relative pattern is provided, then matching is done from the right:>>> PurePath('a/b.py').match('*.py') True >>> PurePath('/a/b/c.py').match('b/*.py') True >>> PurePath('/a/b/c.py').match('a/*.py') False
Distinto en la versión 3.12: The pattern parameter accepts a path-like object.
Distinto en la versión 3.12: The case_sensitive parameter was added.
- PurePath.relative_to(other, walk_up=False)¶
Compute a version of this path relative to the path represented by other. If it’s impossible,
ValueError
is raised:>>> p = PurePosixPath('/etc/passwd') >>> p.relative_to('/') PurePosixPath('etc/passwd') >>> p.relative_to('/etc') PurePosixPath('passwd') >>> p.relative_to('/usr') Traceback (most recent call last): File "<stdin>", line 1, in <module> File "pathlib.py", line 941, in relative_to raise ValueError(error_message.format(str(self), str(formatted))) ValueError: '/etc/passwd' is not in the subpath of '/usr' OR one path is relative and the other is absolute.
When walk_up is false (the default), the path must start with other. When the argument is true,
..
entries may be added to form the relative path. In all other cases, such as the paths referencing different drives,ValueError
is raised.:>>> p.relative_to('/usr', walk_up=True) PurePosixPath('../etc/passwd') >>> p.relative_to('foo', walk_up=True) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "pathlib.py", line 941, in relative_to raise ValueError(error_message.format(str(self), str(formatted))) ValueError: '/etc/passwd' is not on the same drive as 'foo' OR one path is relative and the other is absolute.
Advertencia
This function is part of
PurePath
and works with strings. It does not check or access the underlying file structure. This can impact the walk_up option as it assumes that no symlinks are present in the path; callresolve()
first if necessary to resolve symlinks.Distinto en la versión 3.12: The walk_up parameter was added (old behavior is the same as
walk_up=False
).Deprecated since version 3.12, will be removed in version 3.14: Passing additional positional arguments is deprecated; if supplied, they are joined with other.
- PurePath.with_name(name)¶
Retorna una nueva ruta con
name
cambiado. Si la ruta original no tiene nombre, se genera ValueError:>>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz') >>> p.with_name('setup.py') PureWindowsPath('c:/Downloads/setup.py') >>> p = PureWindowsPath('c:/') >>> p.with_name('setup.py') Traceback (most recent call last): File "<stdin>", line 1, in <module> File "/home/antoine/cpython/default/Lib/pathlib.py", line 751, in with_name raise ValueError("%r has an empty name" % (self,)) ValueError: PureWindowsPath('c:/') has an empty name
- PurePath.with_stem(stem)¶
Retorna una nueva ruta con
stem
cambiado. Si la ruta original no tiene nombre, se lanza ValueError:>>> p = PureWindowsPath('c:/Downloads/draft.txt') >>> p.with_stem('final') PureWindowsPath('c:/Downloads/final.txt') >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz') >>> p.with_stem('lib') PureWindowsPath('c:/Downloads/lib.gz') >>> p = PureWindowsPath('c:/') >>> p.with_stem('') Traceback (most recent call last): File "<stdin>", line 1, in <module> File "/home/antoine/cpython/default/Lib/pathlib.py", line 861, in with_stem return self.with_name(stem + self.suffix) File "/home/antoine/cpython/default/Lib/pathlib.py", line 851, in with_name raise ValueError("%r has an empty name" % (self,)) ValueError: PureWindowsPath('c:/') has an empty name
Added in version 3.9.
- PurePath.with_suffix(suffix)¶
Retorna una nueva ruta con
suffix
cambiado. Si la ruta original no tiene un sufijo, se agrega el nuevo suffix. Si suffix es una cadena vacía, el sufijo original se elimina:>>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz') >>> p.with_suffix('.bz2') PureWindowsPath('c:/Downloads/pathlib.tar.bz2') >>> p = PureWindowsPath('README') >>> p.with_suffix('.txt') PureWindowsPath('README.txt') >>> p = PureWindowsPath('README.txt') >>> p.with_suffix('') PureWindowsPath('README')
- PurePath.with_segments(*pathsegments)¶
Create a new path object of the same type by combining the given pathsegments. This method is called whenever a derivative path is created, such as from
parent
andrelative_to()
. Subclasses may override this method to pass information to derivative paths, for example:from pathlib import PurePosixPath class MyPath(PurePosixPath): def __init__(self, *pathsegments, session_id): super().__init__(*pathsegments) self.session_id = session_id def with_segments(self, *pathsegments): return type(self)(*pathsegments, session_id=self.session_id) etc = MyPath('/etc', session_id=42) hosts = etc / 'hosts' print(hosts.session_id) # 42
Added in version 3.12.
Rutas concretas¶
Las rutas concretas son subclases de las rutas puras. Además de las operaciones proporcionadas por estas últimas, también proporcionan métodos realizar llamadas del sistema a objetos ruta. Hay tres formas de crear instancias de rutas concretas:
- class pathlib.Path(*pathsegments)¶
Una subclase de
PurePath
, esta clase representa rutas concretas de la familia ruta del sistema (al crear una instancia crea ya seaPosixPath
oWindowsPath
):>>> Path('setup.py') PosixPath('setup.py')
pathsegments se especifica de manera similar a
PurePath
.
- class pathlib.PosixPath(*pathsegments)¶
Una subclase de
Path
yPurePosixPath
, esta clase representa rutas concretas de sistemas de archivos que no son de Windows:>>> PosixPath('/etc/hosts') PosixPath('/etc/hosts')
pathsegments se especifica de manera similar a
PurePath
.Distinto en la versión 3.13: Raises
UnsupportedOperation
on Windows. In previous versions,NotImplementedError
was raised instead.
- class pathlib.WindowsPath(*pathsegments)¶
Una subclase de
Path
yPureWindowsPath
, esta clase representa rutas concretas del sistema de archivos de Windows:>>> WindowsPath('c:/', 'Users', 'Ximénez') WindowsPath('c:/Users/Ximénez')
pathsegments se especifica de manera similar a
PurePath
.Distinto en la versión 3.13: Raises
UnsupportedOperation
on non-Windows platforms. In previous versions,NotImplementedError
was raised instead.
Solo puedes crear instancias de la familia de clase que corresponde a su sistema operativo (permitir llamadas del sistema no compatibles podría provocar errores o fallas en su aplicación):
>>> import os
>>> os.name
'posix'
>>> Path('setup.py')
PosixPath('setup.py')
>>> PosixPath('setup.py')
PosixPath('setup.py')
>>> WindowsPath('setup.py')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "pathlib.py", line 798, in __new__
% (cls.__name__,))
UnsupportedOperation: cannot instantiate 'WindowsPath' on your system
Some concrete path methods can raise an OSError
if a system call fails
(for example because the path doesn’t exist).
Parsing and generating URIs¶
Concrete path objects can be created from, and represented as, “file” URIs conforming to RFC 8089.
Nota
File URIs are not portable across machines with different filesystem encodings.
- classmethod Path.from_uri(uri)¶
Return a new path object from parsing a “file” URI. For example:
>>> p = Path.from_uri('file:///etc/hosts') PosixPath('/etc/hosts')
On Windows, DOS device and UNC paths may be parsed from URIs:
>>> p = Path.from_uri('file:///c:/windows') WindowsPath('c:/windows') >>> p = Path.from_uri('file://server/share') WindowsPath('//server/share')
Several variant forms are supported:
>>> p = Path.from_uri('file:////server/share') WindowsPath('//server/share') >>> p = Path.from_uri('file://///server/share') WindowsPath('//server/share') >>> p = Path.from_uri('file:c:/windows') WindowsPath('c:/windows') >>> p = Path.from_uri('file:/c|/windows') WindowsPath('c:/windows')
ValueError
is raised if the URI does not start withfile:
, or the parsed path isn’t absolute.Added in version 3.13.
- Path.as_uri()¶
Represent the path as a “file” URI.
ValueError
is raised if the path isn’t absolute.>>> p = PosixPath('/etc/passwd') >>> p.as_uri() 'file:///etc/passwd' >>> p = WindowsPath('c:/Windows') >>> p.as_uri() 'file:///c:/Windows'
For historical reasons, this method is also available from
PurePath
objects. However, its use ofos.fsencode()
makes it strictly impure.
Expanding and resolving paths¶
- classmethod Path.home()¶
Retorna un nuevo objeto ruta que representa el directorio de inicio del usuario (como lo retorna
os.path.expanduser()
con el agregado~
). Si el directorio de inicio no se puede resolver, se lanzaRuntimeError
.>>> Path.home() PosixPath('/home/antoine')
Added in version 3.5.
- Path.expanduser()¶
Retorna una nueva ruta con las construcciones
~
y~user
expandidas, como lo retornaos.path.expanduser()
. Si el directorio de inicio no se puede resolver, se lanzaRuntimeError
.>>> p = PosixPath('~/films/Monty Python') >>> p.expanduser() PosixPath('/home/eric/films/Monty Python')
Added in version 3.5.
- classmethod Path.cwd()¶
Retorna un nuevo objeto ruta que representa el directorio actual (como lo retorna
os.getcwd()
):>>> Path.cwd() PosixPath('/home/antoine/pathlib')
- Path.absolute()¶
Hace que la ruta sea absoluta, sin normalización ni resolución de enlaces simbólicos. Retorna un nuevo objeto de ruta:
>>> p = Path('tests') >>> p PosixPath('tests') >>> p.absolute() PosixPath('/home/antoine/pathlib/tests')
- Path.resolve(strict=False)¶
Hace que la ruta sea absoluta, resolviendo los enlaces simbólicos. Se retorna un nuevo objeto ruta:
>>> p = Path() >>> p PosixPath('.') >>> p.resolve() PosixPath('/home/antoine/pathlib')
Los componentes «
..
» también se eliminan (este es el único método para hacerlo):>>> p = Path('docs/../setup.py') >>> p.resolve() PosixPath('/home/antoine/pathlib/setup.py')
If a path doesn’t exist or a symlink loop is encountered, and strict is
True
,OSError
is raised. If strict isFalse
, the path is resolved as far as possible and any remainder is appended without checking whether it exists.Distinto en la versión 3.6: The strict parameter was added (pre-3.6 behavior is strict).
Distinto en la versión 3.13: Symlink loops are treated like other errors:
OSError
is raised in strict mode, and no exception is raised in non-strict mode. In previous versions,RuntimeError
is raised no matter the value of strict.
- Path.readlink()¶
Retorna la ruta a la que apunta el vínculo simbólico (como lo retorna
os.readlink()
):>>> p = Path('mylink') >>> p.symlink_to('setup.py') >>> p.readlink() PosixPath('setup.py')
Added in version 3.9.
Distinto en la versión 3.13: Raises
UnsupportedOperation
ifos.readlink()
is not available. In previous versions,NotImplementedError
was raised.
Querying file type and status¶
Distinto en la versión 3.8: exists()
, is_dir()
, is_file()
,
is_mount()
, is_symlink()
,
is_block_device()
, is_char_device()
,
is_fifo()
, is_socket()
now return False
instead of raising an exception for paths that contain characters
unrepresentable at the OS level.
- Path.stat(*, follow_symlinks=True)¶
Return an
os.stat_result
object containing information about this path, likeos.stat()
. The result is looked up at each call to this method.Este método normalmente sigue enlaces simbólicos; para evitar enlaces simbólicos, agregue el argumento
follow_symlinks = False
, o uselstat()
.>>> p = Path('setup.py') >>> p.stat().st_size 956 >>> p.stat().st_mtime 1327883547.852554
Distinto en la versión 3.10: Se agregó el parámetro follow_symlinks.
- Path.lstat()¶
Del mismo modo que
Path.stat()
pero si la ruta apunta a un enlace simbólico, retorna la información del enlace simbólico en lugar de la de su objetivo.
- Path.exists(*, follow_symlinks=True)¶
Return
True
if the path points to an existing file or directory.This method normally follows symlinks; to check if a symlink exists, add the argument
follow_symlinks=False
.>>> Path('.').exists() True >>> Path('setup.py').exists() True >>> Path('/etc').exists() True >>> Path('nonexistentfile').exists() False
Distinto en la versión 3.12: Se agregó el parámetro follow_symlinks.
- Path.is_file(*, follow_symlinks=True)¶
Return
True
if the path points to a regular file,False
if it points to another kind of file.False
también se retorna si la ruta no existe o es un enlace simbólico roto; se propagan otros errores (como errores de permiso).This method normally follows symlinks; to exclude symlinks, add the argument
follow_symlinks=False
.Distinto en la versión 3.13: Se agregó el parámetro follow_symlinks.
- Path.is_dir(*, follow_symlinks=True)¶
Return
True
if the path points to a directory,False
if it points to another kind of file.False
también se retorna si la ruta no existe o es un enlace simbólico roto; se propagan otros errores (como errores de permiso).This method normally follows symlinks; to exclude symlinks to directories, add the argument
follow_symlinks=False
.Distinto en la versión 3.13: Se agregó el parámetro follow_symlinks.
- Path.is_symlink()¶
Retorna
True
si la ruta apunta a un enlace simbólico,False
de lo contrario.False
también se retorna si la ruta no existe; se extiende a otros errores (como errores de permiso).
- Path.is_junction()¶
Return
True
if the path points to a junction, andFalse
for any other type of file. Currently only Windows supports junctions.Added in version 3.12.
- Path.is_mount()¶
Return
True
if the path is a mount point: a point in a file system where a different file system has been mounted. On POSIX, the function checks whether path’s parent,path/..
, is on a different device than path, or whetherpath/..
and path point to the same i-node on the same device — this should detect mount points for all Unix and POSIX variants. On Windows, a mount point is considered to be a drive letter root (e.g.c:\
), a UNC share (e.g.\\server\share
), or a mounted filesystem directory.Added in version 3.7.
Distinto en la versión 3.12: Windows support was added.
- Path.is_socket()¶
Retorna
True
si la ruta apunta a un socket Unix (o un enlace simbólico que apunta a uno),False
si apunta a otro tipo de archivo.False
también se retorna si la ruta no existe o es un enlace simbólico roto; se propagan otros errores (como errores de permiso).
- Path.is_fifo()¶
Retorna
True
si la ruta apunta a un FIFO (o un enlace simbólico que apunta a un FIFO),False
si apunta a otro tipo de archivo.False
también se retorna si la ruta no existe o es un enlace simbólico roto; se propagan otros errores (como errores de permiso).
- Path.is_block_device()¶
Retorna
True
si la ruta apunta a un dispositivo de bloques (o un enlace simbólico que apunta a uno),False
si apunta a otro tipo de archivo.False
también se retorna si la ruta no existe o es un enlace simbólico roto; se propagan otros errores (como errores de permiso).
- Path.is_char_device()¶
Retorna
True
si la ruta apunta a un dispositivo de caracteres (o un enlace simbólico que apunta a uno),False
si apunta a otro tipo de archivo.False
también se retorna si la ruta no existe o es un enlace simbólico roto; se propagan otros errores (como errores de permiso).
- Path.samefile(other_path)¶
Retorna si la ruta apunta al mismo archivo que other_path, que puede ser un objeto Path o una cadena. La semántica es similar a
os.path.samefile()
yos.path.samestat()
.Se puede generar
OSError
si no se accede a alguno de los archivos por algún motivo.>>> p = Path('spam') >>> q = Path('eggs') >>> p.samefile(q) False >>> p.samefile('spam') True
Added in version 3.5.
Reading and writing files¶
- Path.open(mode='r', buffering=-1, encoding=None, errors=None, newline=None)¶
Abre el archivo señalado por la ruta, como lo hace la función incorporada
open()
:>>> p = Path('setup.py') >>> with p.open() as f: ... f.readline() ... '#!/usr/bin/env python3\n'
- Path.read_text(encoding=None, errors=None, newline=None)¶
Retorna el contenido decodificado del archivo apuntado como una cadena:
>>> p = Path('my_text_file') >>> p.write_text('Text file contents') 18 >>> p.read_text() 'Text file contents'
El archivo se abre y luego se cierra. Los parámetros opcionales funcionan de la misma manera que en
open()
.Added in version 3.5.
Distinto en la versión 3.13: Se agregó el parámetro newline.
- Path.read_bytes()¶
Retorna el contenido binario del archivo apuntado como un objeto bytes:
>>> p = Path('my_binary_file') >>> p.write_bytes(b'Binary file contents') 20 >>> p.read_bytes() b'Binary file contents'
Added in version 3.5.
- Path.write_text(data, encoding=None, errors=None, newline=None)¶
Abre el archivo apuntado en modo texto, escribe data y cierra el archivo:
>>> p = Path('my_text_file') >>> p.write_text('Text file contents') 18 >>> p.read_text() 'Text file contents'
Se sobrescribe un archivo existente con el mismo nombre. Los parámetros opcionales tienen el mismo significado que en
open()
.Added in version 3.5.
Distinto en la versión 3.10: Se agregó el parámetro newline.
- Path.write_bytes(data)¶
Abre el archivo apuntado en modo bytes, escribe data y cierra el archivo:
>>> p = Path('my_binary_file') >>> p.write_bytes(b'Binary file contents') 20 >>> p.read_bytes() b'Binary file contents'
Se sobrescribe un archivo existente con el mismo nombre.
Added in version 3.5.
Reading directories¶
- Path.iterdir()¶
Cuando la ruta apunta a un directorio, produce objetos de ruta del contenido del directorio:
>>> p = Path('docs') >>> for child in p.iterdir(): child ... PosixPath('docs/conf.py') PosixPath('docs/_templates') PosixPath('docs/make.bat') PosixPath('docs/index.rst') PosixPath('docs/_build') PosixPath('docs/_static') PosixPath('docs/Makefile')
The children are yielded in arbitrary order, and the special entries
'.'
and'..'
are not included. If a file is removed from or added to the directory after creating the iterator, it is unspecified whether a path object for that file is included.If the path is not a directory or otherwise inaccessible,
OSError
is raised.
- Path.glob(pattern, *, case_sensitive=None, recurse_symlinks=False)¶
Analiza el patrón comodín relativo a esta ruta para producir todos los archivos coincidentes (de cualquier tipo):
>>> sorted(Path('.').glob('*.py')) [PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')] >>> sorted(Path('.').glob('*/*.py')) [PosixPath('docs/conf.py')] >>> sorted(Path('.').glob('**/*.py')) [PosixPath('build/lib/pathlib.py'), PosixPath('docs/conf.py'), PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')]
Ver también
Pattern language documentation.
By default, or when the case_sensitive keyword-only argument is set to
None
, this method matches paths using platform-specific casing rules: typically, case-sensitive on POSIX, and case-insensitive on Windows. Set case_sensitive toTrue
orFalse
to override this behaviour.By default, or when the recurse_symlinks keyword-only argument is set to
False
, this method follows symlinks except when expanding «**
» wildcards. Set recurse_symlinks toTrue
to always follow symlinks.Levanta un auditing event
pathlib.Path.glob
con argumentosself
,pattern
.Distinto en la versión 3.12: The case_sensitive parameter was added.
Distinto en la versión 3.13: The recurse_symlinks parameter was added.
Distinto en la versión 3.13: The pattern parameter accepts a path-like object.
Distinto en la versión 3.13: Any
OSError
exceptions raised from scanning the filesystem are suppressed. In previous versions, such exceptions are suppressed in many cases, but not all.
- Path.rglob(pattern, *, case_sensitive=None, recurse_symlinks=False)¶
Glob the given relative pattern recursively. This is like calling
Path.glob()
with «**/
» added in front of the pattern.Ver también
Pattern language and
Path.glob()
documentation.Levanta un auditing event
pathlib.Path.rglob
con argumentosself
,pattern
.Distinto en la versión 3.12: The case_sensitive parameter was added.
Distinto en la versión 3.13: The recurse_symlinks parameter was added.
Distinto en la versión 3.13: The pattern parameter accepts a path-like object.
- Path.walk(top_down=True, on_error=None, follow_symlinks=False)¶
Generate the file names in a directory tree by walking the tree either top-down or bottom-up.
For each directory in the directory tree rooted at self (including self but excluding “.” and “..”), the method yields a 3-tuple of
(dirpath, dirnames, filenames)
.dirpath is a
Path
to the directory currently being walked, dirnames is a list of strings for the names of subdirectories in dirpath (excluding'.'
and'..'
), and filenames is a list of strings for the names of the non-directory files in dirpath. To get a full path (which begins with self) to a file or directory in dirpath, dodirpath / name
. Whether or not the lists are sorted is file system-dependent.If the optional argument top_down is true (which is the default), the triple for a directory is generated before the triples for any of its subdirectories (directories are walked top-down). If top_down is false, the triple for a directory is generated after the triples for all of its subdirectories (directories are walked bottom-up). No matter the value of top_down, the list of subdirectories is retrieved before the triples for the directory and its subdirectories are walked.
When top_down is true, the caller can modify the dirnames list in-place (for example, using
del
or slice assignment), andPath.walk()
will only recurse into the subdirectories whose names remain in dirnames. This can be used to prune the search, or to impose a specific order of visiting, or even to informPath.walk()
about directories the caller creates or renames before it resumesPath.walk()
again. Modifying dirnames when top_down is false has no effect on the behavior ofPath.walk()
since the directories in dirnames have already been generated by the time dirnames is yielded to the caller.By default, errors from
os.scandir()
are ignored. If the optional argument on_error is specified, it should be a callable; it will be called with one argument, anOSError
instance. The callable can handle the error to continue the walk or re-raise it to stop the walk. Note that the filename is available as thefilename
attribute of the exception object.By default,
Path.walk()
does not follow symbolic links, and instead adds them to the filenames list. Set follow_symlinks to true to resolve symlinks and place them in dirnames and filenames as appropriate for their targets, and consequently visit directories pointed to by symlinks (where supported).Nota
Be aware that setting follow_symlinks to true can lead to infinite recursion if a link points to a parent directory of itself.
Path.walk()
does not keep track of the directories it has already visited.Nota
Path.walk()
assumes the directories it walks are not modified during execution. For example, if a directory from dirnames has been replaced with a symlink and follow_symlinks is false,Path.walk()
will still try to descend into it. To prevent such behavior, remove directories from dirnames as appropriate.Nota
Unlike
os.walk()
,Path.walk()
lists symlinks to directories in filenames if follow_symlinks is false.This example displays the number of bytes used by all files in each directory, while ignoring
__pycache__
directories:from pathlib import Path for root, dirs, files in Path("cpython/Lib/concurrent").walk(on_error=print): print( root, "consumes", sum((root / file).stat().st_size for file in files), "bytes in", len(files), "non-directory files" ) if '__pycache__' in dirs: dirs.remove('__pycache__')
This next example is a simple implementation of
shutil.rmtree()
. Walking the tree bottom-up is essential asrmdir()
doesn’t allow deleting a directory before it is empty:# Delete everything reachable from the directory "top". # CAUTION: This is dangerous! For example, if top == Path('/'), # it could delete all of your files. for root, dirs, files in top.walk(top_down=False): for name in files: (root / name).unlink() for name in dirs: (root / name).rmdir()
Added in version 3.12.
Creating files and directories¶
- Path.touch(mode=0o666, exist_ok=True)¶
Create a file at this given path. If mode is given, it is combined with the process’s
umask
value to determine the file mode and access flags. If the file already exists, the function succeeds when exist_ok is true (and its modification time is updated to the current time), otherwiseFileExistsError
is raised.Ver también
The
open()
,write_text()
andwrite_bytes()
methods are often used to create files.
- Path.mkdir(mode=0o777, parents=False, exist_ok=False)¶
Create a new directory at this given path. If mode is given, it is combined with the process’s
umask
value to determine the file mode and access flags. If the path already exists,FileExistsError
is raised.Si parents es verdadero, los padres que faltan de esta ruta se crean según sea necesario; se crean con los permisos predeterminados sin tener en cuenta mode (imitando el comando POSIX
mkdir -p
).Si parents es falso (el valor predeterminado), se genera un padre que falta
FileNotFoundError
.Si exist_ok es falso (el valor predeterminado), se genera
FileExistsError
si el directorio de destino ya existe.If exist_ok is true,
FileExistsError
will not be raised unless the given path already exists in the file system and is not a directory (same behavior as the POSIXmkdir -p
command).Distinto en la versión 3.5: Se agregó el parámetro exist_ok.
- Path.symlink_to(target, target_is_directory=False)¶
Make this path a symbolic link pointing to target.
On Windows, a symlink represents either a file or a directory, and does not morph to the target dynamically. If the target is present, the type of the symlink will be created to match. Otherwise, the symlink will be created as a directory if target_is_directory is true or a file symlink (the default) otherwise. On non-Windows platforms, target_is_directory is ignored.
>>> p = Path('mylink') >>> p.symlink_to('setup.py') >>> p.resolve() PosixPath('/home/antoine/pathlib/setup.py') >>> p.stat().st_size 956 >>> p.lstat().st_size 8
Nota
El orden de los argumentos (link, target) es el reverso de
os.symlink()
”s.Distinto en la versión 3.13: Raises
UnsupportedOperation
ifos.symlink()
is not available. In previous versions,NotImplementedError
was raised.
- Path.hardlink_to(target)¶
Hace de esta ruta un enlace fijo que apunta al mismo archivo que target.
Nota
El orden de los argumentos (link, target) es el reverso de
os.link()
.Added in version 3.10.
Distinto en la versión 3.13: Raises
UnsupportedOperation
ifos.link()
is not available. In previous versions,NotImplementedError
was raised.
Renaming and deleting¶
- Path.rename(target)¶
Rename this file or directory to the given target, and return a new
Path
instance pointing to target. On Unix, if target exists and is a file, it will be replaced silently if the user has permission. On Windows, if target exists,FileExistsError
will be raised. target can be either a string or another path object:>>> p = Path('foo') >>> p.open('w').write('some text') 9 >>> target = Path('bar') >>> p.rename(target) PosixPath('bar') >>> target.open().read() 'some text'
The target path may be absolute or relative. Relative paths are interpreted relative to the current working directory, not the directory of the
Path
object.It is implemented in terms of
os.rename()
and gives the same guarantees.Distinto en la versión 3.8: Added return value, return the new
Path
instance.
- Path.replace(target)¶
Rename this file or directory to the given target, and return a new
Path
instance pointing to target. If target points to an existing file or empty directory, it will be unconditionally replaced.The target path may be absolute or relative. Relative paths are interpreted relative to the current working directory, not the directory of the
Path
object.Distinto en la versión 3.8: Added return value, return the new
Path
instance.
- Path.unlink(missing_ok=False)¶
Elimine el archivo o enlace simbólico. Si la ruta apunta a un directorio, use
Path.rmdir()
en su lugar.Si missing_ok es falso (el valor predeterminado), se genera
FileNotFoundError
si la ruta no existe.Si missing_ok es verdadero, las excepciones
FileNotFoundError
serán ignoradas (el mismo comportamiento que el comando POSIXrm -f
).Distinto en la versión 3.8: Se agregó el parámetro missing_ok.
- Path.rmdir()¶
Elimina el directorio. El directorio debe estar vacío.
Permissions and ownership¶
- Path.owner(*, follow_symlinks=True)¶
Return the name of the user owning the file.
KeyError
is raised if the file’s user identifier (UID) isn’t found in the system database.This method normally follows symlinks; to get the owner of the symlink, add the argument
follow_symlinks=False
.Distinto en la versión 3.13: Raises
UnsupportedOperation
if thepwd
module is not available. In earlier versions,NotImplementedError
was raised.Distinto en la versión 3.13: Se agregó el parámetro follow_symlinks.
- Path.group(*, follow_symlinks=True)¶
Return the name of the group owning the file.
KeyError
is raised if the file’s group identifier (GID) isn’t found in the system database.This method normally follows symlinks; to get the group of the symlink, add the argument
follow_symlinks=False
.Distinto en la versión 3.13: Raises
UnsupportedOperation
if thegrp
module is not available. In earlier versions,NotImplementedError
was raised.Distinto en la versión 3.13: Se agregó el parámetro follow_symlinks.
- Path.chmod(mode, *, follow_symlinks=True)¶
Cambia el modo y los permisos de archivo, como
os.chmod()
.Este método normalmente sigue enlaces simbólicos. Algunas versiones de Unix admiten el cambio de permisos en el enlace simbólico en sí; en estas plataformas puede agregar el argumento
follow_symlinks=False
, o usarlchmod()
.>>> p = Path('setup.py') >>> p.stat().st_mode 33277 >>> p.chmod(0o444) >>> p.stat().st_mode 33060
Distinto en la versión 3.10: Se agregó el parámetro follow_symlinks.
- Path.lchmod(mode)¶
Del mismo modo que
Path.chmod()
pero si la ruta apunta a un enlace simbólico, el modo del enlace simbólico cambia en lugar del de su objetivo.
Pattern language¶
The following wildcards are supported in patterns for
full_match()
, glob()
and rglob()
:
**
(entire segment)Matches any number of file or directory segments, including zero.
*
(entire segment)Matches one file or directory segment.
*
(part of a segment)Matches any number of non-separator characters, including zero.
?
Matches one non-separator character.
[seq]
Matches one character in seq.
[!seq]
Matches one character not in seq.
For a literal match, wrap the meta-characters in brackets.
For example, "[?]"
matches the character "?"
.
The «**
» wildcard enables recursive globbing. A few examples:
Pattern |
Meaning |
---|---|
« |
Any path with at least one segment. |
« |
Any path with a final segment ending « |
« |
Any path starting with « |
« |
Any path starting with « |
Nota
Globbing with the «**
» wildcard visits every directory in the tree.
Large directory trees may take a long time to search.
Distinto en la versión 3.13: Globbing with a pattern that ends with «**
» returns both files and
directories. In previous versions, only directories were returned.
In Path.glob()
and rglob()
, a trailing slash may be added to
the pattern to match only directories.
Comparison to the glob
module¶
The patterns accepted and results generated by Path.glob()
and
Path.rglob()
differ slightly from those by the glob
module:
Files beginning with a dot are not special in pathlib. This is like passing
include_hidden=True
toglob.glob()
.«
**
» pattern components are always recursive in pathlib. This is like passingrecursive=True
toglob.glob()
.«
**
» pattern components do not follow symlinks by default in pathlib. This behaviour has no equivalent inglob.glob()
, but you can passrecurse_symlinks=True
toPath.glob()
for compatible behaviour.Like all
PurePath
andPath
objects, the values returned fromPath.glob()
andPath.rglob()
don’t include trailing slashes.The values returned from pathlib’s
path.glob()
andpath.rglob()
include the path as a prefix, unlike the results ofglob.glob(root_dir=path)
.The values returned from pathlib’s
path.glob()
andpath.rglob()
may include path itself, for example when globbing «**
», whereas the results ofglob.glob(root_dir=path)
never include an empty string that would correspond to path.
Comparison to the os
and os.path
modules¶
pathlib implements path operations using PurePath
and Path
objects, and so it’s said to be object-oriented. On the other hand, the
os
and os.path
modules supply functions that work with low-level
str
and bytes
objects, which is a more procedural approach. Some
users consider the object-oriented style to be more readable.
Many functions in os
and os.path
support bytes
paths and
paths relative to directory descriptors. These features aren’t
available in pathlib.
Python’s str
and bytes
types, and portions of the os
and
os.path
modules, are written in C and are very speedy. pathlib is
written in pure Python and is often slower, but rarely slow enough to matter.
pathlib’s path normalization is slightly more opinionated and consistent than
os.path
. For example, whereas os.path.abspath()
eliminates
«..
» segments from a path, which may change its meaning if symlinks are
involved, Path.absolute()
preserves these segments for greater safety.
pathlib’s path normalization may render it unsuitable for some applications:
pathlib normalizes
Path("my_folder/")
toPath("my_folder")
, which changes a path’s meaning when supplied to various operating system APIs and command-line utilities. Specifically, the absence of a trailing separator may allow the path to be resolved as either a file or directory, rather than a directory only.pathlib normalizes
Path("./my_program")
toPath("my_program")
, which changes a path’s meaning when used as an executable search path, such as in a shell or when spawning a child process. Specifically, the absence of a separator in the path may force it to be looked up inPATH
rather than the current directory.
As a consequence of these differences, pathlib is not a drop-in replacement
for os.path
.
Corresponding tools¶
A continuación se muestra una tabla que asigna varias funciones os
a sus equivalentes en PurePath
/Path
.
Notas al pie