Advertencia

¡Ayúdanos a traducir la documentación oficial de Python al Español! Puedes encontrar más información en Como contribuir. Ayuda a acercar Python a más personas de habla hispana.

pathlib — Object-oriented filesystem paths

Nuevo en la versión 3.4.

Código fuente: Lib/pathlib.py


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.

../_images/pathlib-inheritance.png

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:

  1. 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 de PureWindowsPath.

  2. 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')]

Listing Python source files in this directory tree:

>>> 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'

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 o PureWindowsPath):

>>> PurePath('setup.py')      # Running on a Unix machine
PurePosixPath('setup.py')

Each element of pathsegments can be either a string representing a path segment, an object implementing the os.PathLike interface which returns a string, or 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('.')

Cuando se proporcionan varias rutas absolutas, la última se toma como un ancla (copiando el comportamiento de os.path.join()):

>>> PurePath('/etc', '/usr', 'lib64')
PurePosixPath('/usr/lib64')
>>> PureWindowsPath('c:/Windows', 'd:bar')
PureWindowsPath('d:bar')

Sin embargo, en una ruta de Windows, cambiar la raíz local no elimina la configuración de la unidad anterior:

>>> PureWindowsPath('c:/Windows', '/Program Files')
PureWindowsPath('c:/Program Files')

Spurious slashes and single dots are collapsed, but double dots ('..') are not, since this would change the meaning of a path in the face of symbolic links:

>>> 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 a PurePosixPath('bar'), lo cual es incorrecto si foo 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')
PurePosixPath('/etc')

pathsegments se especifica de manera similar a PurePath.

class pathlib.PureWindowsPath(*pathsegments)

A subclass of PurePath, this path flavour represents Windows filesystem paths:

>>> PureWindowsPath('c:/Program Files/')
PureWindowsPath('c:/Program Files')

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

El operador barra ayuda a crear rutas secundarias, similar a os.path.join():

>>> p = PurePath('/etc')
>>> p
PurePosixPath('/etc')
>>> p / 'init.d' / 'apache2'
PurePosixPath('/etc/init.d/apache2')
>>> q = PurePath('bin')
>>> '/usr' / q
PurePosixPath('/usr/bin')

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'

The string representation of a path is the raw filesystem path itself (in native form, e.g. with backslashes under Windows), which you can pass to any function taking a file path as a string:

>>> 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.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
''

UNC shares are also considered drives:

>>> 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
'\\'
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:/')
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 explorar una ruta arbitraria del sistema de archivos, 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

La extensión del archivo del componente final, si lo hay:

>>> PurePosixPath('my/library/setup.py').suffix
'.py'
>>> PurePosixPath('my/library.tar.gz').suffix
'.gz'
>>> PurePosixPath('my/library').suffix
''
PurePath.suffixes

Una lista de las extensiones de archivo de la ruta:

>>> 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.as_uri()

Representa la ruta como un file URI. ValueError se genera si la ruta no es absoluta.

>>> p = PurePosixPath('/etc/passwd')
>>> p.as_uri()
'file:///etc/passwd'
>>> p = PureWindowsPath('c:/Windows')
>>> p.as_uri()
'file:///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_reserved()

Con PureWindowsPath, retorna True si la ruta se considera reservada en Windows, False en caso contrario. Con PurePosixPath, siempre retorna False.

>>> PureWindowsPath('nul').is_reserved()
True
>>> PurePosixPath('nul').is_reserved()
False

Las llamadas al sistema de archivos en rutas reservadas pueden fallar inesperadamente o tener efectos no deseados.

PurePath.joinpath(*other)

Llamar a este método es equivalente a combinar la ruta con cada uno de los other argumentos:

>>> 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.match(pattern)

Match this path against the provided glob-style pattern. Return True if matching is successful, False otherwise.

Si pattern es relativo, la ruta puede ser relativa o absoluta, y la coincidencia se realiza desde la derecha:

>>> 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

Si pattern es absoluto, la ruta debe ser absoluta y toda la ruta debe coincidir:

>>> PurePath('/a.py').match('/*.py')
True
>>> PurePath('a/b.py').match('/*.py')
False

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').match('*.PY')
False
>>> PureWindowsPath('b.py').match('*.PY')
True
PurePath.relative_to(*other)

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 694, in relative_to
    .format(str(self), str(formatted)))
ValueError: '/etc/passwd' does not start with '/usr'
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_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')

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 sea PosixPath o WindowsPath):

>>> Path('setup.py')
PosixPath('setup.py')

pathsegments se especifica de manera similar a PurePath.

class pathlib.PosixPath(*pathsegments)

Una subclase de Path y PurePosixPath, esta clase representa rutas concretas de sistemas de archivos que no son de Windows:

>>> PosixPath('/etc')
PosixPath('/etc')

pathsegments se especifica de manera similar a PurePath.

class pathlib.WindowsPath(*pathsegments)

Una subclase de Path y PureWindowsPath, esta clase representa rutas concretas del sistema de archivos de Windows:

>>> WindowsPath('c:/Program Files/')
WindowsPath('c:/Program Files')

pathsegments se especifica de manera similar a PurePath.

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__,))
NotImplementedError: cannot instantiate 'WindowsPath' on your system

Métodos

Las rutas concretas proporcionan los siguientes métodos -además de los métodos de ruta puros-. Muchos de estos métodos pueden generar un OSError si falla una llamada al sistema (por ejemplo, porque la ruta no existe).

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() ahora retorna `` False`` en lugar de generar una excepción para las rutas que contienen caracteres que no se pueden representar a nivel del sistema operativo.

classmethod Path.cwd()

Retorna un nuevo objeto ruta que representa el directorio actual (como lo retorna os.getcwd()):

>>> Path.cwd()
PosixPath('/home/antoine/pathlib')
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 ~):

>>> Path.home()
PosixPath('/home/antoine')

Nuevo en la versión 3.5.

Path.stat()

Retorna un objeto os.stat_result que contiene información sobre esta ruta, del mismo modo que os.stat(). El resultado se consulta en cada llamada a este método.

>>> p = Path('setup.py')
>>> p.stat().st_size
956
>>> p.stat().st_mtime
1327883547.852554
Path.chmod(mode)

Cambia el modo y los permisos de archivo, como os.chmod():

>>> p = Path('setup.py')
>>> p.stat().st_mode
33277
>>> p.chmod(0o444)
>>> p.stat().st_mode
33060
Path.exists()

Si la ruta apunta a un archivo o directorio existente:

>>> Path('.').exists()
True
>>> Path('setup.py').exists()
True
>>> Path('/etc').exists()
True
>>> Path('nonexistentfile').exists()
False

Nota

Si la ruta apunta a un enlace simbólico, exist() retorna si el enlace simbólico apunta a un archivo o directorio existente.

Path.expanduser()

Retorna una nueva ruta con las construcciones ~ y ~user expandidas, como lo retorna os.path.expanduser():

>>> p = PosixPath('~/films/Monty Python')
>>> p.expanduser()
PosixPath('/home/eric/films/Monty Python')

Nuevo en la versión 3.5.

Path.glob(pattern)

Glob the given relative pattern in the directory represented by this path, yielding all matching files (of any kind):

>>> sorted(Path('.').glob('*.py'))
[PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')]
>>> sorted(Path('.').glob('*/*.py'))
[PosixPath('docs/conf.py')]

El patrón «**» significa «este directorio y todos los subdirectorios de forma recursiva». En otras palabras, habilita el comodín recursivo:

>>> sorted(Path('.').glob('**/*.py'))
[PosixPath('build/lib/pathlib.py'),
 PosixPath('docs/conf.py'),
 PosixPath('pathlib.py'),
 PosixPath('setup.py'),
 PosixPath('test_pathlib.py')]

Nota

El uso del patrón «**» en grandes árboles de directorios puede consumir una cantidad excesiva de tiempo.

Path.group()

Retorna el nombre del grupo propietario del archivo. KeyError se genera si el gid del archivo no se encuentra en la base de datos del sistema.

Path.is_dir()

Retorna True si la ruta apunta a un directorio (o un enlace simbólico que apunta a un directorio), False si apunta a otro tipo de archivo.

False is also returned if the path doesn’t exist or is a broken symlink; other errors (such as permission errors) are propagated.

Path.is_file()

Retorna True si la ruta apunta a un archivo normal (o un enlace simbólico que apunta a un archivo normal), Falso si apunta a otro tipo de archivo.

False is also returned if the path doesn’t exist or is a broken symlink; other errors (such as permission errors) are propagated.

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 whether path/.. and path point to the same i-node on the same device — this should detect mount points for all Unix and POSIX variants. Not implemented on Windows.

Nuevo en la versión 3.7.

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_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 is also returned if the path doesn’t exist or is a broken symlink; other errors (such as permission errors) are propagated.

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 is also returned if the path doesn’t exist or is a broken symlink; other errors (such as permission errors) are propagated.

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 is also returned if the path doesn’t exist or is a broken symlink; other errors (such as permission errors) are propagated.

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 is also returned if the path doesn’t exist or is a broken symlink; other errors (such as permission errors) are propagated.

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')
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.

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.mkdir(mode=0o777, parents=False, exist_ok=False)

Crea un nuevo directorio en la ruta dada. Si se proporciona mode, se combina con el valor del proceso umask para determinar el modo de archivo y los derechos de acceso. Si la ruta ya existe, se genera FileExistsError.

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.

Si exist_ok es verdadero, se ignorarán las excepciones FileExistsError (el mismo comportamiento que el comando POSIX mkdir -p), pero solo si el último componente de ruta no es un archivo existente que no sea de directorio.

Distinto en la versión 3.5: Se agregó el parámetro exist_ok.

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.owner()

Retorna el nombre del usuario propietario del archivo. KeyError se genera si el uid del archivo no se encuentra en la base de datos del sistema.

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'

Nuevo en la versión 3.5.

Path.read_text(encoding=None, errors=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().

Nuevo en la versión 3.5.

Path.rename(target)

Cambia el nombre del archivo o directorio apuntado al de target y retorna una nueva instancia de Path que apunte a target. En Unix, si target existe, es un archivo y el usuario tiene permisos, será reemplazado sin notificar. target puede ser una cadena u otro objeto ruta:

>>> p = Path('foo')
>>> p.open('w').write('some text')
9
>>> target = Path('bar')
>>> p.rename(target)
PosixPath('bar')
>>> target.open().read()
'some text'

Distinto en la versión 3.8: Valor de retorno agregado, retorna la nueva instancia de Path.

Path.replace(target)

Cambia el nombre del archivo o directorio al de target y retorna una nueva instancia de Path que apunta a target. Si target apunta a un archivo o directorio existente, será reemplazado incondicionalmente.

Distinto en la versión 3.8: Valor de retorno agregado, retorna la nueva instancia de Path.

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')

Si la ruta no existe y strict es True, se genera FileNotFoundError. Si strict es False, la ruta se resuelve en la medida de lo posible y se agrega el resto sin verificar si existe. Si se encuentra un bucle infinito en la resolución de la ruta se genera RuntimeError.

Nuevo en la versión 3.6: The strict argument (pre-3.6 behavior is strict).

Path.rglob(pattern)

Idéntico a llamar a Path.glob() con «**/» agregado delante del pattern relativo:

>>> sorted(Path().rglob("*.py"))
[PosixPath('build/lib/pathlib.py'),
 PosixPath('docs/conf.py'),
 PosixPath('pathlib.py'),
 PosixPath('setup.py'),
 PosixPath('test_pathlib.py')]
Path.rmdir()

Elimina el directorio. El directorio debe estar vacío.

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() y os.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

Nuevo en la versión 3.5.

Hace de la ruta un enlace simbólico a target. En Windows, target_is_directory debe ser verdadero si el destino del enlace es un directorio (False es predeterminado). En POSIX, el valor de target_is_directory se ignora.

>>> 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.

Path.touch(mode=0o666, exist_ok=True)

Crea un archivo en la ruta dada. Si se proporciona mode, se combina con el valor del proceso umask para determinar el modo de archivo y los indicadores de acceso. Si el archivo ya existe, la función tiene éxito si exist_ok es verdadero (y su hora de modificación se actualiza a la hora actual), de lo contrario se genera FileExistsError.

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 POSIX rm -f).

Distinto en la versión 3.8: Se agregó el parámetro missing_ok.

Crea un enlace fijo que apunta a la ruta target.

Distinto en la versión 3.8.

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.

Nuevo en la versión 3.5.

Path.write_text(data, encoding=None, errors=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().

Nuevo en la versión 3.5.