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

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

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

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

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

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

* 特定の OS に固有の拡張機能も "os" モジュールで利用できますが、それら
  を使うと当然ながら移植性が損なわれる可能性があります。

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

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

* WebAssembly プラットフォーム、Android、iOS では、"os" モジュールの多
  くの機能が利用できないか、異なる動作をします。 プロセス関連の API
  ("fork()"、"execve()" など) やリソース関連の API ("nice()" など) は
  利用できません。 "getuid()" や "getpid()" などは、エミュレーションま
  たはスタブとして実装されています。 WebAssembly プラットフォームでは
  、シグナル関連の機能 ("kill()"、"wait()" など) もサポートされません
  。

注釈:

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

exception os.error

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

os.name

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

   参考:

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

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


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

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

*ファイルシステムのエンコーディングとエラーハンドラ* は、Python の開始
時に "PyConfig_Read()" 関数により設定されます。 "PyConfig" のメンバー
"filesystem_encoding" と "filesystem_errors" を参照してください。

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

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

*ロケールエンコーディング* も参照してください。


Python UTF-8 モード
===================

Added in version 3.7: より詳しくは **PEP 540** を参照してください。

バージョン 3.15 で変更: Python UTF-8 モードがデフォルトで有効になりま
した (**PEP 686**)。 環境変数 "PYTHONUTF8=0" を設定するか、コマンドラ
インオプション "-X utf8=0" を使うと無効にできます。

Python UTF-8 モードは *ロケールエンコーディング* を無視し、UTF-8 エン
コーディングを強制的に使用します。

* *ファイルシステムエンコーディング* として UTF-8 を使用します。

* "sys.getfilesystemencoding()" は "'utf-8'" を返します。

* "locale.getpreferredencoding()" は "'utf-8'" を返します
  (*do_setlocale* 引数は効果を持ちません)。

* "sys.stdin"、"sys.stdout"、"sys.stderr" はすべて、テキストのエンコー
  ディングとして UTF-8 を使用します。 "sys.stdin" と "sys.stdout" では
  、"surrogateescape" エラーハンドラ が有効になります ("sys.stderr" は
  、デフォルトのロケールに従うモードと同じく、引き続き
  "backslashreplace" を使用します)。

* Unix では、"os.device_encoding()" はデバイスのエンコーディングの代わ
  りに "'utf-8'" を返します。

UTF-8 モードでも、標準ストリームの設定は "PYTHONIOENCODING" で上書きで
きます (デフォルトのロケールに従うモードと同様です)。

これらの低水準 API の変更に伴い、高水準の API のデフォルト動作も変わり
ます。

* コマンドライン引数、環境変数、ファイル名は、UTF-8 エンコーディングで
  テキストにデコードされます。

* "os.fsdecode()" と "os.fsencode()" は UTF-8 エンコーディングを使用し
  ます。

* "open()"、"io.open()"、"codecs.open()" はデフォルトで UTF-8 エンコー
  ディングを使用します。 ただし、デフォルトのエラーハンドラは引き続き
  strict なので、バイナリファイルをテキストモードで開こうとすると、意
  味のないデータを生成するのではなく例外を送出する可能性が高くなります
  。

Python UTF-8 モード はデフォルトで有効です。 コマンドラインオプション
"-X utf8=0" または環境変数 "PYTHONUTF8=0" を使うと無効にできます。
Python UTF-8 モードを無効にできるのは Python の起動時のみです。 その値
は "sys.flags.utf8_mode" で確認できます。

If the UTF-8 mode is disabled, the interpreter defaults to using the
current locale settings, *unless* the current locale is identified as
a legacy ASCII-based locale (as described for "PYTHONCOERCECLOCALE"),
and locale coercion is either disabled or fails. In such legacy
locales, the interpreter will default to enabling UTF-8 mode unless
explicitly instructed not to do so.

Windows の UTF-8 モード と *ファイルシステムエンコーディングとエラーハ
ンドラ* も参照してください。


プロセスのパラメーター
======================

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

os.ctermid()

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

   利用可能な環境: Unix, not WASI.

os.environ

   プロセスの環境を表す *マッピング* オブジェクトで、キーと値は文字列
   です。 例えば、一部のプラットフォームで "environ['HOME']" はホーム
   ディレクトリのパス名を表し、C の "getenv("HOME")" に相当します。

   このマッピングは "os" モジュールが最初にインポートされたときに取得
   されます。 通常は Python の起動時、"site.py" の処理の一環として行わ
   れます。 それ以降の環境の変更は、"os.environ" 自体を直接変更した場
   合を除き、"os.environ" に反映されません。

   このマップ型オブジェクトは環境変数に対する変更に使うこともできます
   。 "putenv()" はマップ型オブジェクトが修正される時に、自動的に呼ば
   れることになります。

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

   Windows ではキーが大文字に変換されます。 項目の取得、設定、削除でも
   同様です。 例えば "environ['monty'] = 'python'" は、キー "'MONTY'"
   に値 "'python'" を対応付けます。

   注釈:

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

   注釈:

     FreeBSD や macOS など一部のプラットフォームでは "environ" の値を
     変更するとメモリリークが発生する可能性があります。各システムのド
     キュメントで "putenv()" の項目を参照してください。

   このマッピングから項目を削除すると、環境変数の設定を解除できます。
   "os.environ" から項目を削除したときや、"pop()" または "clear()" メ
   ソッドを呼び出したときに、"unsetenv()" が自動的に呼び出されます。

   *clearenv(3)* 関数が利用できる場合、"clear()" メソッドはそれを使用
   し、"os._clearenv" 監査イベントを 1 回発生させます。 それ以外の場合
   、削除した環境変数ごとに "os.unsetenv" イベントを発生させます。

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

   引数なしの 監査イベント "os._clearenv" を発生させます。

   参考: "os.reload_environ()" 関数。

   バージョン 3.9 で変更: 更新され **PEP 584** の合成演算子 ("|") と更
   新演算子 ("|=") がサポートされました。

   バージョン 3.15 で変更: "clear()" メソッドが "os._clearenv" 監査イ
   ベントを発生させる場合があるようになりました。

os.environb

   "environ" のバイト列版です。 プロセスの環境を表す *マッピング* オブ
   ジェクトで、キーと値はいずれも "bytes" オブジェクトです。 "environ"
   と "environb" は同期されます ("environb" を変更すると "environ" が
   更新され、逆も同様です)。

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

   Added in version 3.2.

   バージョン 3.9 で変更: 更新され **PEP 584** の合成演算子 ("|") と更
   新演算子 ("|=") がサポートされました。

os.reload_environ()

   "os.environ" と "os.environb" のマッピングは、Python 起動時の環境変
   数のキャッシュです。 そのため、Python の外部や "os.putenv()"、
   "os.unsetenv()" で現在のプロセスの環境を変更しても反映されません。
   そのような変更を "os.environ" と "os.environb" に反映するには、
   "os.reload_environ()" を使用してください。

   警告:

     この関数はスレッドセーフではありません。 別のスレッドが環境を変更
     している間に呼び出した場合の動作は未定義です。 再読み込み中に
     "os.environ" や "os.environb" から読み取ったり、"os.getenv()" を
     呼び出したりすると、空の結果が返される場合があります。

   Added in version 3.14.

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

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

os.fsencode(filename)

   *path-like* な *filename* を *ファイルシステムのエンコーディングと
   エラーハンドラ* にエンコードします。 入力が "bytes" の場合は、その
   まま返します。

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

   Added in version 3.2.

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

os.fsdecode(filename)

   *path-like* な *filename* を *ファイルシステムのエンコーディングと
   エラーハンドラ* からデコードします。 入力が "str" の場合は、そのま
   ま返します。

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

   Added in version 3.2.

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

os.fspath(path)

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

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

   Added in version 3.6.

class os.PathLike

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

   Added in version 3.6.

   abstractmethod __fspath__()

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

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

os.getenv(key, default=None)

   環境変数 *key* が存在する場合はその値を文字列として返し、存在しなけ
   れば *default* を返します。*key* は文字列です。注意すべき点として、
   "getenv()" は内部的に "os.environ" を使用するため、"getenv()" のマ
   ップ型オブジェクトはインポート時に取得されます。そのため、それ以降
   に環境変数が変更されても、この関数の値にそれが反映されない可能性が
   あります。

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

   利用可能な環境: Unix, Windows.

os.getenvb(key, default=None)

   環境変数 *key* が存在する場合はその値を bytes として返し、存在しな
   ければ *default* を返します。*key* はbytes である必要があります。注
   意すべき点として、"getenvb()" は内部的に "os.environb" を使用するた
   め、"getenvb()" のマップ型オブジェクトはインポート時に取得されます
   。そのため、それ以降に環境変数が変更されても、この関数の値にそれが
   反映されない可能性があります。

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

   利用可能な環境: Unix.

   Added in version 3.2.

os.get_exec_path(env=None)

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

   Added in version 3.2.

os.getegid()

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

   利用可能な環境: Unix, not WASI.

os.geteuid()

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

   利用可能な環境: Unix, not WASI.

os.getgid()

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

   利用可能な環境: Unix.

   WASI ではこの関数はスタブです。 詳しくは WebAssembly プラットフォー
   ム を参照してください。

os.getgrouplist(user, group, /)

   *user* が属するグループの ID のリストを返します。 *group* がリスト
   に含まれていなければ追加します。 通常、*group* には *user* のパスワ
   ードレコードのグループ ID フィールドを指定します。 そうしないと、そ
   のグループ ID が含まれない可能性があるためです。

   利用可能な環境: Unix, not WASI.

   Added in version 3.3.

os.getgroups()

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

   利用可能な環境: Unix, not WASI.

   注釈:

     macOS の "getgroups()" の動作は、他の Unix プラットフォームと多少
     異なります。 Python インタープリタをデプロイメントターゲット
     "10.5" 以前でビルドした場合、"getgroups()" は現在のユーザープロセ
     スに関連付けられた実効グループ ID のリストを返します。 このリスト
     の要素数はシステムで定められた数 (通常は 16) に制限され、適切な権
     限があれば "setgroups()" で変更できます。 "10.5" より新しいデプロ
     イメントターゲットでビルドした場合、"getgroups()" はプロセスの実
     効ユーザー ID に対応するユーザーの現在のグループアクセスリストを
     返します。 このリストはプロセスの実行中に変わる場合があり、
     "setgroups()" の呼び出しの影響を受けず、長さが 16 に制限されるこ
     ともありません。 デプロイメントターゲットの値は
     "sysconfig.get_config_var('MACOSX_DEPLOYMENT_TARGET')" で取得でき
     ます。

os.getlogin()

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

   利用可能な環境: Unix, Windows, not WASI.

os.getpgid(pid)

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

   利用可能な環境: Unix, not WASI.

os.getpgrp()

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

   利用可能な環境: Unix, not WASI.

os.getpid()

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

   WASI ではこの関数はスタブです。 詳しくは WebAssembly プラットフォー
   ム を参照してください。

os.getppid()

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

   利用可能な環境: Unix, Windows, not WASI.

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

   Added in version 3.3.

os.PRIO_PROCESS
os.PRIO_PGRP
os.PRIO_USER

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

   利用可能な環境: Unix, not WASI.

   Added in version 3.3.

os.PRIO_DARWIN_THREAD
os.PRIO_DARWIN_PROCESS
os.PRIO_DARWIN_BG
os.PRIO_DARWIN_NONUI

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

   利用可能な環境: macOS

   Added in version 3.12.

os.getresuid()

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

   利用可能な環境: Unix, not WASI, not macOS, not iOS.

   Added in version 3.2.

os.getresgid()

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

   利用可能な環境: Unix, not WASI, not macOS, not iOS.

   Added in version 3.2.

os.getuid()

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

   利用可能な環境: Unix.

   WASI ではこの関数はスタブです。 詳しくは WebAssembly プラットフォー
   ム を参照してください。

os.initgroups(username, gid, /)

   システムの "initgroups()" を呼び出し、指定したユーザー名が属するす
   べてのグループと、指定したグループ ID でグループアクセスリストを初
   期化します。

   利用可能な環境: Unix, not WASI, not Android.

   Added in version 3.2.

os.putenv(key, value, /)

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

   "os.environ" の要素に代入すると、それは "putenv()" の呼び出しに自動
   変換されます。 しかし、直接 "putenv()" を呼び出しても "os.environ"
   には反映されないため、"os.environ" の要素に代入する方がベターです。
   "getenv()" と "getenvb()" についても、実装上それぞれ "os.environ"
   と "os.environb" を使用するので、同様に注意が必要です。

   "os.reload_environ()" 関数も参照してください。

   注釈:

     FreeBSD や macOS など一部のプラットフォームでは "environ" の値を
     変更するとメモリリークが発生する可能性があります。 各システムのド
     キュメントで "putenv()" の項目を参照してください。

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

   バージョン 3.9 で変更: 常に利用出来るようになりました。

os.setegid(egid, /)

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

   利用可能な環境: Unix, not WASI, not Android.

os.seteuid(euid, /)

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

   利用可能な環境: Unix, not WASI, not Android.

os.setgid(gid, /)

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

   利用可能な環境: Unix, not WASI, not Android.

os.setgroups(groups, /)

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

   利用可能な環境: Unix, not WASI.

   注釈:

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

os.setns(fd, nstype=0)

   現在のスレッドを Linux の名前空間に再度関連付けます。 詳しくは
   *setns(2)* と *namespaces(7)* のマニュアルページを参照してください
   。

   *fd* が "/proc/*pid*/ns/" のリンクを指している場合、"setns()" は呼
   び出し元のスレッドを、そのリンクに対応する名前空間に再度関連付けま
   す。 *nstype* には CLONE_NEW* 定数 のいずれかを指定して、操作を制限
   できます ("0" は制限なしを意味します)。

   Linux 5.8 以降では、*fd* に "pidfd_open()" で取得した PID ファイル
   記述子を指定できます。 この場合、"setns()" は呼び出し元のスレッドを
   、*fd* が指すスレッドと同じ名前空間のうち 1 つ以上に再度関連付けま
   す。 対象は *nstype* による制約に従います。 *nstype* は CLONE_NEW*
   定数 を 1 つ以上組み合わせたビットマスクです (例: "setns(fd,
   os.CLONE_NEWUTS | os.CLONE_NEWPID)")。 指定されていない名前空間につ
   いては、呼び出し元の所属は変わりません。

   *fd* には "fileno()" メソッドを持つ任意のオブジェクト、またはファイ
   ル記述子そのものを指定できます。

   次の例は、スレッドを "init" プロセスのネットワーク名前空間に再度関
   連付けます。

      fd = os.open("/proc/1/ns/net", os.O_RDONLY)
      os.setns(fd, os.CLONE_NEWNET)
      os.close(fd)

   利用可能な環境: Linux >= 3.0 with glibc >= 2.14.

   Added in version 3.12.

   参考: "unshare()" 関数。

os.setpgrp()

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

   利用可能な環境: Unix, not WASI.

os.setpgid(pid, pgrp, /)

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

   利用可能な環境: Unix, not WASI.

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, not WASI.

   Added in version 3.3.

os.setregid(rgid, egid, /)

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

   利用可能な環境: Unix, not WASI, not Android.

os.setresgid(rgid, egid, sgid, /)

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

   利用可能な環境: Unix, not WASI, not Android, not macOS, not iOS.

   Added in version 3.2.

os.setresuid(ruid, euid, suid, /)

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

   利用可能な環境: Unix, not WASI, not Android, not macOS, not iOS.

   Added in version 3.2.

os.setreuid(ruid, euid, /)

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

   利用可能な環境: Unix, not WASI, not Android.

os.getsid(pid, /)

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

   利用可能な環境: Unix, not WASI.

os.setsid()

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

   利用可能な環境: Unix, not WASI.

os.setuid(uid, /)

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

   利用可能な環境: Unix, not WASI, not Android.

os.strerror(code, /)

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

os.supports_bytes_environ

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

   Added in version 3.2.

os.umask(mask, /)

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

   WASI ではこの関数はスタブです。 詳しくは WebAssembly プラットフォー
   ム を参照してください。

os.uname()

   現在のオペレーティングシステムを識別する情報を返します。 戻り値は
   "uname_result" です。

   macOS、iOS、Android では、*カーネル* の名前とリリースを返します (名
   前は macOS と iOS では "'Darwin'"、Android では "'Linux'")。 iOS と
   Android でユーザー向けの OS 名とリリースを取得するには、
   "platform.uname()" を使用できます。

   参考:

     より細かく区別できる "sys.platform"。

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

   利用可能な環境: Unix.

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

class os.uname_result

   "os.uname()" が返すシステムの名前と情報です。 これらの属性は
   *uname(2)* に記載されたメンバーに対応します。

   後方互換性のため、このオブジェクトはイテラブルでもあり、"sysname"、
   "nodename"、"release"、"version"、"machine" をこの順に含む 5 要素の
   タプルのように動作します。

   sysname

      オペレーティングシステム名。

   nodename

      ネットワーク上のマシン名。 システムによっては "nodename" が 8 文
      字または先頭の構成要素に切り詰められます。 ホスト名を取得するに
      は、"socket.gethostname()" や
      "socket.gethostbyaddr(socket.gethostname())" を使う方が適してい
      ます。

   release

      オペレーティングシステムのリリース。

   version

      オペレーティングシステムのバージョン。

   machine

      ハードウェアの識別子。

os.unsetenv(key, /)

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

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

   "os.reload_environ()" 関数も参照してください。

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

   バージョン 3.9 で変更: この関数は常に利用できるようになり、Windows
   でも利用できるようになりました。

os.unshare(flags)

   プロセスの実行コンテキストの一部を現在の共有関係から切り離し、新し
   く作成した名前空間に移します。 詳しくは *unshare(2)* のマニュアルペ
   ージを参照してください。 *flags* は CLONE_* 定数 を 0 個以上組み合
   わせたビットマスクで、実行コンテキストのどの部分を既存の共有関係か
   ら切り離して新しい名前空間に移すかを指定します。 *flags* が "0" の
   場合、呼び出し元のプロセスの実行コンテキストは変更されません。

   利用可能な環境: Linux >= 2.6.16.

   Added in version 3.12.

   参考: "setns()" 関数。

実装がサポートしている場合に、"unshare()" 関数で使えるフラグです。 正
確な効果と利用可能な環境については、Linux の *unshare(2)* マニュアルを
参照してください。

os.CLONE_FILES
os.CLONE_FS
os.CLONE_NEWCGROUP
os.CLONE_NEWIPC
os.CLONE_NEWNET
os.CLONE_NEWNS
os.CLONE_NEWPID
os.CLONE_NEWTIME
os.CLONE_NEWUSER
os.CLONE_NEWUTS
os.CLONE_SIGHAND
os.CLONE_SYSVSEM
os.CLONE_THREAD
os.CLONE_VM


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

以下の関数は新しい *ファイルオブジェクト* を作成します。(ファイル記述
子のオープンについては "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* から、ファイル記述子
   *dst* のオフセット *offset_dst* へ、*count* バイトをコピーします。
   *offset_src* が "None" の場合、*src* の現在位置から読み込みます。
   *offset_dst* が "None" の場合は、*dst* の現在位置へ書き込みます。

   Linux カーネル 5.3 より前では、*src* と *dst* が指すファイルは同じ
   ファイルシステム上になければなりません。 そうでなければ、"errno" を
   "errno.EXDEV" に設定した "OSError" を送出します。

   このコピーでは、データをカーネルからユーザー空間へ転送してからカー
   ネルへ戻す追加のコストがかかりません。 さらに、ファイルシステムによ
   っては、reflink やサーバー側コピー (NFS の場合) などの最適化も行わ
   れる場合があります。 reflink は、同じコピーオンライトのディスクブロ
   ックへのポインタを 2 つ以上の inode で共有する仕組みで、btrfs や
   XFS などがサポートしています。

   この関数は 2 つのファイル記述子の間でバイト列をコピーします。 エン
   コーディングや改行などのテキストのオプションは無視されます。

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

   注釈:

     Linux では、procfs や sysfs などの特殊なファイルシステムにある疑
     似ファイルの範囲をコピーするために、"os.copy_file_range()" を使用
     しないでください。 Linux カーネルの既知の問題により、常に 1 バイ
     トもコピーせず、ファイルが空であるかのように 0 を返します。

   利用可能な環境: Linux >= 4.5 with glibc >= 2.27.

   Added in version 3.8.

os.device_encoding(fd)

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

   Unix で Python UTF-8 モード が有効な場合、デバイスのエンコーディン
   グの代わりに "'UTF-8'" を返します。

   バージョン 3.10 で変更: Unix で Python UTF-8 モードに対応しました。

os.dup(fd, /)

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

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

   利用可能な環境: not WASI.

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

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

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

   利用可能な環境: not WASI.

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

   WASI ではこの関数に制限があります。 詳しくは WebAssembly プラットフ
   ォーム を参照してください。

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

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.

   WASI ではこの関数に制限があります。 詳しくは WebAssembly プラットフ
   ォーム を参照してください。

os.fdatasync(fd)

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

   利用可能な環境: Unix, not macOS, not iOS.

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* に対応するファイルが置か
   れたファイルシステムの情報を "statvfs_result" として返します。
   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)" と等価です。

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

   利用可能な環境: Unix, Windows.

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

os.get_blocking(fd, /)

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

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

   利用可能な環境: Unix, Windows.

   WASI ではこの関数に制限があります。 詳しくは WebAssembly プラットフ
   ォーム を参照してください。

   Windows では、この関数はパイプにのみ使用できます。

   Added in version 3.5.

   バージョン 3.12 で変更: Windows のパイプをサポートしました。

os.grantpt(fd, /)

   ファイル記述子 *fd* が指すマスター疑似端末デバイスに対応する、スレ
   ーブ疑似端末デバイスへのアクセスを許可します。 失敗してもファイル記
   述子 *fd* は閉じられません。

   C 標準ライブラリ関数 "grantpt()" を呼び出します。

   利用可能な環境: Unix, not WASI.

   Added in version 3.13.

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.

   Added in version 3.3.

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

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

   利用可能な環境: Unix.

   Added in version 3.3.

os.login_tty(fd, /)

   ファイル記述子 "fd" に対応する tty を、新しいログインセッション用に
   準備します。 呼び出し元のプロセスをセッションリーダーにし、その tty
   をプロセスの制御 tty、標準入力、標準出力、標準エラー出力にします。
   その後、"fd" を閉じます。

   利用可能な環境: Unix, not WASI.

   Added in version 3.11.

os.lseek(fd, pos, whence, /)

   *whence* に応じて解釈した *pos* の位置に、ファイル記述子 *fd* の現
   在位置を設定します。 新しい位置を、ファイルの先頭からのバイト数で返
   します。 *whence* に指定できる値は次のとおりです。

   * "SEEK_SET" または "0" -- ファイルの先頭からの相対位置 *pos* に設
     定します。

   * "SEEK_CUR" または "1" -- 現在のファイル位置からの相対位置 *pos*
     に設定します。

   * "SEEK_END" または "2" -- ファイルの末尾からの相対位置 *pos* に設
     定します。

   * "SEEK_HOLE" -- set *pos* to the next data location, relative to
     *pos*

   * "SEEK_DATA" -- set *pos* to the next data hole, relative to *pos*

   バージョン 3.3 で変更: "SEEK_HOLE" と "SEEK_DATA" のサポートを追加
   しました。

os.SEEK_SET
os.SEEK_CUR
os.SEEK_END

   "lseek()" 関数と *ファイルライクオブジェクト* の "seek()" メソッド
   で、ファイル位置指示子を調整するために "whence" に指定する値です。

   "SEEK_SET"
      ファイルの先頭を基準にファイル位置を調整します。

   "SEEK_CUR"
      現在のファイル位置を基準にファイル位置を調整します。

   "SEEK_END"
      ファイルの末尾を基準にファイル位置を調整します。

   値はそれぞれ 0、1、2 です。

os.SEEK_HOLE
os.SEEK_DATA

   "lseek()" 関数と *ファイルライクオブジェクト* の "seek()" メソッド
   で、スパースファイルのデータやホールを探すために指定する値です。

   "SEEK_DATA"
      指定したシーク位置を基準に、次にデータがある位置へファイルオフセ
      ットを調整します。

   "SEEK_HOLE"
      指定したシーク位置を基準に、次にホールがある位置へファイルオフセ
      ットを調整します。 ホールとは、ゼロが連続する領域です。

   注釈:

     これらの操作は、それをサポートするファイルシステムでのみ意味を持
     ちます。

   利用可能な環境: Linux >= 3.1, macOS, Unix

   Added in version 3.3.

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

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

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

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

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

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

   注釈:

     この関数は低水準の I/O 向けです。 通常は、"read()" と "write()"
     メソッドを持つ *ファイルオブジェクト* を返す組み込み関数 "open()"
     を使用してください。 ファイル記述子をファイルオブジェクトでラップ
     するには "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_EVTONLY
os.O_FSYNC
os.O_SYMLINK
os.O_NOFOLLOW_ANY

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

   バージョン 3.10 で変更: "O_EVTONLY"、"O_FSYNC"、"O_SYMLINK"、
   "O_NOFOLLOW_ANY" 定数を追加しました。

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, not WASI.

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

os.pipe()

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

   利用可能な環境: Unix, Windows.

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

os.pipe2(flags, /)

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

   利用可能な環境: Unix, macOS >= 27.0, not WASI, not iOS.

   Added in version 3.3.

os.posix_fallocate(fd, offset, len, /)

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

   利用可能な環境: Unix, not macOS, not iOS.

   Added in version 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, not macOS, not iOS.

   Added in version 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.

   Added in version 3.3.

os.pread(fd, n, offset, /)

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

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

   利用可能な環境: Unix.

   Added in version 3.3.

os.posix_openpt(oflag, /)

   マスター疑似端末デバイスを開き、そのファイル記述子を返します。

   C 標準ライブラリ関数 "posix_openpt()" を呼び出します。 *oflag* 引数
   は、システムの "posix_openpt()" のマニュアルページに従って、ファイ
   ル状態フラグとファイルアクセスモードを設定するために使用します。

   返されるファイル記述子は 継承不可 です。 システムで "O_CLOEXEC" が
   利用できる場合は、*oflag* に追加されます。

   利用可能な環境: Unix, not WASI.

   Added in version 3.13.

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

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

   "flags" 引数には、次のフラグを 0 個以上、ビット単位 OR で組み合わせ
   て指定します。

   * "RWF_HIPRI"

   * "RWF_NOWAIT"

   * "RWF_DONTCACHE"

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

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

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

   利用可能な環境: Linux >= 2.6.30, FreeBSD >= 6.0, OpenBSD >= 2.7,
   AIX >= 7.1.

   フラグを使用するには Linux 4.6 以降が必要です。

   Added in version 3.7.

os.RWF_NOWAIT

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

   If some data was successfully read, it will return the number of
   bytes read. If no bytes were read, it will return "-1" and set
   errno to "errno.EAGAIN".

   利用可能な環境: Linux >= 4.14.

   Added in version 3.7.

os.RWF_HIPRI

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

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

   利用可能な環境: Linux >= 4.6.

   Added in version 3.7.

os.RWF_DONTCACHE

   キャッシュに残さないバッファ付き I/O を使用します。

   利用可能な環境: Linux >= 6.14

   Added in version 3.15.

os.RWF_ATOMIC

   データをアトミックに書き込みます。 デバイスのアトミック書き込み単位
   に合わせたアラインメントが必要です。

   利用可能な環境: Linux >= 6.11

   Added in version 3.15.

os.ptsname(fd, /)

   ファイル記述子 *fd* が指すマスター疑似端末デバイスに対応する、スレ
   ーブ疑似端末デバイスの名前を返します。 失敗してもファイル記述子
   *fd* は閉じられません。

   利用できる場合は、再入可能な C 標準ライブラリ関数 "ptsname_r()" を
   呼び出します。 それ以外の場合は、スレッドセーフが保証されない C 標
   準ライブラリ関数 "ptsname()" を呼び出します。

   利用可能な環境: Unix, not WASI.

   Added in version 3.13.

os.pwrite(fd, str, offset, /)

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

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

   利用可能な環境: Unix.

   Added in version 3.3.

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

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

   "flags" 引数には、次のフラグを 0 個以上、ビット単位 OR で組み合わせ
   て指定します。

   * "RWF_DSYNC"

   * "RWF_SYNC"

   * "RWF_APPEND"

   * "RWF_DONTCACHE"

   * "RWF_ATOMIC"

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

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

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

   利用可能な環境: Linux >= 2.6.30, FreeBSD >= 6.0, OpenBSD >= 2.7,
   AIX >= 7.1.

   フラグを使用するには Linux 4.6 以降が必要です。

   Added in version 3.7.

os.RWF_DSYNC

   書き込みごとに "os.open()" の "O_DSYNC" と同等の効果を提供するフラ
   グです。このフラグはシステムコールによって書き込まれたデータ範囲に
   対してのみ適用されます。

   利用可能な環境: Linux >= 4.7.

   Added in version 3.7.

os.RWF_SYNC

   書き込みごとに "os.open()" の "O_SYNC" と同等の効果を提供するフラグ
   です。このフラグはシステムコールによって書き込まれたデータ範囲に対
   してのみ適用されます。

   利用可能な環境: Linux >= 4.7.

   Added in version 3.7.

os.RWF_APPEND

   "os.open()" の "O_APPEND" フラグと同等の効果を、書き込みごとに提供
   します。 このフラグは "os.pwritev()" でのみ意味を持ち、その効果はシ
   ステムコールが書き込むデータ範囲だけに適用されます。 *offset* 引数
   は書き込み操作に影響せず、データは常にファイルの末尾に追加されます
   。 ただし、*offset* 引数が "-1" の場合は、現在のファイルの *offset*
   が更新されます。

   利用可能な環境: Linux >= 4.16.

   Added in version 3.10.

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.readinto(fd, buffer, /)

   ファイル記述子 *fd* から、変更可能な バッファオブジェクト *buffer*
   に読み込みます。

   *buffer* は変更可能な *bytes-like オブジェクト* でなければなりませ
   ん。 成功すると、読み込んだバイト数を返します。 読み込むバイト数は
   、バッファのサイズより少ない場合があります。 シグナルによって割り込
   まれた場合は、シグナルハンドラが例外を送出しない限り、下層のシステ
   ムコールを再試行します。 それ以外のエラーでは再試行せず、例外を送出
   します。

   *fd* がファイルの終端にある場合や、*buffer* の長さが 0 の場合は 0
   を返します (長さ 0 のバッファを使うと、データを読み込まずにエラーを
   確認できます)。 負の値を返すことはありません。

   注釈:

     この関数は低水準の I/O 向けであり、"os.open()" や "os.pipe()" が
     返すファイル記述子に使用する必要があります。 組み込み関数
     "open()" が返すファイルオブジェクトや "sys.stdin" を読み取るには
     、"io.BufferedIOBase.readinto()"、"io.BufferedIOBase.read()"、
     "io.TextIOBase.read()" などのメソッドを使用してください。

   Added in version 3.14.

os.sendfile(out_fd, in_fd, offset, count)
os.sendfile(out_fd, in_fd, offset, count, headers=(), trailers=(), flags=0)

   ファイル記述子 *in_fd* の位置 *offset* から *count* バイトをファイ
   ル記述子 *out_fd* にコピーします。 送信したバイト数を返し、EOF に達
   すると "0" を返します。

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

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

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

   macOS と FreeBSD では、*count* の値に "0" を指定すると、 *in_fd* の
   末尾に達するまで送信します。

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

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

   利用可能な環境: Unix, not WASI.

   注釈:

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

   Added in version 3.3.

   バージョン 3.9 で変更: 引数 *out* と *in* は *out_fd* と *in_fd* に
   名前が変更されました。

os.SF_NODISKIO
os.SF_MNOWAIT
os.SF_SYNC

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

   利用可能な環境: Unix, not WASI.

   Added in version 3.3.

os.SF_NOCACHE

   実装がサポートしている場合に、"sendfile()" 関数に指定できる値です。
   データは仮想メモリにキャッシュされず、使用後に解放されます。

   利用可能な環境: Unix, not WASI.

   Added in version 3.11.

os.set_blocking(fd, blocking, /)

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

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

   利用可能な環境: Unix, Windows.

   WASI ではこの関数に制限があります。 詳しくは WebAssembly プラットフ
   ォーム を参照してください。

   Windows では、この関数はパイプにのみ使用できます。

   Added in version 3.5.

   バージョン 3.12 で変更: Windows のパイプをサポートしました。

os.splice(src, dst, count, offset_src=None, offset_dst=None, flags=0)

   ファイル記述子 *src* のオフセット *offset_src* から、ファイル記述子
   *dst* のオフセット *offset_dst* へ、*count* バイトを転送します。

   *flags* の値を指定すると、転送の動作を変更できます。 次の値をビット
   単位 OR ("|" 演算子) で組み合わせて指定できます。

   * "SPLICE_F_MOVE" を指定すると、カーネルにページをコピーせずに移動
     するよう要求します。 ただし、カーネルがパイプからページを移動でき
     ない場合は、コピーすることもあります。

   * "SPLICE_F_NONBLOCK" を指定すると、カーネルに I/O でブロックしない
     よう要求します。 これによって splice のパイプ操作は非ブロッキング
     になりますが、転送対象のファイル記述子がブロックする可能性がある
     ため、splice 自体はブロックする場合があります。

   * "SPLICE_F_MORE" を指定すると、後続の splice でさらにデータを転送
     する予定であることをカーネルに伝えます。

   At least one of the file descriptors must refer to a pipe. If
   *offset_src* is "None", then *src* is read from the current
   position; respectively for *offset_dst*. The offset associated to
   the file descriptor that refers to a pipe must be "None". The files
   pointed to by *src* and *dst* must reside in the same filesystem,
   otherwise an "OSError" is raised with "errno" set to "errno.EXDEV".

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

   成功すると、パイプへの転送またはパイプからの転送を行ったバイト数を
   返します。 戻り値 0 は入力の終端を意味します。 *src* がパイプを指す
   場合は、転送するデータがなく、書き込み端に接続されている書き込み元
   もないため、ブロックして待っても意味がないことを示します。

   参考: *splice(2)* のマニュアルページ。

   利用可能な環境: Linux >= 2.6.17 with glibc >= 2.5

   Added in version 3.10.

os.SPLICE_F_MOVE
os.SPLICE_F_NONBLOCK
os.SPLICE_F_MORE

   Added in version 3.10.

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.

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

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

   利用可能な環境: Unix.

   Added in version 3.3.

os.tcgetpgrp(fd, /)

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

   利用可能な環境: Unix, not WASI.

os.tcsetpgrp(fd, pg, /)

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

   利用可能な環境: Unix, not WASI.

os.ttyname(fd, /)

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

   利用可能な環境: Unix.

os.unlockpt(fd, /)

   ファイル記述子 *fd* が指すマスター疑似端末デバイスに対応する、スレ
   ーブ疑似端末デバイスのロックを解除します。 失敗してもファイル記述子
   *fd* は閉じられません。

   C 標準ライブラリ関数 "unlockpt()" を呼び出します。

   利用可能な環境: Unix, not WASI.

   Added in version 3.13.

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 番目のバ
   ッファに進む前に書き込まれ、その次も同様です。

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

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

   利用可能な環境: Unix.

   Added in version 3.3.


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

Added in version 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

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


ファイル記述子の継承
--------------------

Added in version 3.4.

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

Unix では、子プロセスが新しいプログラムを実行するときに、継承不可のフ
ァイル記述子が閉じられ、それ以外のファイル記述子は継承されます。 ただ
し、"os.fork()" の時点では、継承不可のファイル記述子も子プロセスに *継
承されます*。

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

WebAssembly プラットフォームでは、ファイル記述子の継承可能フラグを変更
できません。

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* にフ
  ァイル記述子を指定できるかどうかを確認することができます。 この機能
  が利用可能でない場合、 その関数にファイル記述子を指定すると
  "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" のうち 1 つ以上をビ
   ット単位 OR で組み合わせて指定します。 アクセスが許可される場合は
   "True"、許可されない場合は "False" を返します。 詳しくは Unix の
   *access(2)* マニュアルページを参照してください。

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

   *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" を送出します。

   参考: 入るときに現在の作業ディレクトリを変更し、出るときに元に戻す
       "contextlib.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, not WASI.

   バージョン 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"
     定数、または対応する整数値を使用します)。 それ以外のビットは無視
     されます。 Windows での *follow_symlinks* のデフォルト値は
     "False" です。WASI ではこの関数に制限があります。 詳しくは
     WebAssembly プラットフォーム を参照してください。

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

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

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

   バージョン 3.13 で変更: Windows でファイル記述子と
   *follow_symlinks* 引数をサポートしました。

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.

   WASI ではこの関数に制限があります。 詳しくは WebAssembly プラットフ
   ォーム を参照してください。

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

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

os.chroot(path)

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

   利用可能な環境: Unix, not WASI, not Android.

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

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

os.lchmod(path, mode)

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

   "lchmod()" は POSIX の一部ではありませんが、シンボリックリンクのモ
   ード変更をサポートする Unix 実装では提供されている場合があります。

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

   利用可能な環境: Unix, Windows, not Linux, FreeBSD >= 1.3, NetBSD >=
   1.3, not OpenBSD

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

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

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* を指定することで ディレクトリ記述子か
   らの相対パス を使用でき、シンボリックリンクをたどらない 操作もサポ
   ートできます。 Windows での *follow_symlinks* のデフォルト値は
   "False" です。

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

   利用可能な環境: 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" を送出します。

   注釈:

     "str" のファイル名を "bytes" にエンコードするには、"fsencode()"
     を使用してください。

   参考:

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

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

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

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

   バージョン 3.15 で変更: "os.listdir(-1)" は現在のディレクトリを列挙
   せず、"OSError(errno.EBADF)" で失敗するようになりました。

os.listdrives()

   Windows システムのドライブ名を含むリストを返します。

   ドライブ名は通常 "'C:\\'" のような形式です。 すべてのドライブ名にボ
   リュームが対応しているとは限らず、アクセス権、ネットワーク接続、メ
   ディアの未挿入など、さまざまな理由でアクセスできないものもあります
   。 この関数はアクセスできるかどうかを確認しません。

   ドライブ名の取得中にエラーが発生すると、"OSError" を送出する場合が
   あります。

   引数なしの 監査イベント "os.listdrives" を発生させます。

   利用可能な環境: Windows

   Added in version 3.12.

os.listmounts(volume)

   Windows システムのボリュームのマウントポイントを含むリストを返しま
   す。

   *volume* は "os.listvolumes()" が返すような GUID パスで指定する必要
   があります。 ボリュームは複数の場所にマウントされている場合も、どこ
   にもマウントされていない場合もあります。 後者の場合、リストは空にな
   ります。 この関数は、ボリュームに対応していないマウントポイントを返
   しません。

   この関数が返すマウントポイントは絶対パスであり、ドライブ名より長い
   場合があります。

   ボリュームを認識できない場合や、パスの取得中にエラーが発生した場合
   、"OSError" を送出します。

   "volume" を引数とする 監査イベント "os.listmounts" を発生させます。

   利用可能な環境: Windows

   Added in version 3.12.

os.listvolumes()

   システムのボリュームを含むリストを返します。

   ボリュームは通常 "\\?\Volume{xxxxxxxx-xxxx-xxxx-xxxx-
   xxxxxxxxxxxx}\" のような GUID パスで表されます。 通常、アクセス権が
   あれば GUID パスでファイルにアクセスできます。 ただし、ユーザーには
   一般になじみがないため、この関数の結果を "os.listmounts()" に渡して
   マウントポイントを取得する使い方を推奨します。

   ボリュームの取得中にエラーが発生すると、"OSError" を送出する場合が
   あります。

   引数なしの 監査イベント "os.listvolumes" を発生させます。

   利用可能な環境: Windows

   Added in version 3.12.

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 で変更: Windows では、シンボリックリンクやディレクト
   リジャンクションなど、別のパスを表すリパースポイント (名前代理) を
   開くようになりました。 それ以外の種類のリパースポイントは、"stat()"
   と同様に OS が解決します。

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

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

   ディレクトリがすでに存在する場合は "FileExistsError" を送出します。
   パス中の親ディレクトリが存在しない場合は "FileNotFoundError" を送出
   します。

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

   Windows では *mode* が "0o700" の場合を特別に扱い、新しいディレクト
   リに現在のユーザーと管理者のみがアクセスできるようにアクセス制御を
   設定します。 それ以外の *mode* の値は無視します。

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

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

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

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

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

   バージョン 3.13 で変更: Windows で *mode* が "0o700" の場合に対応し
   ました。

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

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

   *mode* 引数は、末端ディレクトリを作成する "mkdir()" に渡されます。
   解釈方法については mkdir() の説明 を参照してください。 新しく作成す
   る親ディレクトリのアクセス権ビットを設定するには、"makedirs()" を呼
   び出す前に umask を設定できます。 既存の親ディレクトリのアクセス権
   ビットは変更されません。

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

   *parent_mode* が "None" でない場合、新しく作成する中間ディレクトリ
   のモードに使用されます。 *mode* と同様、プロセスの umask 値と組み合
   わせて適用します。 mkdir() の説明 を参照してください。 それ以外の場
   合、中間ディレクトリはデフォルトのモードで作成され、これにも umask
   が適用されます。

   注釈:

     作成するパス要素に "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 で変更: *mode* 引数は、新しく作成する中間ディレクト
   リのアクセス権ビットに影響しなくなりました。

   Added in version 3.15: *parent_mode* 引数を追加しました。 Python
   3.6 以前の動作 (作成するすべてのディレクトリに *mode* を適用) に合
   わせるには、"parent_mode=mode" を渡してください。

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

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

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

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

   利用可能な環境: Unix, not WASI.

   バージョン 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" のいずれかとビット単
   位 OR で組み合わせます。 "stat.S_IFCHR" と "stat.S_IFBLK" の場合、
   *device* は作成するデバイス特殊ファイルを指定します (通常は
   "os.makedev()" で値を作ります)。 それ以外の場合、*device* は無視さ
   れます。

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

   利用可能な環境: Unix, not WASI.

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

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

os.major(device, /)

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

os.minor(device, /)

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

os.makedev(major, minor, /)

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

os.NODEV

   存在しないデバイス。

   Added in version 3.15.

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)" を使って絶対パスに変
   換することができます。

   *path* が文字列オブジェクトの場合 ("PathLike" インターフェースを介
   する場合も含む)、結果も文字列オブジェクトになり、
   "UnicodeDecodeError" が送出される場合があります。 *path* が直接また
   は間接的にバイト列オブジェクトである場合、結果もバイト列オブジェク
   トになります。

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

   リンクを含む可能性があるパスを解決するには、"realpath()" を使用して
   ください。 再帰的なリンクやプラットフォームの違いを適切に処理できま
   す。

   利用可能な環境: 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 オブ
   ジェクトを受け入れるようになりました。ディレクトリジャンクションを
   サポートしました。 また、以前返していた省略可能な "print name" フィ
   ールドではなく、通常 "\\?\" プレフィックスを含む置換パスを返すよう
   になりました。

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

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

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

   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)

   ファイルまたはディレクトリ *src* の名前を *dst* に変更します。
   *dst* が存在する場合、次のような状況で "OSError" のサブクラスを送出
   して失敗します。

   Windows では、*dst* が存在すると常に "FileExistsError" を送出します
   。 *src* と *dst* が異なるファイルシステム上にある場合は失敗するこ
   とがあります。 別のファイルシステムへの移動には "shutil.move()" を
   使用してください。

   Unix では、*src* がファイルで *dst* がディレクトリの場合は
   "IsADirectoryError"、逆の場合は "NotADirectoryError" を送出します。
   両方がディレクトリで *dst* が空の場合は、*dst* を警告なく置き換えま
   す。 *dst* が空でないディレクトリの場合は "OSError" を送出します。
   両方がファイルで、ユーザーに権限がある場合は、*dst* を警告なく置き
   換えます。 一部の Unix では、*src* と *dst* が異なるファイルシステ
   ム上にあると失敗することがあります。 成功した場合、名前の変更はアト
   ミックな操作になります (POSIX の要件です)。

   この関数は *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" を送出します。

   Added in version 3.3.

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

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

   ディレクトリ *path* を削除します。 ディレクトリが存在しない場合は
   "FileNotFoundError"、空でない場合は "OSError" を送出します。 ディレ
   クトリツリー全体を削除するには "shutil.rmtree()" を使用できます。

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

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

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

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

os.scandir(path='.')

   *path* で指定されたディレクトリのエントリに対応する "os.DirEntry"
   オブジェクトのイテレータを返します。 エントリは任意の順序で yield
   され、特別なエントリ "'.'" と "'..'" は含まれません。 イテレータの
   作成後にディレクトリ内のファイルが削除または追加された場合、そのフ
   ァイルのエントリが含まれるかどうかは未規定です。

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

   *path* には *path-like オブジェクト* を指定できます。 *path* が直接
   または "PathLike" インターフェースを介して "bytes" 型である場合、各
   "os.DirEntry" の "name" と "path" 属性も "bytes" 型になります。 そ
   れ以外の場合は "str" 型になります。

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

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

   "scandir()" イテレータを複数のスレッドで共有しても、イテレータは破
   損しませんが、*競合状態* の影響を受けます。 各スレッドがどのエント
   リを受け取るかは未規定です。 また、別のスレッドが反復中にイテレータ
   を閉じると、その反復は途中で終了します。

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

   scandir.close()

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

      イテレータを *使い切った* とき、ガベージコレクションされたとき、
      または反復中にエラーが発生したときに自動的に呼び出されます。 た
      だし、明示的に呼び出すか、"with" 文を使うことを推奨します。

      Added in version 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.

   Added in version 3.5.

   バージョン 3.6 で変更: *コンテキストマネージャ* プロトコルと
   "close()" メソッドをサポートしました。 "scandir()" イテレータを使い
   切らず、明示的にも閉じなかった場合、デストラクタで
   "ResourceWarning" が発生します。関数が *path-like object* を受け入
   れるようになりました。

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

   バージョン 3.15 で変更: "os.scandir(-1)" は現在のディレクトリを列挙
   せず、"OSError(errno.EBADF)" で失敗するようになりました。

class os.DirEntry

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

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

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

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

   *path-like オブジェクト* として直接使用できるように、"os.DirEntry"
   は "PathLike" インターフェースを実装しています。

   "DirEntry" オブジェクトは、パスの型 ("str" または "bytes") を型引数
   とする ジェネリック です。

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

   name

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

      "scandir()" の *path* 引数が "bytes" 型の場合、"name" 属性も
      "bytes" になり、それ以外の場合は "str" になります。 バイト列のフ
      ァイル名をデコードするには "fsdecode()" を使用してください。

   path

      エントリのパス名です。 元の "scandir()" の *path* 引数を
      *scandir_path* とすると、"os.path.join(scandir_path,
      entry.name)" と同等です。 ファイル名を除く部分は、元の
      "scandir()" の引数をそのまま保持します。 "scandir()" の *path*
      引数が相対パスの場合、"path" 属性も相対パスになります。
      "scandir()" イテレータの作成後に現在の作業ディレクトリを変更する
      と、後で "path" を使った際に別の場所に解決される場合があります。
      プラットフォームによっては、元の "scandir()" の引数が列挙には使
      えてもエントリ名との結合には使えず、構築されたパスが無効になる場
      合があります。 "scandir()" の *path* 引数が ファイル記述子 の場
      合、"path" 属性は "name" 属性と同じです。

      "scandir()" の *path* 引数が "bytes" 型の場合、"path" 属性も
      "bytes" になり、それ以外の場合は "str" になります。 バイト列のフ
      ァイル名をデコードするには "fsdecode()" を使用してください。

   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" は捕捉され送出されません。

   is_junction()

      このエントリがジャンクションである場合は、リンク先が存在しなくて
      も "True" を返します。 通常のディレクトリ、何らかのファイル、シ
      ンボリックリンクを指す場合や、すでに存在しない場合は "False" を
      返します。

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

      Added in version 3.12.

   stat(*, follow_symlinks=True)

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

      Unix では、このメソッドは常にシステムコールを必要とします。
      Windows では、*follow_symlinks* が "True" で、エントリがリパース
      ポイント (シンボリックリンクやディレクトリジャンクションなど) の
      場合にのみシステムコールが必要です。

      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()"、"is_junction()"、"stat()" メソッドは同じ意味を持ち
   ます。

   Added in version 3.5.

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

   バージョン 3.12 で変更: Windows では stat 結果の "st_ctime" 属性が
   非推奨です。 ファイルの作成時刻を取得する正しい属性は
   "st_birthtime" であり、将来 "st_ctime" は 0、または取得可能ならメタ
   データの変更時刻を返すように変わる可能性があります。

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

   ファイルまたはファイル記述子の状態を取得します。 指定したパスに対し
   、"stat()" システムコールと同等の操作を行います。 *path* は、直接ま
   たは "PathLike" インターフェースを介した文字列やバイト列、あるいは
   開いているファイル記述子で指定できます。 "stat_result" オブジェクト
   を返します。

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

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

   Windows では、"follow_symlinks=False" を渡すと、シンボリックリンク
   やディレクトリジャンクションを含むすべての名前代理リパースポイント
   をたどらなくなります。 リンクに相当しない種類のリパースポイントや、
   OS がたどれないリパースポイントは直接開きます。 複数のリンクをたど
   る場合、最後までたどれなくなった原因のリンク以外の対象ではなく、元
   のリンクの情報が返ることがあります。 この場合に最後のパスの stat 結
   果を取得するには、"os.path.realpath()" で可能な限りパス名を解決し、
   その結果に "lstat()" を適用してください。 リンク先が存在しないシン
   ボリックリンクやジャンクションポイントではこの動作は適用されず、通
   常の例外が送出されます。

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

      >>> 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 で変更: Windows では、OS が解決できるすべてのリパー
   スポイントをたどるようになり、"follow_symlinks=False" を渡すとすべ
   ての名前代理リパースポイントをたどらなくなりました。 OS がたどれな
   いリパースポイントに達した場合、*stat* はエラーを送出せず、
   "follow_symlinks=False" を指定した場合と同様に元のパスの情報を返す
   ようになりました。

class os.stat_result

   属性がおおむね "stat" 構造体のメンバーに対応するオブジェクトです。
   "os.stat()"、"os.fstat()"、"os.lstat()" の結果として使われます。

   属性:

   st_mode

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

   st_ino

      プラットフォームに依存しますが、0 でなければ、同じ "st_dev" の値
      を持つファイルの中でそのファイルを一意に識別します。 一般的には
      次の値です。

      * Unix では inode 番号。

      * Windows では ファイルインデックス。

   st_dev

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

   st_nlink

      ハードリンクの数。

   st_uid

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

   st_gid

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

   st_size

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

   タイムスタンプ:

   st_atime

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

   st_mtime

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

   st_ctime

      秒で表したメタデータの最終変更時刻。

      バージョン 3.12 で変更: Windows では "st_ctime" は非推奨です。
      ファイルの作成時刻には "st_birthtime" を使用してください。 将来
      、"st_ctime" は他のプラットフォームと同様にメタデータの最終変更
      時刻を表すようになります。

   st_atime_ns

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

      Added in version 3.3.

   st_mtime_ns

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

      Added in version 3.3.

   st_ctime_ns

      ナノ秒の整数で表したメタデータの最終変更時刻。

      Added in version 3.3.

      バージョン 3.12 で変更: "st_ctime_ns" is deprecated on Windows.
      Use "st_birthtime_ns" for the file creation time. In the future,
      "st_ctime" will contain the time of the most recent metadata
      change, as for other platforms.

   st_birthtime

      秒で表したファイルの作成時刻。 この属性は常に利用できるとは限ら
      ず、"AttributeError" が送出される場合があります。

      バージョン 3.12 で変更: Windows で "st_birthtime" が利用できるよ
      うになりました。

   st_birthtime_ns

      ナノ秒の整数で表したファイルの作成時刻。 この属性は常に利用でき
      るとは限らず、"AttributeError" が送出される場合があります。

      Added in version 3.12.

   注釈:

     "st_atime"、"st_mtime"、"st_ctime"、"st_birthtime" 属性の正確な意
     味と分解能は、OS とファイルシステムによって異なります。 例えば、
     FAT32 ファイルシステムを使う Windows システムでは、"st_mtime" の
     分解能は 2 秒、"st_atime" は 1 日です。 詳しくは OS のドキュメン
     トを参照してください。同様に、"st_atime_ns"、"st_mtime_ns"、
     "st_ctime_ns"、"st_birthtime_ns" は常にナノ秒で表されますが、多く
     のシステムはナノ秒の精度を提供しません。 ナノ秒の精度を提供するシ
     ステムでも、"st_atime"、"st_mtime"、"st_ctime"、"st_birthtime" を
     格納する浮動小数点数ではその精度をすべて保持できず、わずかに不正
     確になります。 正確なタイムスタンプが必要な場合は、常に
     "st_atime_ns"、"st_mtime_ns"、"st_ctime_ns"、"st_birthtime_ns" を
     使用してください。

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

   st_blocks

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

   st_blksize

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

   st_rdev

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

   st_flags

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

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

   st_gen

      ファイル生成番号

   Solaris とその派生システムでは、次の属性も利用できる場合があります
   。

   st_fstype

      ファイルが置かれたファイルシステムの種類を一意に識別する文字列。

   macOS システムでは、次の属性も利用できる場合があります。

   st_rsize

      ファイルの実際のサイズ

   st_creator

      ファイルの作成者

   st_type

      ファイルタイプ

   Windows システムでは、次の属性も利用できます。

   st_file_attributes

      Windows のファイル属性です。 "GetFileInformationByHandle()" が返
      す "BY_HANDLE_FILE_INFORMATION" 構造体の "dwFileAttributes" メン
      バーに対応します。 "stat" モジュールの "FILE_ATTRIBUTE_*
      <stat.FILE_ATTRIBUTE_ARCHIVE>" 定数を参照してください。

      Added in version 3.5.

   st_reparse_tag

      "st_file_attributes" に "FILE_ATTRIBUTE_REPARSE_POINT" が設定さ
      れている場合、このフィールドにはリパースポイントの種類を識別する
      タグが入ります。 "stat" モジュールの "IO_REPARSE_TAG_*" 定数を参
      照してください。

   標準モジュール "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.5 で変更: Windows では、取得可能な場合に "st_ino" とし
   てファイルインデックスを返すようになりました。

   バージョン 3.7 で変更: Solaris とその派生システムに "st_fstype" メ
   ンバーを追加しました。

   バージョン 3.8 で変更: Windows に "st_reparse_tag" メンバーを追加し
   ました。

   バージョン 3.8 で変更: Windows では、"st_mode" メンバーが特殊ファイ
   ルを適切に "S_IFCHR"、"S_IFIFO"、"S_IFBLK" として識別するようになり
   ました。

   バージョン 3.12 で変更: Windows では "st_ctime" が非推奨になりまし
   た。 他のプラットフォームと揃えるため、将来はメタデータの最終変更時
   刻を表すようになりますが、現在は引き続き作成時刻を表します。 作成時
   刻には "st_birthtime" を使用してください。Windows では、ファイルシ
   ステムによって "st_ino" が最大 128 ビットになる場合があります。 以
   前は最大 64 ビットで、それより大きなファイル識別子は独自の方法で詰
   め込まれていました。Windows では、"st_rdev" は値を返さなくなりまし
   た。 以前は誤って "st_dev" と同じ値が入っていました。Windows に
   "st_birthtime" メンバーを追加しました。

os.statx(path, mask, *, flags=0, dir_fd=None, follow_symlinks=True)

   指定したパスに対して "statx()" システムコールを行い、ファイルまたは
   ファイル記述子の状態を取得します。

   *path* は *path-like オブジェクト* または開いているファイル記述子で
   す。 *mask* は、取得する情報を指定するモジュールレベルの "STATX_*"
   定数の組み合わせです。 *flags* は、モジュールレベルの "AT_STATX_*"
   定数や "AT_NO_AUTOMOUNT" の組み合わせです。 "statx_result" オブジェ
   クトを返し、その "stx_mask" 属性が実際に取得された情報を示します (
   これは *mask* と異なる場合があります)。

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

   参考: *statx(2)* のマニュアルページ。

   利用可能な環境: Linux >= 4.11 with glibc >= 2.28.

   Added in version 3.15.

class os.statx_result

   "os.statx()" が返すファイルの情報です。

   "statx_result" は次の属性を持ちます。

   stx_atime

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

      "stx_mask" に "STATX_ATIME" が含まれない場合は "None" です。

   stx_atime_ns

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

      "stx_mask" に "STATX_ATIME" が含まれない場合は "None" です。

   stx_atomic_write_segments_max

      書き込みが部分的に反映されること (torn write) を防ぐ保護付き直接
      I/O で使える iovec の最大数。

      "stx_mask" に "STATX_WRITE_ATOMIC" が含まれない場合は "None" で
      す。

      利用可能な環境: Linux >= 4.11 with glibc >= 2.28 and build-time
      kernel userspace API headers >= 6.11.

   stx_atomic_write_unit_max

      書き込みが部分的に反映されること (torn write) を防ぐ保護付き直接
      I/O の最大サイズ。

      "stx_mask" に "STATX_WRITE_ATOMIC" が含まれない場合は "None" で
      す。

      利用可能な環境: Linux >= 4.11 with glibc >= 2.28 and build-time
      kernel userspace API headers >= 6.11.

   stx_atomic_write_unit_max_opt

      書き込みが部分的に反映されること (torn write) を防ぐ保護付き直接
      I/O で、最適化される最大サイズ。

      "stx_mask" に "STATX_WRITE_ATOMIC" が含まれない場合は "None" で
      す。

      利用可能な環境: Linux >= 4.11 with glibc >= 2.28 and build-time
      kernel userspace API headers >= 6.16.

   stx_atomic_write_unit_min

      書き込みが部分的に反映されること (torn write) を防ぐ保護付き直接
      I/O の最小サイズ。

      "stx_mask" に "STATX_WRITE_ATOMIC" が含まれない場合は "None" で
      す。

      利用可能な環境: Linux >= 4.11 with glibc >= 2.28 and build-time
      kernel userspace API headers >= 6.11.

   stx_attributes

      このファイルの属性を指定する "STATX_ATTR_*" 定数のビットマスク。

   stx_attributes_mask

      "stx_attributes" のどのビットを VFS とファイルシステムがサポート
      しているかを示すマスク。

   stx_blksize

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

   stx_blocks

      ファイルに割り当てられた 512 バイトブロックの数。 ファイルにホー
      ルがある場合、"stx_size"/512 より小さいことがあります。

      "stx_mask" に "STATX_BLOCKS" が含まれない場合は "None" です。

   stx_btime

      秒で表したファイルの作成時刻。

      "stx_mask" に "STATX_BTIME" が含まれない場合は "None" です。

   stx_btime_ns

      ナノ秒の整数で表したファイルの作成時刻。

      "stx_mask" に "STATX_BTIME" が含まれない場合は "None" です。

   stx_ctime

      秒で表したメタデータの最終変更時刻。

      "stx_mask" に "STATX_CTIME" が含まれない場合は "None" です。

   stx_ctime_ns

      ナノ秒の整数で表したメタデータの最終変更時刻。

      "stx_mask" に "STATX_CTIME" が含まれない場合は "None" です。

   stx_dev

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

   stx_dev_major

      このファイルが置かれたデバイスのメジャー番号。

   stx_dev_minor

      このファイルが置かれたデバイスのマイナー番号。

   stx_dio_mem_align

      直接 I/O のメモリバッファに必要なアラインメント。

      "stx_mask" に "STATX_DIOALIGN" が含まれない場合は "None" です。

      利用可能な環境: Linux >= 4.11 with glibc >= 2.28 and build-time
      kernel userspace API headers >= 6.1.

   stx_dio_offset_align

      直接 I/O のファイルオフセットに必要なアラインメント。

      "stx_mask" に "STATX_DIOALIGN" が含まれない場合は "None" です。

      利用可能な環境: Linux >= 4.11 with glibc >= 2.28 and build-time
      kernel userspace API headers >= 6.1.

   stx_dio_read_offset_align

      直接 I/O の読み取りで、ファイルオフセットに必要なアラインメント
      。

      "stx_mask" に "STATX_DIO_READ_ALIGN" が含まれない場合は "None"
      です。

      利用可能な環境: Linux >= 4.11 with glibc >= 2.28 and build-time
      kernel userspace API headers >= 6.14.

   stx_gid

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

      "stx_mask" に "STATX_GID" が含まれない場合は "None" です。

   stx_ino

      Iノード番号。

      "stx_mask" に "STATX_INO" が含まれない場合は "None" です。

   stx_mask

      取得された情報を示す "STATX_*" 定数のビットマスク。 要求した情報
      とは異なる場合があります。

   stx_mnt_id

      マウント識別子。

      "stx_mask" に "STATX_MNT_ID" が含まれない場合は "None" です。

      利用可能な環境: Linux >= 4.11 with glibc >= 2.28 and build-time
      kernel userspace API headers >= 5.8.

   stx_mode

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

      "stx_mask" に "STATX_TYPE | STATX_MODE" が含まれない場合は
      "None" です。

   stx_mtime

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

      "stx_mask" に "STATX_MTIME" が含まれない場合は "None" です。

   stx_mtime_ns

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

      "stx_mask" に "STATX_MTIME" が含まれない場合は "None" です。

   stx_nlink

      ハードリンクの数。

      "stx_mask" に "STATX_NLINK" が含まれない場合は "None" です。

   stx_rdev

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

   stx_rdev_major

      このファイルが表すデバイスのメジャー番号。

   stx_rdev_minor

      このファイルが表すデバイスのマイナー番号。

   stx_size

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

      "stx_mask" に "STATX_SIZE" が含まれない場合は "None" です。

   stx_subvol

      サブボリューム識別子。

      "stx_mask" に "STATX_SUBVOL" が含まれない場合は "None" です。

      利用可能な環境: Linux >= 4.11 with glibc >= 2.28 and build-time
      kernel userspace API headers >= 6.10.

   stx_uid

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

      "stx_mask" に "STATX_UID" が含まれない場合は "None" です。

   参考: *statx(2)* のマニュアルページ。

   利用可能な環境: Linux >= 4.11 with glibc >= 2.28.

   Added in version 3.15.

os.STATX_TYPE
os.STATX_MODE
os.STATX_NLINK
os.STATX_UID
os.STATX_GID
os.STATX_ATIME
os.STATX_MTIME
os.STATX_CTIME
os.STATX_INO
os.STATX_SIZE
os.STATX_BLOCKS
os.STATX_BASIC_STATS
os.STATX_BTIME
os.STATX_MNT_ID
os.STATX_DIOALIGN
os.STATX_MNT_ID_UNIQUE
os.STATX_SUBVOL
os.STATX_WRITE_ATOMIC
os.STATX_DIO_READ_ALIGN

   "os.statx()" の *mask* 引数で使用するビットフラグです。
   "statx_result" の対応するメンバーが利用できない場合でも、これらのフ
   ラグの一部は利用できる場合があります。

   利用可能な環境: Linux >= 4.11 with glibc >= 2.28.

   Added in version 3.15.

os.AT_STATX_FORCE_SYNC

   "os.statx()" 関数で使うフラグです。 ネットワークファイルシステム上
   のファイルでサーバーとの通信の往復が必要になるなど、コストが大きい
   場合でも、カーネルに最新の情報を返すよう要求します。

   利用可能な環境: Linux >= 4.11 with glibc >= 2.28.

   Added in version 3.15.

os.AT_STATX_DONT_SYNC

   "os.statx()" 関数で使うフラグです。 可能であれば、キャッシュされた
   情報を返すようカーネルに要求します。

   利用可能な環境: Linux >= 4.11 with glibc >= 2.28.

   Added in version 3.15.

os.AT_STATX_SYNC_AS_STAT

   "os.statx()" 関数で使うフラグです。 このフラグは "0" として定義され
   ているため効果はありませんが、"AT_STATX_FORCE_SYNC" と
   "AT_STATX_DONT_SYNC" のどちらも渡していないことを明示できます。 他
   の 2 つのフラグがなければ、通常、カーネルは "os.stat()" と同程度に
   新しい情報を返します。

   利用可能な環境: Linux >= 4.11 with glibc >= 2.28.

   Added in version 3.15.

os.AT_NO_AUTOMOUNT

   パスの最後の要素が自動マウントポイントの場合、自動マウントを実行せ
   ず、マウントポイント自体を操作します。 Linux では "os.stat()"、
   "os.fstat()"、"os.lstat()" は常にこの動作をします。

   利用可能な環境: Linux.

   Added in version 3.15.

os.statvfs(path)

   指定したパスに対し、*statvfs(3)* システムコールを行います。 戻り値
   は "statvfs_result" で、その属性は指定したパスのファイルシステムを
   記述し、"statvfs" 構造体のメンバーに対応します。

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

   利用可能な環境: Unix.

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

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

class os.statvfs_result

   "os.statvfs()" と "os.fstatvfs()" が返すファイルシステムの統計情報
   です。 詳しくは *statvfs(3)* を参照してください。

   f_bsize

      ブロックサイズ。

   f_frsize

      フラグメントサイズ。

   f_blocks

      ファイルシステムに格納できる、サイズ "f_frsize" のブロックの数。

   f_bfree

      空きブロック数。

   f_bavail

      非特権ユーザーが使用できる空きブロック数。

   f_files

      ファイルシステムに格納できるファイルエントリ (inode) の数。

   f_ffree

      空きファイルエントリ数。

   f_favail

      非特権ユーザーが使用できる空きファイルエントリ数。

   f_flag

      マウントフラグのビットマスク。 "ST_RDONLY"、"ST_NOSUID"、
      "ST_NODEV"、"ST_NOEXEC"、"ST_SYNCHRONOUS"、"ST_MANDLOCK"、
      "ST_WRITE"、"ST_APPEND"、"ST_IMMUTABLE"、"ST_NOATIME"、
      "ST_NODIRATIME"、"ST_RELATIME" が定義されています。

   f_namemax

      ファイルシステムのファイル名の最大長。 Windows MAX_PATH や Linux
      の *pathname(7)* に記載された制限など、OS 固有の制限がある場合が
      あります。

   f_fsid

      ファイルシステム ID。

      Added in version 3.7.

次のフラグは "statvfs_result.f_flag" で使用します。

os.ST_RDONLY

   読み取り専用のファイルシステム。

   Added in version 3.2.

os.ST_NOSUID

   setuid/setgid ビットが無効、またはサポートされていません。

   Added in version 3.2.

os.ST_NODEV

   デバイス特殊ファイルへのアクセスを禁止します。

   利用可能な環境: Linux.

   Added in version 3.4.

os.ST_NOEXEC

   プログラムの実行を禁止します。

   利用可能な環境: Linux.

   Added in version 3.4.

os.ST_SYNCHRONOUS

   書き込みを即座に同期します。

   利用可能な環境: Linux.

   Added in version 3.4.

os.ST_MANDLOCK

   ファイルシステムで強制ロックを許可します。

   利用可能な環境: Linux.

   Added in version 3.4.

os.ST_WRITE

   ファイル、ディレクトリ、シンボリックリンクへの書き込み。

   利用可能な環境: Linux.

   Added in version 3.4.

os.ST_APPEND

   追記専用ファイル。

   利用可能な環境: Linux.

   Added in version 3.4.

os.ST_IMMUTABLE

   変更不可のファイル。

   利用可能な環境: Linux.

   Added in version 3.4.

os.ST_NOATIME

   アクセス時刻を更新しません。

   利用可能な環境: Linux.

   Added in version 3.4.

os.ST_NODIRATIME

   ディレクトリのアクセス時刻を更新しません。

   利用可能な環境: Linux.

   Added in version 3.4.

os.ST_RELATIME

   mtime/ctime に応じて atime を更新します。

   利用可能な環境: Linux.

   Added in version 3.4.

os.supports_dir_fd

   "os" モジュールの関数のうち、*dir_fd* 引数に開いているファイル記述
   子を受け付けるものを示す "set" オブジェクトです。 プラットフォーム
   ごとに提供される機能は異なり、Python が *dir_fd* 引数の実装に使用す
   る機能は、Python がサポートするすべてのプラットフォームで利用できる
   わけではありません。 一貫性のため、*dir_fd* をサポートする可能性の
   ある関数は常にこの引数の指定を受け付けますが、その環境で利用できな
   い機能を使うと例外を送出します。 ただし、*dir_fd* に "None" を指定
   することは、すべてのプラットフォームで常にサポートされます。

   特定の関数が *dir_fd* 引数に開いているファイル記述子を受け付けるか
   どうかは、"supports_dir_fd" に "in" 演算子を使って調べられます。 例
   えば、現在のプラットフォームで "os.stat()" が *dir_fd* に開いている
   ファイル記述子を受け付ける場合、次の式は "True" になります。

      os.stat in os.supports_dir_fd

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

   Added in version 3.3.

os.supports_effective_ids

   現在のプラットフォームで、"os.access()" の *effective_ids* 引数に
   "True" を指定できるかを示す "set" オブジェクトです。
   *effective_ids* に "False" を指定することは、すべてのプラットフォー
   ムで常にサポートされます。 現在のプラットフォームが対応していれば、
   この集合に "os.access()" が含まれ、それ以外の場合は空になります。

   現在のプラットフォームで "os.access()" が "effective_ids=True" をサ
   ポートしていれば、次の式は "True" になります。

      os.access in os.supports_effective_ids

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

   Added in version 3.3.

os.supports_fd

   現在のプラットフォームで、"os" モジュールの関数のうち *path* 引数に
   開いているファイル記述子を指定できるものを示す "set" オブジェクトで
   す。 プラットフォームごとに提供される機能は異なり、Python がファイ
   ル記述子を *path* 引数として受け付けるために使用する機能は、Python
   がサポートするすべてのプラットフォームで利用できるわけではありませ
   ん。

   特定の関数が *path* 引数に開いているファイル記述子を受け付けるかど
   うかは、"supports_fd" に "in" 演算子を使って調べられます。 例えば、
   現在のプラットフォームで "os.chdir()" が *path* に開いているファイ
   ル記述子を受け付ける場合、次の式は "True" になります。

      os.chdir in os.supports_fd

   Added in version 3.3.

os.supports_follow_symlinks

   現在のプラットフォームで、"os" モジュールの関数のうち
   *follow_symlinks* 引数に "False" を受け付けるものを示す "set" オブ
   ジェクトです。 プラットフォームごとに提供される機能は異なり、Python
   が *follow_symlinks* の実装に使用する機能は、Python がサポートする
   すべてのプラットフォームで利用できるわけではありません。 一貫性のた
   め、*follow_symlinks* をサポートする可能性のある関数は常にこの引数
   の指定を受け付けますが、その環境で利用できない機能を使うと例外を送
   出します。 ただし、*follow_symlinks* に "True" を指定することは、す
   べてのプラットフォームで常にサポートされます。

   特定の関数が *follow_symlinks* 引数に "False" を受け付けるかどうか
   は、"supports_follow_symlinks" に "in" 演算子を使って調べられます。
   例えば、現在のプラットフォームで "os.stat()" を呼び出す際に
   "follow_symlinks=False" を指定できる場合、次の式は "True" になりま
   す。

      os.stat in os.supports_follow_symlinks

   Added in version 3.3.

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

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

   *src* 引数はリンク先のファイルやディレクトリを指し、*dst* は作成す
   るリンクの名前です。

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

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

   注釈:

     新しいバージョンの Windows 10 では、開発者モードが有効であれば、
     特権のないアカウントでもシンボリックリンクを作成できます。 開発者
     モードが利用できないか無効の場合は、
     *SeCreateSymbolicLinkPrivilege* 特権を持つか、管理者としてプロセ
     スを実行する必要があります。この関数が特権を持たないユーザーに呼
     び出されると、"OSError" が送出されます。

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

   利用可能な環境: Unix, Windows.

   WASI ではこの関数に制限があります。 詳しくは WebAssembly プラットフ
   ォーム を参照してください。

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

   バージョン 3.3 で変更: *dir_fd* 引数を追加し、Windows 以外のプラッ
   トフォームでも *target_is_directory* を指定できるようになりました。

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

   バージョン 3.8 で変更: Windows の開発者モードで、昇格なしでのシンボ
   リックリンクの作成をサポートしました。

os.sync()

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

   利用可能な環境: Unix.

   Added in version 3.3.

os.truncate(path, length)

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

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

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

   利用可能な環境: Unix, Windows.

   Added in version 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" でない場合、秒を表す実数を 2 つ含む "(atime,
     mtime)" 形式のタプルでなければなりません。 時刻はナノ秒単位で切り
     捨てられます。

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

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

   ここで設定した時刻が、後に "stat()" の呼び出し時正確に返されない場
   合があります。これはオペレーティングシステムが記録するアクセスおよ
   び修正時刻の精度に依存しています; "stat()" を参照してください。正確
   な時刻を保持する最善の方法は、"utime()" で *ns* 引数を指定し、
   "os.stat()" の返り値オブジェクトから *st_atime_ns* および
   *st_mtime_ns* フィールドを使用することです。

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

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

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

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

   バージョン 3.15 で変更: *times* に整数や浮動小数点数だけでなく、任
   意の実数を受け付けるようになりました。

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

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

   *dirpath* はディレクトリへのパスを表す文字列です。 *dirnames* は
   *dirpath* 内のサブディレクトリ名のリストで、ディレクトリへのシンボ
   リックリンクを含み、"'.'" と "'..'" は含みません。 *filenames* は
   *dirpath* 内のディレクトリ以外のファイル名のリストです。 リスト内の
   名前にはパスの構成要素は含まれません。 *dirpath* 内のファイルやディ
   レクトリの完全なパス (*top* で始まるパス) を得るには、
   "os.path.join(dirpath, name)" を使用します。 リストがソートされるか
   どうかはファイルシステムによって異なります。 リストの生成中に
   *dirpath* ディレクトリ内のファイルが削除または追加された場合、その
   ファイル名が含まれるかどうかは未規定です。

   オプション引数 *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()" はカレントディレク
     トリを変更しませんし、呼び出し側もカレントディレクトリを変更しな
     いと仮定しています。

   次の例は、開始ディレクトリの下にある各ディレクトリについて、ディレ
   クトリ以外のファイルが占めるバイト数を表示します。 ただし、
   "__pycache__" サブディレクトリの中は調べません。

      import os
      from os.path import join, getsize
      for root, dirs, files in os.walk('python/Lib/xml'):
          print(root, "consumes", end=" ")
          print(sum(getsize(join(root, name)) for name in files), end=" ")
          print("bytes in", len(files), "non-directory files")
          if '__pycache__' in dirs:
              dirs.remove('__pycache__')  # __pycache__ ディレクトリは走査しない

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

      # シンボリックリンクがないと仮定し、top のディレクトリ以下をすべて削除する。
      # 注意: 危険な操作です!
      # 例えば top == '/' の場合、ディスク上のすべてのファイルを削除する可能性があります。
      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.rmdir(top)

   引数 "top", "topdown", "onerror", "followlinks" を指定して 監査イベ
   ント "os.walk" を送出します。

   バージョン 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()"
     などを使って複製して使用してください。

   次の例は、開始ディレクトリの下にある各ディレクトリについて、ディレ
   クトリ以外のファイルが占めるバイト数を表示します。 ただし、
   "__pycache__" サブディレクトリの中は調べません。

      import os
      for root, dirs, files, rootfd in os.fwalk('python/Lib/xml'):
          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 '__pycache__' in dirs:
              dirs.remove('__pycache__')  # __pycache__ ディレクトリは走査しない

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

      # シンボリックリンクがないと仮定し、top のディレクトリ以下をすべて削除する。
      # 注意: 危険な操作です!
      # 例えば top == '/' の場合、ディスク上のすべてのファイルを削除する可能性があります。
      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)

   引数 "top", "topdown", "onerror", "follow_symlinks", "dir_fd" を指
   定して 監査イベント "os.fwalk" を送出します。

   利用可能な環境: Unix.

   Added in version 3.3.

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

   バージョン 3.7 で変更: "bytes" のパスをサポートしました。

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

   匿名ファイルを作成し、それを指すファイル記述子を返します。 *flags*
   は、システムで利用できる "os.MFD_*" 定数のいずれか、またはそれらを
   ビット単位 OR で組み合わせた値でなければなりません。 新しいファイル
   記述子はデフォルトで 継承不可 です。

   *name* に渡した名前はファイル名として使われ、"/proc/self/fd/" ディ
   レクトリ内の対応するシンボリックリンクのリンク先として表示されます
   。 表示される名前には常に "memfd:" が先頭に付き、デバッグのためにの
   み使われます。 名前はファイル記述子の動作に影響しないため、複数のフ
   ァイルに同じ名前を付けても副作用はありません。

   利用可能な環境: Linux >= 3.17 with glibc >= 2.27.

   Added in version 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

   これらのフラグは "memfd_create()" に渡せます。

   利用可能な環境: Linux >= 3.17 with glibc >= 2.27

   "MFD_HUGE*" フラグは Linux 4.14 以降でのみ利用できます。

   Added in version 3.8.

os.eventfd(initval[, flags=os.EFD_CLOEXEC])

   イベントファイル記述子を作成して返します。 このファイル記述子は、バ
   ッファサイズ 8 の低水準の "read()" と "write()"、"select()"、
   "poll()" などをサポートします。 詳しくは *eventfd(2)* のマニュアル
   ページを参照してください。 新しいファイル記述子はデフォルトで 継承
   不可 です。

   *initval* はイベントカウンタの初期値です。 初期値は 32 ビット符号な
   し整数でなければなりません。 イベントカウンタ自体は最大値が 2^64-2
   の 64 ビット符号なし整数ですが、初期値は 32 ビット符号なし整数に制
   限される点に注意してください。

   *flags* は "EFD_CLOEXEC"、"EFD_NONBLOCK"、"EFD_SEMAPHORE" を組み合
   わせて指定できます。

   "EFD_SEMAPHORE" が指定され、イベントカウンタが 0 でなければ、
   "eventfd_read()" は 1 を返してカウンタを 1 減らします。

   "EFD_SEMAPHORE" が指定されず、イベントカウンタが 0 でなければ、
   "eventfd_read()" は現在のカウンタ値を返してカウンタを 0 に戻します
   。

   イベントカウンタが 0 で "EFD_NONBLOCK" が指定されていなければ、
   "eventfd_read()" はブロックします。

   "eventfd_write()" はイベントカウンタを増やします。 書き込みによって
   カウンタ値が 2^64-2 を超えることになる場合、書き込みはブロックしま
   す。

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

      import os

      # 初期値 '1' のセマフォ
      fd = os.eventfd(1, os.EFD_SEMAPHORE | os.EFD_CLOEXEC)
      try:
          # セマフォを獲得する
          v = os.eventfd_read(fd)
          try:
              do_work()
          finally:
              # セマフォを解放する
              os.eventfd_write(fd, v)
      finally:
          os.close(fd)

   利用可能な環境: Linux >= 2.6.27 with glibc >= 2.8

   Added in version 3.10.

os.eventfd_read(fd)

   "eventfd()" ファイル記述子から値を読み取り、64 ビット符号なし整数を
   返します。 この関数は、*fd* が "eventfd()" であるかどうかを検証しま
   せん。

   利用可能な環境: Linux >= 2.6.27

   Added in version 3.10.

os.eventfd_write(fd, value)

   "eventfd()" ファイル記述子に値を加算します。 *value* は 64 ビット符
   号なし整数でなければなりません。 この関数は、*fd* が "eventfd()" で
   あるかどうかを検証しません。

   利用可能な環境: Linux >= 2.6.27

   Added in version 3.10.

os.EFD_CLOEXEC

   新しい "eventfd()" ファイル記述子に close-on-exec フラグを設定しま
   す。

   利用可能な環境: Linux >= 2.6.27

   Added in version 3.10.

os.EFD_NONBLOCK

   新しい "eventfd()" ファイル記述子に "O_NONBLOCK" 状態フラグを設定し
   ます。

   利用可能な環境: Linux >= 2.6.27

   Added in version 3.10.

os.EFD_SEMAPHORE

   "eventfd()" ファイル記述子からの読み取りを、セマフォのように動作さ
   せます。 読み取り時に内部カウンタを 1 減らします。

   利用可能な環境: Linux >= 2.6.30

   Added in version 3.10.


タイマーファイル記述子
----------------------

Added in version 3.13.

これらの関数は、Linux の *タイマーファイル記述子* API をサポートします
。 したがって、すべて Linux でのみ利用できます。

os.timerfd_create(clockid, /, *, flags=0)

   タイマーファイル記述子 (*timerfd*) を作成して返します。

   "timerfd_create()" が返すファイル記述子は、次の関数をサポートします
   。

   * "read()"

   * "select()"

   * "poll()"

   このファイル記述子に対しては、バッファサイズ 8 で "read()" を呼び出
   せます。 タイマーがすでに 1 回以上満了していれば、"read()" は満了し
   た回数をホストのエンディアンのバイト列で返します。 この値は
   "int.from_bytes(x, byteorder=sys.byteorder)" で "int" に変換できま
   す。

   "select()" と "poll()" を使うと、タイマーが満了してファイル記述子が
   読み取り可能になるまで待機できます。

   *clockid* は "time" モジュールで定義された、次のいずれかの有効な ク
   ロック ID でなければなりません。

   * "time.CLOCK_REALTIME"

   * "time.CLOCK_MONOTONIC"

   * "time.CLOCK_BOOTTIME" (timerfd_create では Linux 3.15 以降)

   If *clockid* is "time.CLOCK_REALTIME", a settable system-wide real-
   time clock is used. If the system clock is changed, the timer
   setting needs to be updated. To cancel the timer when the system
   clock is changed, see "TFD_TIMER_CANCEL_ON_SET".

   *clockid* が "time.CLOCK_MONOTONIC" の場合、設定変更できず、単調に
   増加するクロックを使用します。 システム時計が変更されても、タイマー
   の設定は影響を受けません。

   *clockid* が "time.CLOCK_BOOTTIME" の場合、システムがサスペンドして
   いた時間を含む点を除き、"time.CLOCK_MONOTONIC" と同じです。

   *flags* を指定すると、ファイル記述子の動作を変更できます。 次の値を
   ビット単位 OR ("|" 演算子) で組み合わせて指定できます。

   * "TFD_NONBLOCK"

   * "TFD_CLOEXEC"

   フラグに "TFD_NONBLOCK" が設定されていなければ、"read()" はタイマー
   が満了するまでブロックします。 設定されている場合、"read()" はブロ
   ックしませんが、前回の読み取り以降に満了がなければ、"read()" は
   "errno" を "errno.EAGAIN" に設定した "OSError" を送出します。

   "TFD_CLOEXEC" は常に Python が自動的に設定します。

   不要になったファイル記述子は "os.close()" で閉じる必要があります。
   閉じないとファイル記述子がリークします。

   参考: *timerfd_create(2)* のマニュアルページ。

   利用可能な環境: Linux >= 2.6.27 with glibc >= 2.8

   Added in version 3.13.

os.timerfd_settime(fd, /, *, flags=0, initial=0.0, interval=0.0)

   タイマーファイル記述子の内部タイマーを変更します。 この関数は
   "timerfd_settime_ns()" と同じインターバルタイマーを操作します。

   *fd* は有効なタイマーファイル記述子でなければなりません。

   *flags* を指定すると、タイマーの動作を変更できます。 次の値をビット
   単位 OR ("|" 演算子) で組み合わせて指定できます。

   * "TFD_TIMER_ABSTIME"

   * "TFD_TIMER_CANCEL_ON_SET"

   *initial* をゼロ ("0") に設定すると、タイマーは無効になります。
   *initial* が 0 より大きければ有効になります。 *initial* が 0 より小
   さい場合、"errno" を "errno.EINVAL" に設定した "OSError" を送出しま
   す。

   デフォルトでは、*initial* 秒が経過するとタイマーが発火します。

   ただし、"TFD_TIMER_ABSTIME" フラグが設定されている場合は、タイマー
   のクロック ("timerfd_create()" の *clockid* で設定) が *initial* 秒
   に達したときに発火します。

   タイマーの間隔は実数 *interval* で設定します。 *interval* が 0 の場
   合、タイマーは最初の満了時に 1 回だけ発火します。 *interval* が 0
   より大きい場合、前回の満了から *interval* 秒経過するたびに発火しま
   す。 *interval* が 0 より小さい場合、"errno" を "errno.EINVAL" に設
   定した "OSError" を送出します。

   "TFD_TIMER_CANCEL_ON_SET" を "TFD_TIMER_ABSTIME" とともに設定し、タ
   イマーのクロックが "time.CLOCK_REALTIME" の場合、リアルタイムクロッ
   クが不連続に変更されるとタイマーをキャンセルできるようになります。
   その場合、記述子の読み取りは "errno.ECANCELED" エラーで中断されます
   。

   Linux はシステム時計を UTC で管理します。 夏時間の切り替えは時差を
   変更するだけなので、システム時計の不連続な変更は発生しません。

   次の操作によって、システム時計の不連続な変更が発生します。

   * "settimeofday"

   * "clock_settime"

   * "date" コマンドによるシステムの日時の設定。

   この関数の実行前のタイマー状態を、"(next_expiration, interval)" の
   2 要素タプルで返します。

   参考:

     *timerfd_create(2)*、*timerfd_settime(2)*、*settimeofday(2)*、
     *clock_settime(2)*、*date(1)*。

   利用可能な環境: Linux >= 2.6.27 with glibc >= 2.8

   Added in version 3.13.

os.timerfd_settime_ns(fd, /, *, flags=0, initial=0, interval=0)

   "timerfd_settime()" と似ていますが、時刻をナノ秒で指定します。 この
   関数は "timerfd_settime()" と同じインターバルタイマーを操作します。

   利用可能な環境: Linux >= 2.6.27 with glibc >= 2.8

   Added in version 3.13.

os.timerfd_gettime(fd, /)

   浮動小数点数 2 つからなるタプル "(next_expiration, interval)" を返
   します。

   "next_expiration" は、"TFD_TIMER_ABSTIME" フラグの有無にかかわらず
   、次にタイマーが発火するまでの相対時間を表します。

   "interval" はタイマーの間隔を表します。 0 の場合、タイマーは
   "next_expiration" 秒後に 1 回だけ発火します。

   参考: *timerfd_gettime(2)*

   利用可能な環境: Linux >= 2.6.27 with glibc >= 2.8

   Added in version 3.13.

os.timerfd_gettime_ns(fd, /)

   "timerfd_gettime()" と似ていますが、時刻をナノ秒で返します。

   利用可能な環境: Linux >= 2.6.27 with glibc >= 2.8

   Added in version 3.13.

os.TFD_NONBLOCK

   "timerfd_create()" 用のフラグで、新しいタイマーファイル記述子に
   "O_NONBLOCK" 状態フラグを設定します。 "TFD_NONBLOCK" がフラグに設定
   されていなければ、"read()" はブロックします。

   利用可能な環境: Linux >= 2.6.27 with glibc >= 2.8

   Added in version 3.13.

os.TFD_CLOEXEC

   "timerfd_create()" 用のフラグです。 "TFD_CLOEXEC" を設定すると、新
   しいファイル記述子に close-on-exec フラグを設定します。

   利用可能な環境: Linux >= 2.6.27 with glibc >= 2.8

   Added in version 3.13.

os.TFD_TIMER_ABSTIME

   A flag for the "timerfd_settime()" and "timerfd_settime_ns()"
   functions. If this flag is set, *initial* is interpreted as an
   absolute value on the timer's clock (in UTC seconds or nanoseconds
   since the Unix Epoch).

   利用可能な環境: Linux >= 2.6.27 with glibc >= 2.8

   Added in version 3.13.

os.TFD_TIMER_CANCEL_ON_SET

   "TFD_TIMER_ABSTIME" とともに "timerfd_settime()" と
   "timerfd_settime_ns()" で使用するフラグです。 基になるクロックの時
   刻が不連続に変わると、タイマーがキャンセルされます。

   利用可能な環境: Linux >= 2.6.27 with glibc >= 2.8

   Added in version 3.13.


Linux 拡張属性
--------------

Added in version 3.3.

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

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

   *path* の拡張ファイルシステム属性 *attribute* の値を返します。
   *attribute* には、直接または "PathLike" インターフェースを介して
   "bytes" または "str" を指定できます。 "str" の場合、ファイルシステ
   ムエンコーディングでエンコードされます。

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

   引数 "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* を受け入れるようになりま
   した。

   バージョン 3.15 で変更: "os.listxattr(-1)" はカレントディレクトリの
   拡張属性を列挙せず、"OSError(errno.EBADF)" で失敗するようになりまし
   た。

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

   *path* からファイルシステムの拡張属性 *attribute* を削除します。
   *attribute* には bytes または str を、直接または "PathLike" インタ
   ーフェースを介して指定します。 文字列の場合は *filesystem encoding
   and error handler* でエンコードされます。

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

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

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

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

   *path* のファイルシステム拡張属性 *attribute* に *value* を設定しま
   す。 *attribute* には NUL を含まない bytes または str を、直接また
   は "PathLike" インターフェースを介して指定しなければなりません。
   str の場合は *filesystem encoding and error handler* でエンコードさ
   れます。 *flags* には "XATTR_REPLACE" または "XATTR_CREATE" を指定
   できます。 "XATTR_REPLACE" を指定して属性が存在しない場合は
   "ENODATA" が送出されます。 "XATTR_CREATE" を指定して属性がすでに存
   在する場合は、属性を作成せず "EEXISTS" が送出されます。

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

   注釈:

     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)

   DLL の検索パスにパスを追加します。

   この検索パスはインポートする拡張モジュールの依存関係の解決に使われ
   ます (モジュール自体は "sys.path" で解決されます)。 "ctypes" でも使
   われます。

   返されたオブジェクトの **close()** を呼び出すか、そのオブジェクトを
   "with" 文で使うと、ディレクトリを検索パスから削除できます。

   DLL の読み込み方法について詳しくは、Microsoft のドキュメント を参照
   してください。

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

   利用可能な環境: Windows.

   Added in version 3.8: 以前のバージョンの CPython は現在のプロセスの
   デフォルトの動作に従って DLL を解決していました。 このため、"PATH"
   やカレント作業ディレクトリを検索する場合としない場合がある、
   "AddDllDirectory" などの OS 関数が効果を持たないといった不整合が生
   じていました。3.8 では、DLL を読み込む主な 2 つの方法がプロセス全体
   の動作を明示的に上書きし、一貫性を確保するようになりました。 ライブ
   ラリの更新については 移植時の注意点 を参照してください。

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*" 関数を呼び出す
   前に "flush()" または "os.fsync()" でフラッシュしてください。

   "exec*" 関数の "l" 形式と "v" 形式は、コマンドライン引数の渡し方が
   異なります。 コードを書く時点で引数の数が決まっているなら、"l" 形式
   が最も使いやすいでしょう。 各引数をそのまま "execl*()" 関数の追加の
   引数として渡せます。 引数の数が変わる場合は "v" 形式が適しており、
   引数をリストまたはタプルにして *args* に渡します。 どちらの形式でも
   、子プロセスへの引数の先頭には実行するコマンドの名前を指定するべき
   ですが、これは強制されません。

   末尾近くに "p" が付く形式 ("execlp()"、"execlpe()"、"execvp()"、
   "execvpe()") は、環境変数 "PATH" を使ってプログラム *file* を探しま
   す。 次の段落で説明する "exec*e" 形式で環境を置き換える場合は、新し
   い環境の "PATH" 変数を使います。 それ以外の形式である "execl()"、
   "execle()"、"execv()"、"execve()" は、実行ファイルを探すために
   "PATH" 変数を使いません。 *path* には適切な絶対パスまたは相対パスを
   指定しなければなりません。 名前だけでは解決されないため、Windows で
   も相対パスにはスラッシュが少なくとも 1 つ必要です。

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

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

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

   利用可能な環境: Unix, Windows, not WASI, not Android, not iOS.

   バージョン 3.3 で変更: "execve()" の *path* に開いているファイル記
   述子を指定できるようになりました。

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

os._exit(n)

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

   注釈:

     通常の終了方法は "sys.exit(n)" です。 通常、"_exit()" は "fork()"
     後の子プロセスでのみ使ってください。

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

注釈:

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

os.EX_OK

   エラーが発生しなかったことを表す終了コードです。 一部のプラットフォ
   ームでは "EXIT_SUCCESS" の定義値を使うことがあります。 一般に値はゼ
   ロです。

   利用可能な環境: Unix, Windows.

os.EX_USAGE

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

   利用可能な環境: Unix, not WASI.

os.EX_DATAERR

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

   利用可能な環境: Unix, not WASI.

os.EX_NOINPUT

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

   利用可能な環境: Unix, not WASI.

os.EX_NOUSER

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

   利用可能な環境: Unix, not WASI.

os.EX_NOHOST

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

   利用可能な環境: Unix, not WASI.

os.EX_UNAVAILABLE

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

   利用可能な環境: Unix, not WASI.

os.EX_SOFTWARE

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

   利用可能な環境: Unix, not WASI.

os.EX_OSERR

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

   利用可能な環境: Unix, not WASI.

os.EX_OSFILE

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

   利用可能な環境: Unix, not WASI.

os.EX_CANTCREAT

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

   利用可能な環境: Unix, not WASI.

os.EX_IOERR

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

   利用可能な環境: Unix, not WASI.

os.EX_TEMPFAIL

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

   利用可能な環境: Unix, not WASI.

os.EX_PROTOCOL

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

   利用可能な環境: Unix, not WASI.

os.EX_NOPERM

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

   利用可能な環境: Unix, not WASI.

os.EX_CONFIG

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

   利用可能な環境: Unix, not WASI.

os.EX_NOTFOUND

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

   利用可能な環境: Unix, not WASI.

os.fork()

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

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

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

   警告:

     "fork()" を呼び出すアプリケーションで TLS ソケットを使う場合は、
     "ssl" のドキュメントの警告を参照してください。

   警告:

     macOS では、"urllib.request" を含む高水準のシステム API と併用す
     ると、この関数の使用は安全ではありません。

   バージョン 3.8 で変更: サブインタープリタ内での "fork()" の呼び出し
   はサポートされなくなりました ("RuntimeError" が送出されます)。

   バージョン 3.12 で変更: プロセスに複数のスレッドがあることを Python
   が検出できる場合、"os.fork()" は "DeprecationWarning" を送出するよ
   うになりました。POSIX プラットフォームが明示的にサポートしていない
   設計上の問題を開発者に知らせるため、検出できる場合には警告すること
   にしました。 動作している *ように見える* コードでも、POSIX プラット
   フォームでスレッドと "os.fork()" を併用することが安全だったわけでは
   ありません。 CPython ランタイム自体も以前から、親プロセスにスレッド
   が存在していた場合に子プロセスで使うと安全ではない API ("malloc" や
   "free" など) を呼び出しています。macOS の利用者や、これまで一般的に
   使われてきた glibc 以外の libc や malloc の実装の利用者は、このよう
   なコードを実行するとデッドロックが起こりやすい状況にすでにあります
   。この長年のプラットフォーム互換性の問題を開発者に知らせることにし
   た技術的な理由は、fork とスレッドの非互換性についての議論 を参照し
   てください。

   利用可能な環境: POSIX, not WASI, not Android, not iOS.

os.forkpty()

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

   返されるファイル記述子 *fd* は 継承不可 です。

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

   警告:

     macOS では、"urllib.request" を含む高水準のシステム API と併用す
     ると、この関数の使用は安全ではありません。

   バージョン 3.8 で変更: サブインタープリタ内での "forkpty()" の呼び
   出しはサポートされなくなりました ("RuntimeError" が送出されます)。

   バージョン 3.12 で変更: プロセスに複数のスレッドがあることを Python
   が検出できる場合、"DeprecationWarning" を送出するようになりました。
   詳しくは "os.fork()" の説明を参照してください。

   バージョン 3.15 で変更: 返されるファイル記述子が継承不可になりまし
   た。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.kill(pid, sig, /)

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

   Windows: "signal.CTRL_C_EVENT" と "signal.CTRL_BREAK_EVENT" は、同
   じコンソールウィンドウを共有するコンソールプロセス (一部のサブプロ
   セスなど) にだけ送れる特別なシグナルです。 *sig* にそれ以外の値を指
   定すると、TerminateProcess API によってプロセスが無条件に強制終了さ
   れ、終了コードが *sig* に設定されます。

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

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

   利用可能な環境: Unix, Windows, not WASI, not iOS.

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

os.killpg(pgid, sig, /)

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

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

   利用可能な環境: Unix, not WASI, not iOS.

os.nice(increment, /)

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

   利用可能な環境: Unix, not WASI.

os.pidfd_open(pid, flags=0)

   プロセス *pid* を参照し、*flags* を設定したファイル記述子を返します
   。 この記述子を使うと、競合状態を起こさず、シグナルを使わずにプロセ
   スを管理できます。

   詳しくは *pidfd_open(2)* の man ページを参照してください。

   利用可能な環境: Linux >= 5.3, Android >= "build-time" API level 31

   Added in version 3.9.

   os.PIDFD_NONBLOCK

      ファイル記述子を非ブロッキングにするフラグです。 この記述子が参
      照するプロセスがまだ終了していない場合、*waitid(2)* でこの記述子
      の待機を試みると、ブロックせずにエラー "EAGAIN" を直ちに返します
      。

   利用可能な環境: Linux >= 5.10

   Added in version 3.12.

os.plock(op, /)

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

   利用可能な環境: Unix, not WASI, not macOS, not iOS.

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

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

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

   On Unix, "waitstatus_to_exitcode()" can be used to convert the
   "close" method result (exit status) into an exit code if it is not
   "None". On Windows, the "close" method result is directly the exit
   code (or "None").

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

   利用可能な環境: not WASI, not Android, not iOS.

   注釈:

     Python UTF-8 モード は、*cmd* とパイプの内容に使われるエンコーデ
     ィングに影響します。"popen()" は "subprocess.Popen" の単純なラッ
     パーです。 エンコーディングなどのオプションを制御するには、
     "subprocess.Popen" または "subprocess.run()" を使ってください。

   バージョン 3.14 で ソフト非推奨 <Soft deprecated>: 代わりに
   "subprocess" モジュールを使うことを推奨します。

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

   C ライブラリの "posix_spawn()" API を Python から使えるようにするラ
   ッパーです。

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

   位置専用引数 *path*、*args*、*env* は "execve()" と同様です。 *env*
   には "None" も指定でき、その場合は現在のプロセスの環境を使います。

   *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)" を実行します。

   os.POSIX_SPAWN_CLOSEFROM

      ("os.POSIX_SPAWN_CLOSEFROM", *fd*)

      "os.closerange(fd, INF)" を実行します。

   これらのタプルは、"posix_spawn()" の呼び出し自体を準備するために使
   う C ライブラリの API 呼び出し "posix_spawn_file_actions_addopen()"
   、"posix_spawn_file_actions_addclose()"、
   "posix_spawn_file_actions_adddup2()"、
   "posix_spawn_file_actions_addclosefrom_np()" に対応します。

   *setpgroup* 引数は子プロセスのプロセスグループを指定した値に設定し
   ます。 0 を指定すると、子プロセスのプロセスグループ ID はそのプロセ
   ス ID と同じになります。 *setpgroup* を指定しない場合、子プロセスは
   親のプロセスグループ ID を継承します。 この引数は C ライブラリの
   "POSIX_SPAWN_SETPGROUP" フラグに対応します。

   *resetids* 引数が "True" の場合、子プロセスの実効 UID と実効 GID を
   親プロセスの実 UID と実 GID にリセットします。 "False" の場合、子プ
   ロセスは親の実効 UID と実効 GID を保持します。 どちらの場合も、実行
   ファイルの set-user-ID と set-group-ID の許可ビットが有効であれば、
   その効果が実効 UID と実効 GID の設定に優先します。 この引数は C ラ
   イブラリの "POSIX_SPAWN_RESETIDS" フラグに対応します。

   *setsid* 引数が "True" の場合、"posix_spawn" 用の新しいセッション
   ID を作成します。 *setsid* には "POSIX_SPAWN_SETSID" または
   "POSIX_SPAWN_SETSID_NP" フラグが必要です。 利用できない場合は
   "NotImplementedError" が送出されます。

   *setsigmask* 引数はシグナルマスクを指定したシグナル集合に設定します
   。 この引数を指定しない場合、子プロセスは親のシグナルマスクを継承し
   ます。 この引数は C ライブラリの "POSIX_SPAWN_SETSIGMASK" フラグに
   対応します。

   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.

   *scheduler* 引数は、スケジューリング方針 (省略可能) とスケジューリ
   ングパラメーターを持つ "sched_param" インスタンスを含むタプルでなけ
   ればなりません。 スケジューリング方針の位置に "None" を指定すると、
   方針を指定しないことを表します。 この引数は C ライブラリの
   "POSIX_SPAWN_SETSCHEDPARAM" フラグと "POSIX_SPAWN_SETSCHEDULER" フ
   ラグの組み合わせに対応します。

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

   Added in version 3.8.

   バージョン 3.13 で変更: *env* 引数に "None" を指定できるようになり
   ました。 "posix_spawn_file_actions_addclosefrom_np()" が存在するプ
   ラットフォームでは "os.POSIX_SPAWN_CLOSEFROM" を利用できます。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

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

   C ライブラリの "posix_spawnp()" API を Python から使えるようにする
   ラッパーです。

   "posix_spawn()" と同様ですが、システムが環境変数 "PATH" で指定され
   たディレクトリのリストから *実行ファイル* を探します ("execvp(3)"
   と同じ方法です)。

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

   Added in version 3.8.

   利用可能な環境: POSIX, not WASI, not Android, not iOS.

   "posix_spawn()" のドキュメントを参照してください。

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

   "os.fork()" や同様のプロセス複製 API で新しい子プロセスを fork する
   ときに実行する呼び出し可能オブジェクトを登録します。 引数はすべて省
   略可能なキーワード専用引数で、それぞれ異なる呼び出し時点を指定しま
   す。

   * *before* は子プロセスを fork する前に呼び出す関数です。

   * *after_in_parent* は子プロセスを fork した後に親プロセスから呼び
     出す関数です。

   * *after_in_child* は子プロセスから呼び出す関数です。

   これらの呼び出しは、制御が Python インタープリタに戻る予定の場合に
   だけ行われます。 通常の "subprocess" による起動では、子プロセスがイ
   ンタープリタに戻らないため、これらは呼び出されません。

   fork 前に実行する関数は、登録順と逆の順序で呼び出されます。 fork 後
   に実行する関数は、親と子のどちらで実行する場合も登録順に呼び出され
   ます。

   サードパーティーの C コードから "fork()" を呼び出す場合、
   "PyOS_BeforeFork()"、"PyOS_AfterFork_Parent()"、
   "PyOS_AfterFork_Child()" を明示的に呼び出さない限り、これらの関数は
   呼び出されない可能性があります。

   関数の登録を解除する方法はありません。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

   Added in version 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()" 関数
   で使えます。

   VxWorks では、新しいプロセスが強制終了されたときに、この関数は
   "-signal" を返さず OSError 例外を送出します。

   "spawn*" 関数の "l" 形式と "v" 形式は、コマンドライン引数の渡し方が
   異なります。 コードを書く時点で引数の数が決まっているなら、"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" を送出します。

   利用可能な環境: Unix, Windows, not WASI, not Android, not iOS.

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

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

   バージョン 3.14 で ソフト非推奨 <Soft deprecated>: 代わりに
   "subprocess" モジュールを使うことを推奨します。

os.P_NOWAIT
os.P_NOWAITO

   "spawn*" 関数群の *mode* 引数に指定できる値です。 いずれかの値を指
   定すると、"spawn*" 関数は新しいプロセスを作成するとすぐに、そのプロ
   セス ID を返します。

   利用可能な環境: Unix, Windows.

os.P_WAIT

   "spawn*" 関数群の *mode* 引数に指定できる値です。 この値を *mode*
   に指定すると、"spawn*" 関数は新しいプロセスの実行が完了するまで戻り
   ません。 実行が成功すればプロセスの終了コードを返し、シグナルで強制
   終了された場合は "-signal" を返します。

   利用可能な環境: Unix, Windows.

os.P_DETACH
os.P_OVERLAY

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

   利用可能な環境: Windows.

os.startfile(path[, operation][, arguments][, cwd][, show_cmd])

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

   *operation* を指定しない場合、Windows エクスプローラーでファイルを
   ダブルクリックするか、対話型コマンドシェルの **start** コマンドに引
   数としてファイル名を指定するのと同じ動作をします。 つまり、拡張子に
   関連付けられたアプリケーションがあれば、そのアプリケーションでファ
   イルを開きます。

   *operation* を指定する場合は、ファイルに対して行う操作を示す「コマ
   ンド動詞」でなければなりません。 Microsoft が説明している一般的な動
   詞には、ファイルに使う "'open'"、"'print'"、"'edit'" と、ディレクト
   リに使う "'explore'"、"'find'" があります。

   アプリケーションを起動する場合は、渡す引数を単一の文字列として
   *arguments* に指定します。 この関数で文書を開く場合、この引数は効果
   を持たないことがあります。

   デフォルトでは作業ディレクトリを継承しますが、*cwd* 引数で上書きで
   きます。 この引数には絶対パスを指定します。 *path* が相対パスの場合
   、この引数を基準として解決されます。

   *show_cmd* でデフォルトのウィンドウスタイルを上書きできます。 効果
   があるかどうかは、起動するアプリケーションによって異なります。 値は
   Win32 の "ShellExecute()" 関数がサポートする整数です。

   "startfile()" は関連付けられたアプリケーションを起動するとすぐに戻
   ります。 アプリケーションの終了を待つオプションも、終了ステータスを
   取得する方法もありません。 *path* 引数はカレントディレクトリまたは
   *cwd* からの相対パスです。 絶対パスを使う場合は、先頭の文字がスラッ
   シュ ("'/'") にならないようにしてください。 "pathlib" または
   "os.path.normpath()" 関数を使って、パスを Win32 に適した形式にして
   ください。

   インタープリタの起動時のオーバーヘッドを減らすため、Win32 の
   "ShellExecute()" 関数はこの関数が初めて呼び出されるまで解決されませ
   ん。 解決できなければ "NotImplementedError" が送出されます。

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

   引数 "path"、"operation"、"arguments"、"cwd"、"show_cmd" を指定して
   監査イベント "os.startfile/2" を送出します。

   利用可能な環境: Windows.

   バージョン 3.10 で変更: *arguments*、*cwd*、*show_cmd* 引数と
   "os.startfile/2" 監査イベントが追加されました。

os.system(command)

   コマンド (文字列) をサブシェルで実行します。 標準 C 関数 "system()"
   を呼び出して実装されており、同じ制約があります。 "sys.stdin" などへ
   の変更は、実行されるコマンドの環境には反映されません。 *command* が
   出力を生成すると、インタープリタの標準出力ストリームに送られます。
   C 標準はこの C 関数の戻り値の意味を規定していないため、Python 関数
   の戻り値もシステムに依存します。

   Unix では、戻り値は "wait()" で規定された形式にエンコードされたプロ
   セスの終了ステータスです。

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

   "subprocess" モジュールは、新しいプロセスの起動と結果の取得のための
   、より強力な機能を提供しています。 この関数よりも同モジュールの使用
   を推奨します。 便利なレシピは "subprocess" のドキュメントの
   subprocess モジュールで古い関数を置き換える 節を参照してください。

   Unix では、"waitstatus_to_exitcode()" で結果 (終了ステータス) を終
   了コードに変換できます。 Windows では、結果がそのまま終了コードです
   。

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

   利用可能な環境: Unix, Windows, not WASI, not Android, not iOS.

os.times()

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

   * "user" - ユーザー時間

   * "system" - システム時間

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

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

   * "elapsed" - 過去の固定された時点からの実経過時間

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

   Unix では *times(2)* および times(3) のマニュアルページを、Windows
   では GetProcessTimes の MSDN ドキュメント を参照してください。
   Windows では "user" と "system" だけが取得され、他の属性はゼロです
   。

   利用可能な環境: Unix, Windows.

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

os.wait()

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

   待機できる子プロセスがない場合は "ChildProcessError" が送出されます
   。

   戻り値の終了ステータスを終了コードに変換するために
   "waitstatus_to_exitcode()" を使うことができます。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

   参考:

     以下で説明する他の "wait*()" 関数では、特定の子プロセスの終了を待
     機でき、より多くのオプションを指定できます。 Windows でも利用でき
     るのは "waitpid()" だけです。

os.waitid(idtype, id, options, /)

   子プロセスの終了を待機します。

   *idtype* には "P_PID"、"P_PGID"、"P_ALL"、または Linux では
   "P_PIDFD" を指定できます。 *id* の解釈は *idtype* によって変わりま
   す。 それぞれの説明を参照してください。

   *options* はフラグの OR による組み合わせです。 "WEXITED"、
   "WSTOPPED"、"WCONTINUED" のうち少なくとも 1 つが必要です。 さらに
   "WNOHANG" と "WNOWAIT" を指定できます。

   戻り値は "siginfo_t" 構造体のデータを表すオブジェクトで、次の属性を
   持ちます。

   * "si_pid" (プロセス ID)

   * "si_uid" (子プロセスの実ユーザー ID)

   * "si_signo" (常に "SIGCHLD")

   * "si_status" ("si_code" に応じて、終了ステータスまたはシグナル番号
     )

   * "si_code" (取り得る値は "CLD_EXITED" を参照)

   "WNOHANG" を指定し、要求した状態にある該当する子プロセスがない場合
   は "None" を返します。 それ以外で、待機できる該当する子プロセスがな
   い場合は "ChildProcessError" が送出されます。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

   Added in version 3.3.

   バージョン 3.13 で変更: macOS でも利用できるようになりました。

os.waitpid(pid, options, /)

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

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

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

   *options* はフラグの OR による組み合わせです。 "WNOHANG" が含まれ、
   要求した状態にある該当する子プロセスがない場合は "(0, 0)" を返しま
   す。 それ以外で、待機できる該当する子プロセスがない場合は
   "ChildProcessError" が送出されます。 "WUNTRACED" と "WCONTINUED" も
   指定できます。

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

   戻り値の終了ステータスを終了コードに変換するために
   "waitstatus_to_exitcode()" を使うことができます。

   利用可能な環境: Unix, Windows, not WASI, not Android, not iOS.

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

os.wait3(options)

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

   戻り値の終了ステータスを終了コードに変換するために
   "waitstatus_to_exitcode()" を使うことができます。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.wait4(pid, options)

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

   戻り値の終了ステータスを終了コードに変換するために
   "waitstatus_to_exitcode()" を使うことができます。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.P_PID
os.P_PGID
os.P_ALL
os.P_PIDFD

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

   * "P_PID" - PID が *id* の子プロセスを待機します。

   * "P_PGID" - プロセスグループ ID が *id* のいずれかの子プロセスを待
     機します。

   * "P_ALL" - いずれかの子プロセスを待機します。 *id* は無視されます
     。

   * "P_PIDFD" - ファイル記述子 *id* ("pidfd_open()" で作成したプロセ
     スのファイル記述子) が識別する子プロセスを待機します。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

   注釈:

     "P_PIDFD" は Linux 5.4 以降でのみ利用できます。

   Added in version 3.3.

   Added in version 3.9: "P_PIDFD" 定数。

os.WCONTINUED

   "waitpid()"、"wait3()"、"wait4()"、"waitid()" の *options* に指定す
   るフラグです。 前回の報告以降にジョブ制御による停止から再開した子プ
   ロセスが報告されるようになります。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.WEXITED

   "waitid()" の *options* に指定するフラグで、終了した子プロセスが報
   告されるようになります。

   他の "wait*" 関数は常に終了した子プロセスを報告するため、このオプシ
   ョンは指定できません。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

   Added in version 3.3.

os.WSTOPPED

   "waitid()" の *options* に指定するフラグで、シグナルの配送によって
   停止した子プロセスが報告されるようになります。

   他の "wait*" 関数にはこのオプションを指定できません。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

   Added in version 3.3.

os.WUNTRACED

   "waitpid()"、"wait3()"、"wait4()" の *options* に指定するフラグです
   。 停止していて、停止後に現在の状態がまだ報告されていない子プロセス
   も報告されるようになります。

   "waitid()" にはこのオプションを指定できません。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.WNOHANG

   *options* にこのフラグを指定すると、子プロセスの状態をすぐに取得で
   きない場合、"waitpid()"、"wait3()"、"wait4()"、"waitid()" は直ちに
   戻ります。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.WNOWAIT

   *options* にこのフラグを指定すると、"waitid()" は子プロセスを待機可
   能な状態のまま残します。 後で "wait*()" を呼び出して、子プロセスの
   状態情報を再度取得できます。

   他の "wait*" 関数にはこのオプションを指定できません。

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.CLD_EXITED
os.CLD_KILLED
os.CLD_DUMPED
os.CLD_TRAPPED
os.CLD_STOPPED
os.CLD_CONTINUED

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

   利用可能な環境: Unix, not WASI, not Android, not iOS.

   Added in version 3.3.

   バージョン 3.9 で変更: "CLD_KILLED" と "CLD_STOPPED" が追加されまし
   た。

os.waitstatus_to_exitcode(status)

   待機ステータスを終了コードに変換します。

   Unix の場合:

   * 子プロセスが正常終了した場合 ("WIFEXITED(status)" が真の場合)、子
     プロセスの終了ステータス ("WEXITSTATUS(status)") を返します: 戻り
     値は0または正の整数です。

   * 子プロセスがシグナルによって終了した場合 ("WIFSIGNALED(status)"
     が真の場合)、子プロセスを終了したシグナルの番号に負符号をつけた
     "-signum" ("-WTERMSIG(status)") を返します: 戻り値は負の整数です
     。

   * それ以外の場合、 "ValueError" 例外を送出します。

   Windows の場合、 *status* を8ビット右にシフトした値を返します。

   Unix の場合、プロセスがトレースされているか "waitpid()" が
   "WUNTRACED" オプションをつけて実行されている場合、呼び出しもとは最
   初に "WIFSTOPPED(status)" が真であるかを確認しなければなりません。
   この関数は "WIFSTOPPED(status)" が真の場合呼び出してはいけません。

   参考:

     "WIFEXITED()", "WEXITSTATUS()", "WIFSIGNALED()", "WTERMSIG()",
     "WIFSTOPPED()", "WSTOPSIG()" 関数。

   利用可能な環境: Unix, Windows, not WASI, not Android, not iOS.

   Added in version 3.9.

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

os.WCOREDUMP(status, /)

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

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

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.WIFCONTINUED(status)

   停止していた子プロセスが "SIGCONT" の配送によって再開した場合 (ジョ
   ブ制御による停止から再開した場合) は "True" を、それ以外の場合は
   "False" を返します。

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

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.WIFSTOPPED(status)

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

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

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.WIFSIGNALED(status)

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

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.WIFEXITED(status)

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

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.WEXITSTATUS(status)

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

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

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.WSTOPSIG(status)

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

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

   利用可能な環境: Unix, not WASI, not Android, not iOS.

os.WTERMSIG(status)

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

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

   利用可能な環境: Unix, not WASI, not Android, not iOS.


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

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

Added in version 3.3.

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

os.SCHED_OTHER

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

os.SCHED_BATCH

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

os.SCHED_DEADLINE

   締め切りの制約を持つタスク用のスケジューリングポリシーです。

   Added in version 3.14.

os.SCHED_IDLE

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

os.SCHED_NORMAL

   "SCHED_OTHER" の別名です。

   Added in version 3.14.

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 を明け渡します。 詳しくは *sched_yield(2)* を参照して
   ください。

os.sched_setaffinity(pid, mask, /)

   PID *pid* のプロセス (0 であれば現在のプロセス) を CPU の集合に制限
   します。*mask* はプロセスを制限する CPU の集合を表す整数のイテラブ
   ルなオブジェクトです。

os.sched_getaffinity(pid, /)

   PID が *pid* のプロセスに使用が許可されている CPU の集合を返します
   。

   *pid* がゼロの場合、現在のプロセスの呼び出し元スレッドに使用が許可
   されている CPU の集合を返します。

   "process_cpu_count()" 関数も参照してください。


雑多なシステム情報
==================

os.confstr(name, /)

   文字列値のシステム設定を返します。 *name* には取得する設定値を指定
   します。 定義済みのシステム設定の名前を文字列で指定でき、これらの名
   前は POSIX、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"
   を返します。

   "process_cpu_count()" 関数を使うと、**現在のプロセス** の呼び出し元
   スレッドが使用できる論理 CPU 数を取得できます。

   Added in version 3.4.

   バージョン 3.13 で変更: "-X cpu_count" を指定するか
   "PYTHON_CPU_COUNT" を設定すると、"cpu_count()" は上書き用に指定した
   値 *n* を返します。

os.getloadavg()

   過去 1 分、 5 分、および 15 分間の、システムの実行キューの平均プロ
   セス数を返します。平均負荷が得られない場合には "OSError" を送出しま
   す。

   利用可能な環境: Unix.

os.process_cpu_count()

   **現在のプロセス** の呼び出し元スレッドが使用できる論理 CPU 数を取
   得します。 判定できない場合は "None" を返します。 CPU アフィニティ
   によっては "cpu_count()" より少なくなることがあります。

   "cpu_count()" 関数を使うと、**システム** 内の論理 CPU 数を取得でき
   ます。

   "-X cpu_count" を指定するか "PYTHON_CPU_COUNT" を設定すると、
   "process_cpu_count()" は上書き用に指定した値 *n* を返します。

   "sched_getaffinity()" 関数も参照してください。

   Added in version 3.13.

os.sysconf(name, /)

   整数値のシステム設定値を返します。 *name* で指定された設定値が定義
   されていない場合、 "-1" が返されます。 *name* に関するコメントとし
   ては、 "confstr()" で述べた内容が同様に当てはまります ; 既知の設定
   名についての情報を与える辞書は "sysconf_names" で与えられています。

   利用可能な環境: Unix.

os.sysconf_names

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

   利用可能な環境: Unix.

   バージョン 3.11 で変更: "'SC_MINSIGSTKSZ'" という名前が追加されまし
   た。

以下のデータ値はパス名編集操作をサポートするために利用されます。これら
の値はすべてのプラットフォームで定義されています。

パス名に対する高水準の操作は "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'" のように 1 文字の場合も、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)* ページを参照してください。

   Added in version 3.3.


乱数
====

os.getrandom(size, flags=0)

   最大で *size* バイトからなるランダムなバイト列を返します。この関数
   は要求されたバイト数よりも少ないバイト数を返すことがあります。

   このバイト列は、ユーザー空間の乱数生成器のシードや暗号目的に使えま
   す。

   "getrandom()" はデバイスドライバや他の環境ノイズ源から収集されたエ
   ントロピーに頼っています。不必要な大量のデータの読出しは、
   "/dev/random" と "/dev/urandom" デバイスの他のユーザーに負の影響を
   与えるでしょう。

   "flags" 引数は、"os.GRND_RANDOM" と "GRND_NONBLOCK" のうち 0 個以上
   を OR で組み合わせたビットマスクです。

   Linux getrandom() manual page も参照してください。

   利用可能な環境: Linux >= 3.17.

   Added in version 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で、 "BCryptGenRandom()" を使用します。

   参考:

     "secrets" モジュールは高レベルの乱数生成機能を提供します。プラッ
     トフォームが提供する乱数生成器に対する簡便なインターフェースにつ
     いては、 "random.SystemRandom" を参照してください。

   バージョン 3.5 で変更: Linux 3.17 以降では、使用可能な場合に
   "getrandom()"  システムコールが使用されるようになりました。OpenBSD
   5.6 以降では、C "getentropy()" 関数が使用されるようになりました。こ
   れらの関数は、内部ファイル記述子を使用しません。

   バージョン 3.5.2 で変更: Linux において、 "getrandom()" システムコ
   ールがブロックするなら (urandom エントロピープールが初期化されてい
   なければ) 、 "/dev/urandom" を読む方法にフォールバックします。

   バージョン 3.6 で変更: Linuxで、 セキュリティを高めるために、
   "getrandom()" をブロッキングモードで使用するようになりました。

   バージョン 3.11 で変更: Windows では、非推奨の "CryptGenRandom()"
   の代わりに "BCryptGenRandom()" を使います。

os.GRND_NONBLOCK

   デフォルトでは、"getrandom()" は "/dev/random" から読み込んだときに
   ランダムなバイトが存在しない場合や、 "/dev/urandom" から読み込んだ
   ときにエントロピープールが初期化されていない場合に処理をブロックし
   ます。

   "GRND_NONBLOCK" フラグがセットされると、 "getrandom()" はこれらの場
   合に処理をブロックせず、ただちに "BlockingIOError" 例外を送出します
   。

   Added in version 3.6.

os.GRND_RANDOM

   このビットがセットされた場合、 ランダムバイトは "/dev/urandom" プー
   ルの代わりに  "/dev/random" プールから取り出されます。

   Added in version 3.6.
