"pathlib" --- Object-oriented filesystem paths
**********************************************

バージョン 3.4 で追加.

**Source code:** Lib/pathlib.py

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

このモジュールはファイルシステムのパスを表すクラスを提供していて、様々
なオペレーティングシステムについての適切な意味論をそれらのクラスに持た
せています。 Path クラスは 純粋パス と 具象パス からなります。 純粋パ
スは I/O を伴わない純粋な計算操作を提供します。 具象パスは純粋パスを継
承していますが、 I/O 操作も提供しています。

[画像]

あなたが今までこのモジュールを使用したことがない場合や、タスクに適して
いるのがどのクラスかわからない場合は、 "Path" はきっとあなたに必要なも
のでしょう。 "Path" はコードが実行されているプラットフォーム用の 具象
パス のインスタンスを作成します。

純粋パスは、以下のようないくつかの特殊なケースで有用です:

1. Unix マシン上で Windows のパスを扱いたいとき (またはその逆)。Unix
   上で実行しているときに "WindowsPath" のインスタンスを作成することは
   できませんが、"PureWindowsPath" なら可能になります。

2. 実際に OS にアクセスすることなしにパスを操作するだけのコードを確認
   したいとき。この場合、純粋クラスのインスタンスを一つ作成すれば、そ
   れが OS にアクセスすることはないので便利です。

参考: **PEP 428**: The pathlib module -- オブジェクト指向のファイルシステ
    ムパス。

参考: 文字列による低水準のパス操作の場合は "os.path" も使用できます。


基本的な使い方
==============

メインクラスをインポートします:

   >>> from pathlib import Path

サブディレクトリの一覧を取得します:

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

このディレクトリツリー内の Python ソースファイルの一覧を取得します:

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

ディレクトリツリー内を移動します:

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

パスのプロパティを問い合わせます:

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

ファイルを開きます:

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


純粋パス
========

純粋パスオブジェクトは実際にファイルシステムにアクセスしないパス操作処
理を提供します。これらのクラスにアクセスするには 3 つの方法があり、そ
れらを *フレーバー* と呼んでいます:

class pathlib.PurePath(*pathsegments)

   システムのパスのフレーバーを表すジェネリッククラスです (インスタン
   スを作成することで "PurePosixPath" または "PureWindowsPath" のどち
   らかが作成されます):

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

   Each element of *pathsegments* can be either a string representing
   a path segment, an object implementing the "os.PathLike" interface
   which returns a string, or another path object:

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

   *pathsegments* が空のとき、現在のディレクトリとみなされます:

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

   あるパス構成要素が絶対パスである場合、それより前の要素はすべて無視
   されます ("os.path.join()" と同様):

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

   Windowsの場合、ルート相対パス (例えば "r'\foo'") があってもドライブ
   名はそのまま変わりません:

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

   単一スラッシュと等価な複数スラッシュやシングルドットは簡略化されま
   すが、ダブルドット ("'..'") や先頭に位置するダブルスラッシュ
   ("'//'") は簡略化されません。 これは、様々な理由でパスの意味が簡略
   化した場合と異なってしまうからです (例: シンボリックリンク、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')

   (通常 "PurePosixPath('foo/../bar')" は "PurePosixPath('bar')" と等
   価になりますが、"foo" が他のディレクトリへのシンボリックリンクの場
   合は等価になりません)

   純粋パスオブジェクトは "os.PathLike" インターフェースを実装しており
   、そのインターフェースを受理する箇所ならどこでも使用することができ
   ます。

   バージョン 3.6 で変更: "os.PathLike" インターフェースがサポートされ
   ました。

class pathlib.PurePosixPath(*pathsegments)

   "PurePath" のサブクラスです。このパスフレーバーは非 Windows パスを
   表します:

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

   *pathsegments* の指定は "PurePath" と同じです。

class pathlib.PureWindowsPath(*pathsegments)

   "PurePath" のサブクラスです。このパスフレーバー UNC paths を含む
   Windows ファイルシステムパスを表します:

      >>> PureWindowsPath('c:/Program Files/')
      PureWindowsPath('c:/Program Files')
      >>> PureWindowsPath('//server/share/file')
      PureWindowsPath('//server/share/file')

   *pathsegments* の指定は "PurePath" と同じです。

これらクラスはあらゆるシステムコールを行わないため、起動しているシステ
ムにかかわらずインスタンスを作成できます。


全般的な性質
------------

パスオブジェクトはイミュータブルで *ハッシュ可能* です。同じフレーバー
のパスオブジェクトは比較ならびに順序付け可能です。これらのプロパティは
、フレーバーのケースフォールディング (訳注: 比較のために正規化すること
、例えば全て大文字にする) のセマンティクスに従います。

   >>> PurePosixPath('foo') == PurePosixPath('FOO')
   False
   >>> PureWindowsPath('foo') == PureWindowsPath('FOO')
   True
   >>> PureWindowsPath('FOO') in { PureWindowsPath('foo') }
   True
   >>> PureWindowsPath('C:') < PureWindowsPath('d:')
   True

異なるフレーバーのパスオブジェクト同士の比較は等価になることはなく、順
序付けもできません:

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


演算子
------

スラッシュ演算子を使って、 "os.path.join()" のように子パスを作成するこ
とができます。 スラッシュの右側が絶対パスである場合、左側のパスは無視
されます。 Windows環境で、右側のパスがルート相対パス (例: "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')

"os.PathLike" を実装したオブジェクトが受理できる箇所ならどこでも、パス
オブジェクトが使用できます:

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

パスオブジェクトの文字列表現はそのシステム自身の Raw ファイルシステム
パス (ネイティブの形式、例えば Windows では区切り文字がバックスラッシ
ュ) になり、文字列としてファイルパスを取るあらゆる関数に渡すことができ
ます:

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

同様に、パスオブジェクトを "bytes" で呼び出すと、Raw ファイルシステム
パスを "os.fsencode()" でエンコードされたバイト列オブジェクトで返しま
す:

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

注釈:

  "bytes" での呼び出しは Unix 上での使用のみ推奨します。Windows では
  Unicode 形式が標準的なファイルシステムパス表現になります。


個別の構成要素へのアクセス
--------------------------

パスの個別の "構成要素" へアクセスするには、以下のプロパティを使用しま
す:

PurePath.parts

   パスのさまざまな構成要素へのアクセス手段を提供するタプルになります:

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

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

   (ドライブ名とローカルルートは単一要素にまとめられます)


メソッドとプロパティ
--------------------

純粋パスは以下のメソッドとプロパティを提供します:

PurePath.drive

   ドライブ文字または名前を表す文字列があればそれになります:

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

   UNC 共有名もドライブとみなされます:

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

PurePath.root

   ローカルまたはグローバルルートを表す文字列があればそれになります:

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

   UNC 共有名は常にルートを持ちます:

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

   "PurePosixPath" でパスの先頭が３つ以上の連続したスラッシュである場
   合、 余分なスラッシュは除去されます:

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

   注釈:

     この挙動は、以下に示す、 *The Open Group Base Specifications
     Issue 6* の 4.11 Pathname Resolution に沿ったものです:*"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

   ドライブとルートを結合した文字列になります:

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

PurePath.parents

   パスの論理的な上位パスにアクセスできるイミュータブルなシーケンスに
   なります:

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

   バージョン 3.10 で変更: parents シーケンスが、*スライス* と負のイン
   デックスをサポートするようになりました。

PurePath.parent

   パスの論理的な上位パスになります:

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

   アンカーの位置を超えることや空のパスになる位置には対応していません:

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

   注釈:

     これは純粋な字句操作であるため、以下のような挙動になります:

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

     任意のファイルシステムパスを上位方向に移動したい場合、シンボリッ
     クリンクの解決や "".."" 要素の除去のため、最初に "Path.resolve()"
     を呼ぶことを推奨します。

PurePath.name

   パス要素の末尾を表す文字列があればそれになります。ドライブやルート
   は含まれません:

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

   UNC ドライブ名は考慮されません:

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

PurePath.suffix

   The file extension of the final component, if any:

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

PurePath.suffixes

   A list of the path's file extensions:

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

PurePath.stem

   パス要素の末尾から拡張子を除いたものになります:

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

PurePath.as_posix()

   フォワードスラッシュ ("/") を使用したパスを表す文字列を返します:

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

PurePath.as_uri()

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

   >>> p = PurePosixPath('/etc/passwd')
   >>> p.as_uri()
   'file:///etc/passwd'
   >>> p = PureWindowsPath('c:/Windows')
   >>> p.as_uri()
   'file:///c:/Windows'

PurePath.is_absolute()

   パスが絶対パスかどうかを返します。パスが絶対パスとみなされるのは、
   ルートと (フレーバーが許す場合) ドライブとの両方が含まれる場合です:

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

   このパスが *other* パスに対して相対なのかそうでないのかの結果を返し
   ます。

   >>> p = PurePath('/etc/passwd')
   >>> p.is_relative_to('/etc')
   True
   >>> p.is_relative_to('/usr')
   False

   If multiple arguments are supplied, they are joined together.

   This method is string-based; it neither accesses the filesystem nor
   treats "".."" segments specially. The following code is equivalent:

   >>> u = PurePath('/usr')
   >>> u == p or u in p.parents
   False

   バージョン 3.9 で追加.

PurePath.is_reserved()

   "PureWindowsPath" の場合はパスが Windows 上で予約されていれば
   "True" を返し、そうでなければ "False" を返します。"PurePosixPath"
   の場合は常に "False" を返します。

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

   File system calls on reserved paths can fail mysteriously or have
   unintended effects.

PurePath.joinpath(*other)

   Calling this method is equivalent to combining the path with each
   of the *other* arguments 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.match(pattern)

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

   If *pattern* is relative, the path can be either relative or
   absolute, and 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

   If *pattern* is absolute, the path must be absolute, and the whole
   path must match:

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

   他のメソッドと同様に、大文字小文字の区別はプラットフォームの設定に
   従います:

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

PurePath.relative_to(*other)

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

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

   If multiple arguments are supplied, they are joined together.

   NOTE: This function is part of "PurePath" and works with strings.
   It does not check or access the underlying file structure.

PurePath.with_name(name)

   現在のパスの "name" 部分を変更したパスを返します。オリジナルパスに
   "name" 部分がない場合は 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)

   現在のパスの "stem" 部分を変更したパスを返します。オリジナルパスに
   "stem" 部分がない場合は 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

   バージョン 3.9 で追加.

PurePath.with_suffix(suffix)

   "suffix" を変更した新しいパスを返します。 元のパスに suffix が無か
   った場合、代わりに新しい *suffix* が追加されます。 *suffix* が空文
   字列だった場合、元の suffix は除去されます:

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


具象パス
========

具象パスは純粋パスクラスのサブクラスです。純粋パスが提供する操作に加え
、パスオブジェクト上でシステムコールを呼ぶメソッドも提供しています。具
象パスのインスタンスを作成するには 3 つの方法があります:

class pathlib.Path(*pathsegments)

   "PurePath" のサブクラスであり、システムのパスフレーバーの具象パスを
   表します (このインスタンスの作成で "PosixPath" か "WindowsPath" の
   どちらかが作成されます):

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

   *pathsegments* の指定は "PurePath" と同じです。

class pathlib.PosixPath(*pathsegments)

   "Path" および "PurePosixPath" のサブクラスで、非 Windows ファイルシ
   ステムの具象パスを表します:

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

   *pathsegments* の指定は "PurePath" と同じです。

class pathlib.WindowsPath(*pathsegments)

   "Path" および "PureWindowsPath" のサブクラスで、Windows ファイルシ
   ステムの具象パスを表します:

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

   *pathsegments* の指定は "PurePath" と同じです。

インスタンスを作成できるのはシステムと一致するフレーバーのみです (互換
性のないパスフレーバーでのシステムコールの許可はバグやアプリケーション
の異常終了の原因になります):

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


Methods
-------

Concrete paths provide the following methods in addition to pure paths
methods.  Many of these methods can raise an "OSError" if a system
call fails (for example because the path doesn't exist).

バージョン 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.

classmethod Path.cwd()

   ("os.getcwd()" が返す) 現在のディレクトリを表す新しいパスオブジェク
   トを返します:

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

classmethod Path.home()

   ユーザーのホームディレクトリ ("os.path.expanduser()" での "~" の返
   り値) を表す新しいパスオブジェクトを返します。ホームディレクトリが
   解決できない場合は、 "RuntimeError" を送出します。

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

   バージョン 3.5 で追加.

Path.stat(*, follow_symlinks=True)

   Return a "os.stat_result" object containing information about this
   path, like "os.stat()". The result is looked up at each call to
   this method.

   このメソッドは通常はシンボリックリンクをたどります。シンボリックリ
   ンクに対して stat したい場合は "follow_symlinks=False" とするか、
   "lstat()" を利用してください。

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

   バージョン 3.10 で変更: *follow_symlinks* パラメータが追加されまし
   た。

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

   "os.chmod()" のようにファイルのモードとアクセス権限を変更します。

   このメソッドは通常シンボリックリンクをたどります。一部のUnixではシ
   ンボリックリンク自体のパーミッション変更をサポートしています。その
   ようなプラットフォームでは引数に``follow_symlinks=False`` を追加す
   るか、"lchmod()" を使用してください。

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

   バージョン 3.10 で変更: *follow_symlinks* パラメータが追加されまし
   た。

Path.exists()

   Whether the path points to an existing file or directory:

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

   注釈:

     If the path points to a symlink, "exists()" returns whether the
     symlink *points to* an existing file or directory.

Path.expanduser()

   パス要素 "~" および "~user" を "os.path.expanduser()" が返すように
   展開した新しいパスオブジェクトを返します。ホームディレクトリが解決
   できない場合は、 "RuntimeError" を送出します。

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

   バージョン 3.5 で追加.

Path.glob(pattern)

   現在のパスが表すディレクトリ内で相対 *pattern* に一致する (あらゆる
   種類の) すべてのファイルを yield します:

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

   Patterns are the same as for "fnmatch", with the addition of ""**""
   which means "this directory and all subdirectories, recursively".
   In other words, it enables recursive globbing:

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

   注釈:

     Using the ""**"" pattern in large directory trees may consume an
     inordinate amount of time.

   引数 "self", "pattern" を指定して 監査イベント "pathlib.Path.glob"
   を送出します。

   バージョン 3.11 で変更: Return only directories if *pattern* ends
   with a pathname components separator ("sep" or "altsep").

Path.group()

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

Path.is_dir()

   Return "True" if the path points to a directory (or a symbolic link
   pointing to a directory), "False" if it points to another kind of
   file.

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

Path.is_file()

   Return "True" if the path points to a regular file (or a symbolic
   link pointing to a regular file), "False" if it points to another
   kind of file.

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

Path.is_mount()

   Return "True" if the path is a *mount point*: a point in a file
   system where a different file system has been mounted.  On POSIX,
   the function checks whether *path*'s parent, "path/..", is on a
   different device than *path*, or whether "path/.." and *path* point
   to the same i-node on the same device --- this should detect mount
   points for all Unix and POSIX variants.  Not implemented on
   Windows.

   バージョン 3.7 で追加.

Path.is_symlink()

   Return "True" if the path points to a symbolic link, "False"
   otherwise.

   "False" is also returned if the path doesn't exist; other errors
   (such as permission errors) are propagated.

Path.is_socket()

   Return "True" if the path points to a Unix socket (or a symbolic
   link pointing to a Unix socket), "False" if it points to another
   kind of file.

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

Path.is_fifo()

   Return "True" if the path points to a FIFO (or a symbolic link
   pointing to a FIFO), "False" if it points to another kind of file.

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

Path.is_block_device()

   Return "True" if the path points to a block device (or a symbolic
   link pointing to a block device), "False" if it points to another
   kind of file.

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

Path.is_char_device()

   Return "True" if the path points to a character device (or a
   symbolic link pointing to a character device), "False" if it points
   to another kind of file.

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

Path.iterdir()

   パスがディレクトリを指していた場合、ディレクトリの内容のパスオブジ
   ェクトを yield します:

      >>> 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, whether
   a path object for that file be included is unspecified.

Path.lchmod(mode)

   "Path.chmod()" のように振る舞いますが、パスがシンボリックリンクを指
   していた場合、リンク先ではなくシンボリックリンク自身のモードが変更
   されます。

Path.lstat()

   "Path.stat()" のように振る舞いますが、パスがシンボリックリンクを指
   していた場合、リンク先ではなくシンボリックリンク自身の情報を返しま
   す。

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' "umask" value to determine the file
   mode and access flags.  If the path already exists,
   "FileExistsError" is raised.

   *parents* の値が真の場合、このパスの親ディレクトリを必要に応じて作
   成します; それらのアクセス制限はデフォルト値が取られ、*mode* は使用
   されません (POSIX の "mkdir -p" コマンドを真似ています)。

   *parents* の値が偽の場合 (デフォルト)、親ディレクトリがないと
   "FileNotFoundError" を送出します。

   *exist_ok* の値が (デフォルトの) 偽の場合、対象のディレクトリがすで
   に存在すると "FileExistsError" を送出します。

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

   バージョン 3.5 で変更: *exist_ok* 引数が追加されました。

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

   組み込み関数 "open()" のようにパスが指しているファイルを開きます:

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

Path.owner()

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

Path.read_bytes()

   指定されたファイルの内容をバイナリオブジェクトで返します:

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

   バージョン 3.5 で追加.

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

   指定されたファイルの内容を文字列としてデコードして返します:

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

   ファイルを開いた後に閉じます。 オプションのパラメーターの意味は
   "open()" と同じです。

   バージョン 3.5 で追加.

Path.readlink()

   ( "os.readlink()" が返す) シンボリックリンクが指すパスを返します:

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

   バージョン 3.9 で追加.

Path.rename(target)

   Rename this file or directory to the given *target*, and return a
   new Path instance pointing to *target*.  On Unix, if *target*
   exists and is a file, it will be replaced silently if the user has
   permission. On Windows, if *target* exists, "FileExistsError" will
   be raised. *target* can be either a string or another path object:

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

   The target path may be absolute or relative. Relative paths are
   interpreted relative to the current working directory, *not* the
   directory of the Path object.

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

   バージョン 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.

   バージョン 3.8 で変更: Added return value, return the new Path
   instance.

Path.absolute()

   正規化やシンボリックリンクの解決をせずに、パスを絶対パスにします。
   新しいパスオブジェクトを返します:

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

Path.resolve(strict=False)

   パスを絶対パスにし、あらゆるシンボリックリンクを解決します。新しい
   パスオブジェクトが返されます:

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

   "".."" 要素は除去されます (このような挙動を示すのはこのメソッドだけ
   です):

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

   If the path doesn't exist and *strict* is "True",
   "FileNotFoundError" is raised.  If *strict* is "False", the path is
   resolved as far as possible and any remainder is appended without
   checking whether it exists.  If an infinite loop is encountered
   along the resolution path, "RuntimeError" is raised.

   バージョン 3.6 で追加: The *strict* argument (pre-3.6 behavior is
   strict).

Path.rglob(pattern)

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

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

   引数 "self", "pattern" を指定して 監査イベント "pathlib.Path.rglob"
   を送出します。

   バージョン 3.11 で変更: Return only directories if *pattern* ends
   with a pathname components separator ("sep" or "altsep").

Path.rmdir()

   現在のディレクトリを削除します。ディレクトリは空でなければなりませ
   ん。

Path.samefile(other_path)

   このパスが参照するファイルが *other_path* (Path オブジェクトか文字
   列) と同じであれば "True" を、異なるファイルであれば "False" を返し
   ます。意味的には "os.path.samefile()" および "os.path.samestat()"
   と同じです。

   なんらかの理由でどちらかのファイルにアクセスできない場合は
   "OSError" が送出されます。

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

   バージョン 3.5 で追加.

Path.symlink_to(target, target_is_directory=False)

   Make this path a symbolic link pointing to *target*.

   On Windows, a symlink represents either a file or a directory, and
   does not morph to the target dynamically.  If the target is
   present, the type of the symlink will be created to match.
   Otherwise, the symlink will be created as a directory if
   *target_is_directory* is "True" or a file symlink (the default)
   otherwise.  On non-Windows platforms, *target_is_directory* is
   ignored.

      >>> p = Path('mylink')
      >>> p.symlink_to('setup.py')
      >>> p.resolve()
      PosixPath('/home/antoine/pathlib/setup.py')
      >>> p.stat().st_size
      956
      >>> p.lstat().st_size
      8

   注釈:

     引数の並び (link, target) は "os.symlink()" とは逆です。

Path.hardlink_to(target)

   このパスを *target* と同じファイルへのハードリンクにします。

   注釈:

     引数の並び (link, target) は "os.link()" とは逆です。

   バージョン 3.10 で追加.

Path.link_to(target)

   Make *target* a hard link to this path.

   警告:

     This function does not make this path a hard link to *target*,
     despite the implication of the function and argument names. The
     argument order (target, link) is the reverse of
     "Path.symlink_to()" and "Path.hardlink_to()", but matches that of
     "os.link()".

   バージョン 3.8 で追加.

   バージョン 3.10 で非推奨: This method is deprecated in favor of
   "Path.hardlink_to()", as the argument order of "Path.link_to()"
   does not match that of "Path.symlink_to()".

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

   Create a file at this given path.  If *mode* is given, it is
   combined with the process' "umask" value to determine the file mode
   and access flags.  If the file already exists, the function
   succeeds if *exist_ok* is true (and its modification time is
   updated to the current time), otherwise "FileExistsError" is
   raised.

Path.unlink(missing_ok=False)

   このファイルまたはシンボリックリンクを削除します。パスがディレクト
   リを指している場合は "Path.rmdir()" を使用してください。

   *missing_ok* の値が (デフォルトの) 偽の場合、対象のファイルが存在し
   ないと "FileNotFoundError" を送出します。

   *missing_ok* の値が真の場合、 "FileExistsError" 例外を送出しません
   (POSIX の "rm -f" コマンドの挙動と同じ)。

   バージョン 3.8 で変更: *missing_ok* 引数が追加されました。

Path.write_bytes(data)

   指定されたファイルをバイトモードで開き、*data* を書き込み、ファイル
   を閉じます:

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

   同じ名前のファイルがすでにあれば上書きされます。

   バージョン 3.5 で追加.

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

   指定されたファイルをテキストモードで開き、*data* を書き込み、ファイ
   ルを閉じます:

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

   同じ名前のファイルが存在する場合は上書きされます。オプションのパラ
   メーターの意味は "open()" と同じです。

   バージョン 3.5 で追加.

   バージョン 3.10 で変更: *newline* パラメータが追加されました。


Correspondence to tools in the "os" module
==========================================

下にあるのは、様々な "os" 関数とそれに相当する "PurePath" あるいは
"Path" の同等のものとの対応表です。

注釈:

  Not all pairs of functions/methods below are equivalent. Some of
  them, despite having some overlapping use-cases, have different
  semantics. They include "os.path.abspath()" and "Path.absolute()",
  "os.path.relpath()" and "PurePath.relative_to()".

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

-[ 脚注 ]-

[1] "os.path.abspath()" normalizes the resulting path, which may
    change its meaning in the presence of symlinks, while
    "Path.absolute()" does not.

[2] "PurePath.relative_to()" requires "self" to be the subpath of the
    argument, but "os.path.relpath()" does not.
