# `os.path` --- 共通のパス名操作

ソースコード: Lib/posixpath.py (POSIX), Lib/ntpath.py (Windows)

This module implements some useful functions on pathnames. To read or write files see `open()`, and for accessing the filesystem see the `os` module. The path parameters can be passed as strings, or bytes, or any object implementing the `os.PathLike` protocol.

Unix シェルとは異なり、Python はあらゆるパス展開を 自動的には 行いません。アプリケーションがシェルのようなパス展開を必要とした場合は、 `expanduser()` や `expandvars()` といった関数を明示的に呼び出すことで行えます。(`glob` モジュールも参照してください)

参考

`pathlib` モジュールは高水準のパスオブジェクトを提供します。

注釈

以下のすべての関数は、そのパラメータにバイト列のみ、あるいは文字列のみ受け付けます。パスまたはファイル名を返す場合、返り値は同じ型のオブジェクトになります。

注釈

OS によって異なるパス名の決まりがあるため、標準ライブラリにはこのモジュールのいくつかのバージョンが含まれています。 `os.path` モジュールは常に現在 Python が動作している OS に適したパスモジュールであるため、ローカルのパスを扱うのに適しています。各々のモジュールをインポートして 常に 一つのフォーマットを利用することも可能です。これらはすべて同じインターフェースを持っています:

- `posixpath` UNIX スタイルのパス用

- `ntpath` Windows パス用

バージョン 3.8 で変更: `exists()`、 `lexists()`、 `isdir()`、 `isfile()`、 `islink()`、および `ismount()` は、OS レベルで表現できない文字列を含む可能性がある例外を送出する代わりに `False` を返すようになりました。

`os.path.``abspath`(path)

  パス名 path の正規化された絶対パスを返します。ほとんどのプラットフォームでは、これは関数 `normpath()` を次のように呼び出した時と等価です: `normpath(join(os.getcwd(), path))`。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``basename`(path)

  パス名 path の末尾のファイル名部分を返します。これは関数 `split()` に path を渡した時に返されるペアの 2 番めの要素です。この関数が返すのは Unix の basename とは異なります; Unix の basename は `'/foo/bar/'` に対して `'bar'` を返しますが、関数 `basename()` は空文字列 (`''`) を返します。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``commonpath`(paths)

  シーケンス paths 中の各パス名に共通するサブパスのうち、最も長いものを返します。 paths に絶対パス名と相対パス名の両方が含まれている、 paths が異なるドライブ上にある、または paths が空の場合、 `ValueError` を送出します。 `commonprefix()` とは異なり、有効なパスを返します。

  Availability: Unix, Windows。

  バージョン 3.5 で追加.

  バージョン 3.6 で変更: path-like objects のシーケンスを受け入れるようになりました。

`os.path.``commonprefix`(list)

  list 内のすべてのパスに共通する接頭辞のうち、最も長いものを (パス名の 1 文字 1 文字を判断して) 返します。list が空の場合、空文字列 (`''`) を返します。

  注釈

  この関数は一度に 1 文字ずつ処理するため、不正なパスを返す場合があります。有効なパスを取得するためには、`commonpath()` を参照してください。

      >>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
      '/usr/l'

      >>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
      '/usr'

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``dirname`(path)

  パス名 path のディレクトリ名を返します。これは関数 `split()` に path を渡した時に返されるペアの 1 番めの要素です。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``exists`(path)

  path が実在するパスかオープンしているファイル記述子を参照している場合 `True` を返します。壊れたシンボリックリンクについては `False` を返します。一部のプラットフォームでは、たとえ path が物理的に存在していたとしても、要求されたファイルに対する `os.stat()` の実行権がなければこの関数が `False` を返すことがあります。

  バージョン 3.3 で変更: path は整数でも可能になりました: それがオープンしているファイル記述子なら `True` が返り、それ以外なら `False` が返ります。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``lexists`(path)

  path が実在するパスなら `True` を返します。壊れたシンボリックリンクについては `True` を返します。 `os.lstat()` がない環境では `exists()` と等価です。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``expanduser`(path)

  Unix および Windows では、与えられた引数の先頭のパス要素 `~` 、または `~user` を、 user のホームディレクトリのパスに置き換えて返します。

  Unix では、先頭の `~` は、環境変数 `HOME` が設定されているならその値に置き換えられます。設定されていない場合は、現在のユーザのホームディレクトリをビルトインモジュール `pwd` を使ってパスワードディレクトリから探して置き換えます。先頭の `~user` については、直接パスワードディレクトリから探します。

  On Windows, `USERPROFILE` will be used if set, otherwise a combination of `HOMEPATH` and `HOMEDRIVE` will be used. An initial `~user` is handled by checking that the last directory component of the current user's home directory matches `USERNAME`, and replacing it if so.

  置き換えに失敗したり、引数のパスがチルダで始まっていなかった場合は、パスをそのまま返します。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

  バージョン 3.8 で変更: Windowsで `HOME` は参照しなくなりました。

`os.path.``expandvars`(path)

  引数のパスの環境変数を展開して返します。引数の中の `$name` または `${name}` のような形式の文字列は環境変数、 name の値に置き換えられます。不正な変数名や存在しない変数名の場合には変換されず、そのまま返します。

  Windows では、 `$name` や `${name}` の形式に加えて、 `%name%` の形式もサポートされています。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``getatime`(path)

  path に最後にアクセスした時刻を返します。 返り値は、エポック (`time` モジュールを参照) からの経過秒数を与える浮動小数点数です。 ファイルが存在しない、あるいはアクセスできなかった場合は `OSError` を送出します。

`os.path.``getmtime`(path)

  path に最後に更新した時刻を返します。 返り値は、エポック (`time` モジュールを参照) からの経過秒数を与える浮動小数点数です。 ファイルが存在しない、あるいはアクセスできなかった場合は `OSError` を送出します。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``getctime`(path)

  システムの ctime、Unix系など一部のシステムでは最後にメタデータが変更された時刻、Windows などその他のシステムでは path の作成時刻を返します。返り値はエポック (`time` モジュールを参照) からの経過時間を示す秒数になります。ファイルが存在しない、あるいはアクセスできなかった場合は `OSError` を送出します。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``getsize`(path)

  path のサイズをバイト数で返します。ファイルが存在しない、あるいはアクセスできなかった場合は `OSError` を送出します。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``isabs`(path)

  path が絶対パスなら `True` を返します。すなわち、 Unix ではスラッシュで始まり、 Windows ではドライブレターに続く (バック) スラッシュで始まる場合です。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``isfile`(path)

  path が `存在する` 一般ファイルなら `True` を返します。 この関数はシンボリックリンクの先を辿るので、同じパスに対して `islink()` と `isfile()` の両方が真を返すことがあります。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``isdir`(path)

  path が `存在する` ディレクトリなら `True` を返します。 この関数はシンボリックリンクの先を辿るので、同じパスに対して `islink()` と `isdir()` の両方が真を返すことがあります。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``islink`(path)

  path が `存在する` ディレクトリを指すシンボリックリンクなら `True` を返します。 Python ランタイムがシンボリックリンクをサポートしていないプラットフォームでは、常に `False` を返します。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``ismount`(path)

  パス名 path がマウントポイント mount point (ファイルシステムの中で異なるファイルシステムがマウントされているところ) なら、 `True` を返します。 POSIX では、この関数は path の親ディレクトリである `path/..` が path と異なるデバイス上にあるか、あるいは `path/..` と path が同じデバイス上の同じ i-node を指しているかをチェックします --- これによって全ての Unix 系システムと POSIX 標準でマウントポイントが検出できます。 だたし、同じファイルシステムの bind mount の信頼できる検出はできません。 Windows では、ドライブレターを持つルートと共有 UNC は常にマウントポイントであり、また他のパスでは、入力のパスが異なるデバイスからのものか見るために `GetVolumePathName` が呼び出されます。

  バージョン 3.4 で追加: Windows での、ルートでないマウントポイントの検出をサポートするようになっています。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``join`(path, *paths)

  Join one or more path segments intelligently. The return value is the concatenation of path and all members of *paths, with exactly one directory separator following each non-empty part, except the last. That is, the result will only end in a separator if the last part is either empty or ends in a separator. If a segment is an absolute path (which on Windows requires both a drive and a root), then all previous segments are ignored and joining continues from the absolute path segment.

  On Windows, the drive is not reset when a rooted path segment (e.g., `r'\foo'`) is encountered. If a segment is on a different drive or is an absolute path, all previous segments are ignored and the drive is reset. Note that since there is a current directory for each drive, `os.path.join("c:", "foo")` represents a path relative to the current directory on drive `C:` (`c:foo`), not `c:\foo`.

  バージョン 3.6 で変更: path と paths が path-like object を受け付けるようになりました。

`os.path.``normcase`(path)

  パス名の大文字・小文字を正規化します。 Windowsでは、パス名にある文字を全て小文字に、スラッシュをバックスラッシュに変換します。 他のオペレーティングシステムでは、パスを変更せずに返します。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``normpath`(path)

  > パスを正規化します。余分な区切り文字や上位レベル参照を除去し、`A//B`、`A/B/`、`A/./B` や `A/foo/../B` などはすべて `A/B` になります。この文字列操作は、シンボリックリンクを含むパスの意味を変えてしまう場合があります。Windows では、スラッシュをバックスラッシュに変換します。大文字小文字の正規化には `normcase()` を使用してください。

  注釈

  > On POSIX systems, in accordance with IEEE Std 1003.1 2013 Edition; 4.13 Pathname Resolution, if a pathname begins with exactly two slashes, the first component following the leading characters may be interpreted in an implementation-defined manner, although more than two leading characters shall be treated as a single character.

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``realpath`(path, *, strict=False)

  パスの中のシンボリックリンク (もしそれが当該オペレーティングシステムでサポートされていれば) を取り除いて、指定されたファイル名を正規化したパスを返します。

  By default, the path is evaluated up to the first component that does not exist, is a symlink loop, or whose evaluation raises `OSError`. All such components are appended unchanged to the existing part of the path.

  Some errors that are handled this way include "access denied", "not a directory", or "bad argument to internal function". Thus, the resulting path may be missing or inaccessible, may still contain links or loops, and may traverse non-directories.

  This behavior can be modified by keyword arguments:

  If strict is `True`, the first error encountered when evaluating the path is re-raised. In particular, `FileNotFoundError` is raised if path does not exist, or another `OSError` if it is otherwise inaccessible.

  If strict is `os.path.ALLOW_MISSING`, errors other than `FileNotFoundError` are re-raised (as with `strict=True`). Thus, the returned path will not contain any symbolic links, but the named file and some of its parent directories may be missing.

  注釈

  This function emulates the operating system's procedure for making a path canonical, which differs slightly between Windows and UNIX with respect to how links and subsequent path components interact.

  Operating system APIs make paths canonical as needed, so it's not normally necessary to call this function.

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

  バージョン 3.8 で変更: Windows においてシンボリックリンクとジャンクションが解決されるようになりました。

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

  バージョン 3.10.18 で変更: The `ALLOW_MISSING` value for the strict parameter was added.

`os.path.``ALLOW_MISSING`

  Special value used for the strict argument in `realpath()`.

  バージョン 3.10.18 で追加.

`os.path.``relpath`(path, start=os.curdir)

  カレントディレクトリあるいはオプションの start ディレクトリからの path への相対パスを返します。これはパス計算で行っており、ファイルシステムにアクセスして path や start の存在や性質を確認することはありません。Windowsでは、 path と start が異なるドライブの場合、 `ValueError` を送出します。

  start のデフォルト値は `os.curdir` です。

  Availability: Unix, Windows。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``samefile`(path1, path2)

  引数の両パス名が同じファイルまたはディレクトリを参照している場合、 `True` を返します。これは、デバイス番号と i-node 番号で決定されます。どちらかのパス名への `os.stat()` 呼び出しが失敗した場合、例外が送出されます。

  Availability: Unix, Windows。

  バージョン 3.2 で変更: Windows サポートを追加しました。

  バージョン 3.4 で変更: Windows が他のプラットフォームと同じ実装を使用するようになりました。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``sameopenfile`(fp1, fp2)

  ファイル記述子 fp1 と fp2 が同じファイルを参照していたら `True` を返します。

  Availability: Unix, Windows。

  バージョン 3.2 で変更: Windows サポートを追加しました。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``samestat`(stat1, stat2)

  stat タプル stat1 と stat2 が同じファイルを参照していれば `True` を返します。これらのタプルは `os.fstat()` 、 `os.lstat()` あるいは `os.stat()` の返り値で構いません。この関数は `samefile()` と `sameopenfile()` を使用した比較に基いて実装しています。

  Availability: Unix, Windows。

  バージョン 3.4 で変更: Windows サポートを追加しました。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``split`(path)

  パス名 path を `(head, tail)` のペアに分割します。 tail はパス名の構成要素の末尾で、 head はそれより前の部分です。 tail はスラッシュを含みません; もし path がスラッシュで終わっていれば tail は空文字列になります。もし path にスラッシュがなければ、 head は空文字になります。 path が空文字なら、 head と tail の両方が空文字になります。 head の末尾のスラッシュは head がルートディレクトリ (または 1 個以上のスラッシュだけ) でない限り取り除かれます。 `join(head, tail)` は常に path と同じ場所を返しますが、文字列としては異なるかもしれません。関数 `dirname()`, `basename()` も参照してください。

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``splitdrive`(path)

  パス名 path を `(drive, tail)` のペアに分割します。drive はマウントポイントか空文字列になります。ドライブ指定をサポートしていないシステムでは、drive は常に空文字になります。どの場合でも、`drive + tail` は path と等しくなります。

  Windows では、パス名はドライブ名/UNC 共有ポイントと相対パスに分割されます。

  パスがドライブレターを含む場合、ドライブレターにはコロンまでが含まれます:

      >>> splitdrive("c:/dir")
      ("c:", "/dir")

  If the path contains a UNC path, drive will contain the host name and share, up to but not including the fourth separator:

      >>> splitdrive("//host/computer/dir")
      ("//host/computer", "/dir")

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``splitext`(path)

  Split the pathname path into a pair `(root, ext)` such that `root + ext == path`, and the extension, ext, is empty or begins with a period and contains at most one period.

  If the path contains no extension, ext will be `''`:

      >>> splitext('bar')
      ('bar', '')

  If the path contains an extension, then ext will be set to this extension, including the leading period. Note that previous periods will be ignored:

      >>> splitext('foo.bar.exe')
      ('foo.bar', '.exe')
      >>> splitext('/foo/bar.exe')
      ('/foo/bar', '.exe')

  Leading periods of the last component of the path are considered to be part of the root:

      >>> splitext('.cshrc')
      ('.cshrc', '')
      >>> splitext('/foo/....jpg')
      ('/foo/....jpg', '')

  バージョン 3.6 で変更: path-like object を受け入れるようになりました。

`os.path.``supports_unicode_filenames`

  ファイル名に任意の Unicode 文字列を (システムの制限内で) 使用できる場合は `True` になります。