os --- 雑多なオペレーティングシステムインタフェース

ソースコード: Lib/os.py

---

このモジュールは、 OS 依存の機能を利用するポータブルな方法を提供します。単純なファイルの読み書きについては、 open() を参照してください。パス操作については、 os.path モジュールを参照してください。コマンドラインに与えられたすべてのファイルから行を読み込んでいくには、 fileinput モジュールを参照してください。一時ファイルや一時ディレクトリの作成については、 tempfile モジュールを参照してください。高水準のファイルとディレクトリの操作については、 shutil モジュールを参照してください。

利用可能性に関する注意 :

• Python の、すべての OS 依存モジュールの設計方針は、可能な限り同一のインタフェースで同一の機能を利用できるようにする、というものです。例えば、 os.stat(path) は path に関する stat 情報を、 (POSIX を元にした ) 同じフォーマットで返します。

• 特定のオペレーティングシステム固有の拡張も os を介して利用することができますが、これらの利用はもちろん、可搬性を脅かします。

• パスやファイル名を受け付けるすべての関数は、バイト列型および文字列型両方のオブジェクトを受け付け、パスやファイル名を返す時は、同じ型のオブジェクトを返します。

• VxWorks では、os.fork, os.execv および os.spawn*p* はサポートされていません。

注釈

このモジュール内のすべての関数は、間違った、あるいはアクセス出来ないファイル名やファイルパス、その他型が合っていても OS が受理しない引数に対して、 OSError (またはそのサブクラス)を送出します。

exception os.error

組み込みの OSError 例外に対するエイリアスです。

os.name

import されているオペレーティングシステムに依存するモジュールの名前です。現在次の名前が登録されています: 'posix', 'nt', 'java'。

参考

sys.platform はより細かな粒度を持っています。 os.uname() はシステム依存のバージョン情報を提供します。

platform モジュールはシステムの詳細な識別情報をチェックする機能を提供しています。

ファイル名、コマンドライン引数、および環境変数

Python では、ファイル名、コマンドライン引数、および環境変数を表すのに文字列型を使用します。一部のシステムでは、これらをオペレーティングシステムに渡す前に、文字列からバイト列へ、またはその逆のデコードが必要です。Python はこの変換を行うためにファイルシステムのエンコーディングを使用します (sys.getfilesystemencoding() 参照)。

バージョン 3.1 で変更: 一部のシステムでは、ファイルシステムのエンコーディングを使用して変換すると失敗する場合があります。この場合、Python は surrogateescape エンコーディングエラーハンドラー を使用します。これは、デコード時にデコードできないバイト列は Unicode 文字 U+DCxx に置き換えられ、それらはエンコード時に再び元のバイト列に変換されることを意味します。

ファイルシステムのエンコーディングでは、すべてが 128 バイト以下に正常にデコードされることが保証されなくてはなりません。ファイルシステムのエンコーディングでこれが保証されなかった場合は、API 関数が UnicodeError を送出します。

プロセスのパラメーター

これらの関数とデータアイテムは、現在のプロセスおよびユーザーに対する情報提供および操作のための機能を提供しています。

os.ctermid()

プロセスの制御端末に対応するファイル名を返します。

利用可能な環境: Unix。

os.environ

文字列の環境を表す マップ型 オブジェクトです。例えば、 environ['HOME'] は (一部のプラットフォームでは) ホームディレクトリのパス名であり、 C における getenv("HOME") と等価です。

このマップ型の内容は、 os モジュールの最初の import の時点、通常は Python の起動時に site.py が処理される中で取り込まれます。それ以後に変更された環境変数は os.environ を直接変更しない限り os.environ には反映されません。

プラットフォーム上で putenv() がサポートされている場合、このマップ型オブジェクトは環境変数に対する変更に使うこともできます。 putenv() はマップ型オブジェクトが修正される時に、自動的に呼ばれることになります。

Unix では、キーと値に sys.getfilesystemencoding()、エラーハンドラーに 'surrogateescape' を使用します。異なるエンコーディングを使用したい場合は environb を使用します。

注釈

putenv() を直接呼び出しても os.environ の内容は変わらないので、 os.environ を直接変更する方が良いです。

注釈

FreeBSD と Mac OS X を含む一部のプラットフォームでは、 environ の値を変更するとメモリリークの原因になる場合があります。システムの putenv() に関するドキュメントを参照してください。

putenv() が提供されていない場合、このマップ型オブジェクトに変更を加えたコピーを適切なプロセス生成機能に渡すことで、生成された子プロセスが変更された環境変数を利用するようにできます。

プラットフォームが unsetenv() 関数をサポートしている場合、このマップ型オブジェクトからアイテムを削除することで環境変数を消すことができます。 unsetenv() は os.environ からアイテムが取り除かれた時に自動的に呼ばれます。 pop() または clear() が呼ばれた時も同様です。

os.environb

environ のバイト列版です。環境変数をバイト文字列で表す マップ型 オブジェクトです。environ と environb は同期されます。(environb を変更すると environ が更新され、逆の場合も同様に更新されます)。

environb は supports_bytes_environ が True の場合のみ利用可能です。

バージョン 3.2 で追加.

os.chdir(path)

os.fchdir(fd)

os.getcwd()

これらの関数は、 ファイルとディレクトリ 節で説明されています。

os.fsencode(filename)

path-like な filename をファイルシステムのエンコーディングにエンコードします。エラーハンドラーに 'surrogateescape' (Windows の場合は 'strict') が指定されます; 未変更の bytes オブジェクトを返します。

fsdecode() はこの逆変換を行う関数です。

バージョン 3.2 で追加.

バージョン 3.6 で変更: os.PathLike インタフェースを実装したオブジェクトを受け入れるようになりました。

os.fsdecode(filename)

ファイルシステムのエンコーディングから path-like な filename にデコードします。エラーハンドラーに 'surrogateescape' (Windows の場合は 'strict') が指定されます; 未変更の bytes オブジェクトを返します。

fsencode() はこの逆変換を行う関数です。

バージョン 3.2 で追加.

バージョン 3.6 で変更: os.PathLike インタフェースを実装したオブジェクトを受け入れるようになりました。

os.fspath(path)

path のファイルシステム表現を返します。

もし str か bytes: のオブジェクトが渡された場合は、変更せずにそのまま返します。さもなければ、 __fspath__() が呼び出され、その戻り値が str か bytes のオブジェクトであれば、その値を返します。他のすべてのケースでは TypeError が送出されます。

バージョン 3.6 で追加.

class os.PathLike

ファイルシステムパスを表すオブジェクト(例: pathlib.PurePath) 向けの abstract base class です。

バージョン 3.6 で追加.

abstractmethod __fspath__()

このオブジェクトが表現するファイルシステムパスを返します。

このメソッドは str か bytes のオブジェクトのみを返す必要があります(str が好まれます)。

os.getenv(key, default=None)

環境変数 key が存在すればその値を返し、存在しなければ default を返します。key、default、および返り値は文字列です。

Unix では、キーと値は sys.getfilesystemencoding()、エラーハンドラー 'surrogateescape' でデコードされます。異なるエンコーディングを使用したい場合は os.getenvb() を使用します。

利用できる環境: 主なUnix互換環境、 Windows。

os.getenvb(key, default=None)

環境変数 key が存在すればその値を返し、存在しなければ default を返します。key、default、および返り値はバイト列型です。

getenvb() は supports_bytes_environ が ``True``の場合のみ利用可能です。

利用できる環境: 主なUnix互換環境。

バージョン 3.2 で追加.

os.get_exec_path(env=None)

プロセスを起動する時に名前付き実行ファイルを検索するディレクトリのリストを返します。 env が指定されると、それを環境変数の辞書とみなし、その辞書からキー PATH の値を探します。 デフォルトでは env は None であり、environ が使用されます。

バージョン 3.2 で追加.

os.getegid()

現在のプロセスの実効グループ id を返します。この id は現在のプロセスで実行されているファイルの "set id" ビットに対応します。

利用可能な環境: Unix。

os.geteuid()

現在のプロセスの実効ユーザー id を返します。

利用可能な環境: Unix。

os.getgid()

現在のプロセスの実グループ id を返します。

利用可能な環境: Unix。

os.getgrouplist(user, group)

user が所属するグループ id のリストを返します。group がリストにない場合、それを追加します。通常、group にはユーザー user のパスワードレコードに書かれているグループ ID を指定します。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.getgroups()

現在のプロセスに関連付けられた従属グループ id のリストを返します。

利用可能な環境: Unix。

注釈

Mac OS X では getgroups() の挙動は他の Unix プラットフォームとはいくぶん異なります。 Python のインタープリタが 10.5 以前の Deployment Target でビルドされている場合、 getgroups() は現在のユーザープロセスに関連付けられている実効グループ id を返します。このリストはシステムで定義されたエントリ数 ( 通常は 16) に制限され、適切な特権があれば setgroups() の呼び出しによって変更することができます。 10.5 より新しい Deployment Target でビルドされている場合、 getgroups() はプロセスの実効ユーザー id に関連付けられたユーザーの現在のグループアクセスリストを返します。このグループアクセスリストは、プロセスのライフタイムで変更される可能性があり、 setgroups() の呼び出しの影響を受けず、長さ 16 の制限を受けません。 Deployment Target の値 MACOSX_DEPLOYMENT_TARGET は、 sysconfig.get_config_var() で取得することができます。

os.getlogin()

プロセスの制御端末にログインしているユーザー名を返します。ほとんどの場合、getpass.getuser() を使う方が便利です。なぜなら、getpass.getuser() は、ユーザーを見つけるために、環境変数 LOGNAME や USERNAME を調べ、さらには pwd.getpwuid(os.getuid())[0] まで調べに行くからです。

Availability: Unix, Windows。

os.getpgid(pid)

プロセス id pid のプロセスのプロセスグループ id を返します。 pid が 0 の場合、現在のプロセスのプロセスグループ id を返します。

利用可能な環境: Unix。

os.getpgrp()

現在のプロセスグループの id を返します。

利用可能な環境: Unix。

os.getpid()

現在のプロセス id を返します。

os.getppid()

親プロセスのプロセス id を返します。親プロセスが終了していた場合、Unix では init プロセスの id (1) が返され、Windows では親のプロセス id だったもの (別のプロセスで再利用されているかもしれない) がそのまま返されます。

Availability: Unix, Windows。

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

os.getpriority(which, who)

プログラムのスケジューリング優先度を取得します。which の値は PRIO_PROCESS、PRIO_PGRP、あるいは PRIO_USER のいずれか一つで、who の値は which に応じて解釈されます (PRIO_PROCESS であればプロセス識別子、PRIO_PGRP であればプロセスグループ識別子、そして PRIO_USER であればユーザー ID)。who の値がゼロの場合、呼び出したプロセス、呼び出したプロセスのプロセスグループ、および呼び出したプロセスの実ユーザー id を (それぞれ) 意味します。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.PRIO_PROCESS

os.PRIO_PGRP

os.PRIO_USER

getpriority() と setpriority() 用のパラメータです。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.getresuid()

現在のプロセスの実ユーザー id 、実効ユーザー id 、および保存ユーザー id を示す、 (ruid, euid, suid) のタプルを返します。

利用可能な環境: Unix。

バージョン 3.2 で追加.

os.getresgid()

現在のプロセスの実グループ id 、実効グループ id 、および保存グループ id を示す、 (rgid, egid, sgid) のタプルを返します。

利用可能な環境: Unix。

バージョン 3.2 で追加.

os.getuid()

現在のプロセスの実ユーザー id を返します。

利用可能な環境: Unix。

os.initgroups(username, gid)

システムの initgroups() を呼び出し、指定された username がメンバーである全グループと gid で指定されたグループでグループアクセスリストを初期化します。

利用可能な環境: Unix。

バージョン 3.2 で追加.

os.putenv(key, value)

key という名前の環境変数に文字列 value を設定します。このような環境変数の変更は、os.system()、popen()、または fork() と execv() で起動されたサブプロセスに影響を与えます。

利用できる環境: 主なUnix互換環境、 Windows。

注釈

FreeBSD と Mac OS X を含む一部のプラットフォームでは、 environ の値を変更するとメモリリークの原因になる場合があります。システムの putenv に関するドキュメントを参照してください。

putenv() がサポートされている場合、 os.environ のアイテムに対する代入を行うと、自動的に putenv() の対応する呼び出しに変換されます。直接 putenv() を呼び出した場合 os.environ は更新されないため、実際には os.environ のアイテムに代入する方が望ましい操作です。

引数 key, value を指定して 監査イベント os.putenv を送出します。

os.setegid(egid)

現在のプロセスに実効グループ id をセットします。

利用可能な環境: Unix。

os.seteuid(euid)

現在のプロセスに実効ユーザー id をセットします。

利用可能な環境: Unix。

os.setgid(gid)

現在のプロセスにグループ id をセットします。

利用可能な環境: Unix。

os.setgroups(groups)

現在のグループに関連付けられた従属グループ id のリストを groups に設定します。 groups はシーケンス型でなくてはならず、各要素はグループを特定する整数でなくてはなりません。通常、この操作はスーパユーザーしか利用できません。

利用可能な環境: Unix。

注釈

Mac OS X では、 groups の長さはシステムで定義された実効グループ id の最大数 ( 通常は 16) を超えない場合があります。 setgroups() 呼び出しで設定されたものと同じグループリストが返されないケースについては、 getgroups() のドキュメントを参照してください。

os.setpgrp()

システムコール setpgrp() か setpgrp(0, 0) のどちらか(実装されているもの)を呼び出します。機能については UNIX マニュアルを参照して下さい。

利用可能な環境: Unix。

os.setpgid(pid, pgrp)

システムコール setpgid() を呼び出してプロセス id pid のプロセスのプロセスグループ id を pgrp に設定します。この動作に関しては Unix のマニュアルを参照してください。

利用可能な環境: Unix。

os.setpriority(which, who, priority)

プログラムのスケジューリング優先度を設定します。which は PRIO_PROCESS、PRIO_PGRP、あるいは PRIO_USER のいずれか一つで、who の値は which に応じて解釈されます (PRIO_PROCESS であればプロセス識別子、PRIO_PGRP であればプロセスグループ識別子、そして PRIO_USER であればユーザー ID)。who の値がゼロの場合、呼び出したプロセス、呼び出したプロセスのプロセスグループ、および呼び出したプロセスの実ユーザー id を (それぞれ) 意味します。priority は -20 から 19 の整数値で、デフォルトの優先度は 0 です。小さい数値ほど優先されるスケジューリングとなります。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.setregid(rgid, egid)

現在のプロセスの実グループ id および実効グループ id を設定します。

利用可能な環境: Unix。

os.setresgid(rgid, egid, sgid)

現在のプロセスの、実グループ id 、実効グループ id 、および保存グループ id を設定します。

利用可能な環境: Unix。

バージョン 3.2 で追加.

os.setresuid(ruid, euid, suid)

現在のプロセスの実ユーザー id 、実効ユーザー id 、および保存ユーザー id を設定します。

利用可能な環境: Unix。

バージョン 3.2 で追加.

os.setreuid(ruid, euid)

現在のプロセスの実ユーザー id および実効ユーザー id を設定します。

利用可能な環境: Unix。

os.getsid(pid)

getsid() システムコールを呼び出します。機能については Unix のマニュアルを参照してください。

利用可能な環境: Unix。

os.setsid()

setsid() システムコールを呼び出します。機能については Unix のマニュアルを参照してください。

利用可能な環境: Unix。

os.setuid(uid)

現在のプロセスのユーザー id を設定します。

利用可能な環境: Unix。

os.strerror(code)

エラーコード code に対応するエラーメッセージを返します。未知のエラーコードの対して strerror() が NULL を返すプラットフォームでは、 ValueError が送出されます。

os.supports_bytes_environ

環境のネイティブ OS タイプがバイト型の場合、 True です (例: Windows では、 False です)。

バージョン 3.2 で追加.

os.umask(mask)

現在の数値 umask を設定し、以前の umask 値を返します。

os.uname()

現在のオペレーティングシステムを識別する情報を返します。返り値は 5 個の属性を持つオブジェクトです:

• sysname - OS の名前

• nodename - (実装時に定義された) ネットワーク上でのマシン名

• release - OS のリリース

• version - OS のバージョン

• machine - ハードウェア識別子

後方互換性のため、このオブジェクトはイテラブルでもあり、sysname、nodename、release、version、および machine の 5 個の要素をこの順序で持つタプルのように振る舞います。

一部のシステムでは、nodename はコンポーネントを読み込むために 8 文字または先頭の要素だけに切り詰められます; ホスト名を取得する方法としては、socket.gethostname() を使う方がよいでしょう。あるいは socket.gethostbyaddr(socket.gethostname()) でもかまいません。

利用できる環境: 最近のUnix互換環境。

バージョン 3.3 で変更: 返り値の型が、タプルから属性名のついたタプルライクオブジェクトに変更されました。

os.unsetenv(key)

key という名前の環境変数を unset (削除) します。このような環境変数の変更は、os.system()、popen()、または fork() と execv() で起動されたサブプロセスに影響を与えます。

unsetenv() がサポートされている場合、 os.environ のアイテムの削除を行うと、自動的に unsetenv() の対応する呼び出しに変換されます。直接 unsetenv() を呼び出した場合 os.environ は更新されないため、実際には os.environ のアイテムを削除する方が望ましい操作です。

引数 key を指定して 監査イベント os.unsetenv を送出します。

利用できる環境: 主なUnix互換環境。

ファイルオブジェクトの生成

以下の関数は新しい ファイルオブジェクト を作成します。(ファイル記述子のオープンについては open() も参照してください)

os.fdopen(fd, *args, **kwargs)

ファイル記述子 fd に接続し、オープンしたファイルオブジェクトを返します。これは組み込み関数 open() の別名であり、同じ引数を受け取ります。唯一の違いは fdopen() の第一引数が常に整数でなければならないことです。

ファイル記述子の操作

これらの関数は、ファイル記述子を使って参照されている I/O ストリームを操作します。

ファイル記述子とは現在のプロセスで開かれたファイルに対応する小さな整数です。例えば、標準入力のファイル記述子は通常 0 で、標準出力は 1 、標準エラーは 2 です。プロセスから開かれたその他のファイルには 3 、 4 、 5 と割り振られていきます。「ファイル記述子」という名称は少し誤解を与えるものかもしれません。Unix プラットフォームでは、ソケットやパイプもファイル記述子によって参照されます。

fileno() メソッドを使用して、必要な場合に file object に関連付けられているファイル記述子を取得することができます。ファイル記述子を直接使用すると、ファイルオブジェクトのメソッドが使用されないため、データの内部バッファなどの性質は無視されることに注意してください。

os.close(fd)

ファイル記述子 fd をクローズします。

注釈

この関数は低水準の I/O 向けのもので、 os.open() や pipe() が返すファイル記述子に対して使用しなければなりません。 組み込み関数 open() や popen() 、 fdopen() が返す "ファイルオブジェクト" を閉じるには、オブジェクトの close() メソッドを使用してください。

os.closerange(fd_low, fd_high)

fd_low 以上 fd_high 未満のすべてのファイル記述子をエラーを無視してクローズします。以下のコードと等価です:

for fd in range(fd_low, fd_high):
    try:
        os.close(fd)
    except OSError:
        pass

os.copy_file_range(src, dst, count, offset_src=None, offset_dst=None)

ファイル記述子 src の offset_src から count バイトを、ファイル記述子 dst の offset_dst にコピーします。もし offset_src が None の場合は src は現在の位置から読まれます。 offset_dst についても同様です。src および dst のファイルは同じファイルシステム上になければなりません。違う場合には errno を errno.EXDEV として OSError が送出されます。

このコピーは、カーネルからユーザースペースにデータを転送した後カーネルに戻すという追加のコスト無しに完了します。 加えて、追加の最適化ができるファイルシステムもあります。 このコピーはファイルが両方ともバイナリファイルとして開かれたかのように行われます。

返り値はコピーされたバイトの量です。 この値は、要求した量より少なくなることもあります。

Availability: Linux kernel >= 4.5 または glibc >= 2.27。

バージョン 3.8 で追加.

os.device_encoding(fd)

fd に関連付けられたデバイスが端末 (ターミナル) に接続されている場合に、そのデバイスのエンコーディングを表す文字列を返します。端末に接続されていない場合、 None を返します。

os.dup(fd)

ファイル記述子 fd の複製を返します。新しいファイル記述子は 継承不可 です。

Windows では、標準ストリーム (0: 標準入力、1: 標準出力、2: 標準エラー出力) を複製する場合、新しいファイル記述子は 継承可能 です。

バージョン 3.4 で変更: 新しいファイル記述子が継承不可になりました。

os.dup2(fd, fd2, inheritable=True)

ファイル記述子 fd を fd2 に複製し、必要な場合には後者を先に閉じます。 fd2 が返ります。 新しいファイル記述子はデフォルトでは 継承可能 で、inheritable が False の場合は継承不可です。

バージョン 3.4 で変更: オプションの inheritable 引数が追加されました。

バージョン 3.7 で変更: 成功したときは fd2 が返ります。 以前は常に None が返っていました。

os.fchmod(fd, mode)

fd で指定されたファイルのモードを mode に変更します。mode に指定できる値については、chmod() のドキュメントを参照してください。Python 3.3 以降では os.chmod(fd, mode) と等価です。

引数 path, mode, dir_fd を指定して 監査イベント os.chmod を送出します。

利用可能な環境: Unix。

os.fchown(fd, uid, gid)

fd で指定されたファイルの所有者 id およびグループ id を数値 uid および gid に変更します。いずれかの id を変更せずにおくにはその値として -1 を指定します。chown() を参照してください。Python 3.3 以降では os.chown(fd, uid, gid) と等価です。

引数 path, uid, gid, dir_fd を指定して 監査イベント os.chown を送出します。

利用可能な環境: Unix。

os.fdatasync(fd)

ファイル記述子 fd を持つファイルのディスクへの書き込みを強制します。メタデータの更新は強制しません。

利用可能な環境: Unix。

注釈

この関数は MacOS では利用できません。

os.fpathconf(fd, name)

開いているファイルに関連するシステム設定情報を返します。 name は取得する設定名を指定します。これは、いくつかの標準 (POSIX.1 、 Unix 95 、 Unix 98 その他 ) で定義された定義済みのシステム値名の文字列である場合があります。プラットフォームによっては別の名前も定義されています。ホストオペレーティングシステムの関知する名前は pathconf_names 辞書で与えられています。このマップ型オブジェクトに含まれていない構成変数については、 name に整数を渡してもかまいません。

name が不明の文字列である場合、 ValueError を送出します。 name の特定の値がホストシステムでサポートされていない場合、 pathconf_names に含まれていたとしても、 errno.EINVAL をエラー番号として OSError を送出します。

Python 3.3 以降では os.pathconf(fd, name) と等価です。

利用可能な環境: Unix。

os.fstat(fd)

ファイル記述子 fd の状態を取得します。stat_result オブジェクトを返します。

Python 3.3 以降では os.stat(fd) と等価です。

参考

stat() 関数。

os.fstatvfs(fd)

statvfs() と同様に、ファイル記述子 fd に関連付けられたファイルが格納されているファイルシステムに関する情報を返します。Python 3.3 以降では os.statvfs(fd) と等価です。

利用可能な環境: Unix。

os.fsync(fd)

ファイル記述子 fd を持つファイルのディスクへの書き込みを強制します。 Unix では、ネイティブの fsync() 関数を、 Windows では _commit() 関数を呼び出します。

Python の ファイルオブジェクト f を使う場合、f の内部バッファを確実にディスクに書き込むために、まず f.flush() を、その後 os.fsync(f.fileno()) を実行してください。

Availability: Unix, Windows。

os.ftruncate(fd, length)

ファイル記述子 fd に対応するファイルを、サイズが最長で length バイトになるように切り詰めます。Python 3.3 以降では os.truncate(fd, length) と等価です。

引数 fd, length を指定して 監査イベント os.truncate を送出します。

Availability: Unix, Windows。

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

os.get_blocking(fd)

記述子のブロッキングモードを取得します。 O_NONBLOCK フラグが設定されている場合は False で、フラグがクリアされている場合は True です。

set_blocking() および socket.socket.setblocking() も参照してください。

利用可能な環境: Unix。

バージョン 3.5 で追加.

os.isatty(fd)

ファイル記述子 fd がオープンされていて、 tty (のような) デバイスに接続されている場合、 True を返します。そうでない場合は False を返します。

os.lockf(fd, cmd, len)

オープンされたファイル記述子に対して、POSIX ロックの適用、テスト、解除を行います。fd はオープンされたファイル記述子です。cmd には使用するコマンド (F_LOCK、F_TLOCK、F_ULOCK、あるいは F_TEST のいずれか一つ) を指定します。len にはロックするファイルのセクションを指定します。

引数 fd, cmd, len を指定して 監査イベント os.lockf を送出します。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.F_LOCK

os.F_TLOCK

os.F_ULOCK

os.F_TEST

lockf() がとる動作を指定するフラグです。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.lseek(fd, pos, how)

ファイル記述子 fd の現在の位置を pos に設定します。 pos の意味は how で次のように修飾されます。ファイルの先頭からの相対位置には SEEK_SET か 0 を、現在の位置からの相対位置には SEEK_CUR か 1 を、ファイルの末尾からの相対位置には SEEK_END か 2 を設定します。戻り値は、新しいカーソル位置のファイルの先頭からのバイト数です。

os.SEEK_SET

os.SEEK_CUR

os.SEEK_END

lseek() 関数に渡すパラメーター。値は順に 0, 1, 2 です。

バージョン 3.3 で追加: 一部のオペレーティングシステムは os.SEEK_HOLE や os.SEEK_DATA など、追加の値をサポートすることがあります。

os.open(path, flags, mode=0o777, *, dir_fd=None)

ファイル path を開き、flag に従って様々なフラグを設定し、可能なら mode に従ってファイルモードを設定します。mode を計算する際、まず現在の umask 値でマスクされます。新たに開いたファイルのファイル記述子を返します。新しいファイル記述子は 継承不可 です。

フラグとファイルモードの値についての詳細は C ランタイムのドキュメントを参照してください; (O_RDONLY や O_WRONLY のような) フラグ定数は os モジュールでも定義されています。特に、Windows ではバイナリモードでファイルを開く時に O_BINARY を加える必要があります。

この関数は dir_fd パラメタで ディレクトリ記述子への相対パス をサポートしています。

引数 path, mode, flags を指定して 監査イベント open を送出します。

バージョン 3.4 で変更: 新しいファイル記述子が継承不可になりました。

注釈

この関数は低水準の I/O 向けのものです。 通常の利用では、組み込み関数 open() を使用してください。 open() は read() や write() (そしてさらに多くの) メソッドを持つ ファイルオブジェクト を返します。 ファイル記述子をファイルオブジェクトでラップするには fdopen() を使用してください。

バージョン 3.3 で追加: 引数 dir_fd が追加されました。

バージョン 3.5 で変更: システムコールが中断されシグナルハンドラが例外を送出しなかった場合、この関数は InterruptedError 例外を送出する代わりにシステムコールを再試行するようになりました (論拠については PEP 475 を参照してください)。

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

以下の定数は open() 関数の flags 引数に利用します。これらの定数は、ビット単位に OR 演算子 | で組み合わせることができます。一部、すべてのプラットフォームでは使用できない定数があります。利用可能かどうかや使い方については、Unix では open(2)、Windows では MSDN を参照してください。

os.O_RDONLY

os.O_WRONLY

os.O_RDWR

os.O_APPEND

os.O_CREAT

os.O_EXCL

os.O_TRUNC

上記の定数は Unix および Windows で利用可能です。

os.O_DSYNC

os.O_RSYNC

os.O_SYNC

os.O_NDELAY

os.O_NONBLOCK

os.O_NOCTTY

os.O_CLOEXEC

上記の定数は Unix でのみ利用可能です。

バージョン 3.3 で変更: 定数 O_CLOEXEC が追加されました。

os.O_BINARY

os.O_NOINHERIT

os.O_SHORT_LIVED

os.O_TEMPORARY

os.O_RANDOM

os.O_SEQUENTIAL

os.O_TEXT

上記の定数は Windows でのみ利用可能です。

os.O_ASYNC

os.O_DIRECT

os.O_DIRECTORY

os.O_NOFOLLOW

os.O_NOATIME

os.O_PATH

os.O_TMPFILE

os.O_SHLOCK

os.O_EXLOCK

上記の定数は拡張仕様であり、Cライブラリで定義されていない場合は利用できません。

バージョン 3.4 で変更: O_PATH を、それをサポートするシステムで追加しました。また、 O_TMPFILE を追加しました (Linux Kernel 3.11 以降でのみ利用可能です)。

os.openpty()

新しい擬似端末のペアを開きます。pty および tty を表すファイル記述子のペア (master, slave) を返します。新しいファイル記述子は 継承不可 です。(若干) 可搬性の高いアプローチには pty を使用してください。

利用できる環境: 一部の Unix 互換環境。

バージョン 3.4 で変更: 新しいファイル記述子が継承不可になりました。

os.pipe()

パイプを作成します。読み込み、書き込みに使うことの出来るファイル記述子のペア (r, w) を返します。新しいファイル記述子は 継承不可 です。

Availability: Unix, Windows。

バージョン 3.4 で変更: 新しいファイル記述子が継承不可になりました。

os.pipe2(flags)

flags を設定したパイプをアトミックに作成します。flags には値 O_NONBLOCK と O_CLOEXEC を一つ以上論理和指定できます。読み込み、書き込みに使うことの出来るファイル記述子のペア (r, w) を返します。

利用できる環境: 一部の Unix 互換環境。

バージョン 3.3 で追加.

os.posix_fallocate(fd, offset, len)

fd で指定されたファイルに対し、開始位置 offset から len バイト分割り当てるに十分なディスクスペースを確保します。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.posix_fadvise(fd, offset, len, advice)

データへアクセスする意思を、パターンを指定して宣言します。これによりカーネルが最適化を行えるようになります。advice は fd で指定されたファイルに対し、開始位置 offset から len バイト分の領域に適用されます。advice には POSIX_FADV_NORMAL、POSIX_FADV_SEQUENTIAL、POSIX_FADV_RANDOM、POSIX_FADV_NOREUSE、POSIX_FADV_WILLNEED、または POSIX_FADV_DONTNEED のいずれか一つを指定します。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.POSIX_FADV_NORMAL

os.POSIX_FADV_SEQUENTIAL

os.POSIX_FADV_RANDOM

os.POSIX_FADV_NOREUSE

os.POSIX_FADV_WILLNEED

os.POSIX_FADV_DONTNEED

posix_fadvise() において、使われるであろうアクセスパターンを指定する advice に使用できるフラグです。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.pread(fd, n, offset)

ファイル記述子の位置 offset から最大で n バイトを読み出します。 ファイルオフセットは変化しません。

読み込んだバイト分のバイト列を返します。 fd が参照しているファイルの終端に達した場合、空のバイト列が返されます。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.preadv(fd, buffers, offset, flags=0)

ファイル記述子 fd の offset の位置から、可変な bytes-like オブジェクト buffers にオフセットを変更せずに読み込みます。 データをそれぞれのバッファがいっぱいになるまで移し、いっぱいになったらシーケンスの次のバッファに処理を移し、残りのデータを読み込ませます。

flags 引数にはゼロあるいは次のフラグのバイトごとの OR を取った結果が保持されています。

• RWF_HIPRI

• RWF_NOWAIT

実際に読み込んだ合計バイト数を返します。この値は、すべてのオブジェクトの容量の総量よりも小さくなることがあります。

オペレーティングシステムは、使用可能なバッファの個数に基づいて上限 (func:sysconf の 'SC_IOV_MAX' の値) を設定することがあります。

os.readv() と os.pread() の機能を統合します。

Availability: Linux 2.6.30 and newer, FreeBSD 6.0 and newer, OpenBSD 2.7 and newer. Using flags requires Linux 4.6 or newer.

バージョン 3.7 で追加.

os.RWF_NOWAIT

即座に利用できないデータを待ちません。このフラグを指定すると、バックエンドのストレージからデータを読む必要があるか、ロックを待機する場合、システムコールは即座にリターンします。

読み込みに成功したデータがある場合、読み込んだバイト数を返します。読み込めるバイト列がない場合、 -1 を返し、errno に errno.EAGAIN を設定します。

利用可能な環境: Linux 4.14以上。

バージョン 3.7 で追加.

os.RWF_HIPRI

優先度の高い読み込み・書き込み (read/write) フラグです。ブロックストレージに対して、追加のリソースを必要とする一方で低レイテンシなデバイスのポーリングを使うことを許可します。

現状、Linuxでは、ファイル記述子を O_DIRECT フラグを指定したオープンした場合でのみ、この機能を利用できます。

利用可能な環境: Linux 4.6以上。

バージョン 3.7 で追加.

os.pwrite(fd, str, offset)

str 中のバイト文字列をファイル記述子 fd の offset の位置に書き込みます。ファイルオフセットを変化しません。

実際に書き込まれたバイト数を返します。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.pwritev(fd, buffers, offset, flags=0)

buffers の内容をファイル記述子 fd のオフセット位置 offset に書き込みます。ファイルのオフセット位置は変更しません。 buffers は bytes-like オブジェクト のシーケンスでなければなりません。バッファは配列の順番で処理されます。すなわち、最初のバッファの内容は、次のバッファの処理に移る前に全て書き込まれ、以降も同様に処理されます。

flags 引数にはゼロあるいは次のフラグのバイトごとの OR を取った結果が保持されています。

• RWF_DSYNC

• RWF_SYNC

実際に書き込まれた合計バイト数を返します。

オペレーティングシステムは、使用可能なバッファの個数に基づいて上限 (func:sysconf の 'SC_IOV_MAX' の値) を設定することがあります。

os.writev() と os.pwrite() の機能を統合します。

Availability: Linux 2.6.30 and newer, FreeBSD 6.0 and newer, OpenBSD 2.7 and newer. Using flags requires Linux 4.7 or newer.

バージョン 3.7 で追加.

os.RWF_DSYNC

Provide a per-write equivalent of the O_DSYNC open(2) flag. This flag effect applies only to the data range written by the system call.

利用可能な環境: Linux 4.7以上。

バージョン 3.7 で追加.

os.RWF_SYNC

Provide a per-write equivalent of the O_SYNC open(2) flag. This flag effect applies only to the data range written by the system call.

利用可能な環境: Linux 4.7以上。

バージョン 3.7 で追加.

os.read(fd, n)

ファイル記述子 fd から 最大 n バイトを読み込みます。

読み込んだバイト分のバイト列を返します。 fd が参照しているファイルの終端に達した場合、空のバイト列が返されます。

注釈

この関数は低水準の I/O 向けのもので、 os.open() や pipe() が返すファイル記述子に対して使用されなければなりません。 組み込み関数 open() や popen() 、 fdopen() 、あるいは sys.stdin が返す "ファイルオブジェクト" を読み込むには、オブジェクトの read() か readline() メソッドを使用してください。

バージョン 3.5 で変更: システムコールが中断されシグナルハンドラが例外を送出しなかった場合、この関数は InterruptedError 例外を送出する代わりにシステムコールを再試行するようになりました (論拠については PEP 475 を参照してください)。

os.sendfile(out, in, offset, count)

os.sendfile(out, in, offset, count, [headers, ][trailers, ]flags=0)

ファイル記述子 in からファイル記述子 out への開始位置 offset へ count バイトコピーします。 送信バイト数を返します。 EOF に達した場合は 0 を返します。

前者の関数表記は sendfile() が定義されているすべてのプラットフォームでサポートされています。

Linux では、offset に None が与えられると、バイト列は in の現在の位置から読み込まれ、in の位置は更新されます。

後者は Mac OS X および FreeBSD で使用される場合があります。headers および trailers は任意のバッファのシーケンス型オブジェクトで、in からのデータが書き出される前と後に書き出されます。返り値は前者と同じです。

Mac OS X と FreeBSD では、count の値に 0 を指定すると、in の末尾に達するまで送信します。

全てのプラットフォームはソケットをファイル記述子 out としてサポートし、あるプラットフォームは他の種類 (例えば、通常のファイル、パイプ) も同様にサポートします。

クロスプラットフォームのアプリケーションは headers、trailers ならびに flags 引数を使用するべきではありません。

利用可能な環境: Unix。

注釈

sendfile() のより高水準のラッパについては socket.socket.sendfile() を参照してください。

バージョン 3.3 で追加.

os.set_blocking(fd, blocking)

指定されたファイル記述子のブロッキングモードを設定します。 ブロッキングが False の場合 O_NONBLOCK フラグを設定し、そうでない場合はクリアします。

get_blocking() および socket.socket.setblocking() も参照してください。

利用可能な環境: Unix。

バージョン 3.5 で追加.

os.SF_NODISKIO

os.SF_MNOWAIT

os.SF_SYNC

実装がサポートしている場合 sendfile() 関数に渡すパラメーターです。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.readv(fd, buffers)

Read from a file descriptor fd into a number of mutable bytes-like objects buffers. Transfer data into each buffer until it is full and then move on to the next buffer in the sequence to hold the rest of the data.

実際に読み込んだ合計バイト数を返します。この値は、すべてのオブジェクトの容量の総量よりも小さくなることがあります。

オペレーティングシステムは、使用可能なバッファの個数に基づいて上限 (func:sysconf の 'SC_IOV_MAX' の値) を設定することがあります。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.tcgetpgrp(fd)

fd (os.open() が返すオープンしたファイル記述子 ) で与えられる端末に関連付けられたプロセスグループを返します。

利用可能な環境: Unix。

os.tcsetpgrp(fd, pg)

fd (os.open() が返すオープンしたファイル記述子 ) で与えられる端末に関連付けられたプロセスグループを pg に設定します。

利用可能な環境: Unix。

os.ttyname(fd)

ファイル記述子 fd に関連付けられている端末デバイスを特定する文字列を返します。 fd が端末に関連付けられていない場合、例外が送出されます。

利用可能な環境: Unix。

os.write(fd, str)

str のバイト列をファイル記述子 fd に書き出します。

実際に書き込まれたバイト数を返します。

注釈

この関数は低水準の I/O 向けのもので、 os.open() や pipe() が返すファイル記述子に対して使用しなければなりません。 組み込み関数 open() や popen() 、 fdopen() 、あるいは sys.stdout や sys.stderr が返す "ファイルオブジェクト" に書き込むには、オブジェクトの write() メソッドを使用してください。

バージョン 3.5 で変更: システムコールが中断されシグナルハンドラが例外を送出しなかった場合、この関数は InterruptedError 例外を送出する代わりにシステムコールを再試行するようになりました (論拠については PEP 475 を参照してください)。

os.writev(fd, buffers)

buffers の内容をファイル記述子 fd へ書き出します。 buffers は bytes-like オブジェクト のシーケンスでなければなりません。バッファは配列の順番で処理されます。最初のバッファの内容全体は 2 番目のバッファに進む前に書き込まれ、その次も同様です。

実際に書き込まれた合計バイト数を返します。

オペレーティングシステムは、使用可能なバッファの個数に基づいて上限 (func:sysconf の 'SC_IOV_MAX' の値) を設定することがあります。

利用可能な環境: Unix。

バージョン 3.3 で追加.

ターミナルのサイズの問い合わせ

バージョン 3.3 で追加.

os.get_terminal_size(fd=STDOUT_FILENO)

ターミナル (端末) のサイズ (columns, lines) を、terminal_size 型のタプルで返します。

オプションの引数 fd には問い合わせるファイル記述子を指定します (デフォルトは STDOUT_FILENO、または標準出力)。

ファイル記述子が接続されていなかった場合、 OSError が送出されます。

通常は高水準関数である shutil.get_terminal_size() を使用してください。os.get_terminal_size は低水準の実装です。

Availability: Unix, Windows。

class os.terminal_size

ターミナルウィンドウのサイズ (columns, lines) を保持するタプルのサブクラスです。

columns

ターミナルウィンドウの横幅 (文字数) です。

lines

ターミナルウィンドウの高さ (文字数) です。

ファイル記述子の継承

バージョン 3.4 で追加.

ファイル記述子には「継承可能 (inheritable)」フラグというものがあって、これにより子プロセスにファイル記述子が引き継がれるかどうかが決定されます。Python 3.4 より、 Python によって作成されるファイル記述子はデフォルトで継承不可 (non-inheritable) となりました。

UNIX の場合、継承不可のファイル記述子は新規プロセス実行時にクローズされ、そうでないファイル記述子は引き継がれます。

Windows の場合は、標準ストリームを除き、継承不可のハンドルと継承不可のファイル記述子は子プロセスでクローズされます。標準ストリーム (ファイル記述子の 0, 1, 2: 標準入力, 標準出力, 標準エラー出力) は常に引き継がれます。 spawn* 関数を使う場合、全ての継承可能なハンドルと全ての継承可能なファイル記述子は引き継がれます。 subprocess モジュールを使う場合、標準ストリームを除く全てのファイル記述子はクローズされ、継承可能なハンドルは close_fds 引数が False の場合にのみ引き継がれます。

os.get_inheritable(fd)

指定したファイル記述子の「継承可能 (inheritable)」フラグを取得します (boolean)。

os.set_inheritable(fd, inheritable)

指定したファイル記述子の「継承可能 (inheritable)」フラグをセットします。

os.get_handle_inheritable(handle)

指定したハンドルの「継承可能 (inheritable)」フラグを取得します (boolean)。

利用可能な環境: Windows 。

os.set_handle_inheritable(handle, inheritable)

指定したハンドルの「継承可能 (inheritable)」フラグをセットします。

利用可能な環境: Windows 。

ファイルとディレクトリ

一部の Unix プラットフォームでは、このセクションの関数の多くが以下の機能を一つ以上サポートしています。

• ファイル記述子の指定: os モジュールの関数で path 引数に渡される値はファイルパスでなければなりません。しかしながら、いくつかの関数では path 引数にファイルパスではなく、そのファイルをオープンしたファイル記述子を指定できるようになりました。この場合それらの関数はファイル記述子が参照するファイルに対して操作を行います。 (POSIX システムの場合、 Python はプレフィックス f の付いた関数の亜種 (たとえば chdir``の代わりに ``fchdir) を呼び出します。)

  os.supports_fd を使うことで、そのプラットフォーム上で path にファイル記述子を指定できるかどうかを確認することができます。この機能が利用可能でない場合、 os.supports_fd の利用は NotImplementedError 例外を送出します。

  その関数が引数に dir_fd または follow_symlinks もサポートしている場合、path にファイル記述子を指定した時にそれらのいずれかを指定するとエラーになります。

• ディレクトリ記述子からの相対パス: dir_fd が None でない場合、その値はディレクトリを参照するファイル記述子である必要があり、また操作対象のファイルパスは相対パスである必要があります; このときパスはファイル記述子が指すディレクトリからの相対パスと解釈されます。パスが絶対パスの場合、 dir_fd は無視されます。 (POSIX システムでは、 Python はサフィックス at が付いた関数の亜種、もしくはさらにプレフィックス f が付いたもの (たとえば access の代わりに faccessat) を呼び出します。

  そのプラットフォーム上で特別な関数に dir_fd がサポートされているかどうかは、os.supports_dir_fd で確認できます。利用できない場合 NotImplementedError が送出されます。

• シンボリックリンクをたどらない: follow_symlinks が False で、かつパスの末尾の要素がシンボリックリンクの場合、関数はシンボリックリンクが指すファイルではなくシンボリックリンク自身を操作対象とします。 (POSIX システムの場合、 Python はプレフィックス l... 付きの関数の亜種を呼び出します。)

  そのプラットフォーム上で特別な関数に follow_symlinks がサポートされているかどうかは、os.supports_follow_symlinks で確認できます。利用できない場合 NotImplementedError が送出されます。

os.access(path, mode, *, dir_fd=None, effective_ids=False, follow_symlinks=True)

実 uid/gid を使って path に対するアクセスが可能か調べます。ほとんどのオペレーティングシステムは実効 uid/gid を使うため、このルーチンは suid/sgid 環境において、プログラムを起動したユーザーが path に対するアクセス権をもっているかを調べるために使われます。 path が存在するかどうかを調べるには mode を F_OK にします。ファイルアクセス権限 ( パーミッション ) を調べるには、 R_OK, W_OK, X_OK から一つまたはそれ以上のフラグを論理和指定でとることもできます。アクセスが許可されている場合 True を、そうでない場合 False を返します。詳細は access(2) の Unix マニュアルページを参照してください。

この関数は ディレクトリ記述子への相対パス および シンボリックリンクをたどらない をサポートしています。

effective_ids が True の場合、access() は実 uid/gid ではなく実効 uid/gid を使用してアクセス権を調べます。プラットフォームによっては effective_ids がサポートされていない場合があります; サポートされているかどうかは os.supports_effective_ids で確認できます。利用できない場合 NotImplementedError が送出されます。

注釈

ユーザーが、例えばファイルを開く権限を持っているかどうかを調べるために実際に open() を行う前に access() を使用することはセキュリティホールの原因になります。なぜなら、調べた時点とオープンした時点との時間差を利用してそのユーザーがファイルを不当に操作してしまうかもしれないからです。その場合は EAFP テクニックを利用するのが望ましいやり方です。例えば

if os.access("myfile", os.R_OK):
    with open("myfile") as fp:
        return fp.read()
return "some default data"

このコードは次のように書いたほうが良いです

try:
    fp = open("myfile")
except PermissionError:
    return "some default data"
else:
    with fp:
        return fp.read()

注釈

I/O 操作は access() が成功を示した時でも失敗することがあります。特にネットワークファイルシステムが通常の POSIX のパーミッションビットモデルをはみ出すアクセス権限操作を備える場合にはそのようなことが起こりえます。

バージョン 3.3 で変更: 引数 dir_fd、effective_ids、および follow_symlinks が追加されました。

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

os.F_OK

os.R_OK

os.W_OK

os.X_OK

access() で path をテストする時に mode 引数に渡す値です。上からそれぞれ、ファイルの存在、読み込み許可、書き込み許可、および実行許可になります。

os.chdir(path)

現在の作業ディレクトリを path に設定します。

この関数は ファイル記述子の指定 をサポートしています。記述子は、オープンしているファイルではなく、オープンしているディレクトリを参照していなければなりません。

この関数は OSError やそのサブクラスである FileNotFoundError, PermissionError, NotADirectoryError などの例外を送出することがあります。

引数 path を指定して 監査イベント os.chdir を送出します。

バージョン 3.3 で追加: 一部のプラットフォームで、path にファイル記述子の指定をサポートしました。

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

os.chflags(path, flags, *, follow_symlinks=True)

path のフラグを flags に変更します。 flags は、以下の値 (stat モジュールで定義されているもの ) をビット単位の論理和で組み合わせることができます :

• stat.UF_NODUMP

• stat.UF_IMMUTABLE

• stat.UF_APPEND

• stat.UF_OPAQUE

• stat.UF_NOUNLINK

• stat.UF_COMPRESSED

• stat.UF_HIDDEN

• stat.SF_ARCHIVED

• stat.SF_IMMUTABLE

• stat.SF_APPEND

• stat.SF_NOUNLINK

• stat.SF_SNAPSHOT

この関数は シンボリックリンクをたどらない をサポートしています。

引数 path, flags を指定して 監査イベント os.chflags を送出します。

利用可能な環境: Unix。

バージョン 3.3 で追加: 引数 follow_symlinks を追加しました。

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

os.chmod(path, mode, *, dir_fd=None, follow_symlinks=True)

path のモードを数値 mode に変更します。 mode は、 (stat モジュールで定義されている ) 以下の値のいずれかまたはビット単位の論理和で組み合わせた値を取り得ます :

• stat.S_ISUID

• stat.S_ISGID

• stat.S_ENFMT

• stat.S_ISVTX

• stat.S_IREAD

• stat.S_IWRITE

• stat.S_IEXEC

• stat.S_IRWXU

• stat.S_IRUSR

• stat.S_IWUSR

• stat.S_IXUSR

• stat.S_IRWXG

• stat.S_IRGRP

• stat.S_IWGRP

• stat.S_IXGRP

• stat.S_IRWXO

• stat.S_IROTH

• stat.S_IWOTH

• stat.S_IXOTH

この関数は ファイル記述子の指定 、 ディレクトリ記述子への相対パス 、および シンボリックリンクをたどらない をサポートしています。

注釈

Windows は chmod() をサポートしていますが、ファイルの読み出し専用フラグを (stat.S_IWRITE および stat.S_IREAD 定数または対応する整数値によって) 設定できるだけです。その他のビットはすべて無視されます。

引数 path, mode, dir_fd を指定して 監査イベント os.chmod を送出します。

バージョン 3.3 で追加: path にオープンしているファイル記述子の指定のサポート、および引数 dir_fd と follow_symlinks を追加しました。

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

os.chown(path, uid, gid, *, dir_fd=None, follow_symlinks=True)

path の所有者 id およびグループ id を、数値 uid および gid に変更します。いずれかの id を変更せずにおくには、その値として -1 を指定します。

この関数は ファイル記述子の指定 、 ディレクトリ記述子への相対パス 、および シンボリックリンクをたどらない をサポートしています。

数値 id の他に名前でも受け取る高水準関数の shutil.chown() を参照してください。

引数 path, uid, gid, dir_fd を指定して 監査イベント os.chown を送出します。

利用可能な環境: Unix。

バージョン 3.3 で追加: path にオープンしているファイル記述子の指定のサポート、および引数 dir_fd と follow_symlinks を追加しました。

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

os.chroot(path)

現在のプロセスのルートディレクトリを path に変更します。

利用可能な環境: Unix。

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

os.fchdir(fd)

現在の作業ディレクトリをファイル記述子 fd が表すディレクトリに変更します。記述子はオープンしているファイルではなく、オープンしたディレクトリを参照していなければなりません。Python 3.3 以降では os.chdir(fd) と等価です。

引数 path を指定して 監査イベント os.chdir を送出します。

利用可能な環境: Unix。

os.getcwd()

現在の作業ディレクトリを表す文字列を返します。

os.getcwdb()

現在の作業ディレクトリを表すバイト列を返します。

バージョン 3.8 で変更: この関数は Windows において ANSI コードページ ではなく UTF-8 エンコーディングを使うようになりました: 変更の背景については PEP 529 をご覧ください。この関数は Windows において非推奨になりません。

os.lchflags(path, flags)

path のフラグを数値 flags に設定します。chflags() に似ていますが、シンボリックリンクをたどりません。Python 3.3 以降では os.chflags(path, flags, follow_symlinks=False) と等価です。

引数 path, flags を指定して 監査イベント os.chflags を送出します。

利用可能な環境: Unix。

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

os.lchmod(path, mode)

path のモードを数値 mode に変更します。パスがシンボリックリンクの場合はそのリンク先ではなくシンボリックリンクそのものに対して作用します。mode に指定できる値については chmod() のドキュメントを参照してください。Python 3.3 以降では os.chmod(path, mode, follow_symlinks=False) と等価です。

引数 path, mode, dir_fd を指定して 監査イベント os.chmod を送出します。

利用可能な環境: Unix。

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

os.lchown(path, uid, gid)

path の所有者 id およびグループ id を、数値 uid および gid に変更します。この関数はシンボリックリンクをたどりません。Python 3.3 以降では os.chown(path, uid, gid, follow_symlinks=False) と等価です。

引数 path, uid, gid, dir_fd を指定して 監査イベント os.chown を送出します。

利用可能な環境: Unix。

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

os.link(src, dst, *, src_dir_fd=None, dst_dir_fd=None, follow_symlinks=True)

src を指し示すハードリンク dst を作成します。

この関数は src_dir_fd と dst_dir_fd の両方またはどちらかに対し ディレクトリ記述子への相対パス および シンボリックリンクをたどらない をサポートしています。

引数 src, dst, src_dir_fd, dst_dir_fd を指定して 監査イベント os.link を送出します。

Availability: Unix, Windows。

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

バージョン 3.3 で追加: 引数 src_dir_fd、dst_dir_fd、および follow_symlinks を追加しました。

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

os.listdir(path='.')

path に指定したディレクトリに含まれるエントリ名のリストを返します。リストの順番は不定です。特別なエントリ '.' と '..' はリストに含まれません。この関数の呼び出し中にディレクトリからファイルが削除されたり、ディレクトリにファイルが追加されたりした場合、それらのファイルがリストに含まれるかどうかは不定です。

path に path-like オブジェクト を指定することもできます。 path が (直接的または間接的に PathLike インターフェースを介した) bytes 型の場合、戻り値のファイル名も bytes 型になります; それ以外の場合、ファイル名は str 型です。

この関数は ファイル記述子の指定 もサポートしています; ファイル記述子はディレクトリを参照していなくてはなりません。

引数 path を指定して 監査イベント os.listdir を送出します。

注釈

文字列型 のファイル名を バイト列型 にエンコードするには、fsencode() を使用します。

参考

ディレクトリエントリに加えてファイル属性情報も返す scandir() 関数の方が、多くの一般的な用途では使い勝手が良くなります。

バージョン 3.2 で変更: 引数 path は任意になりました。

バージョン 3.3 で追加: path へのオープン・ファイル記述子の指定をサポートしました。

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

os.lstat(path, *, dir_fd=None)

与えられたパスに対して lstat() システムコールと同じ処理を行います。stat() と似ていますが、シンボリックリンクをたどりません。 stat_result オブジェクトを返します。

シンボリックリンクをサポートしていないプラットフォームでは stat() の別名です。

Python 3.3 以降では os.stat(path, dir_fd=dir_fd, follow_symlinks=False) と等価です。

この関数は ディレクトリ記述子への相対パス もサポートすることができます。

参考

stat() 関数。

バージョン 3.2 で変更: Windows 6.0 (Vista) のシンボリックリンクをサポートしました。

バージョン 3.3 で変更: 引数 dir_fd を追加しました。

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

バージョン 3.8 で変更: On Windows, now opens reparse points that represent another path (name surrogates), including symbolic links and directory junctions. Other kinds of reparse points are resolved by the operating system as for stat().

os.mkdir(path, mode=0o777, *, dir_fd=None)

ディレクトリ path を数値モード mode で作成します。

すでにディレクトリが存在したら、 FileExistsError が上げられます。

いくつかのシステムにおいては mode は無視されます。それが使われる時には、最初に現在の umask 値でマスクされます。もし最後の 9 ビット (つまり mode の8進法表記の最後の3桁) を除いたビットが設定されていたら、それらの意味はプラットフォームに依存します。いくつかのプラットフォームではそれらは無視され、それらを設定するためには明示的に chmod() を呼ぶ必要があるでしょう。

On Windows, a mode of 0o700 is specifically handled to apply access control to the new directory such that only the current user and administrators have access. Other values of mode are ignored.

この関数は ディレクトリ記述子への相対パス もサポートすることができます。

一時ディレクトリを作成することもできます : tempfile モジュールの tempfile.mkdtemp() 関数を参照してください。

引数 path, mode, dir_fd を指定して 監査イベント os.mkdir を送出します。

バージョン 3.3 で追加: 引数 dir_fd が追加されました。

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

バージョン 3.8.20 で変更: Windows now handles a mode of 0o700.

os.makedirs(name, mode=0o777, exist_ok=False)

再帰的にディレクトリを作成する関数です。mkdir() と似ていますが、末端ディレクトリを作成するために必要なすべての中間ディレクトリも作成します。

The mode parameter is passed to mkdir() for creating the leaf directory; see the mkdir() description for how it is interpreted. To set the file permission bits of any newly-created parent directories you can set the umask before invoking makedirs(). The file permission bits of existing parent directories are not changed.

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

注釈

作成するパス要素に pardir (UNIX では "..") が含まれる場合、makedirs() は混乱します。

この関数は UNC パスを正しく扱えるようになりました。

引数 path, mode, dir_fd を指定して 監査イベント os.mkdir を送出します。

バージョン 3.2 で追加: 引数 exist_ok が追加されました。

バージョン 3.4.1 で変更: Python 3.4.1 より前、 exist_ok が True でそのディレクトリが既存の場合でも、 makedirs() は mode が既存ディレクトリのモードと合わない場合にはエラーにしようとしていました。このモードチェックの振る舞いを安全に実装することが出来なかったため、 Python 3.4.1 でこのチェックは削除されました。 bpo-21082 を参照してください。

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

バージョン 3.7 で変更: The mode argument no longer affects the file permission bits of newly-created intermediate-level directories.

os.mkfifo(path, mode=0o666, *, dir_fd=None)

FIFO (名前付きパイプ) path を数値モード mode で作成します。先に現在の umask 値でマスクされます。

この関数は ディレクトリ記述子への相対パス もサポートすることができます。

FIFO は通常のファイルのようにアクセスできるパイプです。 FIFO は ( 例えば os.unlink() を使って ) 削除されるまで存在しつづけます。一般的に、 FIFO は " クライアント " と " サーバー " 形式のプロセス間でランデブーを行うために使われます : この時、サーバーは FIFO を読み込み用に、クライアントは書き出し用にオープンします。 mkfifo() は FIFO をオープンしない --- 単にランデブーポイントを作成するだけ --- なので注意してください。

利用可能な環境: Unix。

バージョン 3.3 で追加: 引数 dir_fd が追加されました。

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

os.mknod(path, mode=0o600, device=0, *, dir_fd=None)

path という名前で、ファイルシステムノード (ファイル、デバイス特殊ファイル、または名前つきパイプ) を作成します。mode は、作成するノードのアクセス権限とタイプの両方を stat.S_IFREG、stat.S_IFCHR、stat.S_IFBLK、および stat.S_IFIFO の組み合わせ (ビット単位の論理和) で指定します (これらの定数は stat で利用可能です)。stat.S_IFCHR と stat.S_IFBLK を指定した場合、devide は新しく作成されたデバイス特殊ファイルを (おそらく os.makedev() を使って) 定義し、それ以外の定数を指定した場合は無視されます。

この関数は ディレクトリ記述子への相対パス もサポートすることができます。

利用可能な環境: Unix。

バージョン 3.3 で追加: 引数 dir_fd が追加されました。

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

os.major(device)

RAW デバイス番号から、デバイスのメジャー番号を取り出します ( 通常 stat の st_dev か st_rdev フィールドです ) 。

os.minor(device)

RAW デバイス番号から、デバイスのマイナー番号を取り出します ( 通常 stat の st_dev か st_rdev フィールドです ) 。

os.makedev(major, minor)

メジャーおよびマイナーデバイス番号から、新しく RAW デバイス番号を作成します。

os.pathconf(path, name)

名前付きファイルに関連するシステム設定情報を返します。 name には取得したい設定名を指定します ; これは定義済みのシステム値名の文字列で、多くの標準 (POSIX.1 、 Unix 95 、 Unix 98 その他 ) で定義されています。プラットフォームによっては別の名前も定義しています。ホストオペレーティングシステムの関知する名前は pathconf_names 辞書で与えられています。このマップ型オブジェクトに入っていない設定変数については、 name に整数を渡してもかまいません。

name が不明の文字列である場合、 ValueError を送出します。 name の特定の値がホストシステムでサポートされていない場合、 pathconf_names に含まれていたとしても、 errno.EINVAL をエラー番号として OSError を送出します。

この関数は ファイル記述子の指定 をサポートしています。

利用可能な環境: Unix。

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

os.pathconf_names

pathconf() および fpathconf() が受理するシステム設定名を、ホストオペレーティングシステムで定義されている整数値に対応付けている辞書です。この辞書はシステムでどの設定名が定義されているかを知るために利用できます。

利用可能な環境: Unix。

os.readlink(path, *, dir_fd=None)

シンボリックリンクが指しているパスを表す文字列を返します。返される値は絶対パスにも、相対パスにもなり得ます ; 相対パスの場合、 os.path.join(os.path.dirname(path), result) を使って絶対パスに変換することができます。

If the path is a string object (directly or indirectly through a PathLike interface), the result will also be a string object, and the call may raise a UnicodeDecodeError. If the path is a bytes object (direct or indirectly), the result will be a bytes object.

この関数は ディレクトリ記述子への相対パス もサポートすることができます。

When trying to resolve a path that may contain links, use realpath() to properly handle recursion and platform differences.

Availability: Unix, Windows。

バージョン 3.2 で変更: Windows 6.0 (Vista) のシンボリックリンクをサポートしました。

バージョン 3.3 で追加: 引数 dir_fd が追加されました。

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

バージョン 3.8 で変更: Windowsで、 path-like object と bytes オブジェクトを受け入れるようになりました。

バージョン 3.8 で変更: Added support for directory junctions, and changed to return the substitution path (which typically includes \\?\ prefix) rather than the optional "print name" field that was previously returned.

os.remove(path, *, dir_fd=None)

Remove (delete) the file path. If path is a directory, an IsADirectoryError is raised. Use rmdir() to remove directories. If the file does not exist, a FileNotFoundError is raised.

この関数は ディレクトリ記述子への相対パス をサポートしています。

Windows では、使用中のファイルを削除しようとすると例外を送出します; Unixでは、ディレクトリエントリは削除されますが、記憶装置上に割り当てられたファイル領域は元のファイルが使われなくなるまで残されます。

この関数は意味論的に unlink() と同一です。

引数 path, dir_fd を指定して 監査イベント os.remove を送出します。

バージョン 3.3 で追加: 引数 dir_fd が追加されました。

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

os.removedirs(name)

再帰的なディレクトリ削除関数です。 rmdir() と同じように動作しますが、末端ディレクトリがうまく削除できるかぎり、 removedirs() は path に現れる親ディレクトリをエラーが送出されるまで ( このエラーは通常、指定したディレクトリの親ディレクトリが空でないことを意味するだけなので無視されます ) 順に削除することを試みます。例えば、 os.removedirs('foo/bar/baz') では最初にディレクトリ 'foo/bar/baz' を削除し、次に 'foo/bar' さらに 'foo' をそれらが空ならば削除します。末端のディレクトリが削除できなかった場合には OSError が送出されます。

引数 path, dir_fd を指定して 監査イベント os.remove を送出します。

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

os.rename(src, dst, *, src_dir_fd=None, dst_dir_fd=None)

Rename the file or directory src to dst. If dst exists, the operation will fail with an OSError subclass in a number of cases:

On Windows, if dst exists a FileExistsError is always raised.

On Unix, if src is a file and dst is a directory or vice-versa, an IsADirectoryError or a NotADirectoryError will be raised respectively. If both are directories and dst is empty, dst will be silently replaced. If dst is a non-empty directory, an OSError is raised. If both are files, dst it will be replaced silently if the user has permission. The operation may fail on some Unix flavors if src and dst are on different filesystems. If successful, the renaming will be an atomic operation (this is a POSIX requirement).

この関数は src_dir_fd と dst_dir_fd のどちらかまたは両方の指定に ディレクトリ記述子への相対パス をサポートしています。

対象の上書きがクロスプラットフォームになる場合は replace() を使用してください。

引数 src, dst, src_dir_fd, dst_dir_fd を指定して 監査イベント os.rename を送出します。

バージョン 3.3 で追加: 引数 src_dir_fd および dst_dir_fd が追加されました。

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

os.renames(old, new)

再帰的にディレクトリやファイル名を変更する関数です。 rename() のように動作しますが、新たなパス名を持つファイルを配置するために必要な途中のディレクトリ構造をまず作成しようと試みます。名前変更の後、元のファイル名のパス要素は removedirs() を使って右側から順に削除されます。

注釈

この関数はコピー元の末端のディレクトリまたはファイルを削除する権限がない場合には失敗します。

引数 src, dst, src_dir_fd, dst_dir_fd を指定して 監査イベント os.rename を送出します。

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

os.replace(src, dst, *, src_dir_fd=None, dst_dir_fd=None)

ファイルまたはディレクトリ src の名前を dst へ変更します。dst がディレクトリの場合 OSError が送出されます。dst が存在し、かつファイルの場合、ユーザーの権限がある限り暗黙のうちに置き換えられます。src と dst が異なるファイルシステム上にあると失敗することがあります。ファイル名の変更が成功する場合はアトミック操作となります (これは POSIX 要求仕様です)。

この関数は src_dir_fd と dst_dir_fd のどちらかまたは両方の指定に ディレクトリ記述子への相対パス をサポートしています。

引数 src, dst, src_dir_fd, dst_dir_fd を指定して 監査イベント os.rename を送出します。

バージョン 3.3 で追加.

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

os.rmdir(path, *, dir_fd=None)

Remove (delete) the directory path. If the directory does not exist or is not empty, an FileNotFoundError or an OSError is raised respectively. In order to remove whole directory trees, shutil.rmtree() can be used.

この関数は ディレクトリ記述子への相対パス をサポートしています。

引数 path, dir_fd を指定して 監査イベント os.rmdir を送出します。

バージョン 3.3 で追加: 引数 dir_fd が追加されました。

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

os.scandir(path='.')

Return an iterator of os.DirEntry objects corresponding to the entries in the directory given by path. The entries 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 an entry for that file be included is unspecified.

listdir() の代わりに scandir() を使用すると、ファイルタイプや属性情報も必要とするコードのパフォーマンスが大幅に向上します。これは、オペレーティングシステムがディレクトリのスキャン中にこの情報を提供した場合、os.DirEntry オブジェクトがその情報を公開するからです。すべての os.DirEntry メソッドはシステムコールを実行する場合がありますが、is_dir() と is_file() は、通常はシンボリックリンクにしかシステムコールを必要としません。os.DirEntry.stat() は、Unix 上では常にシステムコールを必要としますが、Windows ではシンボリックリンク用にシステムコールを一つ必要とするだけです。

path may be a path-like object. If path is of type bytes (directly or indirectly through the PathLike interface), the type of the name and path attributes of each os.DirEntry will be bytes; in all other circumstances, they will be of type str.

この関数は ファイル記述子の指定 もサポートしています; ファイル記述子はディレクトリを参照していなくてはなりません。

引数 path を指定して 監査イベント os.scandir を送出します。

scandir() イテレータは、 コンテキストマネージャ プロトコルをサポートし、次のメソッドを持ちます。

scandir.close()

イテレータを閉じ、獲得した資源を開放します。

この関数は、イテレータがすべて消費されるか、ガーベージコレクトされた、もしくはイテレート中にエラーが発生した際に自動的に呼び出されます。しかし、 with 文を用いるか、明示的に呼び出すことを推奨します。

バージョン 3.6 で追加.

次の単純な例では、scandir() を使用して、指定した path 内の先頭が '.' でないすべてのファイル (ディレクトリを除く) をすべて表示します。entry.is_file() を呼び出しても、通常は追加のシステムコールは行われません:

with os.scandir(path) as it:
    for entry in it:
        if not entry.name.startswith('.') and entry.is_file():
            print(entry.name)

注釈

On Unix-based systems, scandir() uses the system's opendir() and readdir() functions. On Windows, it uses the Win32 FindFirstFileW and FindNextFileW functions.

バージョン 3.5 で追加.

バージョン 3.6 で追加: Added support for the context manager protocol and the close() method. If a scandir() iterator is neither exhausted nor explicitly closed a ResourceWarning will be emitted in its destructor.

関数が path-like object を受け入れるようになりました。

バージョン 3.7 で変更: Unix で ファイル記述子の指定 のサポートが追加されました。

class os.DirEntry

ディレクトリエントリのファイルパスとその他のファイル属性を公開するために、scandir() が yield するオブジェクトです。

scandir() は、追加のシステムコールを実行することなく、この情報をできるだけ多く提供します。stat() または lstat() システムコールが実行された場合、os.DirEntry オブジェクトは結果をキャッシュします。

os.DirEntry インスタンスは、寿命の長いデータ構造に保存されることは想定されていません。ファイルメタデータが変更された場合や、 scandir() が呼び出されてから長時間が経過した場合は、 os.stat(entry.path) を呼び出して最新の情報を取得してください。

os.DirEntry のメソッドはオペレーティングシステムコールを実行する場合があるため、それらは OSError も送出する場合があります。エラーを細かく制御する必要がある場合、 os.DirEntry のメソッドの一つの呼び出し時に OSError を捕捉して、適切な処理を行うことができます。

To be directly usable as a path-like object, os.DirEntry implements the PathLike interface.

os.DirEntry インスタンスの属性とメソッドは以下の通りです:

name

scandir() の path 引数に対して相対的な、エントリのベースファイル名です。

The name attribute will be bytes if the scandir() path argument is of type bytes and str otherwise. Use fsdecode() to decode byte filenames.

path

The entry's full path name: equivalent to os.path.join(scandir_path, entry.name) where scandir_path is the scandir() path argument. The path is only absolute if the scandir() path argument was absolute. If the scandir() path argument was a file descriptor, the path attribute is the same as the name attribute.

The path attribute will be bytes if the scandir() path argument is of type bytes and str otherwise. Use fsdecode() to decode byte filenames.

inode()

項目の inode 番号を返します。

結果は os.DirEntry オブジェクトにキャッシュされます。最新の情報を取得するには os.stat(entry.path, follow_symlinks=False).st_ino を使用してください。

Windows 上では、最初のキャッシュされていない呼び出しでシステムコールが必要ですが、 Unix 上では必要ありません。

is_dir(*, follow_symlinks=True)

この項目がディレクトリまたはディレクトリへのシンボリックリンクである場合、 True を返します。項目がそれ以外のファイルやそれ以外のファイルへのシンボリックリンクである場合や、もはや存在しない場合は False を返します。

follow_symlinks が False の場合、項目がディレクトリ (シンボリックリンクはたどりません) の場合にのみ True を返します。項目がディレクトリ以外のファイルである場合や、項目がもはや存在しない場合は False を返します。

結果は os.DirEntry オブジェクトにキャッシュされます。follow_symlinks が True の場合と False の場合とでは、別のオブジェクトにキャッシュされます。最新の情報を取得するには stat.S_ISDIR() と共に os.stat() を呼び出してください。

多くの場合、最初のキャッシュされない呼び出しでは、システムコールは必要とされません。具体的には、シンボリックリンク以外では、Windows も Unix もシステムコールを必要としません。ただし、dirent.d_type == DT_UNKNOWN を返す、ネットワークファイルシステムなどの特定の Unix ファイルシステムは例外です。項目がシンボリックリンクの場合、follow_symlinks が False の場合を除き、シンボリックリンクをたどるためにシステムコールが必要となります。

このメソッドは PermissionError のような OSError を送出することがありますが、 FileNotFoundError は捕捉され送出されません。

is_file(*, follow_symlinks=True)

この項目がファイルまたはファイルへのシンボリックリンクである場合、 True を返します。項目がディレクトリやファイル以外の項目へのシンボリックリンクである場合や、もはや存在しない場合は False を返します。

follow_symlinks が False の場合、項目がファイル (シンボリックリンクはたどりません) の場合にのみ True を返します。項目がディレクトリやその他のファイル以外の項目である場合や、項目がもはや存在しない場合は False を返します。

結果は os.DirEntry オブジェクトにキャッシュされます。キャッシュ、システムコール、例外は、is_dir() と同様に行われます。

is_symlink()

この項目がシンボリックリンクの場合 (たとえ破損していても)、True を返します。項目がディレクトリやあらゆる種類のファイルの場合、またはもはや存在しない場合は False を返します。

結果は os.DirEntry オブジェクトにキャッシュされます。 最新の情報をフェッチするには os.path.islink() を呼び出してください。

多くの場合、最初のキャッシュされない呼び出しでは、システムコールは必要とされません。具体的には、Windows も Unix もシステムコールを必要としません。ただし、dirent.d_type == DT_UNKNOWN を返す、ネットワークファイルシステムなどの特定の Unix ファイルシステムは例外です。

このメソッドは PermissionError のような OSError を送出することがありますが、 FileNotFoundError は捕捉され送出されません。

stat(*, follow_symlinks=True)

この項目の stat_result オブジェクトを返します。このメソッドは、デフォルトでシンボリックリンクをたどります。シンボリックリンクを開始するには、 follow_symlinks=False 引数を追加します。

On Unix, this method always requires a system call. On Windows, it only requires a system call if follow_symlinks is True and the entry is a reparse point (for example, a symbolic link or directory junction).

Windows では、stat_result の st_ino 、 st_dev 、 st_nlink 属性は常にゼロに設定されます。これらの属性を取得するには、 os.stat() を呼び出します。

結果は os.DirEntry オブジェクトにキャッシュされます。follow_symlinks が True の場合と False の場合とでは、別のオブジェクトにキャッシュされます。最新の情報を取得するには、 os.stat() を呼び出してください。

os.DirEntry と pathlib.Path では、いくつかの属性やメソッドがよい対応関係にあります。特に、 name 属性は同じ意味を持ちます。is_dir() 、 is_file() 、 is_symlink() 、 stat() メソッドも同じ意味を持ちます。

バージョン 3.5 で追加.

バージョン 3.6 で変更: PathLike インターフェースをサポートしました。Windowsで:class:bytes パスをサポートしました。

os.stat(path, *, dir_fd=None, follow_symlinks=True)

Get the status of a file or a file descriptor. Perform the equivalent of a stat() system call on the given path. path may be specified as either a string or bytes -- directly or indirectly through the PathLike interface -- or as an open file descriptor. Return a stat_result object.

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

この関数は ファイル記述子の指定 および シンボリックリンクをたどらない をサポートしています。

On Windows, passing follow_symlinks=False will disable following all name-surrogate reparse points, which includes symlinks and directory junctions. Other types of reparse points that do not resemble links or that the operating system is unable to follow will be opened directly. When following a chain of multiple links, this may result in the original link being returned instead of the non-link that prevented full traversal. To obtain stat results for the final path in this case, use the os.path.realpath() function to resolve the path name as far as possible and call lstat() on the result. This does not apply to dangling symlinks or junction points, which will raise the usual exceptions.

以下はプログラム例です:

>>> import os
>>> statinfo = os.stat('somefile.txt')
>>> statinfo
os.stat_result(st_mode=33188, st_ino=7876932, st_dev=234881026,
st_nlink=1, st_uid=501, st_gid=501, st_size=264, st_atime=1297230295,
st_mtime=1297230027, st_ctime=1297230027)
>>> statinfo.st_size
264

参考

fstat() と lstat()。

バージョン 3.3 で追加: dir_fd, follow_symlinks 引数の追加、ファイル記述子の指定の追加。

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

バージョン 3.8 で変更: On Windows, all reparse points that can be resolved by the operating system are now followed, and passing follow_symlinks=False disables following all name surrogate reparse points. If the operating system reaches a reparse point that it is not able to follow, stat now returns the information for the original path as if follow_symlinks=False had been specified instead of raising an error.

class os.stat_result

おおむね stat 構造体のメンバーに対応する属性を持つオブジェクトです。os.stat() 、 os.fstat() 、 os.lstat() の結果に使用されます。

属性:

st_mode

ファイルモード。ファイルタイプとファイルモードのビット （権限）。

st_ino

Platform dependent, but if non-zero, uniquely identifies the file for a given value of st_dev. Typically:

• the inode number on Unix,

• the file index on Windows

st_dev

このファイルが存在するデバイスの識別子。

st_nlink

ハードリンクの数。

st_uid

ファイル所有者のユーザ識別子。

st_gid

ファイル所有者のグループ識別子。

st_size

ファイルが通常のファイルまたはシンボリックリンクの場合、そのファイルのバイト単位でのサイズです。シンボリックリンクのサイズは、含まれるパス名の長さで、null バイトで終わることはありません。

タイムスタンプ:

st_atime

秒で表した最終アクセス時刻。

st_mtime

秒で表した最終内容更新時刻。

st_ctime

プラットフォーム依存:

• Unix ではメタデータの最終更新時刻

• Windows では作成時刻、単位は秒

st_atime_ns

ナノ秒 (整数) で表した最終アクセス時刻。

st_mtime_ns

ナノ秒 (整数) で表した最終内容更新時刻。

st_ctime_ns

プラットフォーム依存:

• Unix ではメタデータの最終更新時刻

• Windows で、ナノ秒 (整数) で表した作成時刻。

注釈

st_atime 、 st_mtime 、および st_ctime 属性の厳密な意味や精度はオペレーティングシステムやファイルシステムによって変わります。例えば、 FAT や FAT32 ファイルシステムを使用している Windows システムでは、 st_mtime の精度は 2 秒であり、 st_atime の精度は 1 日に過ぎません。詳しくはお使いのオペレーティングシステムのドキュメントを参照してください。

同じように、st_atime_ns、st_mtime_ns、および st_ctime_ns は常にナノ秒で表されますが、多くのシステムではナノ秒単位の精度では提供していません。ナノ秒単位の精度を提供するシステムであっても、st_atime、st_mtime、および st_ctime についてはそれらが格納される浮動小数点オブジェクトがそのすべてを保持できず、それ自体が少々不正確です。正確なタイムスタンプが必要な場合は、st_atime_ns、st_mtime_ns、および st_ctime_ns を使用するべきです。

(Linux のような ) 一部の Unix システムでは、以下の属性が利用できる場合があります :

st_blocks

ファイルに対して割り当てられている 512 バイトのブロックの数です。ファイルにホール (hole) が含まれている場合、st_size/512 より小さくなる場合があります。

st_blksize

効率的なファイルシステム I/O のための「推奨される」ブロックサイズです。ファイルに、これより小さいチャンクで書き込むと、非効率的な読み込み、編集、再書き込みが起こる場合があります。

st_rdev

inode デバイスの場合デバイスタイプ

st_flags

ファイルのユーザ定義フラグ

他の (FreeBSD のような ) Unix システムでは、以下の属性が利用できる場合があります ( ただし root ユーザ以外が使うと値が入っていない場合があります ):

st_gen

ファイル生成番号

st_birthtime

ファイル作成時刻

On Solaris and derivatives, the following attributes may also be available:

st_fstype

String that uniquely identifies the type of the filesystem that contains the file.

Mac OS システムでは、以下の属性も利用できる場合があります:

st_rsize

ファイルの実際のサイズ

st_creator

ファイルの作成者

st_type

ファイルタイプ

On Windows systems, the following attributes are also available:

st_file_attributes

Windows のファイルの属性。GetFileInformationByHandle() の返す BY_HANDLE_FILE_INFORMATION 構造の dwFileAttributes メンバーです。stat モジュールの FILE_ATTRIBUTE_* 定数を参照してください。

st_reparse_tag

When st_file_attributes has the FILE_ATTRIBUTE_REPARSE_POINT set, this field contains the tag identifying the type of reparse point. See the IO_REPARSE_TAG_* constants in the stat module.

標準モジュール stat は stat 構造体からの情報の取り出しに役立つ関数と定数を定義しています。 (Windows では、一部のアイテムにダミー値が入ります )

後方互換性のため、stat_result インスタンスには、 stat 構造体の最も重要な (そして移植性の高い) メンバーを表す少なくとも 10 個の整数からなるタプルとしてもアクセス可能です。このタプルは、 st_mode、st_ino、st_dev、st_nlink、st_uid、st_gid、st_size、st_atime、st_mtime、st_ctime の順になります。実装によってはそれ以上のアイテムが末尾に追加されます。古いバージョンの Python との互換性のため、 stat_result にタプルとしてアクセスすると、常に整数を返します。

バージョン 3.3 で追加: st_atime_ns、st_mtime_ns、st_ctime_ns メンバが追加されました。

バージョン 3.5 で追加: Windows において st_file_attributes メンバが追加されました。

バージョン 3.5 で変更: Windows now returns the file index as st_ino when available.

バージョン 3.7 で追加: Added the st_fstype member to Solaris/derivatives.

バージョン 3.8 で追加: Added the st_reparse_tag member on Windows.

バージョン 3.8 で変更: On Windows, the st_mode member now identifies special files as S_IFCHR, S_IFIFO or S_IFBLK as appropriate.

os.statvfs(path)

与えられたパスに対して statvfs() システムコールを実行します。返り値はオブジェクトで、その属性は与えられたパスが格納されているファイルシステムについて記述したものです。各属性は statvfs 構造体のメンバーに対応します : f_bsize, f_frsize, f_blocks, f_bfree, f_bavail, f_files, f_ffree, f_favail, f_flag, f_namemax, :attr:`f_fsid 。

f_flag 属性のビットフラグ用に 2 つのモジュールレベル定数が定義されています: ST_RDONLY が設定されるとファイルシステムは読み出し専用でマウントされ、ST_NOSUID が設定されると setuid/setgid ビットの動作は無効になるか、サポートされません。

GNU/glibc ベースのシステム用に、追加のモジュールレベルの定数が次のように定義されています。 ST_NODEV (デバイス特殊ファイルへのアクセスを許可しない) 、 ST_NOEXEC (プログラムの実行を許可しない) 、 ST_SYNCHRONOUS (書き込みが一度に同期される) 、ST_MANDLOCK (ファイルシステムで強制的なロックを許可する) 、 ST_WRITE (ファイル/ディレクトリ/シンボリックリンクに書き込む) 、 ST_APPEND (追記のみのファイル) 、ST_IMMUTABLE (変更不能なファイル) 、 ST_NOATIME (アクセス時刻を更新しない) 、ST_NODIRATIME (ディレクトリアクセス時刻を更新しない) 、ST_RELATIME (mtime/ctimeに対して相対的に atime を更新する)。

この関数は ファイル記述子の指定 をサポートしています。

利用可能な環境: Unix。

バージョン 3.2 で変更: 定数 ST_RDONLY および ST_NOSUID が追加されました。

バージョン 3.3 で追加: path へのオープン・ファイル記述子の指定をサポートしました。

バージョン 3.4 で変更: ST_NODEV, ST_NOEXEC, ST_SYNCHRONOUS, ST_MANDLOCK, ST_WRITE, ST_APPEND, ST_IMMUTABLE, ST_NOATIME, ST_NODIRATIME, ST_RELATIME 定数が追加されました。

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

バージョン 3.7 で追加: f_fsid が追加されました。

os.supports_dir_fd

A set object indicating which functions in the os module accept an open file descriptor for their dir_fd parameter. Different platforms provide different features, and the underlying functionality Python uses to implement the dir_fd parameter is not available on all platforms Python supports. For consistency's sake, functions that may support dir_fd always allow specifying the parameter, but will throw an exception if the functionality is used when it's not locally available. (Specifying None for dir_fd is always supported on all platforms.)

To check whether a particular function accepts an open file descriptor for its dir_fd parameter, use the in operator on supports_dir_fd. As an example, this expression evaluates to True if os.stat() accepts open file descriptors for dir_fd on the local platform:

os.stat in os.supports_dir_fd

現在 dir_fd 引数は Unix プラットフォームでのみ動作します。Windows で動作する関数はありません。

バージョン 3.3 で追加.

os.supports_effective_ids

A set object indicating whether os.access() permits specifying True for its effective_ids parameter on the local platform. (Specifying False for effective_ids is always supported on all platforms.) If the local platform supports it, the collection will contain os.access(); otherwise it will be empty.

This expression evaluates to True if os.access() supports effective_ids=True on the local platform:

os.access in os.supports_effective_ids

現在 effective_ids は Unix プラットフォームでのみサポートされています。Windows では動作しません。

バージョン 3.3 で追加.

os.supports_fd

A set object indicating which functions in the os module permit specifying their path parameter as an open file descriptor on the local platform. Different platforms provide different features, and the underlying functionality Python uses to accept open file descriptors as path arguments is not available on all platforms Python supports.

To determine whether a particular function permits specifying an open file descriptor for its path parameter, use the in operator on supports_fd. As an example, this expression evaluates to True if os.chdir() accepts open file descriptors for path on your local platform:

os.chdir in os.supports_fd

バージョン 3.3 で追加.

os.supports_follow_symlinks

A set object indicating which functions in the os module accept False for their follow_symlinks parameter on the local platform. Different platforms provide different features, and the underlying functionality Python uses to implement follow_symlinks is not available on all platforms Python supports. For consistency's sake, functions that may support follow_symlinks always allow specifying the parameter, but will throw an exception if the functionality is used when it's not locally available. (Specifying True for follow_symlinks is always supported on all platforms.)

To check whether a particular function accepts False for its follow_symlinks parameter, use the in operator on supports_follow_symlinks. As an example, this expression evaluates to True if you may specify follow_symlinks=False when calling os.stat() on the local platform:

os.stat in os.supports_follow_symlinks

バージョン 3.3 で追加.

os.symlink(src, dst, target_is_directory=False, *, dir_fd=None)

src を指し示すシンボリックリンク dst を作成します。

Windows では、シンボリックリンクはファイルかディレクトリのどちらかを表しますが、ターゲットに合わせて動的に変化することはありません。ターゲットが存在する場合、シンボリックリンクの種類は対象に合わせて作成されます。ターゲットが存在せず target_is_directory に True が設定された場合、シンボリックリンクはディレクトリのリンクとして作成され、False に設定された場合 (デフォルト) はファイルのリンクになります。Windows 以外のプラットフォームでは target_is_directory は無視されます。

この関数は ディレクトリ記述子への相対パス をサポートしています。

注釈

On newer versions of Windows 10, unprivileged accounts can create symlinks if Developer Mode is enabled. When Developer Mode is not available/enabled, the SeCreateSymbolicLinkPrivilege privilege is required, or the process must be run as an administrator.

この関数が特権を持たないユーザーに呼び出されると、OSError が送出されます。

引数 src, dst, dir_fd を指定して 監査イベント os.symlink を送出します。

Availability: Unix, Windows。

バージョン 3.2 で変更: Windows 6.0 (Vista) のシンボリックリンクをサポートしました。

バージョン 3.3 で追加: 引数 dir_fd が追加され、非 Windows プラットフォームでの target_is_directory 指定がサポートされました。

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

バージョン 3.8 で変更: Added support for unelevated symlinks on Windows with Developer Mode.

os.sync()

ディスクキャッシュのディスクへの書き出しを強制します。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.truncate(path, length)

path に対応するファイルを、サイズが最大で length バイトになるよう切り詰めます。

この関数は ファイル記述子の指定 をサポートしています。

引数 path, length を指定して 監査イベント os.truncate を送出します。

Availability: Unix, Windows。

バージョン 3.3 で追加.

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

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

os.unlink(path, *, dir_fd=None)

ファイル path を削除します。意味上は remove() と等価です。 unlink の名前は伝統的な Unix の関数名です。詳細は remove() のドキュメントを参照してください。

引数 path, dir_fd を指定して 監査イベント os.remove を送出します。

バージョン 3.3 で追加: 引数 dir_fd が追加されました。

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

os.utime(path, times=None, *, [ns, ]dir_fd=None, follow_symlinks=True)

path で指定されたファイルに最終アクセス時刻および最終修正時刻を設定します。

utime() は 2 つの任意引数 times と ns をとります。これらは path に設定する時刻を指定し、以下のように使用されます:

• ns を指定する場合、ナノ秒を表す整数値をメンバーとして使用して、 (atime_ns, mtime_ns) の形式の 2 要素タプルを指定する必要があります。

• times が None ではない場合、(atime, mtime) の形式で各メンバーは単位を秒で表す整数か浮動小数点値のタプルを指定しなければなりません。

• times が None で、 ns が指定されていない場合、これは両方の時間を現在時刻として ns=(atime_ns, mtime_ns) を指定することと等価です。

times と ns の両方にタプルが指定されるとエラーになります。

Note that the exact times you set here may not be returned by a subsequent stat() call, depending on the resolution with which your operating system records access and modification times; see stat(). The best way to preserve exact times is to use the st_atime_ns and st_mtime_ns fields from the os.stat() result object with the ns parameter to utime.

この関数は ファイル記述子の指定 、 ディレクトリ記述子への相対パス 、および シンボリックリンクをたどらない をサポートしています。

引数 path, times, ns, dir_fd を指定して 監査イベント os.utime を送出します。

バージョン 3.3 で追加: path にオープンしているファイル記述子の指定のサポート、および引数 dir_fd, follow_symlinks, ns を追加しました。

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

os.walk(top, topdown=True, onerror=None, followlinks=False)

ディレクトリツリー以下のファイル名を、ツリーをトップダウンもしくはボトムアップに走査することで作成します。ディレクトリ top を根に持つディレクトリツリーに含まれる、各ディレクトリ (top 自身を含む ) ごとに、タプル (dirpath, dirnames, filenames) を yield します。

dirpath is a string, the path to the directory. dirnames is a list of the names of the subdirectories in dirpath (excluding '.' and '..'). filenames is a list of the names of the non-directory files in dirpath. Note that the names in the lists contain no path components. To get a full path (which begins with top) to a file or directory in dirpath, do os.path.join(dirpath, name). Whether or not the lists are sorted depends on the file system. If a file is removed from or added to the dirpath directory during generating the lists, whether a name for that file be included is unspecified.

オプション引数 topdown が True であるか、指定されなかった場合、各ディレクトリからタプルを生成した後で、サブディレクトリからタプルを生成します。 ( ディレクトリはトップダウンで生成 ) 。 topdown が False の場合、ディレクトリに対応するタプルは、そのディレクトリ以下の全てのサブディレクトリに対応するタプルの後で ( ボトムアップで ) 生成されます。 topdown の値によらず、サブディレクトリのリストは、ディレクトリとそのサブディレクトリのタプルを生成する前に取り出されます。

topdown が True のとき、呼び出し側は dirnames リストを、インプレースで ( たとえば、 del やスライスを使った代入で ) 変更でき、 walk() は dirnames に残っているサブディレクトリ内のみを再帰します。これにより、検索を省略したり、特定の訪問順序を強制したり、呼び出し側が walk() を再開する前に、呼び出し側が作った、または名前を変更したディレクトリを、 walk() に知らせたりすることができます。 topdown が False のときに dirnames を変更しても効果はありません。ボトムアップモードでは dirpath 自身が生成される前に dirnames 内のディレクトリの情報が生成されるからです。

デフォルトでは、 scandir() 呼び出しからのエラーは無視されます。オプション引数の onerror を指定する場合は関数でなければなりません ; この関数は単一の引数として OSError インスタンスを伴って呼び出されます。この関数でエラーを報告して走査を継続したり、例外を送出して走査を中止したりできます。ファイル名は例外オブジェクトの filename 属性として利用できます。

デフォルトでは、 walk() はディレクトリへのシンボリックリンクをたどりません。 followlinks に True を指定すると、ディレクトリへのシンボリックリンクをサポートしているシステムでは、シンボリックリンクの指しているディレクトリを走査します。

注釈

followlinks に True を指定すると、シンボリックリンクが親ディレクトリを指していた場合に、無限ループになることに注意してください。 walk() はすでにたどったディレクトリを管理したりはしません。

注釈

相対パスを渡した場合、 walk() が再開されるまでの間に現在の作業ディレクトリを変更しないでください。 walk() はカレントディレクトリを変更しませんし、呼び出し側もカレントディレクトリを変更しないと仮定しています。

以下の例では、最初のディレクトリ以下にある各ディレクトリに含まれる、非ディレクトリファイルのバイト数を表示します。ただし、 CVS サブディレクトリ以下は見に行きません

import os
from os.path import join, getsize
for root, dirs, files in os.walk('python/Lib/email'):
    print(root, "consumes", end=" ")
    print(sum(getsize(join(root, name)) for name in files), end=" ")
    print("bytes in", len(files), "non-directory files")
    if 'CVS' in dirs:
        dirs.remove('CVS')  # don't visit CVS directories

次の例 (shutil.rmtree() の単純な実装) では、ツリーをボトムアップで走査することが不可欠になります; rmdir() はディレクトリが空になるまで削除を許さないからです:

# Delete everything reachable from the directory named in "top",
# assuming there are no symbolic links.
# CAUTION:  This is dangerous!  For example, if top == '/', it
# could delete all your disk files.
import os
for root, dirs, files in os.walk(top, topdown=False):
    for name in files:
        os.remove(os.path.join(root, name))
    for name in dirs:
        os.rmdir(os.path.join(root, name))

バージョン 3.5 で変更: この関数は、今では os.listdir() ではなく os.scandir() を呼び出します。これにより、 os.stat() の呼び出し回数を削減でき、動作が高速化します。

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

os.fwalk(top='.', topdown=True, onerror=None, *, follow_symlinks=False, dir_fd=None)

挙動は walk() と同じですが、dir_fd をサポートし、タプル (dirpath, dirnames, filenames, dirfd) を yield します。

dirpath、dirnames、および filenames は walk() の出力と同じで、dirfd は dirpath を参照するファイル記述子です。

この関数は常に ディレクトリ記述子への相対パス および シンボリックリンクをたどらない をサポートしています。ただし、他の関数と異なり、fwalk() での follow_symlinks のデフォルト値は False になることに注意してください。

注釈

fwalk() はファイル記述子を yield するため、それらが有効なのは次のイテレートステップまでです。それ以後も保持したい場合は dup() などを使って複製して使用してください。

以下の例では、最初のディレクトリ以下にある各ディレクトリに含まれる、非ディレクトリファイルのバイト数を表示します。ただし、 CVS サブディレクトリ以下は見に行きません

import os
for root, dirs, files, rootfd in os.fwalk('python/Lib/email'):
    print(root, "consumes", end="")
    print(sum([os.stat(name, dir_fd=rootfd).st_size for name in files]),
          end="")
    print("bytes in", len(files), "non-directory files")
    if 'CVS' in dirs:
        dirs.remove('CVS')  # don't visit CVS directories

次の例では、ツリーをボトムアップで走査することが不可欠になります ; rmdir() はディレクトリが空になるまで削除を許さないからです

# Delete everything reachable from the directory named in "top",
# assuming there are no symbolic links.
# CAUTION:  This is dangerous!  For example, if top == '/', it
# could delete all your disk files.
import os
for root, dirs, files, rootfd in os.fwalk(top, topdown=False):
    for name in files:
        os.unlink(name, dir_fd=rootfd)
    for name in dirs:
        os.rmdir(name, dir_fd=rootfd)

利用可能な環境: Unix。

バージョン 3.3 で追加.

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

バージョン 3.7 で変更: Added support for bytes paths.

os.memfd_create(name[, flags=os.MFD_CLOEXEC])

Create an anonymous file and return a file descriptor that refers to it. flags must be one of the os.MFD_* constants available on the system (or a bitwise ORed combination of them). By default, the new file descriptor is non-inheritable.

The name supplied in name is used as a filename and will be displayed as the target of the corresponding symbolic link in the directory /proc/self/fd/. The displayed name is always prefixed with memfd: and serves only for debugging purposes. Names do not affect the behavior of the file descriptor, and as such multiple files can have the same name without any side effects.

利用可能な環境: Linux 3.17 以上または glibc 2.27 以上。

バージョン 3.8 で追加.

os.MFD_CLOEXEC

os.MFD_ALLOW_SEALING

os.MFD_HUGETLB

os.MFD_HUGE_SHIFT

os.MFD_HUGE_MASK

os.MFD_HUGE_64KB

os.MFD_HUGE_512KB

os.MFD_HUGE_1MB

os.MFD_HUGE_2MB

os.MFD_HUGE_8MB

os.MFD_HUGE_16MB

os.MFD_HUGE_32MB

os.MFD_HUGE_256MB

os.MFD_HUGE_512MB

os.MFD_HUGE_1GB

os.MFD_HUGE_2GB

os.MFD_HUGE_16GB

These flags can be passed to memfd_create().

Availability: Linux 3.17 or newer with glibc 2.27 or newer. The MFD_HUGE* flags are only available since Linux 4.14.

バージョン 3.8 で追加.

Linux 拡張属性

バージョン 3.3 で追加.

以下の関数はすべて Linux でのみ使用可能です。

os.getxattr(path, attribute, *, follow_symlinks=True)

Return the value of the extended filesystem attribute attribute for path. attribute can be bytes or str (directly or indirectly through the PathLike interface). If it is str, it is encoded with the filesystem encoding.

この関数は ファイル記述子の指定 および シンボリックリンクをたどらない をサポートしています。

引数 path, attribute を指定して 監査イベント os.getxattr を送出します。

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

os.listxattr(path=None, *, follow_symlinks=True)

path の拡張ファイルシステム属性のリストを返します。リスト内の属性はファイルシステムのエンコーディングでデコードされた文字列で表されます。path が None の場合、listxattr() はカレントディレクトリを調べます。

この関数は ファイル記述子の指定 および シンボリックリンクをたどらない をサポートしています。

引数 path を指定して 監査イベント os.listxattr を送出します。

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

os.removexattr(path, attribute, *, follow_symlinks=True)

Removes the extended filesystem attribute attribute from path. attribute should be bytes or str (directly or indirectly through the PathLike interface). If it is a string, it is encoded with the filesystem encoding.

この関数は ファイル記述子の指定 および シンボリックリンクをたどらない をサポートしています。

引数 path, attribute を指定して 監査イベント os.removexattr を送出します。

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

os.setxattr(path, attribute, value, flags=0, *, follow_symlinks=True)

Set the extended filesystem attribute attribute on path to value. attribute must be a bytes or str with no embedded NULs (directly or indirectly through the PathLike interface). If it is a str, it is encoded with the filesystem encoding. flags may be XATTR_REPLACE or XATTR_CREATE. If XATTR_REPLACE is given and the attribute does not exist, ENODATA will be raised. If XATTR_CREATE is given and the attribute already exists, the attribute will not be created and EEXISTS will be raised.

この関数は ファイル記述子の指定 および シンボリックリンクをたどらない をサポートしています。

注釈

Linux カーネル 2.6.39 以前では、バグのため一部のファイルシステムで引数 flags が無視されます。

引数 path, attribute, value, flags を指定して 監査イベント os.setxattr を送出します。

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

os.XATTR_SIZE_MAX

拡張属性の値にできる最大サイズです。現在、Linux では 64 キロバイトです。

os.XATTR_CREATE

setxattr() の引数 flags に指定できる値です。その操作で属性を作成しなければならないことを意味します。

os.XATTR_REPLACE

setxattr() の引数 flags に指定できる値です。その操作で既存の属性を置き換えなければならないことを意味します。

プロセス管理

以下の関数はプロセスの生成や管理に利用できます。

さまざまな exec* 関数は、プロセス内にロードされる新しいプログラムに与えるための、引数のリストを取ります。どの関数の場合でも、新しいプログラムに渡されるリストの最初の引数は、ユーザがコマンドラインで入力する引数ではなく、そのプログラム自体の名前です。 C プログラマならば、プログラムの main() に渡される argv[0] だと考えれば良いでしょう。たとえば、 os.execv('/bin/echo', ['foo', 'bar']) が標準出力に出力するのは bar だけで、 foo は無視されたかのように見えることになります。

os.abort()

SIGABRT シグナルを現在のプロセスに対して生成します。 Unix では、デフォルトの動作はコアダンプの生成です ; Windows では、プロセスは即座に終了コード 3 を返します。この関数の呼び出しは signal.signal() を使って SIGABRT に対し登録された Python シグナルハンドラーを呼び出さないことに注意してください。

os.add_dll_directory(path)

Add a path to the DLL search path.

This search path is used when resolving dependencies for imported extension modules (the module itself is resolved through sys.path), and also by ctypes.

Remove the directory by calling close() on the returned object or using it in a with statement.

See the Microsoft documentation for more information about how DLLs are loaded.

引数 path を指定して 監査イベント os.add_dll_directory を送出します。

利用可能な環境: Windows 。

バージョン 3.8 で追加: Previous versions of CPython would resolve DLLs using the default behavior for the current process. This led to inconsistencies, such as only sometimes searching PATH or the current working directory, and OS functions such as AddDllDirectory having no effect.

In 3.8, the two primary ways DLLs are loaded now explicitly override the process-wide behavior to ensure consistency. See the porting notes for information on updating libraries.

os.execl(path, arg0, arg1, ...)

os.execle(path, arg0, arg1, ..., env)

os.execlp(file, arg0, arg1, ...)

os.execlpe(file, arg0, arg1, ..., env)

os.execv(path, args)

os.execve(path, args, env)

os.execvp(file, args)

os.execvpe(file, args, env)

これらの関数はすべて、現在のプロセスを置き換える形で新たなプログラムを実行します ; 現在のプロセスは返り値を返しません。 Unix では、新たに実行される実行コードは現在のプロセス内に読み込まれ、呼び出し側と同じプロセス ID を持つことになります。エラーは OSError 例外として報告されます。

現在のプロセスは瞬時に置き換えられます。開かれているファイルオブジェクトやファイル記述子はフラッシュされません。そのため、バッファ内にデータが残っているかもしれない場合、 exec* 関数を実行する前に sys.stdout.flush() か os.fsync() を利用してバッファをフラッシュしておく必要があります。

"l" および "v" のついた exec* 関数は、コマンドライン引数をどのように渡すかが異なります。 "l" 型は、コードを書くときにパラメタ数が決まっている場合に、おそらくもっとも簡単に利用できます。個々のパラメタは単に execl*() 関数の追加パラメタとなります。 "v" 型は、パラメタの数が可変の時に便利で、リストかタプルの引数が args パラメタとして渡されます。どちらの場合も、子プロセスに渡す引数は動作させようとしているコマンドの名前から始まるべきですが、これは強制されません。

末尾近くに "p" をもつ型 (execlp(), execlpe(), execvp(), および execvpe()) は、プログラム file を探すために環境変数 PATH を利用します。環境変数が ( 次の段で述べる exec*e 型関数で ) 置き換えられる場合、環境変数は PATH を決定する上の情報源として使われます。その他の型、 execl(), execle(), execv(), および execve() では、実行コードを探すために PATH を使いません。 path には適切に設定された絶対パスまたは相対パスが入っていなくてはなりません。

execle() 、 execlpe() 、 execve() 、および execvpe() (すべて末尾に "e" がついています) では、 env 引数は新たなプロセスで利用される環境変数を定義するためのマップ型でなくてはなりません ( 現在のプロセスの環境変数の代わりに利用されます ); execl() 、 execlp() 、 execv() 、および execvp() では、すべて新たなプロセスは現在のプロセスの環境を引き継ぎます。

一部のプラットフォームの execve() では、path はオープンしているファイル記述子で指定することもできます。この機能をサポートしていないプラットフォームもあります; os.supports_fd を使うことで利用可能かどうか調べることができます。利用できない場合、NotImplementedError が送出されます。

引数 path, args, env を指定して 監査イベント os.exec を送出します。

Availability: Unix, Windows。

バージョン 3.3 で追加: Added support for specifying path as an open file descriptor for execve().

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

os._exit(n)

終了ステータス n でプロセスを終了します。この時クリーンアップハンドラーの呼び出しや、標準入出力バッファのフラッシュなどは行いません。

注釈

終了する標準的な方法は sys.exit(n) です。 _exit() は通常、 fork() された後の子プロセスでのみ使われます。

以下の終了コードは必須ではありませんが _exit() で使うことができます。一般に、メールサーバーの外部コマンド配送プログラムのような、 Python で書かれたシステムプログラムに使います。

注釈

いくつかのバリエーションがあって、これらのすべてがすべての Unix プラットフォームで使えるわけではありません。以下の定数は下層のプラットフォームで定義されていれば定義されます。

os.EX_OK

エラーが起きなかったことを表す終了コード。

利用可能な環境: Unix。

os.EX_USAGE

誤った個数の引数が渡された時など、コマンドが間違って使われたことを表す終了コード。

利用可能な環境: Unix。

os.EX_DATAERR

入力データが誤っていたことを表す終了コード。

利用可能な環境: Unix。

os.EX_NOINPUT

入力ファイルが存在しなかった、または、読み込み不可だったことを表す終了コード。

利用可能な環境: Unix。

os.EX_NOUSER

指定されたユーザーが存在しなかったことを表す終了コード。

利用可能な環境: Unix。

os.EX_NOHOST

指定されたホストが存在しなかったことを表す終了コード。

利用可能な環境: Unix。

os.EX_UNAVAILABLE

要求されたサービスが利用できないことを表す終了コード。

利用可能な環境: Unix。

os.EX_SOFTWARE

内部ソフトウェアエラーが検出されたことを表す終了コード。

利用可能な環境: Unix。

os.EX_OSERR

fork できない、 pipe の作成ができないなど、オペレーティングシステムのエラーが検出されたことを表す終了コード。

利用可能な環境: Unix。

os.EX_OSFILE

システムファイルが存在しなかった、開けなかった、あるいはその他のエラーが起きたことを表す終了コード。

利用可能な環境: Unix。

os.EX_CANTCREAT

ユーザーには作成できない出力ファイルを指定したことを表す終了コード。

利用可能な環境: Unix。

os.EX_IOERR

ファイルの I/O を行っている途中にエラーが発生した時の終了コード。

利用可能な環境: Unix。

os.EX_TEMPFAIL

一時的な失敗が発生したことを表す終了コード。これは、再試行可能な操作の途中に、ネットワークに接続できないというような、実際にはエラーではないかも知れないことを意味します。

利用可能な環境: Unix。

os.EX_PROTOCOL

プロトコル交換が不正、不適切、または理解不能なことを表す終了コード。

利用可能な環境: Unix。

os.EX_NOPERM

操作を行うために十分な許可がなかった（ファイルシステムの問題を除く）ことを表す終了コード。

利用可能な環境: Unix。

os.EX_CONFIG

設定エラーが起こったことを表す終了コード。

利用可能な環境: Unix。

os.EX_NOTFOUND

"an entry was not found" のようなことを表す終了コード。

利用可能な環境: Unix。

os.fork()

子プロセスを fork します。子プロセスでは 0 が返り、親プロセスでは子プロセスの id が返ります。エラーが発生した場合は、 OSError を送出します。

FreeBSD 6.3 以下、Cygwinを含む一部のプラットフォームにおいて、 fork() をスレッド内から利用した場合に既知の問題があることに注意してください。

引数無しで 監査イベント os.fork を送出します。

バージョン 3.8 で変更: Calling fork() in a subinterpreter is no longer supported (RuntimeError is raised).

警告

SSL モジュールを fork() とともに使うアプリケーションについて、 ssl を参照して下さい。

利用可能な環境: Unix。

os.forkpty()

子プロセスを fork します。この時新しい擬似端末を子プロセスの制御端末として使います。親プロセスでは (pid, fd) からなるペアが返り、 fd は擬似端末のマスター側のファイル記述子となります。可搬性のあるアプローチを取るには、 pty モジュールを利用してください。エラーが発生した場合は、 OSError を送出します。

引数無しで 監査イベント os.forkpty を送出します。

バージョン 3.8 で変更: Calling forkpty() in a subinterpreter is no longer supported (RuntimeError is raised).

利用できる環境: 一部の Unix 互換環境。

os.kill(pid, sig)

プロセス pid にシグナル sig を送ります。ホストプラットフォームで利用可能なシグナルを特定する定数は signal モジュールで定義されています。

Windows: signal.CTRL_C_EVENT と signal.CTRL_BREAK_EVENT は、同じコンソールウィンドウを共有しているコンソールプロセス ( 例 : 子プロセス ) にだけ送ることができる特別なシグナルです。その他の値を sig に与えると、そのプロセスが無条件に TerminateProcess API によって kill され、終了コードが sig に設定されます。 Windows の kill() は kill するプロセスのハンドルも受け取ります。

signal.pthread_kill() も参照してください。

引数 pid, sig を指定して 監査イベント os.kill を送出します。

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

os.killpg(pgid, sig)

プロセスグループ pgid にシグナル sig を送ります。

引数 pgid, sig を指定して 監査イベント os.killpg を送出します。

利用可能な環境: Unix。

os.nice(increment)

プロセスの "nice 値 " に increment を加えます。新たな nice 値を返します。

利用可能な環境: Unix。

os.plock(op)

プログラムのセグメントをメモリ内にロックします。 op (<sys/lock.h> で定義されています ) にはどのセグメントをロックするかを指定します。

利用可能な環境: Unix。

os.popen(cmd, mode='r', buffering=-1)

コマンド cmd への、または cmd からのパイプ入出力を開きます。戻り値はパイプに接続されている開かれたファイルオブジェクトで、 mode が 'r' (デフォルト) または 'w' かによって読み出しまたは書き込みを行うことができます。引数 bufsize は、組み込み関数 open() における対応する引数と同じ意味を持ちます。 返されるファイルオブジェクトは、バイトではなくテキスト文字列を読み書きします。

close メソッドは、サブプロセスが正常に終了した場合は None を返し、エラーが発生した場合にはサブプロセスの返りコードを返します。POSIX システムでは、返りコードが正の場合、そのコードは1バイト左にシフトしてプロセスが終了したことを示します。返りコードが負の場合、プロセスは返りコードの符号を変えた信号により終了します 。 (例えば、サブプロセスが kill された場合、返り値は - signal.SIGKILL となる場合があります。) Windows システムでは、返り値には子プロセスからの符号のついた整数の返りコードを含まれます。

これは、subprocess.Popen を使用して実装されています。サブプロセスを管理し、サブプロセスと通信を行うためのより強力な方法については、クラスのドキュメンテーションを参照してください。

os.posix_spawn(path, argv, env, *, file_actions=None, setpgroup=None, resetids=False, setsid=False, setsigmask=(), setsigdef=(), scheduler=None)

C ライブラリAPIの posix_spawn() をPythonから利用できるようにラップしたものです。

大部分のユーザーは posix_spawn`ではなく、 func:`subprocess.run() を使うべきです。

位置引数 path, args, env は execve() と同じように解釈されます。

path には実行ファイルへのパスを指定します。 path はディレクトリを含む形（実行ファイルへの絶対パスまたは相対パス）で指定する必要があります。実行ファイル名のみを指定したい場合は posix_spawnp() を使ってください。

file_actions 引数はCライブラリ実装の fork() と exec() の間で子プロセスが持つファイルデスクリプタに対して行うアクションを記述するタプルのシーケンスです。各タプルの最初の要素は、残りのタプル要素の解釈方法を指定する以下の3つの型指定子のうちのひとつでなければなりません。

os.POSIX_SPAWN_OPEN

(os.POSIX_SPAWN_OPEN, fd, path, flags, mode)

os.dup2(os.open(path, flags, mode), fd) を実行します。

os.POSIX_SPAWN_CLOSE

(os.POSIX_SPAWN_CLOSE, fd)

os.close(fd) を実行します。

os.POSIX_SPAWN_DUP2

(os.POSIX_SPAWN_DUP2, fd, new_fd)

os.dup2(fd, new_fd) を実行します。

これらのタプルは、 posix_spawn() の準備のために使われるCライブラリの posix_spawn_file_actions_addopen(), posix_spawn_file_actions_addclose(), および posix_spawn_file_actions_adddup2() の3つのAPIコールに対応します。

The setpgroup argument will set the process group of the child to the value specified. If the value specified is 0, the child's process group ID will be made the same as its process ID. If the value of setpgroup is not set, the child will inherit the parent's process group ID. This argument corresponds to the C library POSIX_SPAWN_SETPGROUP flag.

If the resetids argument is True it will reset the effective UID and GID of the child to the real UID and GID of the parent process. If the argument is False, then the child retains the effective UID and GID of the parent. In either case, if the set-user-ID and set-group-ID permission bits are enabled on the executable file, their effect will override the setting of the effective UID and GID. This argument corresponds to the C library POSIX_SPAWN_RESETIDS flag.

If the setsid argument is True, it will create a new session ID for posix_spawn. setsid requires POSIX_SPAWN_SETSID or POSIX_SPAWN_SETSID_NP flag. Otherwise, NotImplementedError is raised.

The setsigmask argument will set the signal mask to the signal set specified. If the parameter is not used, then the child inherits the parent's signal mask. This argument corresponds to the C library POSIX_SPAWN_SETSIGMASK flag.

The sigdef argument will reset the disposition of all signals in the set specified. This argument corresponds to the C library POSIX_SPAWN_SETSIGDEF flag.

The scheduler argument must be a tuple containing the (optional) scheduler policy and an instance of sched_param with the scheduler parameters. A value of None in the place of the scheduler policy indicates that is not being provided. This argument is a combination of the C library POSIX_SPAWN_SETSCHEDPARAM and POSIX_SPAWN_SETSCHEDULER flags.

引数 path, argv, env を指定して 監査イベント os.posix_spawn を送出します。

バージョン 3.8 で追加.

利用可能な環境: Unix。

os.posix_spawnp(path, argv, env, *, file_actions=None, setpgroup=None, resetids=False, setsid=False, setsigmask=(), setsigdef=(), scheduler=None)

Wraps the posix_spawnp() C library API for use from Python.

Similar to posix_spawn() except that the system searches for the executable file in the list of directories specified by the PATH environment variable (in the same way as for execvp(3)).

引数 path, argv, env を指定して 監査イベント os.posix_spawn を送出します。

バージョン 3.8 で追加.

Availability: See posix_spawn() documentation.

os.register_at_fork(*, before=None, after_in_parent=None, after_in_child=None)

Register callables to be executed when a new child process is forked using os.fork() or similar process cloning APIs. The parameters are optional and keyword-only. Each specifies a different call point.

• before is a function called before forking a child process.

• after_in_parent is a function called from the parent process after forking a child process.

• after_in_child is a function called from the child process.

These calls are only made if control is expected to return to the Python interpreter. A typical subprocess launch will not trigger them as the child is not going to re-enter the interpreter.

Functions registered for execution before forking are called in reverse registration order. Functions registered for execution after forking (either in the parent or in the child) are called in registration order.

Note that fork() calls made by third-party C code may not call those functions, unless it explicitly calls PyOS_BeforeFork(), PyOS_AfterFork_Parent() and PyOS_AfterFork_Child().

There is no way to unregister a function.

利用可能な環境: Unix。

バージョン 3.7 で追加.

os.spawnl(mode, path, ...)

os.spawnle(mode, path, ..., env)

os.spawnlp(mode, file, ...)

os.spawnlpe(mode, file, ..., env)

os.spawnv(mode, path, args)

os.spawnve(mode, path, args, env)

os.spawnvp(mode, file, args)

os.spawnvpe(mode, file, args, env)

新たなプロセス内でプログラム path を実行します。

(subprocess モジュールが、新しいプロセスを実行して結果を取得するための、より強力な機能を提供しています。この関数の代わりに subprocess モジュールを利用することが推奨されています。 subprocess モジュールのドキュメントの、 古い関数を subprocess モジュールで置き換える セクションを参照してください )

mode が P_NOWAIT の場合、この関数は新たなプロセスのプロセス ID を返します ; mode が P_WAIT の場合、子プロセスが正常に終了するとその終了コードが返ります。そうでない場合にはプロセスを kill したシグナル signal に対して -signal が返ります。 Windows では、プロセス ID は実際にはプロセスハンドル値になるので、 waitpid() 関数で使えます。

Note on VxWorks, this function doesn't return -signal when the new process is killed. Instead it raises OSError exception.

"l" および "v" のついた spawn* 関数は、コマンドライン引数をどのように渡すかが異なります。 "l" 型は、コードを書くときにパラメタ数が決まっている場合に、おそらくもっとも簡単に利用できます。個々のパラメタは単に spawnl*() 関数の追加パラメタとなります。 "v" 型は、パラメタの数が可変の時に便利で、リストかタプルの引数が args パラメタとして渡されます。どちらの場合も、子プロセスに渡す引数は動作させようとしているコマンドの名前から始まらなければなりません。

末尾近くに "p" をもつ型 (spawnlp(), spawnlpe(), spawnvp(), spawnvpe()) は、プログラム file を探すために環境変数 PATH を利用します。環境変数が ( 次の段で述べる spawn*e 型関数で ) 置き換えられる場合、環境変数は PATH を決定する上の情報源として使われます。その他の型、 spawnl(), spawnle(), spawnv(), および spawnve() では、実行コードを探すために PATH を使いません。 path には適切に設定された絶対パスまたは相対パスが入っていなくてはなりません。

spawnle(), spawnlpe(), spawnve(), および spawnvpe() (すべて末尾に "e" がついています) では、 env 引数は新たなプロセスで利用される環境変数を定義するためのマップ型でなくてはなりません ; spawnl() 、 spawnlp() 、 spawnv() 、および spawnvp() では、すべて新たなプロセスは現在のプロセスの環境を引き継ぎます。 env 辞書のキーと値はすべて文字列である必要があります。不正なキーや値を与えると関数が失敗し、 127 を返します。

例えば、以下の spawnlp() および spawnvpe() 呼び出しは等価です

import os
os.spawnlp(os.P_WAIT, 'cp', 'cp', 'index.html', '/dev/null')

L = ['cp', 'index.html', '/dev/null']
os.spawnvpe(os.P_WAIT, 'cp', L, os.environ)

引数 mode, path, args, env を指定して 監査イベント os.spawn を送出します。

Availability: Unix, Windows. spawnlp(), spawnlpe(), spawnvp() and spawnvpe() are not available on Windows. spawnle() and spawnve() are not thread-safe on Windows; we advise you to use the subprocess module instead.

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

os.P_NOWAIT

os.P_NOWAITO

spawn* 関数ファミリに対する mode パラメタとして取れる値です。この値のいずれかを mode として与えた場合、 spawn*() 関数は新たなプロセスが生成されるとすぐに、プロセスの ID を戻り値として返ります。

Availability: Unix, Windows。

os.P_WAIT

spawn* 関数ファミリに対する mode パラメタとして取れる値です。この値を mode として与えた場合、 spawn*() 関数は新たなプロセスを起動して完了するまで返らず、プロセスがうまく終了した場合には終了コードを、シグナルによってプロセスが kill された場合には -signal を返します。

Availability: Unix, Windows。

os.P_DETACH

os.P_OVERLAY

spawn* 関数ファミリに対する mode パラメタとして取れる値です。これらの値は上の値よりもやや可搬性において劣っています。 P_DETACH は P_NOWAIT に似ていますが、新たなプロセスは呼び出しプロセスのコンソールから切り離され (detach) ます。 P_OVERLAY が使われた場合、現在のプロセスは置き換えられます。したがって spawn* は返りません。

利用可能な環境: Windows 。

os.startfile(path[, operation])

ファイルを関連付けられたアプリケーションを使ってスタートします。

operation が指定されないか、または 'open' である時、この動作は、 Windows の Explorer 上でのファイルをダブルクリックした、あるいはコマンドプロンプト上でファイル名を start コマンドの引数としての実行した場合と等価です : ファイルは拡張子が関連付けされているアプリケーション ( が存在する場合 ) を使って開かれます。

他の operation が与えられる場合、それはファイルに対して何がなされるべきかを表す "command verb" ( コマンドを表す動詞 ) でなければなりません。 Microsoft が文書化している動詞は、 'print' と 'edit' ( ファイルに対して ) および 'explore' と 'find' ( ディレクトリに対して ) です。

startfile() は関連付けされたアプリケーションが起動すると同時に返ります。アプリケーションが閉じるまで待機させるためのオプションはなく、アプリケーションの終了状態を取得する方法もありません。引数 path はカレントディレクトリからの相対パスです。絶対パスで指定したい場合は、最初の文字はスラッシュ ('/') ではないので注意してください。最初の文字がスラッシュの場合、下層の Win32 ShellExecute() 関数は動作しません。 os.path.normpath() 関数を使って、 Win32 用に正しくコード化されたパスになるようにしてください。

インタープリタの起動時のオーバーヘッドを削減するため、この関数が最初に呼ばれるまで、Win32 ShellExecute() 関数は決定されません。関数を決定できない場合、 NotImplementedError が送出されます。

引数 path, operation を指定して 監査イベント os.startfile を送出します。

利用可能な環境: Windows 。

os.system(command)

サブシェル内でコマンド (文字列) を実行します。この関数は標準 C 関数 system() を使って実装されており、system() と同じ制限があります。sys.stdin などに対する変更を行っても、実行されるコマンドの環境には反映されません。command が何らかの出力を生成した場合、インタープリターの標準出力ストリームに送られます。

Unix では、返り値はプロセスの終了ステータスで、 wait() で定義されている書式にコード化されています。 POSIX は system() 関数の返り値の意味について定義していないので、 Python の system() における返り値はシステム依存となることに注意してください。

Windows では、返り値は command を実行した後にシステムシェルから返される値です。シェルは通常 cmd.exe であり、返す値は実行したコマンドの終了ステータスになります。シェルの種類は Windows の環境変数 COMSPEC: に指定されています。ネイティブでないシェルを使用している場合は、そのドキュメントを参照してください。

subprocess モジュールは、新しいプロセスを実行して結果を取得するためのより強力な機能を提供しています。この関数の代わりに subprocess モジュールを利用することが推奨されています。 subprocess モジュールのドキュメントの 古い関数を subprocess モジュールで置き換える 節のレシピを参考にして下さい。

引数 command を指定して 監査イベント os.system を送出します。

Availability: Unix, Windows。

os.times()

現在の全体的なプロセス時間を返します。返り値は 5 個の属性を持つオブジェクトになります:

• user - ユーザー時間

• system - システム時間

• children_user - すべての子プロセスのユーザー時間

• children_system - すべての子プロセスのシステム時間

• elapsed - 去のある固定時点からの経過実時間

後方互換性のため、このオブジェクトは 5 個のアイテム user 、 system 、 children_user 、 children_system 、および elapsed を持つタプルのようにも振る舞います。

See the Unix manual page times(2) and times(3) manual page on Unix or the GetProcessTimes MSDN on Windows. On Windows, only user and system are known; the other attributes are zero.

Availability: Unix, Windows。

バージョン 3.3 で変更: 返り値の型が、タプルから属性名のついたタプルライクオブジェクトに変更されました。

os.wait()

子プロセスの実行完了を待機し、子プロセスの pid と終了コードインジケーター --- 16 ビットの数値で、下位バイトがプロセスを kill したシグナル番号、上位バイトが終了ステータス ( シグナル番号がゼロの場合 ) --- の入ったタプルを返します ; コアダンプファイルが生成された場合、下位バイトの最上桁ビットが立てられます。

利用可能な環境: Unix。

os.waitid(idtype, id, options)

一つ以上のプロセスの完了を待機します。idtype には P_PID、P_PGID、または P_ALL を指定できます。id は待機する pid を指定します。options は WEXITED、WSTOPPED、または WCONTINUED を一つ以上、論理和で指定でき、他に WNOHANG または WNOWAIT も追加できます。返り値は siginfo_t 構造体に含まれるデータ (si_pid、si_uid、si_signo、si_status、および si_code) を表すオブジェクトになります。WNOHANG が指定され、待機状態の子プロセスがない場合は None を返します。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.P_PID

os.P_PGID

os.P_ALL

waitid() の idtype に指定できる値です。これらは id がどう解釈されるかに影響します。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.WEXITED

os.WSTOPPED

os.WNOWAIT

waitid() の options で使用できるフラグです。子プロセスのどのシグナルを待機するかを指定します。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.CLD_EXITED

os.CLD_DUMPED

os.CLD_TRAPPED

os.CLD_CONTINUED

waitid() の返り値の si_code に設定され得る値です。

利用可能な環境: Unix。

バージョン 3.3 で追加.

os.waitpid(pid, options)

この関数の詳細は Unix と Windows で異なります。

Unix の場合 : プロセス id pid で与えられた子プロセスの完了を待機し、子プロセスのプロセス id と (wait() と同様にコード化された ) 終了ステータスインジケーターからなるタプルを返します。この関数の動作は options によって変わります。通常の操作では 0 にします。

pid が 0 よりも大きい場合、 waitpid() は特定のプロセスのステータス情報を要求します。 pid が 0 の場合、現在のプロセスグループ内の任意の子プロセスの状態に対する要求です。 pid が -1 の場合、現在のプロセスの任意の子プロセスに対する要求です。 pid が -1 よりも小さい場合、プロセスグループ -pid ( すなわち pid の絶対値 ) 内の任意のプロセスに対する要求です。

システムコールが -1 を返した時、 OSError を errno と共に送出します。

Windows では、プロセスハンドル pid を指定してプロセスの終了を待って、 pid と、終了ステータスを 8bit 左シフトした値のタプルを返します。 ( シフトは、この関数をクロスプラットフォームで利用しやすくするために行われます ) 0 以下の pid は Windows では特別な意味を持っておらず、例外を発生させます。 options の値は効果がありません。 pid は、子プロセスで無くても、プロセス ID を知っているどんなプロセスでも参照することが可能です。 spawn* 関数を P_NOWAIT と共に呼び出した場合、適切なプロセスハンドルが返されます。

バージョン 3.5 で変更: システムコールが中断されシグナルハンドラが例外を送出しなかった場合、この関数は InterruptedError 例外を送出する代わりにシステムコールを再試行するようになりました (論拠については PEP 475 を参照してください)。

os.wait3(options)

waitpid() に似ていますが、プロセス id を引数に取らず、子プロセス id 、終了ステータスインジケータ、リソース使用情報の 3 要素からなるタプルを返します。リソース使用情報の詳しい情報は resource. getrusage() を参照してください。 オプション引数は waitpid() および wait4() と同じです。

利用可能な環境: Unix。

os.wait4(pid, options)

waitpid() に似ていますが、子プロセス id 、終了ステータスインジケータ、リソース使用情報の 3 要素からなるタプルを返します。リソース使用情報の詳しい情報は resource. getrusage() を参照してください。 wait4() の引数は waitpid() に与えられるものと同じです。

利用可能な環境: Unix。

os.WNOHANG

子プロセス状態がすぐに取得できなかった場合に直ちに終了するようにするための waitpid() のオプションです。この場合、関数は (0, 0) を返します。

利用可能な環境: Unix。

os.WCONTINUED

このオプションによって子プロセスは前回状態が報告された後にジョブ制御による停止状態から実行を再開された場合に報告されるようになります。

利用可能な環境: 一部の Unix システム。

os.WUNTRACED

このオプションによって子プロセスは停止されていながら停止されてから状態が報告されていない場合に報告されるようになります。

利用可能な環境: Unix。

以下の関数は system() 、 wait() 、あるいは waitpid() が返すプロセス状態コードを引数にとります。これらの関数はプロセスの配置を決めるために利用できます。

os.WCOREDUMP(status)

プロセスに対してコアダンプが生成されていた場合には True を、それ以外の場合は False を返します。

この関数は WIFSIGNALED() が真である場合のみ使用されるべきです。

利用可能な環境: Unix。

os.WIFCONTINUED(status)

停止していた子プロセスが SIGCONT シグナルの送信によって再開された場合 (ジョブ制御の停止から親プロセスの実行が継続している場合) True を返します。そうでない場合は False を返します。

WCONTINUED オプションを参照してください。

利用可能な環境: Unix。

os.WIFSTOPPED(status)

プロセスがシグナルの送信によって中断させられた場合に True を返します。それ以外の場合は False を返します。

WIFSTOPPED() は waitpid() が WUNTRACED オプションを使って実行されたか、もしくはプロセスがトレースされている場合 (ptrace(2) を参照してください) にのみ True を返します。

利用可能な環境: Unix。

os.WIFSIGNALED(status)

プロセスがシグナルによって終了させられた場合に True を返します。そうでない場合は False を返します。

利用可能な環境: Unix。

os.WIFEXITED(status)

プロセスが正常終了した場合、すなわち exit() や _exit() を呼び出したか、もしくは main() から戻ることにより終了した場合に True を返します。それ以外は False を返します。

利用可能な環境: Unix。

os.WEXITSTATUS(status)

プロセスの終了ステータスを返します。

この関数は WIFEXITED() が真である場合のみ使用されるべきです。

利用可能な環境: Unix。

os.WSTOPSIG(status)

プロセスを停止させたシグナル番号を返します。

この関数は WIFSTOPPED() が真である場合のみ使用されるべきです。

利用可能な環境: Unix。

os.WTERMSIG(status)

プロセスを終了させたシグナルの番号を返します。

この関数は WIFSIGNALED() が真である場合のみ使用されるべきです。

利用可能な環境: Unix。

スケジューラーへのインターフェイス

以下の関数は、オペレーティングシステムがプロセスに CPU 時間を割り当てる方法を制御します。これらは一部の Unix プラットフォームでのみ利用可能です。詳しくは Unix マニュアルページを参照してください。

バージョン 3.3 で追加.

次のスケジューリングポリシーは、オペレーティングシステムでサポートされていれば公開されます。

os.SCHED_OTHER

デフォルトのスケジューリングポリシーです。

os.SCHED_BATCH

常にCPUに負荷のかかる (CPU-intensive) プロセス用のポリシーです。他の対話式プロセスなどの応答性を維持するよう試みます。

os.SCHED_IDLE

非常に優先度の低いバックグラウンドタスク用のスケジューリングポリシーです。

os.SCHED_SPORADIC

散発的なサーバープログラム用のスケジューリングポリシーです。

os.SCHED_FIFO

FIFO (First In, First Out) 型のスケジューリングポリシーです。

os.SCHED_RR

ラウンドロビン型のスケジューリングポリシーです。

os.SCHED_RESET_ON_FORK

このフラグは他のスケジューリングポリシーとともに論理和指定できます。このフラグが与えられたプロセスが fork されると、その子プロセスのスケジューリングポリシーおよび優先度はデフォルトにリセットされます。

class os.sched_param(sched_priority)

このクラスは、sched_setparam()、sched_setscheduler()、および sched_getparam() で使用される、調節可能なスケジューリングパラメーターを表します。これはイミュータブルです。

現在、一つの引数のみ指定できます:

sched_priority

スケジューリングポリシーのスケジューリング優先度です。

os.sched_get_priority_min(policy)

policy の最小優先度値を取得します。policy には上記のスケジューリングポリシー定数の一つを指定します。

os.sched_get_priority_max(policy)

policy の最大優先度値を取得します。policy には上記のスケジューリングポリシー定数の一つを指定します。

os.sched_setscheduler(pid, policy, param)

PID pid のプロセスのスケジューリングポリシーを設定します。pid が 0 の場合、呼び出しプロセスを意味します。policy には上記のスケジューリングポリシー定数の一つを指定します。param は sched_param のインスタンスです。

os.sched_getscheduler(pid)

PID pid のプロセスのスケジューリングポリシーを返します。pid が 0 の場合、呼び出しプロセスを意味します。返り値は上記のスケジューリングポリシー定数の一つになります。

os.sched_setparam(pid, param)

PID pid のプロセスのスケジュールパラメーターを設定します。pid が 0 の場合、呼び出しプロセスを意味します。param は sched_param のインスタンスです。

os.sched_getparam(pid)

PID pid のプロセスのスケジューリングパラメーターを sched_param のインスタンスとして返します。pid が 0 の場合、呼び出しプロセスを意味します。

os.sched_rr_get_interval(pid)

PID pid のプロセスのラウンドロビンクォンタム (秒) を返します。pid が 0 の場合、呼び出しプロセスを意味します。

os.sched_yield()

自発的に CPU を解放します。

os.sched_setaffinity(pid, mask)

PID pid のプロセス (0 であれば現在のプロセス) を CPU の集合に制限します。mask はプロセスを制限する CPU の集合を表す整数のイテラブルなオブジェクトです。

os.sched_getaffinity(pid)

PID pid のプロセス (0 の場合、現在のプロセス) が制限されている CPU の集合を返します。

雑多なシステム情報

os.confstr(name)

システム設定値を文字列で返します。 name には取得したい設定名を指定します ; この値は定義済みのシステム値名を表す文字列にすることができます ; 名前は多くの標準 (POSIX.1 、 Unix 95 、 Unix 98 その他 ) で定義されています。ホストオペレーティングシステムの関知する名前は confstr_names 辞書のキーとして与えられています。このマップ型オブジェクトに入っていない設定変数については、 name に整数を渡してもかまいません。

name に指定された設定値が定義されていない場合、 None を返します。

name が文字列で、かつ不明の場合、 ValueError を送出します。 name の指定値がホストシステムでサポートされておらず、 confstr_names にも入っていない場合、 errno.EINVAL をエラー番号として OSError を送出します。

利用可能な環境: Unix。

os.confstr_names

confstr() が受理する名前を、ホストオペレーティングシステムで定義されている整数値に対応付けている辞書です。この辞書はシステムでどの設定名が定義されているかを決定するために利用できます。

利用可能な環境: Unix。

os.cpu_count()

システムの CPU 数を返します。未定の場合は None を返します。

この数は現在のプロセスが使える CPU 数と同じものではありません。 使用可能な CPU 数は len(os.sched_getaffinity(0)) で取得できます。

バージョン 3.4 で追加.

os.getloadavg()

過去 1 分、 5 分、および 15 分間の、システムの実行キューの平均プロセス数を返します。平均負荷が得られない場合には OSError を送出します。

利用可能な環境: Unix。

os.sysconf(name)

整数値のシステム設定値を返します。 name で指定された設定値が定義されていない場合、 -1 が返されます。 name に関するコメントとしては、 confstr() で述べた内容が同様に当てはまります ; 既知の設定名についての情報を与える辞書は sysconf_names で与えられています。

利用可能な環境: Unix。

os.sysconf_names

sysconf() が受理する名前を、ホストオペレーティングシステムで定義されている整数値に対応付けている辞書です。この辞書はシステムでどの設定名が定義されているかを決定するために利用できます。

利用可能な環境: Unix。

以下のデータ値はパス名編集操作をサポートするために利用されます。これらの値はすべてのプラットフォームで定義されています。

パス名に対する高水準の操作は os.path モジュールで定義されています。

os.curdir

現在のディレクトリ参照するためにオペレーティングシステムで使われる文字列定数です。 POSIX と Windows では '.' になります。 os.path からも利用できます。

os.pardir

親ディレクトリを参照するためにオペレーティングシステムで使われる文字列定数です。 POSIX と Windows では '..' になります。 os.path からも利用できます。

os.sep

パス名を要素に分割するためにオペレーティングシステムで利用されている文字です。例えば POSIX では '/' で、 Windows では '\\' です。しかし、このことを知っているだけではパス名を解析したり、パス名同士を結合したりするには不十分です --- こうした操作には os.path.split() や os.path.join() を使用してください --- が、たまに便利なこともあります。 os.path からも利用できます。

os.altsep

文字パス名を要素に分割する際にオペレーティングシステムで利用されるもう一つの文字で、分割文字が一つしかない場合には None になります。この値は sep がバックスラッシュとなっている DOS や Windows システムでは '/' に設定されています。 os.path からも利用できます。

os.extsep

ベースのファイル名と拡張子を分ける文字です。例えば、 os.py であれば '.' です。 os.path からも利用できます。

os.pathsep

(PATH のような ) サーチパス内の要素を分割するためにオペレーティングシステムが慣習的に用いる文字で、 POSIX における ':' や DOS および Windows における ';' に相当します。 os.path からも利用できます。

os.defpath

exec*p* や spawn*p* において、環境変数辞書内に 'PATH' キーがない場合に使われる標準設定のサーチパスです。 os.path からも利用できます。

os.linesep

現在のプラットフォーム上で行を分割 ( あるいは終端 ) するために用いられている文字列です。この値は例えば POSIX での '\n' や Mac OS での '\r' のように、単一の文字にもなりますし、例えば Windows での '\r\n' のように複数の文字列にもなります。テキストモードで開いたファイルに書き込む時には、 os.linesep を利用しないでください。すべてのプラットフォームで、単一の '\n' を使用してください。

os.devnull

ヌルデバイスのファイルパスです。例えば POSIX では '/dev/null' で、 Windows では 'nul' です。この値は os.path からも利用できます。

os.RTLD_LAZY

os.RTLD_NOW

os.RTLD_GLOBAL

os.RTLD_LOCAL

os.RTLD_NODELETE

os.RTLD_NOLOAD

os.RTLD_DEEPBIND

setdlopenflags() 関数と getdlopenflags() 関数と一緒に使用するフラグ。それぞれのフラグの意味については、Unix マニュアルの dlopen(3) ページを参照してください。

バージョン 3.3 で追加.

乱数

os.getrandom(size, flags=0)

最大で size バイトからなるランダムなバイト列を返します。この関数は要求されたバイト数よりも少ないバイト数を返すことがあります。

バイト列は、ユーザー空間の乱数生成器や暗号目的ののシードとして利用できます。

getrandom() はデバイスドライバや他の環境ノイズ源から収集されたエントロピーに頼っています。不必要な大量のデータの読出しは、/dev/random と /dev/urandom デバイスの他のユーザーに負の影響を与えるでしょう。

flags 引数には、次に示す値の0個以上の論理和で与えられるビットマスクを指定できます: os.GRND_RANDOM および GRND_NONBLOCK。

Linux getrandom() manual page も参照してください。

利用可能な環境: Linux 3.17以上。

バージョン 3.6 で追加.

os.urandom(size)

暗号に関する用途に適した size バイトからなるランダムな文字列を返します。

この関数は OS 固有の乱数発生源からランダムなバイト列を生成して返します。この関数の返すデータは暗号を用いたアプリケーションで十分利用できる程度に予測不能ですが、実際のクオリティは OS の実装によって異なります。

Linux では、 getrandom() システムコールが利用可能ならブロッキングモードで呼び出されます: すなわちシステムの urandom エントロピープールが初期化されるまで (128 ビットのエントロピーがカーネルにより収集されるまで) 処理がブロックされます。論拠については PEP 524 を参照してください。 Linux では、 (GRND_NONBLOCK フラグを使って) 非ブロッキングモードでランダムなバイトを取得したり、システムの urandom エントロピープールが初期化されるまでポーリングするために getrandom() 関数を利用することができます。

Unix ライクなシステムでは、ランダムなバイトは /dev/urandom デバイスから読み込みます。 /dev/urandom デバイスが利用できないか、もしくは読み取り不可のときは、 NotImplementedError 例外が送出されます。

Windowsで、 CryptGenRandom() を使用します。

参考

secrets モジュールは高レベルの乱数生成機能を提供します。プラットフォームが提供する乱数生成器に対する簡便なインターフェースについては、 random.SystemRandom を参照してください。

バージョン 3.6.0 で変更: Linuxで、 セキュリティを高めるために、getrandom() をブロッキングモードで使用するようになりました。

バージョン 3.5.2 で変更: Linux において、 getrandom() システムコールがブロックするなら (urandom エントロピープールが初期化されていなければ) 、 /dev/urandom を読む方法にフォールバックします。

バージョン 3.5 で変更: Linux 3.17 以降では、使用可能な場合に getrandom() システムコールが使用されるようになりました。OpenBSD 5.6 以降では、C getentropy() 関数が使用されるようになりました。これらの関数は、内部ファイル記述子を使用しません。

os.GRND_NONBLOCK

デフォルトでは、getrandom() は ``/dev/random``から読み込んだときにランダムなバイトが存在しない場合や、 ``/dev/urandom``から読み込んだときにエントロピープールが初期化されていない場合に処理をブロックします。

GRND_NONBLOCK フラグがセットされると、 getrandom() はこれらの場合に処理をブロックせず、ただちに BlockingIOError 例外を送出します。

バージョン 3.6 で追加.

os.GRND_RANDOM

このビットがセットされた場合、 ランダムバイトは /dev/urandom プールの代わりに /dev/random プールから取り出されます。

バージョン 3.6 で追加.