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

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

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

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

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

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

  • 「利用できる環境: Unix」の意味はこの関数が Unix システムにあることが多いということです。このことは特定の OS における存在を主張するものではありません。

  • 特に記述がない場合、「利用できる環境: Unix」と書かれている関数は、Unix をコアにしている Mac OS X でも利用することができます。

注釈

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

exception os.error

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

os.name

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

参考

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

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

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

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

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

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

16.1.2. プロセスのパラメーター

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

os.ctermid()

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

利用できる環境: Unix。

os.environ

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

このマップ型の内容は、os モジュールの最初の import の時点、通常は Python の起動時に site.py が処理される中で取り込まれます。それ以後に変更された環境変数は 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 のバイト列版: 環境変数をバイト文字列で表す マップ型 オブジェクトです。environenvironb は同期されます。(environb を変更すると environ が、逆の場合も同様に更新されます)。

environbsupports_bytes_environ が True の場合のみ利用可能です。

バージョン 3.2 で追加.

os.chdir(path)
os.fchdir(fd)
os.getcwd()

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

os.fsencode(filename)

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

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

バージョン 3.2 で追加.

os.fsdecode(filename)

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

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

バージョン 3.2 で追加.

os.getenv(key, default=None)

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

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

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

os.getenvb(key, default=None)

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

利用できる環境: 主な 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 の Deployment Target が 10.5 以前でビルドされている場合、getgroups() は現在のユーザープロセスに関連付けられている実効グループ id を返します; このリストはシステムで定義されたエントリ数 (通常は16) に制限され、適切な特権があれば setgroups() の呼び出しによって変更される場合があります。Deployment Target が 10.5 より新しい場合、getgroups() はプロセスの実効ユーザー id に関連付けられたユーザーの現在のグループアクセスリストを返します; グループアクセスリストはプロセスのライフタイムで変更される可能性があり、setgroups() の呼び出しの影響を受けず、長さ 16 の制限を受けません。Deployment Target の値 MACOSX_DEPLOYMENT_TARGET は、sysconfig.get_config_var() で取得することができます。

os.getlogin()

プロセスの制御端末にログインしているユーザー名を返します。ほとんどの場合、ユーザーが誰かを知りたい時には環境変数 LOGNAMEUSERNAME を、現在の実効ユーザー id のユーザー名を知りたい時は pwd.getpwuid(os.getuid())[0] を使う方が便利です。

利用できる環境: Unix、 Windows。

os.getpgid(pid)

プロセス id pid のプロセスのプロセスグループ id を返します。もし pid が 0 ならば、現在のプロセスのプロセスグループ id を返します。

利用できる環境: Unix。

os.getpgrp()

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

利用できる環境: Unix。

os.getpid()

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

利用できる環境: Unix、 Windows。

os.getppid()

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

利用できる環境: Unix、 Windows。

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

os.getpriority(which, who)

プログラムのスケジューリング優先度を取得します。which の値は PRIO_PROCESSPRIO_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 のアイテムに代入する方が望ましい操作です。

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)

プロセス id pid のプロセスのプロセスグループ id を pgrp に設定します。この動作に関しては Unix のマニュアルを参照してください。

利用できる環境: Unix。

os.setpriority(which, who, priority)

プログラムのスケジューリング優先度を設定します。whichPRIO_PROCESSPRIO_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 が送出されます。

利用できる環境: Unix、 Windows。

os.supports_bytes_environ

True if the native OS type of the environment is bytes (eg. False on Windows).

バージョン 3.2 で追加.

os.umask(mask)

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

利用できる環境: Unix、 Windows。

os.uname()

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

  • sysname - OS の名前

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

  • release - OS のリリース

  • version - OS のバージョン

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

後方互換性のため、このオブジェクトはイテラブルでもあり、sysnamenodenamereleaseversion、および 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 のアイテムを削除する方が望ましい操作です。

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

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

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

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

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

16.1.4. ファイル記述子の操作

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

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

The fileno() method can be used to obtain the file descriptor associated with a file object when required. Note that using the file descriptor directly will bypass the file object methods, ignoring aspects such as internal buffering of data.

os.close(fd)

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

利用できる環境: Unix、 Windows。

注釈

This function is intended for low-level I/O and must be applied to a file descriptor as returned by os.open() or pipe(). To close a “file object” returned by the built-in function open() or by popen() or fdopen(), use its close() method.

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

利用できる環境: Unix、 Windows。

os.device_encoding(fd)

fd に関連付けられたデバイスが端末だった場合に、そのエンコーディングを表す文字列を返します。端末でなければ None を返します。

os.dup(fd)

ファイル記述子 fd の複製を返します。

利用できる環境: Unix、 Windows。

os.dup2(fd, fd2)

ファイル記述子を fd から fd2 に複製し、必要なら後者の記述子を前もって閉じておきます。

利用できる環境: Unix、 Windows。

os.fchmod(fd, mode)

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

利用できる環境: Unix。

os.fchown(fd, uid, gid)

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

利用できる環境: Unix。

os.fdatasync(fd)

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

利用できる環境: Unix。

注釈

この機能は Mac OS X では利用できません。

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)

stat() と同様に、ファイル記述子 fd の状態を返します。Python 3.3 では、これは os.stat(fd) と等価です。

利用できる環境: Unix、 Windows。

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()) を実行してください。

利用できる環境: Unix、 Windows。

os.ftruncate(fd, length)

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

利用できる環境: Unix。

os.isatty(fd)

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

os.lockf(fd, cmd, len)

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

利用できる環境: Unix。

バージョン 3.3 で追加.

os.F_LOCK
os.F_TLOCK
os.F_ULOCK
os.F_TEST

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

利用できる環境: Unix。

バージョン 3.3 で追加.

os.lseek(fd, pos, how)

Set the current position of file descriptor fd to position pos, modified by how: SEEK_SET or 0 to set the position relative to the beginning of the file; SEEK_CUR or 1 to set it relative to the current position; SEEK_END or 2 to set it relative to the end of the file. Return the new cursor position in bytes, starting from the beginning.

利用できる環境: Unix、 Windows。

os.SEEK_SET
os.SEEK_CUR
os.SEEK_END

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

利用できる環境: Unix、 Windows。

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

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

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

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

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

利用できる環境: Unix、 Windows。

注釈

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

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

os.openpty()

新しい擬似端末のペアを開きます。ファイル記述子のペア (master, slave) を返し、それぞれ pty および tty を表します。(少しだけ) より可搬性のあるアプローチとしては、pty モジュールを使用してください。

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

os.pipe()

パイプを作成します。ファイル記述子のペア (r, w) を返し、それぞれ読み込み、書き出し用に使うことができます。

利用できる環境: Unix、 Windows。

os.pipe2(flags)

flags をアトミックに設定したパイプを作成します。flags には値 O_NONBLOCKO_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)

データへアクセスする意思を、パターンを指定して宣言します。これによりカーネルが最適化を行えるようになります。advicefd で指定されたファイルに対し、開始位置 offset から len バイト分の領域に適用されます。advice には POSIX_FADV_NORMALPOSIX_FADV_SEQUENTIALPOSIX_FADV_RANDOMPOSIX_FADV_NOREUSEPOSIX_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, buffersize, offset)

ファイル記述子 fd に対し、位置 offset から読み込みます。読み込み量は最大で buffersize バイトです。ファイルオフセットは変化しません。

利用できる環境: Unix。

バージョン 3.3 で追加.

os.pwrite(fd, string, offset)

ファイル記述子 fd に対し、位置 offset から string を書き出します。ファイルオフセットは変化しません。

利用できる環境: Unix。

バージョン 3.3 で追加.

os.read(fd, n)

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

利用できる環境: Unix、 Windows。

注釈

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

os.sendfile(out, in, offset, nbytes)
os.sendfile(out, in, offset, nbytes, headers=None, trailers=None, flags=0)

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

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

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

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

Mac OS X と FreeBSD では、nbytes に 0 を指定すると、in の最後まで送信します。

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

利用できる環境: Unix。

バージョン 3.3 で追加.

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. readv() will 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. readv() returns the total number of bytes read (which may be less than the total capacity of all the objects).

利用できる環境: Unix。

バージョン 3.3 で追加.

os.tcgetpgrp(fd)

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

利用できる環境: Unix。

os.tcsetpgrp(fd, pg)

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

利用できる環境: Unix。

os.ttyname(fd)

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

利用できる環境: Unix。

os.write(fd, str)

str のバイト列をファイル記述子 fd に書き出します。実際に書き出されたバイト数が返されます。

利用できる環境: Unix、 Windows。

注釈

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

os.writev(fd, buffers)

Write the contents of buffers to file descriptor fd. buffers must be a sequence of bytes-like objects. writev() writes the contents of each object to the file descriptor and returns the total number of bytes written.

利用できる環境: Unix。

バージョン 3.3 で追加.

16.1.4.1. open() フラグ定数

以下の定数は 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_SHLOCK
os.O_EXLOCK
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

これらの定数は GNU 拡張で、Cライブラリで定義されていない場合は利用できません。

os.RTLD_LAZY
os.RTLD_NOW
os.RTLD_GLOBAL
os.RTLD_LOCAL
os.RTLD_NODELETE
os.RTLD_NOLOAD
os.RTLD_DEEPBIND

dlopen(3) の Unix マニュアルページを参照してください。

バージョン 3.3 で追加.

16.1.4.2. 端末のサイズの問い合わせ

バージョン 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 は低レベルの実装です。

利用できる環境: Unix、 Windows。

class os.terminal_size

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

columns

端末ウィンドウの横幅 (文字数) です。

lines

端末ウィンドウの高さ (文字数) です。

16.1.5. ファイルとディレクトリ

一部の Unix プラットフォームでは、これらの関数の多くが以下の機能を一つ以上サポートしています:

  • ファイル記述子の指定: 一部の関数では、path 引数はパス名を示す文字列だけでなく、ファイル記述子でも指定できます。関数はファイル記述子が参照するファイルを操作します。(POSIX システムでは、Python は関数の f... バージョンを呼び出します)

    そのプラットフォーム上で path にファイル記述子を使用できるかどうかは、os.supports_fd で確認できます。使用できない場合 NotImplementedError が送出されます。

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

  • ディレクトリ記述子への相対パス: dir_fdNone ではない場合、そのファイル記述子はディレクトリを参照しているはずであり、操作するパスは相対パスであるべきです; パスはそのディレクトリへの相対パスになります。パスが絶対パスであった場合、dir_fd は無視されます。(POSIX システムでは、Python は関数の ...at または f...at バージョンを呼び出します)

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

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

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

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

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

利用できる環境: Unix、 Windows。

注釈

ユーザーが、例えばファイルを開く権限を持っているかどうかを調べるために実際に 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_fdeffective_ids、および follow_symlinks が追加されました。

os.F_OK
os.R_OK
os.W_OK
os.X_OK

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

os.chdir(path)

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

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

利用できる環境: Unix、 Windows。

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

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

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

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

利用できる環境: Unix。

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

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

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

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

利用できる環境: Unix、 Windows。

注釈

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

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

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

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

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

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

利用できる環境: Unix。

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

os.chroot(path)

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

利用できる環境: Unix。

os.fchdir(fd)

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

利用できる環境: Unix。

os.getcwd()

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

利用できる環境: Unix、 Windows。

os.getcwdb()

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

利用できる環境: Unix、 Windows。

os.lchflags(path, flags)

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

利用できる環境: Unix。

os.lchmod(path, mode)

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

利用できる環境: Unix。

os.lchown(path, uid, gid)

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

利用できる環境: Unix。

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

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

利用できる環境: Unix、 Windows。

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

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

os.listdir(path='.')

path で指定されたディレクトリ内のエントリ名が入ったリストを返します。リスト内の順番は不定です。特殊エントリ '.' および '..' は、それらがディレクトリ内に存在してもリストには含められません。

path文字列型バイト列型 のどちらでもかまいません。pathバイト列型 の場合、ファイル名も バイト列型 で返されます; その他の場合はすべて 文字列型 になります。

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

注釈

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

利用できる環境: Unix、 Windows。

バージョン 3.2 で変更: パラメーター path の指定は任意になりました。

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

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

与えられたパスに対して lstat() システムコールと同じ処理を行います。stat() と似ていますが、シンボリックリンクをたどりません。シンボリックリンクをサポートしていないプラットフォームでは stat() の別名です。Python 3.3 では、os.stat(path, dir_fd=dir_fd, follow_symlinks=False) と等価です。

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

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

バージョン 3.3 で変更: パラメーター dir_fd を追加しました。

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

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

一部のシステムでは mode は無視されます。使用される場合は、先に現在の umask 値でマスクされます。ディレクトリがすでに存在する場合は OSError が送出されます。

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

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

利用できる環境: Unix、 Windows。

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

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

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

mode のデフォルトは 0o777 (8進数) です。一部のシステムでは mode は無視されます。これが使用される場合は、先に現在の umask 値でマスクされます。

If exist_ok is False (the default), an OSError is raised if the target directory already exists.

注釈

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

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

バージョン 3.2 で追加: パラメーター exist_ok が追加されました。

バージョン 3.3.6 で変更: Before Python 3.3.6, if exist_ok was True and the directory existed, makedirs() would still raise an error if mode did not match the mode of the existing directory. Since this behavior was impossible to implement safely, it was removed in Python 3.3.6. See issue 21082.

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

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

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

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

利用できる環境: Unix。

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

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

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

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

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

os.major(device)

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

os.minor(device)

RAW デバイス番号から、デバイスのマイナー番号を取り出します (通常 statst_devst_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。

os.pathconf_names

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

利用できる環境: Unix。

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

path が文字列オブジェクトだった場合、返り値も文字列オブジェクトになり、UnicodeDecodeError が呼び出される場合があります。path がバイト列オブジェクトだった場合、返り値はバイト列オブジェクトになります。

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

利用できる環境: Unix, Windows

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

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

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

ファイル path を削除します。 path がディレクトリの場合、OSError が送出されます; ディレクトリの削除には rmdir() を使用してください。

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

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

この関数は unlink() と同一です。

利用できる環境: Unix、 Windows。

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

os.removedirs(path)

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

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

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

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

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

利用できる環境: Unix、 Windows。

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

os.renames(old, new)

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

注釈

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

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

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

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

利用できる環境: Unix、 Windows。

バージョン 3.3 で追加.

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

ディレクトリ path を削除します。ディレクトリが空の場合にだけ正常に動作します。そうでなければ OSError が送出されます。ディレクトリツリー全体を削除するには shutil.rmtree() を使います。

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

利用できる環境: Unix、 Windows。

バージョン 3.3 で追加: パラメーター dir_fd が追加されました。

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

与えられたパスに対して stat() システムコールと同じ処理を行います。path には文字列かオープンしているファイル記述子のいずれかを指定できます。(この関数は通常シンボリックリンクをたどります; シンボリックリンクに対して stat したい場合は引数に follow_symlinks=False を追加するか、lstat() を使用してください)

返り値はオブジェクトになり、その属性はおおむね stat 構造体のメンバーに対応します:

  • st_mode - 保護ビット

  • st_ino - inode 番号

  • st_dev - デバイス

  • st_nlink - ハードリンクの数

  • st_uid - 所有者のユーザー id

  • st_gid - 所有者のグループ id

  • st_size - ファイルのサイズ (単位: バイト)

  • st_atime - 最終アクセス時刻 (単位: 秒)

  • st_mtime - 最終修正時刻 (単位: 秒)

  • st_ctime - プラットフォーム依存; Unix では最終属性修正時刻、Windows では作成時刻 (単位: 秒)

  • st_atime_ns - 最終アクセス時刻 (単位: ナノ秒 [整数])

  • st_mtime_ns - 最終修正時刻 (単位: ナノ秒 [整数])

  • st_ctime_ns - プラットフォーム依存; Unix では最終属性修正時刻、Windows では作成時刻 (単位: ナノ秒 [整数])

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

  • st_blocks - number of 512-byte blocks allocated for file
  • st_blksize - filesystem blocksize for efficient file system I/O
  • st_rdev - i ノードデバイスの場合、デバイスのタイプ

  • st_flags - ファイルに対するユーザー定義のフラグ

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

  • st_gen - ファイル生成番号

  • st_birthtime - ファイル作成時刻

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

  • st_rsize
  • st_creator
  • st_type

注釈

st_atimest_mtime、および st_ctime 属性の厳密な意味や精度はオペレーティングシステムやファイルシステムによって変わります。例えば、FAT や FAT32 ファイルシステムを使用している Windows システムでは、st_mtime の精度は 2 秒であり、st_atime の精度は 1 日に過ぎません。詳しくはお使いのオペレーティングシステムのドキュメントを参照してください。同じように、st_atime_nsst_mtime_ns、および st_ctime_ns は常にナノ秒で表されますが、多くのシステムではナノ秒単位の精度では提供していません。ナノ秒単位の精度を提供するシステムであっても、st_atimest_mtime、および st_ctime についてはそれらが格納される浮動小数点オブジェクトがそのすべてを保持できず、それ自体が少々不正確です。正確なタイムスタンプが必要な場合は、st_atime_nsst_mtime_ns、および st_ctime_ns を使用するべきです。

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

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

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

例:

>>> import os
>>> statinfo = os.stat('somefile.txt')
>>> statinfo
posix.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

利用できる環境: Unix、 Windows。

バージョン 3.3 で追加: 引数 dir_fdfollow_symlinks、パスの代わりにファイル記述子の指定、およびメンバー st_atime_nsst_mtime_ns、および st_ctime_ns が追加されました。

os.stat_float_times([newvalue])

stat_result がタイムスタンプに浮動小数点オブジェクトを使うかどうかを決定します。newvalueTrue の場合、以後の stat() 呼び出しは浮動小数点を返し、False の場合には以後整数を返します。newvalue が省略された場合、現在の設定どおりの返り値になります。

古いバージョンの Python と互換性を保つため、stat_result にタプルとしてアクセスすると、常に整数が返されます。

Python は現在デフォルトで浮動小数点値を返します。タイムスタンプが浮動小数点では正常に動作しないアプリケーションは、この関数で古い挙動を利用できます。

タイムスタンプの精度 (すなわち最小の小数部分) はシステム依存です。システムによっては秒単位の精度しかサポートしません。そういったシステムでは小数部分は常に 0 です。

この設定の変更は、プログラムの起動時に、__main__ モジュールの中でのみ行うことを推奨します。ライブラリは決してこの設定を変更すべきではありません。浮動小数点型のタイムスタンプを処理すると不正確な動作をするようなライブラリを使う場合、ライブラリが修正されるまで、その機能を停止させておくべきです。

バージョン 3.3 で撤廃.

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

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

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

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

利用できる環境: Unix。

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

os.supports_dir_fd

A Set object indicating which functions in the os module permit use of their dir_fd parameter. Different platforms provide different functionality, and an option that might work on one might be unsupported on another. For consistency’s sakes, functions that support dir_fd always allow specifying the parameter, but will raise an exception if the functionality is not actually available.

特定の関数が dir_fd パラメーターの使用を許可しているかどうか確認するには、supports_dir_fdin 演算子で比較します。例えば、以下の式では os.stat()dir_fd パラメーターがローカルシステム上で利用できるかどうか確認できます:

os.stat in os.supports_dir_fd

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

バージョン 3.3 で追加.

os.supports_effective_ids

A Set object indicating which functions in the os module permit use of the effective_ids parameter for os.access(). If the local platform supports it, the collection will contain os.access(), otherwise it will be empty.

os.access()effective_ids パラメーターが使用できるかどうか確認するには、以下のように supports_dir_fdin 演算子で比較します:

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. Different platforms provide different functionality, and an option that might work on one might be unsupported on another. For consistency’s sakes, functions that support fd always allow specifying the parameter, but will raise an exception if the functionality is not actually available.

特定の関数が path パラメーターにオープンしているファイル記述子の指定を許可しているかどうか確認するには、supports_fdin 演算子で比較します。例えば、以下の式では os.chdir() がローカルプラットフォーム上で呼び出された時にオープンしているファイル記述子を受け付けるかどうか確認できます:

os.chdir in os.supports_fd

バージョン 3.3 で追加.

A Set object indicating which functions in the os module permit use of their follow_symlinks parameter. Different platforms provide different functionality, and an option that might work on one might be unsupported on another. For consistency’s sakes, functions that support follow_symlinks always allow specifying the parameter, but will raise an exception if the functionality is not actually available.

特定の関数が follow_symlinks をサポートしているかどうか確認するには、supports_follow_symlinksin 演算子で比較します。例えば、以下の式では os.stat() がローカルシステム上で follow_symlinks パラメーターを利用できるかどうか確認できます:

os.stat in os.supports_follow_symlinks

バージョン 3.3 で追加.

source を指すシンボリックリンク link_name を作成します。

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

シンボリックリンクのサポートは Windows 6.0 (Vista) から導入されました。Windows がそれより古い場合 symlink()NotImplementedError を送出します。

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

注釈

Windowsでは、シンボリックリンクを作成するには特権 SeCreateSymbolicLinkPrivilege が必要です。この特権は通常一般ユーザーには与えられていませんが、管理者レベルに特権をエスカレートしたアカウントで利用できます。この特権を取得するか、アプリケーションを管理者として実行すると、シンボリックリンクを作成することができます。

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

利用できる環境: Unix、 Windows。

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

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

os.sync()

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

利用できる環境: Unix。

バージョン 3.3 で追加.

os.truncate(path, length)

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

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

利用できる環境: Unix。

バージョン 3.3 で追加.

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

利用できる環境: Unix、 Windows。

バージョン 3.3 で追加: パラメーター dir_fd が追加されました。

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

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

utime() は 2 つのオプションパラメーター timesns をとり、これらは path に設定する時刻を指定し、以下のように使用されます:

  • nsNone ではない場合、(atime_ns, mtime_ns) の形式で各メンバーは単位をナノ秒で表す整数値のタプルを指定しなくてはなりません。

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

  • If times and ns are both None, this is equivalent to specifying ns=(atime_ns, mtime_ns) where both times are the current time.

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

path にディレクトリを指定できるかどうかは、オペレーティングシステムがディレクトリをファイルとして実装しているかどうかによります (例えば Windows はそうではありません)。ここで設定した時刻が、後に stat() の呼び出し時正確に返されない場合があります。これはオペレーティングシステムが記録するアクセスおよび修正時刻の精度に依存しています; stat() を参照してください。正確な時刻を保持する最善の方法は、utimens パラメーターを指定し、os.stat() の返り値オブジェクトから st_atime_ns および st_mtime_ns フィールドを使用することです。

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

利用できる環境: Unix、 Windows。

バージョン 3.3 で追加: path にオープンしているファイル記述子の指定がサポートされ、パラメーター dir_fdfollow_symlinks、および ns が追加されました。

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

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

dirpath は文字列で、ディレクトリへのパスです。dirnamesdirpath 内のサブディレクトリ名のリスト ('.''..' は除く)です。filenamesdirpath 内の非ディレクトリ・ファイル名のリストです。このリスト内の名前にはファイル名までのパスが含まれません。dirpath 内のファイルやディレクトリへの (top からたどった) フルパスを得るには、os.path.join(dirpath, name) を使用してください。

オプション引数 topdownTrue であるか、指定されなかった場合、top ディレクトリのタプルを生成した後で、各サブディレクトリのタプルを生成します (ディレクトリはトップダウンで生成)。topdownFalse の場合、top ディレクトリのタプルは、そのディレクトリ以下のすべてのサブディレクトリのタプル (ボトムアップで生成) の後に生成されます。

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

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

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

注釈

followlinksTrue を指定すると、シンボリックリンクが親ディレクトリを指していた場合に、無限ループになることに注意してください。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

次の例では、ツリーをボトムアップで走査することが不可欠になります; 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))
os.fwalk(top='.', topdown=True, onerror=None, *, follow_symlinks=False, dir_fd=None)

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

dirpathdirnames、および filenameswalk() の出力と同じで、dirfddirpath を参照するファイル記述子です。

この関数は常に ディレクトリ記述子への相対パス および シンボリックリンクをたどらない をサポートしています。ただし、他の関数と異なり、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 で追加.

16.1.5.1. Linux 拡張属性

バージョン 3.3 で追加.

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

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

path の拡張ファイルシステム属性 attribute の値を返します。attribute にはバイト列か文字列を渡すことができ、文字列の場合はファイルシステムのエンコーディングにエンコードされます。

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

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

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

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

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

path から拡張ファイルシステム属性 attribute を削除します。attribute はバイト列か文字列でなければなりません。文字列の場合、ファイルシステムのエンコーディングにエンコードされます。

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

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

path の拡張ファイルシステム属性 attributevalue を設定します。attribute はバイト列か文字列で NULL を含んではいけません。文字列の場合、ファイルシステムのエンコーディングでエンコードされます。flags には XATTR_REPLACE または XATTR_CREATE を指定できます。XATTR_REPLACE が与えられ、かつ属性が存在しない倍、EEXISTS が送出されます。XATTR_CREATE が与えられ、かつ属性がすでに存在する場合、属性は作成されず、ENODATA が送出されます。

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

注釈

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

os.XATTR_SIZE_MAX

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

os.XATTR_CREATE

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

os.XATTR_REPLACE

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

16.1.6. プロセス管理

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

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

os.abort()

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

利用できる環境: Unix、 Windows。

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 例外として報告されます。

The current process is replaced immediately. Open file objects and descriptors are not flushed, so if there may be data buffered on these open files, you should flush them using sys.stdout.flush() or os.fsync() before calling an exec* function.

The “l” and “v” variants of the exec* functions differ in how command-line arguments are passed. The “l” variants are perhaps the easiest to work with if the number of parameters is fixed when the code is written; the individual parameters simply become additional parameters to the execl*() functions. The “v” variants are good when the number of parameters is variable, with the arguments being passed in a list or tuple as the args parameter. In either case, the arguments to the child process should start with the name of the command being run, but this is not enforced.

The variants which include a “p” near the end (execlp(), execlpe(), execvp(), and execvpe()) will use the PATH environment variable to locate the program file. When the environment is being replaced (using one of the exec*e variants, discussed in the next paragraph), the new environment is used as the source of the PATH variable. The other variants, execl(), execle(), execv(), and execve(), will not use the PATH variable to locate the executable; path must contain an appropriate absolute or relative path.

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

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

利用できる環境: Unix、 Windows。

バージョン 3.3 で追加: execve() において、path へのオープンしているファイル記述子の指定のサポートを追加しました。

os._exit(n)

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

利用できる環境: Unix、 Windows。

注釈

終了する標準的な方法は 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、OS/2 EMX を含む一部のプラットフォームにおいて、fork() をスレッド内から利用した場合に既知の問題があることに注意してください。

警告

See ssl for applications that use the SSL module with fork().

利用できる環境: Unix。

os.forkpty()

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

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

os.kill(pid, sig)

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

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

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

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

os.killpg(pgid, sig)

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

利用できる環境: Unix。

os.nice(increment)

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

利用できる環境: Unix。

os.plock(op)

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

利用できる環境: Unix。

os.popen(...)

子プロセスを起動し、子プロセスとの通信のために開かれたパイプを返します。これらの関数は ファイルオブジェクトの生成 節で説明されています。

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 モジュールで置き換える セクションを参照してください)

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

The “l” and “v” variants of the spawn* functions differ in how command-line arguments are passed. The “l” variants are perhaps the easiest to work with if the number of parameters is fixed when the code is written; the individual parameters simply become additional parameters to the spawnl*() functions. The “v” variants are good when the number of parameters is variable, with the arguments being passed in a list or tuple as the args parameter. In either case, the arguments to the child process must start with the name of the command being run.

The variants which include a second “p” near the end (spawnlp(), spawnlpe(), spawnvp(), and spawnvpe()) will use the PATH environment variable to locate the program file. When the environment is being replaced (using one of the spawn*e variants, discussed in the next paragraph), the new environment is used as the source of the PATH variable. The other variants, spawnl(), spawnle(), spawnv(), and spawnve(), will not use the PATH variable to locate the executable; path must contain an appropriate absolute or relative 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)

利用できる環境: Unix、Windows spawnlp()spawnlpe()spawnvp()、および spawnvpe() は Windows では利用できません。spawnle() および spawnve() は Windows においてスレッドセーフではありません; 代わりに subprocess モジュールの利用を推奨します。

os.P_NOWAIT
os.P_NOWAITO

Possible values for the mode parameter to the spawn* family of functions. If either of these values is given, the spawn*() functions will return as soon as the new process has been created, with the process id as the return value.

利用できる環境: Unix、 Windows。

os.P_WAIT

Possible value for the mode parameter to the spawn* family of functions. If this is given as mode, the spawn*() functions will not return until the new process has run to completion and will return the exit code of the process the run is successful, or -signal if a signal kills the process.

利用できる環境: Unix、 Windows。

os.P_DETACH
os.P_OVERLAY

Possible values for the mode parameter to the spawn* family of functions. These are less portable than those listed above. P_DETACH is similar to P_NOWAIT, but the new process is detached from the console of the calling process. If P_OVERLAY is used, the current process will be replaced; the spawn* function will not return.

利用できる環境: 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 用に正しくコード化されたパスになるようにしてください。

利用できる環境: 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 モジュールで置き換える 節のレシピを参考にして下さい。

利用できる環境: Unix、 Windows。

os.times()

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

  • user - ユーザー時間

  • system - システム時間

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

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

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

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

times(2) の Unix マニュアルページ、または対応する Windows プラットフォーム API ドキュメントを参照してください。Windows では、user および system のみ有効で、その他の属性にはゼロが入ります。OS/2 では、elapsed のみ有効で、その他の属性にはゼロが入ります。

利用できる環境: Unix、 Windows。

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

os.wait()

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

利用できる環境: Unix。

os.waitid(idtype, id, options)

一つ以上のプロセスの完了を待機します。idtype には P_PIDP_PGID、または P_ALL を指定できます。id は待機する pid を指定します。optionsWEXITEDWSTOPPED、または WCONTINUED を一つ以上、論理和で指定でき、他に WNOHANG または WNOWAIT も追加できます。返り値は siginfo_t 構造体に含まれるデータ (si_pidsi_uidsi_signosi_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 にします。

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

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

On Windows: Wait for completion of a process given by process handle pid, and return a tuple containing pid, and its exit status shifted left by 8 bits (shifting makes cross-platform use of the function easier). A pid less than or equal to 0 has no special meaning on Windows, and raises an exception. The value of integer options has no effect. pid can refer to any process whose id is known, not necessarily a child process. The spawn* functions called with P_NOWAIT return suitable process handles.

os.wait3(options)

Similar to waitpid(), except no process id argument is given and a 3-element tuple containing the child’s process id, exit status indication, and resource usage information is returned. Refer to resource.getrusage() for details on resource usage information. The option argument is the same as that provided to waitpid() and wait4().

利用できる環境: Unix。

os.wait4(pid, options)

Similar to waitpid(), except a 3-element tuple, containing the child’s process id, exit status indication, and resource usage information is returned. Refer to resource.getrusage() for details on resource usage information. The arguments to wait4() are the same as those provided to waitpid().

利用できる環境: Unix。

os.WNOHANG

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

利用できる環境: Unix。

os.WCONTINUED

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

利用できる環境: 一部の Unix システム。

os.WUNTRACED

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

利用できる環境: Unix。

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

os.WCOREDUMP(status)

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

利用できる環境: Unix。

os.WIFCONTINUED(status)

プロセスがジョブ制御による停止状態から実行を再開された (continue) 場合に True を、それ以外の場合は False を返します。

利用できる環境: Unix。

os.WIFSTOPPED(status)

プロセスが停止された (stop) 場合に True を、それ以外の場合は False を返します。

利用できる環境: Unix。

os.WIFSIGNALED(status)

プロセスがシグナルによって終了した (exit) 場合に True を、それ以外の場合は False を返します。

利用できる環境: Unix。

os.WIFEXITED(status)

プロセスが exit(2) システムコールで終了した場合に True を、それ以外の場合は False を返します。

利用できる環境: Unix。

os.WEXITSTATUS(status)

WIFEXITED(status) が真の場合、exit(2) システムコールに渡された整数パラメーターを返します。そうでない場合、返される値には意味がありません。

利用できる環境: Unix。

os.WSTOPSIG(status)

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

利用できる環境: Unix。

os.WTERMSIG(status)

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

利用できる環境: Unix。

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

以下の関数は、オペレーティングシステムがプロセスに 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 には上記のスケジューリングポリシー定数の一つを指定します。paramsched_param のインスタンスです。

os.sched_getscheduler(pid)

PID pid のプロセスのスケジューリングポリシーを返します。pid が 0 の場合、呼び出しプロセスを意味します。返り値は上記のスケジューリングポリシー定数の一つになります。

os.sched_setparam(pid, param)

PID pid のプロセスのスケジュールパラメーターを設定します。pid が 0 の場合、呼び出しプロセスを意味します。paramsched_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 の集合を返します。

参考

multiprocessing.cpu_count() はシステムの CPU 数を返します。

16.1.8. 雑多なシステム情報

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

The default search path used by exec*p* and spawn*p* if the environment doesn’t have a 'PATH' key. Also available via os.path.

os.linesep

現在のプラットフォーム上で行を分割 (あるいは終端) するために用いられている文字列です。この値は例えば POSIX での '\n' や Mac OS での '\r' のように、単一の文字にもなりますし、例えば Windows での '\r\n' のように複数の文字列にもなります。テキストモードで開いたファイルに書き込む時には、os.linesep を利用しないでください。すべてのプラットフォームで、単一の '\n' を使用してください。

os.devnull

ヌルデバイスのファイルパスです。例えば POSIX では '/dev/null' で、Windows では 'nul' です。この値は os.path からも利用できます。

16.1.9. 雑多な関数

os.urandom(n)

暗号に関する用途に適した n バイトからなるランダムな文字列を返します。

This function returns random bytes from an OS-specific randomness source. The returned data should be unpredictable enough for cryptographic applications, though its exact quality depends on the OS implementation. On a Unix-like system this will query /dev/urandom, and on Windows it will use CryptGenRandom(). If a randomness source is not found, NotImplementedError will be raised.

プラットフォームが提供している乱数発生器へのインターフェイスについては、random.SystemRandom を参照してください。