# `pathlib` — Rutas de sistemas orientada a objetos

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.

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

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'

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

  Cada elemento de pathsegments puede ser una cadena que representa un segmento de ruta, un objeto que implemente la interfaz `os.PathLike` la cual retorna una cadena o bien otro objeto ruta:

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

  Una subclase de `PurePath`, este tipo de ruta representa las rutas del sistema de archivos de Windows, incluido UNC paths:

      >>> PureWindowsPath('c:/Program Files/')
      PureWindowsPath('c:/Program Files')
      >>> 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.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

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

  If multiple arguments are supplied, they are joined together.

  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

  Nuevo en la versión 3.9.

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)

  Haga coincidir esta ruta con el pattern global proporcionado. Retorna `True` si la coincidencia es exitosa, `False` en caso contrario.

  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)

  Computa una versión de la ruta en relación a la ruta representada por other. Si es imposible, se genera ValueError:

      >>> 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' is not in the subpath of '/usr' OR one path is relative and the other absolute.

  If multiple arguments are supplied, they are joined together.

  NOTA: Esta función es parte de `PurePath` y trabaja con strings. No revisa ni accede a la estructura de archivos subyacentes.

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

  Nuevo en la versión 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')

## 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 `~`). Si el directorio de inicio no se puede resolver, se lanza `RuntimeError`.

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

  Nuevo en la versión 3.5.

Path.stat(*, follow_symlinks=True)

  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.

  Este método normalmente sigue enlaces simbólicos; para evitar enlaces simbólicos, agregue el argumento `follow_symlinks = False`, o use `lstat()`.

      >>> 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.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 usar `lchmod()`.

      >>> 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.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()`. Si el directorio de inicio no se puede resolver, se lanza `RuntimeError`.

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

  Nuevo en la versión 3.5.

Path.glob(pattern)

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

  Los patrones son los mismos que para `fnmatch`, con el agregado de «`**`» que 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.

  Levanta un auditing event `pathlib.Path.glob` con argumentos `self`, `pattern`.

  Distinto en la versión 3.11: Retorna solo directorios si pattern termina con un separador de componentes de nombre de ruta (`sep` o `altsep`).

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` 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_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` 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_mount()

  Retorna `True` si la ruta es un punto de montaje; un punto en un sistema de archivos donde otro sistema de archivo se encuentra montado. En POSIX, la función comprueba si el padre de path , `path/..`, se encuentra en un dispositivo diferente que path, o si `path/..` y path apuntan al mismo i-nodo en el mismo dispositivo — esto debería detectar puntos de montajes para todas las variantes Unix y POSIX. No está implementado en Windows.

  Nuevo en la versión 3.7.

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

  Los hijos se generan en orden arbitrario y las entradas especiales `'.'` y `'..'` no están incluidas. Si un archivo se elimina o se agrega al directorio después de crear el iterador, no se especifica si se incluirá un objeto de ruta para ese archivo.

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.

  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 POSIX `mkdir -p` command).

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

  Nuevo en la versión 3.9.

Path.rename(target)

  Cambia el nombre de este archivo o directorio al target dado y retorna una nueva instancia de Path apuntando al target. En Unix, si el target existe y es un archivo, se reemplazará silenciosamente si el usuario tiene permiso. En Windows, si el target existe, se lanzará una excepción `FileExistsError`. El target puede ser una cadena u otro objeto de ruta:

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

  La ruta de destino puede ser absoluta o relativa. Las rutas de acceso relativas se interpretan en relación con el directorio de trabajo actual, no el directorio del objeto Path.

  It is implemented in terms of `os.rename()` and gives the same guarantees.

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

Path.replace(target)

  Cambia el nombre de este archivo o directorio al target dado y retorna una nueva instancia de Path que apunte a target. Si target apunta a un archivo existente o a un directorio vacío, se reemplazará incondicionalmente.

  La ruta de destino puede ser absoluta o relativa. Las rutas de acceso relativas se interpretan en relación con el directorio de trabajo actual, no el directorio del objeto Path.

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

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

  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: El argumento strict (el comportamiento previo a 3.6 es strict = `True`).

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

  Levanta un auditing event `pathlib.Path.rglob` con argumentos `self`, `pattern`.

  Distinto en la versión 3.11: Retorna solo directorios si pattern termina con un separador de componentes de nombre de ruta (`sep` o `altsep`).

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.

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.

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

  Nuevo en la versión 3.10.

Path.link_to(target)

  Hace que taget sea un enlace fijo a esta ruta.

  Advertencia

  Esta función no hace que esta ruta sea un enlace fijo a target, a pesar de la implicación de los nombres de la función y los argumentos. El orden de los argumentos (target, link) es el inverso de `Path.symlink_to()` y `Path.hardlink_to()`, pero coincide con el de `os.link()`.

  Nuevo en la versión 3.8.

  Obsoleto desde la versión 3.10: Este método está deprecado en favor de `Path.hardlink_to()`, ya que el orden de los argumentos de `Path.link_to()` no coincide con el de `Path.symlink_to()`.

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

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

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

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, 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()`.

  Nuevo en la versión 3.5.

  Distinto en la versión 3.10: Se agregó el parámetro newline.

## Correspondencia a herramientas en el módulo `os`

A continuación se muestra una tabla que asigna varias funciones `os` a sus equivalentes en `PurePath`/`Path`.

Nota

No todos los pares de funciones/métodos a continuación son equivalentes. Algunos de ellos, a pesar de tener algunos casos de uso superpuestos, tienen una semántica diferente. Incluyen `os.path.abspath()` y `Path.absolute()`, `os.path.relpath()` y `PurePath.relative_to()`.

`os` y `os.path` | `pathlib`
--- | ---
`os.path.abspath()` | `Path.absolute()` [1]
`os.path.realpath()` | `Path.resolve()`
`os.chmod()` | `Path.chmod()`
`os.mkdir()` | `Path.mkdir()`
`os.makedirs()` | `Path.mkdir()`
`os.rename()` | `Path.rename()`
`os.replace()` | `Path.replace()`
`os.rmdir()` | `Path.rmdir()`
`os.remove()`, `os.unlink()` | `Path.unlink()`
`os.getcwd()` | `Path.cwd()`
`os.path.exists()` | `Path.exists()`
`os.path.expanduser()` | `Path.expanduser()` y `Path.home()`
`os.listdir()` | `Path.iterdir()`
`os.path.isdir()` | `Path.is_dir()`
`os.path.isfile()` | `Path.is_file()`
`os.path.islink()` | `Path.is_symlink()`
`os.link()` | `Path.hardlink_to()`
`os.symlink()` | `Path.symlink_to()`
`os.readlink()` | `Path.readlink()`
`os.path.relpath()` | `PurePath.relative_to()` [2]
`os.stat()` | `Path.stat()`, `Path.owner()`, `Path.group()`
`os.path.isabs()` | `PurePath.is_absolute()`
`os.path.join()` | `PurePath.joinpath()`
`os.path.basename()` | `PurePath.name`
`os.path.dirname()` | `PurePath.parent`
`os.path.samefile()` | `Path.samefile()`
`os.path.splitext()` | `PurePath.stem` and `PurePath.suffix`

Notas al pie

[1]

`os.path.abspath()` normaliza la ruta resultante, lo cual puede cambiar su significado en presencia de enlaces simbólicos, mientras que `Path.absolute()` no lo hace.

[2]

`PurePath.relative_to()` requiere que `self` sea la ruta secundaria del argumento, pero `os.path.relpath()` no.