"pathlib" — Chemins de système de fichiers orientés objet
*********************************************************

Ajouté dans la version 3.4.

**Code source :** Lib/pathlib/

======================================================================

Ce module offre des classes représentant le système de fichiers avec
la sémantique appropriée pour différents systèmes d'exploitation. Les
classes de chemins sont divisées en chemins purs, qui fournissent
uniquement des opérations de manipulation sans entrées-sorties, et
chemins concrets, qui héritent des chemins purs et fournissent
également les opérations d'entrées-sorties.

[image: Inheritance diagram showing the classes available in pathlib.
The most basic class is PurePath, which has three direct subclasses:
PurePosixPath, PureWindowsPath, and Path. Further to these four
classes, there are two classes that use multiple inheritance:
PosixPath subclasses PurePosixPath and Path, and WindowsPath
subclasses PureWindowsPath and Path.][image]

Si vous n'avez jamais utilisé ce module précédemment, ou si vous
n'êtes pas sûr de quelle classe est faite pour votre tâche, "Path" est
très certainement ce dont vous avez besoin. Elle instancie un chemin
concret pour la plateforme sur laquelle s'exécute le code.

Les chemins purs sont utiles dans certains cas particuliers ; par
exemple :

1. Si vous voulez manipuler des chemins Windows sur une machine Unix
   (ou vice versa). Vous ne pouvez pas instancier un "WindowsPath"
   quand vous êtes sous Unix, mais vous pouvez instancier
   "PureWindowsPath".

2. Vous voulez être sûr que votre code manipule des chemins sans
   réellement accéder au système d'exploitation. Dans ce cas,
   instancier une de ces classes pures peut être utile puisqu'elle ne
   possède tout simplement aucune opération permettant d'accéder au
   système d'exploitation.

Voir aussi:

  **PEP 428** : le module *pathlib* – implémentation orientée-objet
  des chemins de systèmes de fichiers.

Voir aussi:

  Pour de la manipulation de chemins bas-niveau avec des chaînes de
  caractères, vous pouvez aussi utiliser le module "os.path".


Utilisation basique
===================

Importer la classe principale :

   >>> from pathlib import Path

Lister les sous-dossiers :

   >>> p = Path('.')
   >>> [x for x in p.iterdir() if x.is_dir()]
   [PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'),
    PosixPath('__pycache__'), PosixPath('build')]

Lister les fichiers source Python dans cette arborescence de dossiers
:

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

Naviguer à l'intérieur d'une arborescence de dossiers :

   >>> p = Path('/etc')
   >>> q = p / 'init.d' / 'reboot'
   >>> q
   PosixPath('/etc/init.d/reboot')
   >>> q.resolve()
   PosixPath('/etc/rc.d/init.d/halt')

Récupérer les propriétés de chemin :

   >>> q.exists()
   True
   >>> q.is_dir()
   False

Ouvrir un fichier :

   >>> with q.open() as f: f.readline()
   ...
   '#!/bin/bash\n'


Exceptions
==========

exception pathlib.UnsupportedOperation

   Une exception qui hérite de "NotImplementedError" levée quand une
   opération non prise en charge est appelée sur un objet *path*

   Ajouté dans la version 3.13.


Chemins purs
============

Les objets chemins purs fournissent les opérations de gestion de
chemin qui n'accèdent pas réellement au système de fichiers. Il y a
trois façons d'accéder à ces classes que nous appelons aussi
*familles* :

class pathlib.PurePath(*pathsegments)

   Une classe générique qui représente la famille de chemin du système
   (l'instancier crée soit un "PurePosixPath" soit un
   "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, or an object implementing the "os.PathLike"
   interface where the "__fspath__()" method returns a string, such as
   another path object:

      >>> PurePath('foo', 'some/path', 'bar')
      PurePosixPath('foo/some/path/bar')
      >>> PurePath(Path('foo'), Path('bar'))
      PurePosixPath('foo/bar')

   Quand *pathsegments* est vide, le dossier courant est utilisé :

      >>> PurePath()
      PurePosixPath('.')

   Si un segment est un chemin absolu, tous les segments précédents
   sont ignorés (comme "os.path.join()") :

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

   Sous Windows, le nom de lecteur est conservé quand un chemin
   relatif à la racine (par exemple "r'\foo'") est rencontré :

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

   Les points et slashs superflus sont supprimés, mais les doubles
   points ("'..'") et les double slashes  ("'//'") en début de segment
   ne le sont pas, puisque cela changerait la signification du chemin
   pour différentes raisons (par exemple pour des liens symboliques ou
   des chemins 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')

   (une analyse naïve considérerait "PurePosixPath('foo/../bar')"
   équivalent à "PurePosixPath('bar')", ce qui est faux si "foo" est
   un lien symbolique vers un autre dossier)

   Les objets chemins purs implémentent l'interface "os.PathLike",
   leur permettant d'être utilisés n'importe où l'interface est
   acceptée.

   Modifié dans la version 3.6: ajout de la gestion de l'interface
   "os.PathLike".

class pathlib.PurePosixPath(*pathsegments)

   Sous-classe de "PurePath", cette famille de chemin représente les
   chemins de systèmes de fichiers en dehors des chemins Windows :

      >>> PurePosixPath('/etc/hosts')
      PurePosixPath('/etc/hosts')

   *pathsegments* est spécifié de manière similaire à "PurePath".

class pathlib.PureWindowsPath(*pathsegments)

   Sous-classe de "PurePath", cette famille de chemin représente les
   chemins de systèmes de fichiers Windows, y compris les chemins UNC
   (voir UNC paths) :

      >>> PureWindowsPath('c:/', 'Users', 'Ximénez')
      PureWindowsPath('c:/Users/Ximénez')
      >>> PureWindowsPath('//server/share/file')
      PureWindowsPath('//server/share/file')

   *pathsegments* est spécifié de manière similaire à "PurePath".

Sans tenir compte du système sur lequel vous êtes, vous pouvez
instancier toutes ces classes, puisqu'elles ne fournissent aucune
opération qui appelle le système d'exploitation.


Propriétés générales
--------------------

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

Les chemins de différentes familles ne sont pas égaux et ne peuvent
être ordonnés :

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


Opérateurs
----------

L'opérateur slash aide à créer les chemins enfants, de manière
similaire à "os.path.join()". Si l'argument est un chemin absolu, le
chemin précédent est ignoré. Sous Windows, le lecteur n'est pas effacé
quand l'argument est un chemin relatif enraciné (par exemple
"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')

Un objet chemin peut être utilisé n'importe où un objet implémentant
"os.PathLike" est accepté :

   >>> import os
   >>> p = PurePath('/etc')
   >>> os.fspath(p)
   '/etc'

La représentation d'un chemin en chaîne de caractères est celle du
chemin brut du système de fichiers lui-même (dans sa forme native,
c.-à-d. avec des antislashs sous Windows), telle que vous pouvez la
passer à n'importe quelle fonction prenant un chemin en tant que
chaîne de caractères :

   >>> p = PurePath('/etc')
   >>> str(p)
   '/etc'
   >>> p = PureWindowsPath('c:/Program Files')
   >>> str(p)
   'c:\\Program Files'

De manière similaire, appeler "bytes" sur un chemin donne le chemin
brut du système de fichiers en tant que bytes, tel qu'encodé par
"os.fsencode()" :

   >>> bytes(p)
   b'/etc'

Note:

  Appeler "bytes" est seulement recommandé sous Unix. Sous Windows, la
  forme Unicode est la représentation canonique des chemins du système
  de fichiers.


Accéder aux parties individuelles
---------------------------------

Pour accéder aux parties individuelles (composantes) d'un chemin,
utilisez les propriétés suivantes :

PurePath.parts

   Un tuple donnant accès aux différentes composantes du chemin :

      >>> p = PurePath('/usr/bin/python3')
      >>> p.parts
      ('/', 'usr', 'bin', 'python3')

      >>> p = PureWindowsPath('c:/Program Files/PSF')
      >>> p.parts
      ('c:\\', 'Program Files', 'PSF')

   (notez comme le lecteur et la racine locale sont regroupés en une
   seule partie)


Méthodes et propriétés
----------------------

Les chemins purs fournissent les méthodes et propriétés suivantes :

PurePath.parser

   The implementation of the "os.path" module used for low-level path
   parsing and joining: either "posixpath" or "ntpath".

   Ajouté dans la version 3.13.

PurePath.drive

   Une chaîne représentant la lettre du lecteur ou le nom, s'il y en a
   un :

      >>> PureWindowsPath('c:/Program Files/').drive
      'c:'
      >>> PureWindowsPath('/Program Files/').drive
      ''
      >>> PurePosixPath('/etc').drive
      ''

   Les partages UNC sont aussi considérés comme des lecteurs :

      >>> PureWindowsPath('//host/share/foo.txt').drive
      '\\\\host\\share'

PurePath.root

   Une chaîne de caractères représentant la racine (locale ou
   globale), s'il y en a une :

      >>> PureWindowsPath('c:/Program Files/').root
      '\\'
      >>> PureWindowsPath('c:Program Files/').root
      ''
      >>> PurePosixPath('/etc').root
      '/'

   Les partages UNC ont toujours une racine :

      >>> PureWindowsPath('//host/share').root
      '\\'

   Si le chemin commence par plus de deux slashes successifs,
   "PurePosixPath" n'en conserve qu'un :

      >>> PurePosixPath('//etc').root
      '//'
      >>> PurePosixPath('///etc').root
      '/'
      >>> PurePosixPath('////etc').root
      '/'

   Note:

     Ce comportement se conforme au paragraphe 4.11 Pathname
     Resolution des *Open Group Base Specifications* version 6 :*"A
     pathname that begins with two successive slashes may be
     interpreted in an implementation-defined manner, although more
     than two leading slashes shall be treated as a single slash."*

PurePath.anchor

   La concaténation du lecteur et de la racine :

      >>> PureWindowsPath('c:/Program Files/').anchor
      'c:\\'
      >>> PureWindowsPath('c:Program Files/').anchor
      'c:'
      >>> PurePosixPath('/etc').anchor
      '/'
      >>> PureWindowsPath('//host/share').anchor
      '\\\\host\\share\\'

PurePath.parents

   Une séquence immuable fournissant accès aux ancêtres logiques du
   chemin :

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

   Modifié dans la version 3.10: La séquence de *parents* prend
   désormais en charge les *tranches* et les valeurs d’index
   négatives.

PurePath.parent

   Le parent logique du chemin :

      >>> p = PurePosixPath('/a/b/c/d')
      >>> p.parent
      PurePosixPath('/a/b/c')

   Vous ne pouvez pas aller au-delà d'une ancre, ou d'un chemin vide :

      >>> p = PurePosixPath('/')
      >>> p.parent
      PurePosixPath('/')
      >>> p = PurePosixPath('.')
      >>> p.parent
      PurePosixPath('.')

   Note:

     C'est une opération purement lexicale, d'où le comportement
     suivant :

        >>> p = PurePosixPath('foo/..')
        >>> p.parent
        PurePosixPath('foo')

     Si vous voulez remonter un chemin arbitraire du système de
     fichiers, il est recommandé d'appeler d'abord "Path.resolve()" de
     manière à résoudre les liens symboliques et éliminer les
     composantes "".."".

PurePath.name

   Une chaîne représentant la composante finale du chemin, en excluant
   le lecteur et la racine, si présent :

      >>> PurePosixPath('my/library/setup.py').name
      'setup.py'

   Les noms de lecteur UNC ne sont pas pris en compte :

      >>> PureWindowsPath('//some/share/setup.py').name
      'setup.py'
      >>> PureWindowsPath('//some/share').name
      ''

PurePath.suffix

   The last dot-separated portion of the final component, if any:

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

   Ceci est communément appelé une extension de fichier.

   Modifié dans la version 3.14: A single dot (""."") is considered a
   valid suffix.

PurePath.suffixes

   Une liste de suffixes du chemin concerné, souvent appelées
   extensions de fichier :

      >>> PurePosixPath('my/library.tar.gar').suffixes
      ['.tar', '.gar']
      >>> PurePosixPath('my/library.tar.gz').suffixes
      ['.tar', '.gz']
      >>> PurePosixPath('my/library').suffixes
      []

   Modifié dans la version 3.14: A single dot (""."") is considered a
   valid suffix.

PurePath.stem

   La composante finale du chemin, sans son suffixe :

      >>> PurePosixPath('my/library.tar.gz').stem
      'library.tar'
      >>> PurePosixPath('my/library.tar').stem
      'library'
      >>> PurePosixPath('my/library').stem
      'library'

   Modifié dans la version 3.14: A single dot (""."") is considered a
   valid suffix.

PurePath.as_posix()

   Renvoie une représentation en chaîne de caractères du chemin avec
   des slashs ("/") :

      >>> p = PureWindowsPath('c:\\windows')
      >>> str(p)
      'c:\\windows'
      >>> p.as_posix()
      'c:/windows'

PurePath.is_absolute()

   Renvoie si le chemin est absolu ou non. Un chemin est considéré
   absolu s'il a une racine et un lecteur (si la famille le permet) :

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

   Renvoie si ce chemin est relatif ou non au chemin *other*.

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

   Ajouté dans la version 3.9.

   Deprecated since version 3.12, removed in version 3.14: Passing
   additional arguments is deprecated; if supplied, they are joined
   with *other*.

PurePath.is_reserved()

   Avec "PureWindowsPath", renvoie "True" si le chemin est considéré
   réservé sous Windows, "False" sinon. Avec "PurePosixPath", "False"
   est systématiquement renvoyé.

   Modifié dans la version 3.13: Windows path names that contain a
   colon, or end with a dot or a space, are considered reserved. UNC
   paths may be reserved.

   Deprecated since version 3.13, will be removed in version 3.15:
   This method is deprecated; use "os.path.isreserved()" to detect
   reserved paths on Windows.

PurePath.joinpath(*pathsegments)

   Calling this method is equivalent to combining the path with each
   of the given *pathsegments* in turn:

      >>> PurePosixPath('/etc').joinpath('passwd')
      PurePosixPath('/etc/passwd')
      >>> PurePosixPath('/etc').joinpath(PurePosixPath('passwd'))
      PurePosixPath('/etc/passwd')
      >>> PurePosixPath('/etc').joinpath('init.d', 'apache2')
      PurePosixPath('/etc/init.d/apache2')
      >>> PureWindowsPath('c:').joinpath('/Program Files')
      PureWindowsPath('c:/Program Files')

PurePath.full_match(pattern, *, case_sensitive=None)

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

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

   Voir aussi: documentation Pattern language.

   Comme pour les autres méthodes, la sensibilité à la casse est la
   sensibilité par défaut de la plate-forme :

      >>> PurePosixPath('b.py').full_match('*.PY')
      False
      >>> PureWindowsPath('b.py').full_match('*.PY')
      True

   La sensibilité à la casse peut être choisie en passant "True" ou
   "False" à l'argument *case_sensitive*.

   Ajouté dans la version 3.13.

PurePath.match(pattern, *, case_sensitive=None)

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

   This method is similar to "full_match()", but empty patterns aren't
   allowed ("ValueError" is raised), the recursive wildcard ""**""
   isn't supported (it acts like non-recursive ""*""), and if a
   relative pattern is provided, then matching is done from the right:

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

   Modifié dans la version 3.12: Le paramètre *pattern* accepte un
   *path-like object*.

   Modifié dans la version 3.12: ajout du paramètre *case_sensitive*

PurePath.relative_to(other, walk_up=False)

   Compute a version of this path relative to the path represented by
   *other*.  If it's impossible, "ValueError" is raised:

      >>> p = PurePosixPath('/etc/passwd')
      >>> p.relative_to('/')
      PurePosixPath('etc/passwd')
      >>> p.relative_to('/etc')
      PurePosixPath('passwd')
      >>> p.relative_to('/usr')
      Traceback (most recent call last):
        File "<stdin>", line 1, in <module>
        File "pathlib.py", line 941, in relative_to
          raise ValueError(error_message.format(str(self), str(formatted)))
      ValueError: '/etc/passwd' is not in the subpath of '/usr' OR one path is relative and the other is absolute.

   When *walk_up* is false (the default), the path must start with
   *other*. When the argument is true, ".." entries may be added to
   form the relative path. In all other cases, such as the paths
   referencing different drives, "ValueError" is raised.:

      >>> p.relative_to('/usr', walk_up=True)
      PurePosixPath('../etc/passwd')
      >>> p.relative_to('foo', walk_up=True)
      Traceback (most recent call last):
        File "<stdin>", line 1, in <module>
        File "pathlib.py", line 941, in relative_to
          raise ValueError(error_message.format(str(self), str(formatted)))
      ValueError: '/etc/passwd' is not on the same drive as 'foo' OR one path is relative and the other is absolute.

   Avertissement:

     This function is part of "PurePath" and works with strings. It
     does not check or access the underlying file structure. This can
     impact the *walk_up* option as it assumes that no symlinks are
     present in the path; call "resolve()" first if necessary to
     resolve symlinks.

   Modifié dans la version 3.12: The *walk_up* parameter was added
   (old behavior is the same as "walk_up=False").

   Deprecated since version 3.12, removed in version 3.14: Passing
   additional positional arguments is deprecated; if supplied, they
   are joined with *other*.

PurePath.with_name(name)

   Renvoie un nouveau chemin avec "name" changé. Si le chemin original
   n'a pas de nom, une "ValueError" est levée :

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

   Renvoie un nouveau chemin avec "stem" changé. Si le chemin original
   n'a pas de nom, *ValueError* est levée :

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

   Ajouté dans la version 3.9.

PurePath.with_suffix(suffix)

   Renvoie un nouveau chemin avec "suffix" changé. Si le chemin
   original n'a pas de suffixe, le nouveau *suffix* est alors ajouté.
   Si *suffix* est une chaîne vide, le suffixe d'origine est retiré :

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

   Modifié dans la version 3.14: A single dot (""."") is considered a
   valid suffix. In previous versions, "ValueError" is raised if a
   single dot is supplied.

PurePath.with_segments(*pathsegments)

   Create a new path object of the same type by combining the given
   *pathsegments*. This method is called whenever a derivative path is
   created, such as from "parent" and "relative_to()". Subclasses may
   override this method to pass information to derivative paths, for
   example:

      from pathlib import PurePosixPath

      class MyPath(PurePosixPath):
          def __init__(self, *pathsegments, session_id):
              super().__init__(*pathsegments)
              self.session_id = session_id

          def with_segments(self, *pathsegments):
              return type(self)(*pathsegments, session_id=self.session_id)

      etc = MyPath('/etc', session_id=42)
      hosts = etc / 'hosts'
      print(hosts.session_id)  # 42

   Ajouté dans la version 3.12.


Chemins concrets
================

Les chemins concrets sont des sous-classes des chemins purs. En plus
des opérations fournies par ces derniers, ils fournissent aussi des
méthodes pour faire appel au système sur des objets chemin. Il y a
trois façons d'instancier des chemins concrets :

class pathlib.Path(*pathsegments)

   Une sous-classe de "PurePath", cette classe représente les chemins
   concrets d'une famille de chemins de système de fichiers
   (l'instancier créé soit un "PosixPath", soit un "WindowsPath") :

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

   *pathsegments* est spécifié de manière similaire à "PurePath".

class pathlib.PosixPath(*pathsegments)

   Une sous-classe de "Path" et "PurePosixPath", cette classe
   représente les chemins concrets de systèmes de fichiers non Windows
   :

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

   *pathsegments* est spécifié de manière similaire à "PurePath".

   Modifié dans la version 3.13: Raises "UnsupportedOperation" on
   Windows. In previous versions, "NotImplementedError" was raised
   instead.

class pathlib.WindowsPath(*pathsegments)

   Une sous-classe de "Path" et "PureWindowsPath", cette classe
   représente les chemins concrets de systèmes de fichiers Windows :

      >>> WindowsPath('c:/', 'Users', 'Ximénez')
      WindowsPath('c:/Users/Ximénez')

   *pathsegments* est spécifié de manière similaire à "PurePath".

   Modifié dans la version 3.13: Raises "UnsupportedOperation" on non-
   Windows platforms. In previous versions, "NotImplementedError" was
   raised instead.

Vous pouvez seulement instancier la classe de la famille qui
correspond à votre système (permettre des appels au système pour des
familles de chemins non compatibles pourrait mener à des bogues ou à
des pannes de votre application) :

   >>> import os
   >>> os.name
   'posix'
   >>> Path('setup.py')
   PosixPath('setup.py')
   >>> PosixPath('setup.py')
   PosixPath('setup.py')
   >>> WindowsPath('setup.py')
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
     File "pathlib.py", line 798, in __new__
       % (cls.__name__,))
   UnsupportedOperation: cannot instantiate 'WindowsPath' on your system

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


Analyse et génération des URI
-----------------------------

Concrete path objects can be created from, and represented as, 'file'
URIs conforming to **RFC 8089**.

Note:

  File URIs are not portable across machines with different filesystem
  encodings.

classmethod Path.from_uri(uri)

   Return a new path object from parsing a 'file' URI. For example:

      >>> p = Path.from_uri('file:///etc/hosts')
      PosixPath('/etc/hosts')

   On Windows, DOS device and UNC paths may be parsed from URIs:

      >>> p = Path.from_uri('file:///c:/windows')
      WindowsPath('c:/windows')
      >>> p = Path.from_uri('file://server/share')
      WindowsPath('//server/share')

   Plusieurs variants du formulaire sont pris en charge :

      >>> p = Path.from_uri('file:////server/share')
      WindowsPath('//server/share')
      >>> p = Path.from_uri('file://///server/share')
      WindowsPath('//server/share')
      >>> p = Path.from_uri('file:c:/windows')
      WindowsPath('c:/windows')
      >>> p = Path.from_uri('file:/c|/windows')
      WindowsPath('c:/windows')

   "ValueError" is raised if the URI does not start with "file:", or
   the parsed path isn't absolute.

   Ajouté dans la version 3.13.

   Modifié dans la version 3.14: The URL authority is discarded if it
   matches the local hostname. Otherwise, if the authority isn't empty
   or "localhost", then on Windows a UNC path is returned (as before),
   and on other platforms a "ValueError" is raised.

Path.as_uri()

   Represent the path as a 'file' URI.  "ValueError" is raised if the
   path isn't absolute.

      >>> p = PosixPath('/etc/passwd')
      >>> p.as_uri()
      'file:///etc/passwd'
      >>> p = WindowsPath('c:/Windows')
      >>> p.as_uri()
      'file:///c:/Windows'

   Deprecated since version 3.14, will be removed in version 3.19:
   Calling this method from "PurePath" rather than "Path" is possible
   but deprecated. The method's use of "os.fsencode()" makes it
   strictly impure.


Expansion et résolution de chemins
----------------------------------

classmethod Path.home()

   Renvoie un nouveau chemin représentant le dossier d’accueil de
   l'utilisateur (comme renvoyé par "os.path.expanduser()" avec la
   construction "~"). Si le dossier d’accueil de l'utilisateur ne peut
   être résolu, "RuntimeError" est levée.

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

   Ajouté dans la version 3.5.

Path.expanduser()

   Renvoie un nouveau chemin avec les résolutions des constructions
   "~" et "~user", comme renvoyé par "os.path.expanduser()". Si le
   dossier d’accueil de l'utilisateur ne peut être résolu,
   "RuntimeError" est levée.

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

   Ajouté dans la version 3.5.

classmethod Path.cwd()

   Renvoie un nouveau chemin représentant le dossier courant (comme
   renvoyé par "os.getcwd()") :

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

Path.absolute()

   Rend le chemin absolu, sans normaliser ou résoudre les liens
   symboliques. Renvoie un nouveau :

      >>> p = Path('tests')
      >>> p
      PosixPath('tests')
      >>> p.absolute()
      PosixPath('/home/antoine/pathlib/tests')

Path.resolve(strict=False)

   Rend le chemin absolu, résolvant les liens symboliques. Un nouveau
   chemin est renvoyé :

      >>> p = Path()
      >>> p
      PosixPath('.')
      >>> p.resolve()
      PosixPath('/home/antoine/pathlib')

   Les composantes "".."" sont aussi éliminées (c'est la seule méthode
   pour le faire) :

      >>> p = Path('docs/../setup.py')
      >>> p.resolve()
      PosixPath('/home/antoine/pathlib/setup.py')

   If a path doesn't exist or a symlink loop is encountered, and
   *strict* is "True", "OSError" is raised.  If *strict* is "False",
   the path is resolved as far as possible and any remainder is
   appended without checking whether it exists.

   Modifié dans la version 3.6: The *strict* parameter was added
   (pre-3.6 behavior is strict).

   Modifié dans la version 3.13: Symlink loops are treated like other
   errors: "OSError" is raised in strict mode, and no exception is
   raised in non-strict mode. In previous versions, "RuntimeError" is
   raised no matter the value of *strict*.

Path.readlink()

   Renvoie le chemin vers lequel le lien symbolique pointe (tel que
   renvoyé par "os.readlink()") :

      >>> p = Path('mylink')
      >>> p.symlink_to('setup.py')
      >>> p.readlink()
      PosixPath('setup.py')

   Ajouté dans la version 3.9.

   Modifié dans la version 3.13: Raises "UnsupportedOperation" if
   "os.readlink()" is not available. In previous versions,
   "NotImplementedError" was raised.


Requête sur type et statut du fichier
-------------------------------------

Modifié dans la version 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.

Modifié dans la version 3.14: The methods given above now return
"False" instead of raising any "OSError" exception from the operating
system. In previous versions, some kinds of "OSError" exception are
raised, and others suppressed. The new behaviour is consistent with
"os.path.exists()", "os.path.isdir()", etc. Use "stat()" to retrieve
the file status without suppressing exceptions.

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.

   Cette méthode suit normalement les liens symboliques ; pour appeler
   "stat" sur un lien symbolique lui-même, ajoutez l’argument
   "follow_symlinks=False", ou utilisez "lstat()".

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

   Modifié dans la version 3.10: ajout du paramètre *follow_symlinks*.

Path.lstat()

   Comme "Path.stat()", mais, si le chemin pointe vers un lien
   symbolique, renvoie les informations du lien symbolique plutôt que
   celui de sa cible.

Path.exists(*, follow_symlinks=True)

   Return "True" if the path points to an existing file or directory.
   "False" will be returned if the path is invalid, inaccessible or
   missing. Use "Path.stat()" to distinguish between these cases.

   This method normally follows symlinks; to check if a symlink
   exists, add the argument "follow_symlinks=False".

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

   Modifié dans la version 3.12: ajout du paramètre *follow_symlinks*.

Path.is_file(*, follow_symlinks=True)

   Return "True" if the path points to a regular file. "False" will be
   returned if the path is invalid, inaccessible or missing, or if it
   points to something other than a regular file. Use "Path.stat()" to
   distinguish between these cases.

   This method normally follows symlinks; to exclude symlinks, add the
   argument "follow_symlinks=False".

   Modifié dans la version 3.13: ajout du paramètre *follow_symlinks*.

Path.is_dir(*, follow_symlinks=True)

   Return "True" if the path points to a directory. "False" will be
   returned if the path is invalid, inaccessible or missing, or if it
   points to something other than a directory. Use "Path.stat()" to
   distinguish between these cases.

   This method normally follows symlinks; to exclude symlinks to
   directories, add the argument "follow_symlinks=False".

   Modifié dans la version 3.13: ajout du paramètre *follow_symlinks*.

Path.is_symlink()

   Return "True" if the path points to a symbolic link, even if that
   symlink is broken. "False" will be returned if the path is invalid,
   inaccessible or missing, or if it points to something other than a
   symbolic link. Use "Path.stat()" to distinguish between these
   cases.

Path.is_junction()

   Return "True" if the path points to a junction, and "False" for any
   other type of file. Currently only Windows supports junctions.

   Ajouté dans la version 3.12.

Path.is_mount()

   Return "True" if the path is a *mount point*: a point in a file
   system where a different file system has been mounted.  On POSIX,
   the function checks whether *path*'s parent, "path/..", is on a
   different device than *path*, or 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.  On Windows, a mount point
   is considered to be a drive letter root (e.g. "c:\"), a UNC share
   (e.g. "\\server\share"), or a mounted filesystem directory.

   Ajouté dans la version 3.7.

   Modifié dans la version 3.12: Ajout de la gestion de Windows.

Path.is_socket()

   Return "True" if the path points to a Unix socket. "False" will be
   returned if the path is invalid, inaccessible or missing, or if it
   points to something other than a Unix socket. Use "Path.stat()" to
   distinguish between these cases.

Path.is_fifo()

   Return "True" if the path points to a FIFO. "False" will be
   returned if the path is invalid, inaccessible or missing, or if it
   points to something other than a FIFO. Use "Path.stat()" to
   distinguish between these cases.

Path.is_block_device()

   Return "True" if the path points to a block device. "False" will be
   returned if the path is invalid, inaccessible or missing, or if it
   points to something other than a block device. Use "Path.stat()" to
   distinguish between these cases.

Path.is_char_device()

   Return "True" if the path points to a character device. "False"
   will be returned if the path is invalid, inaccessible or missing,
   or if it points to something other than a character device. Use
   "Path.stat()" to distinguish between these cases.

Path.samefile(other_path)

   Renvoie si ce chemin pointe vers le même fichier que *other_path*,
   qui peut être soit un chemin, soit une chaîne de caractères. La
   sémantique est similaire à "os.path.samefile()" et
   "os.path.samestat()".

   "OSError" peut être levée si l'un des fichiers ne peut être accédé
   pour quelque raison.

      >>> p = Path('spam')
      >>> q = Path('eggs')
      >>> p.samefile(q)
      False
      >>> p.samefile('spam')
      True

   Ajouté dans la version 3.5.

Path.info

   A "PathInfo" object that supports querying file type information.
   The object exposes methods that cache their results, which can help
   reduce the number of system calls needed when switching on file
   type. For example:

      >>> p = Path('src')
      >>> if p.info.is_symlink():
      ...     print('symlink')
      ... elif p.info.is_dir():
      ...     print('directory')
      ... elif p.info.exists():
      ...     print('something else')
      ... else:
      ...     print('not found')
      ...
      directory

   If the path was generated from "Path.iterdir()" then this attribute
   is initialized with some information about the file type gleaned
   from scanning the parent directory. Merely accessing "Path.info"
   does not perform any filesystem queries.

   To fetch up-to-date information, it's best to call "Path.is_dir()",
   "is_file()" and "is_symlink()" rather than methods of this
   attribute. There is no way to reset the cache; instead you can
   create a new path object with an empty info cache via "p =
   Path(p)".

   Ajouté dans la version 3.14.


Lecture et écriture de fichiers
-------------------------------

Path.open(mode='r', buffering=-1, encoding=None, errors=None, newline=None)

   Ouvre le fichier pointé par le chemin, comme la fonction native
   "open()" le fait :

      >>> p = Path('setup.py')
      >>> with p.open() as f:
      ...     f.readline()
      ...
      '#!/usr/bin/env python3\n'

Path.read_text(encoding=None, errors=None, newline=None)

   Renvoie le contenu décodé du fichier pointé en tant que chaîne de
   caractères :

      >>> p = Path('my_text_file')
      >>> p.write_text('Text file contents')
      18
      >>> p.read_text()
      'Text file contents'

   Le fichier est ouvert, puis fermé. Les paramètres optionnels ont la
   même signification que dans "open()".

   Ajouté dans la version 3.5.

   Modifié dans la version 3.13: ajout du paramètre *newline*.

Path.read_bytes()

   Renvoie le contenu binaire du fichier pointé en tant que chaîne
   d’octets :

      >>> p = Path('my_binary_file')
      >>> p.write_bytes(b'Binary file contents')
      20
      >>> p.read_bytes()
      b'Binary file contents'

   Ajouté dans la version 3.5.

Path.write_text(data, encoding=None, errors=None, newline=None)

   Ouvre le fichier pointé en mode texte, écrit *data* dedans, et
   ferme le fichier :

      >>> p = Path('my_text_file')
      >>> p.write_text('Text file contents')
      18
      >>> p.read_text()
      'Text file contents'

   Le fichier du même nom, s'il existe, est écrasé. Les paramètres
   optionnels ont la même signification que dans "open()".

   Ajouté dans la version 3.5.

   Modifié dans la version 3.10: ajout du paramètre *newline*.

Path.write_bytes(data)

   Ouvre le fichier pointé en mode binaire, écrit *data* dedans, et
   ferme le fichier :

      >>> p = Path('my_binary_file')
      >>> p.write_bytes(b'Binary file contents')
      20
      >>> p.read_bytes()
      b'Binary file contents'

   Le fichier du même nom, s'il existe, est écrasé.

   Ajouté dans la version 3.5.


Lecture des dossiers
--------------------

Path.iterdir()

   Quand le chemin pointe vers un dossier, donne par séquences les
   objets chemin du contenu du dossier :

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

   Si le chemin n'est pas un dossier ou n'est pas accessible,
   "OSError" est levée.

Path.glob(pattern, *, case_sensitive=None, recurse_symlinks=False)

   *Glob* de manière relative suivant le motif *pattern* fourni dans
   le dossier représenté par ce chemin, donnant tous les fichiers
   correspondants (de n'importe quelle sorte) :

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

   Note:

     The paths are returned in no particular order. If you need a
     specific order, sort the results.

   Voir aussi: documentation Pattern language.

   By default, or when the *case_sensitive* keyword-only argument is
   set to "None", this method matches paths using platform-specific
   casing rules: typically, case-sensitive on POSIX, and case-
   insensitive on Windows. Set *case_sensitive* to "True" or "False"
   to override this behaviour.

   By default, or when the *recurse_symlinks* keyword-only argument is
   set to "False", this method follows symlinks except when expanding
   ""**"" wildcards. Set *recurse_symlinks* to "True" to always follow
   symlinks.

   Lève un évènement d’audit "pathlib.Path.glob" avec comme arguments
   "self" et "pattern".

   Modifié dans la version 3.12: ajout du paramètre *case_sensitive*

   Modifié dans la version 3.13: Ajout du paramètre
   *recurse_symlinks*.

   Modifié dans la version 3.13: Le paramètre *pattern* accepte un
   *path-like object*.

   Modifié dans la version 3.13: Any "OSError" exceptions raised from
   scanning the filesystem are suppressed. In previous versions, such
   exceptions are suppressed in many cases, but not all.

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

   Glob the given relative *pattern* recursively.  This is like
   calling "Path.glob()" with ""**/"" added in front of the *pattern*.

   Note:

     The paths are returned in no particular order. If you need a
     specific order, sort the results.

   Voir aussi: Documentation pour Pattern language et "Path.glob()" .

   Lève un évènement d’audit "pathlib.Path.glob" avec comme arguments
   "self" et "pattern".

   Modifié dans la version 3.12: ajout du paramètre *case_sensitive*

   Modifié dans la version 3.13: Ajout du paramètre
   *recurse_symlinks*.

   Modifié dans la version 3.13: Le paramètre *pattern* accepte un
   *path-like object*.

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

   Generate the file names in a directory tree by walking the tree
   either top-down or bottom-up.

   For each directory in the directory tree rooted at *self*
   (including *self* but excluding '.' and '..'), the method yields a
   3-tuple of "(dirpath, dirnames, filenames)".

   *dirpath* is a "Path" to the directory currently being walked,
   *dirnames* is a list of strings for the names of subdirectories in
   *dirpath* (excluding "'.'" and "'..'"), and *filenames* is a list
   of strings for the names of the non-directory files in *dirpath*.
   To get a full path (which begins with *self*) to a file or
   directory in *dirpath*, do "dirpath / name". Whether or not the
   lists are sorted is file system-dependent.

   If the optional argument *top_down* is true (which is the default),
   the triple for a directory is generated before the triples for any
   of its subdirectories (directories are walked top-down).  If
   *top_down* is false, the triple for a directory is generated after
   the triples for all of its subdirectories (directories are walked
   bottom-up). No matter the value of *top_down*, the list of
   subdirectories is retrieved before the triples for the directory
   and its subdirectories are walked.

   When *top_down* is true, the caller can modify the *dirnames* list
   in-place (for example, using "del" or slice assignment), 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.

   By default, errors from "os.scandir()" are ignored.  If the
   optional argument *on_error* is specified, it should be a callable;
   it will be called with one argument, an "OSError" instance. The
   callable can handle the error to continue the walk or re-raise it
   to stop the walk. Note that the filename is available as the
   "filename" attribute of the exception object.

   By default, "Path.walk()" does not follow symbolic links, and
   instead adds them to the *filenames* list. Set *follow_symlinks* to
   true to resolve symlinks and place them in *dirnames* and
   *filenames* as appropriate for their targets, and consequently
   visit directories pointed to by symlinks (where supported).

   Note:

     Be aware that setting *follow_symlinks* to true can lead to
     infinite recursion if a link points to a parent directory of
     itself. "Path.walk()" does not keep track of the directories it
     has already visited.

   Note:

     "Path.walk()" assumes the directories it walks are not modified
     during execution. For example, if a directory from *dirnames* has
     been replaced with a symlink and *follow_symlinks* is false,
     "Path.walk()" will still try to descend into it. To prevent such
     behavior, remove directories from *dirnames* as appropriate.

   Note:

     Unlike "os.walk()", "Path.walk()" lists symlinks to directories
     in *filenames* if *follow_symlinks* is false.

   This example displays the number of bytes used by all files in each
   directory, while ignoring "__pycache__" directories:

      from pathlib import Path
      for root, dirs, files in Path("cpython/Lib/concurrent").walk(on_error=print):
        print(
            root,
            "consumes",
            sum((root / file).stat().st_size for file in files),
            "bytes in",
            len(files),
            "non-directory files"
        )
        if '__pycache__' in dirs:
              dirs.remove('__pycache__')

   This next example is a simple implementation of "shutil.rmtree()".
   Walking the tree bottom-up is essential as "rmdir()" doesn't allow
   deleting a directory before it is empty:

      # Delete everything reachable from the directory "top".
      # CAUTION:  This is dangerous! For example, if top == Path('/'),
      # it could delete all of your files.
      for root, dirs, files in top.walk(top_down=False):
          for name in files:
              (root / name).unlink()
          for name in dirs:
              (root / name).rmdir()

   Ajouté dans la version 3.12.


Création de fichiers et de dossiers
-----------------------------------

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.

   Voir aussi:

     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* est vrai, chaque parent de ce chemin est créé si
   besoin ; ils sont créés avec les permissions par défaut sans
   prendre en compte *mode* (reproduisant la commande POSIX "mkdir
   -p").

   Si *parents* est faux (valeur par défaut), un parent manquant lève
   "FileNotFoundError".

   Si *exist_ok* est faux (valeur par défaut), "FileExistsError" est
   levé si le dossier cible existe déjà.

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

   Modifié dans la version 3.5: ajout du paramètre *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

   Note:

     L'ordre des arguments (lien, cible) est l'opposé de ceux de
     "os.symlink()".

   Modifié dans la version 3.13: Raises "UnsupportedOperation" if
   "os.symlink()" is not available. In previous versions,
   "NotImplementedError" was raised.

Path.hardlink_to(target)

   Crée un lien physique pointant sur le même fichier que *target*.

   Note:

     L'ordre des arguments (lien, cible) est l'opposé de celui de
     "os.link()".

   Ajouté dans la version 3.10.

   Modifié dans la version 3.13: Raises "UnsupportedOperation" if
   "os.link()" is not available. In previous versions,
   "NotImplementedError" was raised.


Copying, moving and deleting
----------------------------

Path.copy(target, *, follow_symlinks=True, preserve_metadata=False)

   Copy this file or directory tree to the given *target*, and return
   a new "Path" instance pointing to *target*.

   If the source is a file, the target will be replaced if it is an
   existing file. If the source is a symlink and *follow_symlinks* is
   true (the default), the symlink's target is copied. Otherwise, the
   symlink is recreated at the destination.

   If *preserve_metadata* is false (the default), only directory
   structures and file data are guaranteed to be copied. Set
   *preserve_metadata* to true to ensure that file and directory
   permissions, flags, last access and modification times, and
   extended attributes are copied where supported. This argument has
   no effect when copying files on Windows (where metadata is always
   preserved).

   Note:

     Where supported by the operating system and file system, this
     method performs a lightweight copy, where data blocks are only
     copied when modified. This is known as copy-on-write.

   Ajouté dans la version 3.14.

Path.copy_into(target_dir, *, follow_symlinks=True, preserve_metadata=False)

   Copy this file or directory tree into the given *target_dir*, which
   should be an existing directory. Other arguments are handled
   identically to "Path.copy()". Returns a new "Path" instance
   pointing to the copy.

   Ajouté dans la version 3.14.

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.

   Cette méthode est implémentée d'après "os.rename()" et fournit les
   mêmes garanties.

   Modifié dans la version 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.

   Modifié dans la version 3.8: Added return value, return the new
   "Path" instance.

Path.move(target)

   Move this file or directory tree to the given *target*, and return
   a new "Path" instance pointing to *target*.

   If the *target* doesn't exist it will be created. If both this path
   and the *target* are existing files, then the target is
   overwritten. If both paths point to the same file or directory, or
   the *target* is a non-empty directory, then "OSError" is raised.

   If both paths are on the same filesystem, the move is performed
   with "os.replace()". Otherwise, this path is copied (preserving
   metadata and symlinks) and then deleted.

   Ajouté dans la version 3.14.

Path.move_into(target_dir)

   Move this file or directory tree into the given *target_dir*, which
   should be an existing directory. Returns a new "Path" instance
   pointing to the moved path.

   Ajouté dans la version 3.14.

Path.unlink(missing_ok=False)

   Supprime ce fichier ou lien symbolique. Si le chemin pointe vers un
   dossier, utilisez "Path.rmdir()" à la place.

   Si *missing_ok* est faux (valeur par défaut), une
   "FileNotFoundError" est levée si le chemin n'existe pas.

   Si *missing_ok* est vrai, les exceptions "FileNotFoundError" sont
   ignorées (même comportement que la commande POSIX "rm -f").

   Modifié dans la version 3.8: Ajout du paramètre *missing_ok*.

Path.rmdir()

   Supprime ce dossier. Le dossier doit être vide.


Permissions et propriété
------------------------

Path.owner(*, follow_symlinks=True)

   Return the name of the user owning the file. "KeyError" is raised
   if the file's user identifier (UID) isn't found in the system
   database.

   This method normally follows symlinks; to get the owner of the
   symlink, add the argument "follow_symlinks=False".

   Modifié dans la version 3.13: Raises "UnsupportedOperation" if the
   "pwd" module is not available. In earlier versions,
   "NotImplementedError" was raised.

   Modifié dans la version 3.13: ajout du paramètre *follow_symlinks*.

Path.group(*, follow_symlinks=True)

   Return the name of the group owning the file. "KeyError" is raised
   if the file's group identifier (GID) isn't found in the system
   database.

   This method normally follows symlinks; to get the group of the
   symlink, add the argument "follow_symlinks=False".

   Modifié dans la version 3.13: Raises "UnsupportedOperation" if the
   "grp" module is not available. In earlier versions,
   "NotImplementedError" was raised.

   Modifié dans la version 3.13: ajout du paramètre *follow_symlinks*.

Path.chmod(mode, *, follow_symlinks=True)

   Change le mode et les permissions du fichier, comme "os.chmod()".

   Cette méthode suit normalement les liens symboliques. Certaines
   versions d’Unix prennent en charge la modification des permissions
   sur le lien symbolique lui-même ; sur ces plateformes, vous pouvez
   ajouter l’argument "follow_symlinks=False", ou utiliser "lchmod()".

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

   Modifié dans la version 3.10: ajout du paramètre *follow_symlinks*.

Path.lchmod(mode)

   Comme "Path.chmod()", mais, si le chemin pointe vers un lien
   symbolique, le mode du lien symbolique est changé plutôt que celui
   de sa cible.


Pattern language
================

The following wildcards are supported in patterns for "full_match()",
"glob()" and "rglob()":

"**" (tout le segment)
   Matche un nombre quelconque de segments de fichiers ou dossiers,
   zéro inclus

"*" (tout le segment)
   Correspondance d'un segment de fichier ou de dossier

"*" (partie du segment)
   Matches any number of non-separator characters, including zero.

"?"
   Matches one non-separator character.

"[seq]"
   Matches one character in *seq*, where *seq* is a sequence of
   characters. Range expressions are supported; for example, "[a-z]"
   matches any lowercase ASCII letter. Multiple ranges can be
   combined: "[a-zA-Z0-9_]" matches any ASCII letter, digit, or
   underscore.

"[!seq]"
   Matches one character not in *seq*, where *seq* follows the same
   rules as above.

For a literal match, wrap the meta-characters in brackets. For
example, ""[?]"" matches the character ""?"".

The ""**"" wildcard enables recursive globbing. A few examples:

+---------------------------+-----------------------------------------------------------------------+
| Motif                     | Signification                                                         |
|===========================|=======================================================================|
| ""**/*""                  | N'importe quel chemin avec au moins un segment                        |
+---------------------------+-----------------------------------------------------------------------+
| ""**/*.py""               | Any path with a final segment ending "".py"".                         |
+---------------------------+-----------------------------------------------------------------------+
| ""assets/**""             | Any path starting with ""assets/"".                                   |
+---------------------------+-----------------------------------------------------------------------+
| ""assets/**/*""           | Any path starting with ""assets/"", excluding ""assets/"" itself.     |
+---------------------------+-----------------------------------------------------------------------+

Note:

  Globbing with the ""**"" wildcard visits every directory in the
  tree. Large directory trees may take a long time to search.

Modifié dans la version 3.13: Globbing with a pattern that ends with
""**"" returns both files and directories. In previous versions, only
directories were returned.

In "Path.glob()" and "rglob()", a trailing slash may be added to the
pattern to match only directories.

Modifié dans la version 3.11: Globbing with a pattern that ends with a
pathname components separator ("sep" or "altsep") returns only
directories.


Comparaison avec les outils du module "glob"
============================================

The patterns accepted and results generated by "Path.glob()" and
"Path.rglob()" differ slightly from those by the "glob" module:

1. Files beginning with a dot are not special in pathlib. This is like
   passing "include_hidden=True" to "glob.glob()".

2. ""**"" pattern components are always recursive in pathlib. This is
   like passing "recursive=True" to "glob.glob()".

3. ""**"" pattern components do not follow symlinks by default in
   pathlib. This behaviour has no equivalent in "glob.glob()", but you
   can pass "recurse_symlinks=True" to "Path.glob()" for compatible
   behaviour.

4. Like all "PurePath" and "Path" objects, the values returned from
   "Path.glob()" and "Path.rglob()" don't include trailing slashes.

5. The values returned from pathlib's "path.glob()" and "path.rglob()"
   include the *path* as a prefix, unlike the results of
   "glob.glob(root_dir=path)".

6. The values returned from pathlib's "path.glob()" and "path.rglob()"
   may include *path* itself, for example when globbing ""**"",
   whereas the results of "glob.glob(root_dir=path)" never include an
   empty string that would correspond to *path*.


Comparaison  aux modules "os" et "os.path"
==========================================

pathlib implements path operations using "PurePath" and "Path"
objects, and so it's said to be *object-oriented*. On the other hand,
the "os" and "os.path" modules supply functions that work with low-
level "str" and "bytes" objects, which is a more *procedural*
approach. Some users consider the object-oriented style to be more
readable.

Many functions in "os" and "os.path" support "bytes" paths and paths
relative to directory descriptors. These features aren't available in
pathlib.

Python's "str" and "bytes" types, and portions of the "os" and
"os.path" modules, are written in C and are very speedy. pathlib is
written in pure Python and is often slower, but rarely slow enough to
matter.

pathlib's path normalization is slightly more opinionated and
consistent than "os.path". For example, whereas "os.path.abspath()"
eliminates "".."" segments from a path, which may change its meaning
if symlinks are involved, "Path.absolute()" preserves these segments
for greater safety.

pathlib's path normalization may render it unsuitable for some
applications:

1. pathlib normalizes "Path("my_folder/")" to "Path("my_folder")",
   which changes a path's meaning when supplied to various operating
   system APIs and command-line utilities. Specifically, the absence
   of a trailing separator may allow the path to be resolved as either
   a file or directory, rather than a directory only.

2. pathlib normalizes "Path("./my_program")" to "Path("my_program")",
   which changes a path's meaning when used as an executable search
   path, such as in a shell or when spawning a child process.
   Specifically, the absence of a separator in the path may force it
   to be looked up in "PATH" rather than the current directory.

As a consequence of these differences, pathlib is not a drop-in
replacement for "os.path".


Outils correspondants
---------------------

Ci-dessous se trouve un tableau associant diverses fonctions "os" à
leur équivalent "PurePath" / "Path" correspondant.

+---------------------------------------+------------------------------------------------+
| "os" et "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()"                                |
+---------------------------------------+------------------------------------------------+

-[ Notes ]-

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


Protocoles
==========

The "pathlib.types" module provides types for static type checking.

Ajouté dans la version 3.14.

class pathlib.types.PathInfo

   A "typing.Protocol" describing the "Path.info" attribute.
   Implementations may return cached results from their methods.

   exists(*, follow_symlinks=True)

      Return "True" if the path is an existing file or directory, or
      any other kind of file; return "False" if the path doesn't
      exist.

      If *follow_symlinks* is "False", return "True" for symlinks
      without checking if their targets exist.

   is_dir(*, follow_symlinks=True)

      Return "True" if the path is a directory, or a symbolic link
      pointing to a directory; return "False" if the path is (or
      points to) any other kind of file, or if it doesn't exist.

      If *follow_symlinks* is "False", return "True" only if the path
      is a directory (without following symlinks); return "False" if
      the path is any other kind of file, or if it doesn't exist.

   is_file(*, follow_symlinks=True)

      Return "True" if the path is a file, or a symbolic link pointing
      to a file; return "False" if the path is (or points to) a
      directory or other non-file, or if it doesn't exist.

      If *follow_symlinks* is "False", return "True" only if the path
      is a file (without following symlinks); return "False" if the
      path is a directory or other non-file, or if it doesn't exist.

   is_symlink()

      Return "True" if the path is a symbolic link (even if broken);
      return "False" if the path is a directory or any kind of file,
      or if it doesn't exist.
