# `pathlib` — Object-oriented filesystem paths

Added in version 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 o un objeto que implemente la interfaz `os.PathLike` donde el método `__fspath__()` retorna una cadena como otro objeto de 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('.')

  Si un segmento es una ruta absoluta, se ignoran todos los segmentos anteriores (como `os.path.join()`):

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

  En Windows, la unidad no se restablece cuando se encuentra un segmento de ruta relativa en la raíz (por ejemplo, `r'\foo'`):

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

Las rutas son inmutables y hashable. Las rutas de una misma familia son comparables y ordenables. Estas propiedades respetan el orden lexicográfico definido por la familia:

    >>> 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 de barra inclinada ayuda a crear rutas hijas, como `os.path.join()`. Si el argumento es una ruta absoluta, se ignora la ruta anterior. En Windows, la unidad no se restablece cuando el argumento es una ruta relativa en la raíz (por ejemplo, `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

  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: Está obsoleto pasar argumentos adicionales; si se suministran, se juntan con other.

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(*pathsegments)

  Llamar a este método es equivalente a combinar la ruta con cada uno de los pathsegments dados sucesivamente:

      >>> 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, *, case_sensitive=None)

  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

  El pattern puede ser otro objeto de ruta; esto acelera la coincidencia del mismo patrón con varios archivos:

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

  Nota

  The recursive wildcard «`**`» isn’t supported by this method (it acts like non-recursive «`*`».)

  Distinto en la versión 3.12: Accepts an object implementing the `os.PathLike` interface.

  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

  Establece case_sensitive en `True` o `False` para invalidar este comportamiento.

  Distinto en la versión 3.12: Se agregó el parámetro case_sensitive.

PurePath.relative_to(other, walk_up=False)

  Computa una versión de esta ruta relativa a la ruta representada por other. Si es imposible, se lanza `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 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

  Esta función es parte de `PurePath` y trabaja con cadenas de caracteres. No revisa ni accede a la estructura de archivos subyacentes. Esto puede afectar la opción walk_up ya que supone que no hay enlaces simbólicos en la ruta; si es necesario llame primero `resolve()` para resolver los enlaces simbólicos.

  Distinto en la versión 3.12: Se agregó el parámetro walk_up (el comportamiento anterior es el mismo que `walk_up=False`).

  Deprecated since version 3.12, will be removed in version 3.14: Está obsoleto pasar argumentos posicionales adicionales; si se suministran, se juntan con 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)

  Crea un nuevo objeto de ruta del mismo tipo combinando los pathsegments dados. Este método se llama siempre que se crea una ruta derivada, como `parent` y `relative_to()`. Las subclases pueden anular este método para pasar información a las rutas derivadas, por ejemplo:

      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 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/hosts')
      PosixPath('/etc/hosts')

  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:/', 'Users', 'Ximénez')
      WindowsPath('c:/Users/Ximénez')

  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

Some concrete path methods can raise an `OSError` if a system call fails (for example because the path doesn’t exist).

### 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 lanza `RuntimeError`.

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

  Added in version 3.5.

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

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

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

  Distinto en la versión 3.6: Se agregó el parámetro strict (el comportamiento previo a 3.6 es 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.

### 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, like `os.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 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.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)

  Retorna `True` si la ruta apunta a un archivo o directorio existente.

  Este método normalmente sigue enlaces simbólicos; para comprobar si existe un enlace simbólico, agregue el argumento `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()

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

  Retorna `True` si la ruta apunta a una unión y `False` para cualquier otro tipo de archivo. Actualmente, solo Windows admite uniones.

  Added in version 3.12.

Path.is_mount()

  Retorna `True` si la ruta es un mount point: 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. En Windows, se considera que un punto de montaje es una letra de unidad de raíz (por ejemplo, `c:\`), un recurso compartido UNC (por ejemplo, `\\server\share`) o un directorio de sistema de archivos montado.

  Added in version 3.7.

  Distinto en la versión 3.12: Se agregó soporte para Windows.

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

  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)

  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.

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)

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

  This method calls `Path.is_dir()` on the top-level directory and propagates any `OSError` exception that is raised. Subsequent `OSError` exceptions from scanning directories are suppressed.

  De forma predeterminada, o cuando el argumento de sólo palabra clave case_sensitive está configurado en `None`, este método coincide con las rutas utilizando reglas de mayúsculas y minúsculas específicas de la plataforma: normalmente, distingue entre mayúsculas y minúsculas en POSIX y no distingue entre mayúsculas y minúsculas en Windows. Se configura case_sensitive en `True` o `False` para anular este comportamiento.

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

  Distinto en la versión 3.12: Se agregó el parámetro case_sensitive.

Path.rglob(pattern, *, case_sensitive=None)

  Agrupa el pattern relativo dado de forma recursiva. Esto es como llamar a `Path.glob()` con «`**/`» agregado antes del pattern, donde los patterns son los mismos que para `fnmatch`:

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

  De forma predeterminada, o cuando el argumento de sólo palabra clave case_sensitive está configurado en `None`, este método coincide con las rutas utilizando reglas de mayúsculas y minúsculas específicas de la plataforma: normalmente, distingue entre mayúsculas y minúsculas en POSIX y no distingue entre mayúsculas y minúsculas en Windows. Se configura case_sensitive en `True` o `False` para anular este comportamiento.

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

  Distinto en la versión 3.12: Se agregó el parámetro case_sensitive.

Path.walk(top_down=True, on_error=None, follow_symlinks=False)

  Genera los nombres de archivos en un árbol de directorios recorriendo el árbol de arriba hacia abajo o de abajo hacia arriba.

  Para cada directorio en el árbol de directorios con raíz en self (incluyendo self pero excluyendo “.” y “..”), el método produce una tupla de 3 de elementos (o tripleta) `(dirpath, dirnames, filenames)`.

  dirpath es un objeto `Path` al directorio que se está recorriendo actualmente, dirnames es una lista de cadenas de caracteres para los nombres de los subdirectorios en dirpath (excluyendo `'.'` y `'..'`), y filenames es una lista de cadenas de caracteres para los nombres de los archivos que no son directorios en dirpath. Para obtener una ruta completa (que comienza con self) a un archivo o directorio en dirpath, se ejecuta `dirpath / name`. El orden de las listas depende del sistema de archivos.

  Si el argumento opcional top_down es verdadero (que es el valor predeterminado), la tripleta de un directorio se genera antes que las tripletas de cualquiera de sus subdirectorios (los directorios se recorren de arriba hacia abajo). Si top_down es falso, la tripleta de un directorio se genera después de las tripletas de todos sus subdirectorios (los directorios se recorren de abajo hacia arriba). Sin importar el valor de top_down, la lista de subdirectorios se recupera antes de que se recorran las tripletas del directorio y sus subdirectorios.

  When top_down is true, the caller can modify the dirnames list in-place (for example, using `del` or slice assignment), and `Path.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 inform `Path.walk()` about directories the caller creates or renames before it resumes `Path.walk()` again. Modifying dirnames when top_down is false has no effect on the behavior of `Path.walk()` since the directories in dirnames have already been generated by the time dirnames is yielded to the caller.

  De forma predeterminada, los errores de `os.scandir()` se ignoran. Si se especifica el argumento opcional on_error, debe ser un objeto invocable; se llamará con un argumento, una instancia de `OSError`. El objeto invocable puede manejar el error para continuar la ejecución o volver a generarlo para detenerla. Tenga en cuenta que el nombre del archivo está disponible como el atributo `filename` del objeto de excepción.

  De forma predeterminada, `Path.walk()` no sigue los enlaces simbólicos, sino que los agrega a la lista filenames. Establezca follow_symlinks como verdadero para resolver los enlaces simbólicos y colocarlos en dirnames y filenames según corresponda para sus destinos y, en consecuencia, visitar los directorios a los que apuntan los enlaces simbólicos (donde sea compatible).

  Nota

  Tener en cuenta que establecer follow_symlinks como verdadero puede generar una recursión infinita si un enlace apunta a un directorio principal de sí mismo. `Path.walk()` no realiza un seguimiento de los directorios que ya ha visitado.

  Nota

  `Path.walk()` asume que los directorios que recorre no se modifican durante la ejecución. Por ejemplo, si un directorio de dirnames ha sido reemplazado por un enlace simbólico y follow_symlinks es falso, `Path.walk()` intentará descender a él. Para evitar este comportamiento, elimine los directorios de dirnames según corresponda.

  Nota

  A diferencia de `os.walk()`, `Path.walk()` enumera enlaces simbólicos a directorios en filenames si follow_symlinks es falso.

  Este ejemplo muestra la cantidad de bytes utilizados por todos los archivos en cada directorio, mientras ignora los directorios `__pycache__`:

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

  El siguiente ejemplo es una implementación simple de `shutil.rmtree()`. Recorrer el árbol de abajo a arriba es esencial ya que `rmdir()` no permite eliminar un directorio antes de que esté vacío:

      # 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), otherwise `FileExistsError` is raised.

  Ver también

  The `open()`, `write_text()` and `write_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 POSIX `mkdir -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.

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.

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

  Se implementa en términos de `os.rename()` y ofrece las mismas garantías.

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

  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.

Path.group()

  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.

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

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

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

Notas al pie

[1]

`os.path.relpath()` calls `abspath()` to make paths absolute and remove «`..`» parts, whereas `PurePath.relative_to()` is a lexical operation that raises `ValueError` when its inputs” anchors differ (e.g. if one path is absolute and the other relative.)

[2]

`os.path.expanduser()` returns the path unchanged if the home directory can’t be resolved, whereas `Path.expanduser()` raises `RuntimeError`.

[3]

`os.path.abspath()` removes «`..`» components without resolving symlinks, which may change the meaning of the path, whereas `Path.absolute()` leaves any «`..`» components in the path.

[4]

`os.walk()` always follows symlinks when categorizing paths into dirnames and filenames, whereas `Path.walk()` categorizes all symlinks into filenames when follow_symlinks is false (the default.)