# インタープリタの初期化と終了処理

See Python Initialization Configuration for details on how to configure the interpreter prior to initialization.

## Before Python initialization

In an application embedding Python, the `Py_Initialize()` function must be called before using any other Python/C API functions; with the exception of a few functions and the global configuration variables.

次の関数は Python の初期化の前でも安全に呼び出せます:

- Functions that initialize the interpreter:

  - `Py_Initialize()`

  - `Py_InitializeEx()`

  - `Py_InitializeFromConfig()`

  - `Py_BytesMain()`

  - `Py_Main()`

  - the runtime pre-initialization functions covered in Python 初期化設定

- 設定関数:

  - `PyImport_AppendInittab()`

  - `PyImport_ExtendInittab()`

  - `PyInitFrozenExtensions()`

  - `PyMem_SetAllocator()`

  - `PyMem_SetupDebugHooks()`

  - `PyObject_SetArenaAllocator()`

  - `Py_SetProgramName()`

  - `Py_SetPythonHome()`

  - the configuration functions covered in Python 初期化設定

- 情報取得の関数:

  - `Py_IsInitialized()`

  - `PyMem_GetAllocator()`

  - `PyObject_GetArenaAllocator()`

  - `Py_GetBuildInfo()`

  - `Py_GetCompiler()`

  - `Py_GetCopyright()`

  - `Py_GetPlatform()`

  - `Py_GetVersion()`

  - `Py_IsInitialized()`

- ユーティリティ:

  - `Py_DecodeLocale()`

  - the status reporting and utility functions covered in Python 初期化設定

- メモリアロケータ:

  - `PyMem_RawMalloc()`

  - `PyMem_RawRealloc()`

  - `PyMem_RawCalloc()`

  - `PyMem_RawFree()`

- Synchronization:

  - `PyMutex_Lock()`

  - `PyMutex_Unlock()`

注釈

Despite their apparent similarity to some of the functions listed above, the following functions should not be called before the interpreter has been initialized: `Py_EncodeLocale()`, `PyEval_InitThreads()`, and `Py_RunMain()`.

## グローバルな設定変数

Python には、様々な機能やオプションを制御するグローバルな設定のための変数があります。 デフォルトでは、これらのフラグは コマンドラインオプション で制御されます。

オプションでフラグがセットされると、フラグの値はそのオプションがセットされた回数になります。 例えば、 `-b` では `Py_BytesWarningFlag` が 1 に設定され、 `-bb` では `Py_BytesWarningFlag` が 2 に設定されます。

int Py_BytesWarningFlag

  This API is kept for backward compatibility: setting `PyConfig.bytes_warning` should be used instead, see Python Initialization Configuration.

  `bytes` または `bytearray` を `str` と比較した場合、または、 `bytes` を `int` と比較した場合に警告を発生させます。 `2` 以上の値を設定している場合は、エラーを発生させます。

  `-b` オプションで設定します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_DebugFlag

  This API is kept for backward compatibility: setting `PyConfig.parser_debug` should be used instead, see Python Initialization Configuration.

  パーサーのデバッグ出力を有効にします。(専門家専用です。コンパイルオプションに依存します)。

  `-d` オプションと `PYTHONDEBUG` 環境変数で設定します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_DontWriteBytecodeFlag

  This API is kept for backward compatibility: setting `PyConfig.write_bytecode` should be used instead, see Python Initialization Configuration.

  非ゼロに設定した場合、Python はソースモジュールのインポート時に `.pyc` ファイルの作成を試みません。

  `-B` オプションと `PYTHONDONTWRITEBYTECODE` 環境変数で設定します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_FrozenFlag

  This API is kept for backward compatibility: setting `PyConfig.pathconfig_warnings` should be used instead, see Python Initialization Configuration.

  `_freeze_module` プログラムと `frozenmain` プログラムが使用する非公開フラグです。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_HashRandomizationFlag

  This API is kept for backward compatibility: setting `PyConfig.hash_seed` and `PyConfig.use_hash_seed` should be used instead, see Python Initialization Configuration.

  `PYTHONHASHSEED` 環境変数が空でない文字列に設定された場合に、 `1` が設定されます。

  フラグがゼロでない場合、 `PYTHONHASHSEED` 環境変数を読みシークレットハッシュシードを初期化します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_IgnoreEnvironmentFlag

  This API is kept for backward compatibility: setting `PyConfig.use_environment` should be used instead, see Python Initialization Configuration.

  Ignore all `PYTHON*` environment variables, e.g. `PYTHONPATH` and `PYTHONHOME`, that might be set.

  `-E` オプションと `-I` オプションで設定します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_InspectFlag

  This API is kept for backward compatibility: setting `PyConfig.inspect` should be used instead, see Python Initialization Configuration.

  最初の引数にスクリプトが指定されたときや `-c` オプションが利用された際に、 `sys.stdin` がターミナルに出力されないときであっても、スクリプトかコマンドを実行した後にインタラクティブモードに入ります。

  `-i` オプションと `PYTHONINSPECT` 環境変数で設定します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_InteractiveFlag

  This API is kept for backward compatibility: setting `PyConfig.interactive` should be used instead, see Python Initialization Configuration.

  `-i` オプションで設定します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_IsolatedFlag

  This API is kept for backward compatibility: setting `PyConfig.isolated` should be used instead, see Python Initialization Configuration.

  Python を隔離モードで実行します。 隔離モードでは `sys.path` はスクリプトのディレクトリやユーザのサイトパッケージのディレクトリを含みません。

  `-I` オプションで設定します。

  Added in version 3.4.

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_LegacyWindowsFSEncodingFlag

  This API is kept for backward compatibility: setting `PyPreConfig.legacy_windows_fs_encoding` should be used instead, see Python Initialization Configuration.

  If the flag is non-zero, use the `mbcs` encoding with `replace` error handler, instead of the UTF-8 encoding with `surrogatepass` error handler, for the filesystem encoding and error handler.

  `PYTHONLEGACYWINDOWSFSENCODING` 環境変数が空でない文字列に設定された場合に、 `1` に設定されます。

  より詳しくは PEP 529 を参照してください。

  Availability: Windows.

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_LegacyWindowsStdioFlag

  This API is kept for backward compatibility: setting `PyConfig.legacy_windows_stdio` should be used instead, see Python Initialization Configuration.

  If the flag is non-zero, use `io.FileIO` instead of `io._WindowsConsoleIO` for `sys` standard streams.

  `PYTHONLEGACYWINDOWSSTDIO` 環境変数が空でない文字列に設定された場合に、 `1` に設定されます。

  より詳しくは PEP 528 を参照してください。

  Availability: Windows.

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_NoSiteFlag

  This API is kept for backward compatibility: setting `PyConfig.site_import` should be used instead, see Python Initialization Configuration.

  `site` モジュールの import と、そのモジュールが行なっていた site ごとの `sys.path` への操作を無効にします。後で `site` を明示的に import しても、これらの操作は実行されません (実行したい場合は、 `site.main()` を呼び出してください)。

  `-S` オプションで設定します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_NoUserSiteDirectory

  This API is kept for backward compatibility: setting `PyConfig.user_site_directory` should be used instead, see Python Initialization Configuration.

  `ユーザのサイトパッケージのディレクトリ` を `sys.path` に追加しません。

  `-s` オプション、 `-I` 、 `PYTHONNOUSERSITE` 環境変数で設定します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_OptimizeFlag

  This API is kept for backward compatibility: setting `PyConfig.optimization_level` should be used instead, see Python Initialization Configuration.

  `-O` オプションと `PYTHONOPTIMIZE` 環境変数で設定します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_QuietFlag

  This API is kept for backward compatibility: setting `PyConfig.quiet` should be used instead, see Python Initialization Configuration.

  インタラクティブモードでも copyright とバージョンのメッセージを表示しません。

  `-q` オプションで設定します。

  Added in version 3.2.

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_UnbufferedStdioFlag

  This API is kept for backward compatibility: setting `PyConfig.buffered_stdio` should be used instead, see Python Initialization Configuration.

  標準出力と標準エラーをバッファリングしないように強制します。

  `-u` オプションと `PYTHONUNBUFFERED` 環境変数で設定します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

int Py_VerboseFlag

  This API is kept for backward compatibility: setting `PyConfig.verbose` should be used instead, see Python Initialization Configuration.

  モジュールが初期化されるたびにメッセージを出力し、それがどこ (ファイル名やビルトインモジュール) からロードされたのかを表示します。 値が 2 以上の場合は、モジュールを検索するときにチェックしたファイルごとにメッセージを出力します。また、終了時のモジュールクリーンアップに関する情報も提供します。

  `-v` オプションと `PYTHONVERBOSE` 環境変数で設定します。

  バージョン 3.12 で非推奨、バージョン 3.15 で削除予定.

## インタープリタの初期化と終了処理

void Py_Initialize()
  次に属します: Stable ABI.

  Initialize the Python interpreter. In an application embedding Python, this should be called before using any other Python/C API functions; see Before Python Initialization for the few exceptions.

  This initializes the table of loaded modules (`sys.modules`), and creates the fundamental modules `builtins`, `__main__` and `sys`. It also initializes the module search path (`sys.path`). It does not set `sys.argv`; use the Python Initialization Configuration API for that. This is a no-op when called for a second time (without calling `Py_FinalizeEx()` first). There is no return value; it is a fatal error if the initialization fails.

  Use `Py_InitializeFromConfig()` to customize the Python Initialization Configuration.

  注釈

  Windows では `O_TEXT` から `O_BINARY` へコンソールモードが変更されますが、これはその C ランタイムを使っているコンソールでの Python 以外の使い勝手にも影響を及ぼします。

void Py_InitializeEx(int initsigs)
  次に属します: Stable ABI.

  This function works like `Py_Initialize()` if initsigs is `1`. If initsigs is `0`, it skips initialization registration of signal handlers, which may be useful when CPython is embedded as part of a larger application.

  Use `Py_InitializeFromConfig()` to customize the Python Initialization Configuration.

PyStatus Py_InitializeFromConfig(const PyConfig *config)

  Initialize Python from config configuration, as described in Initialization with PyConfig.

  See the Python 初期化設定 section for details on pre-initializing the interpreter, populating the runtime configuration structure, and querying the returned status structure.

int Py_IsInitialized()
  次に属します: Stable ABI.

  Python インタプリタが初期化済みであれば真(非ゼロ)を、さもなければ偽(ゼロ)を返します。`Py_FinalizeEx()` を呼び出した後は、`Py_Initialize()` を再び呼び出すまで、この関数は偽を返します。

int Py_IsFinalizing()
  次に属します: Stable ABI (バージョン 3.13 より).

  Return true (non-zero) if the main Python interpreter is shutting down. Return false (zero) otherwise.

  Added in version 3.13.

int Py_FinalizeEx()
  次に属します: Stable ABI (バージョン 3.6 より).

  Undo all initializations made by `Py_Initialize()` and subsequent use of Python/C API functions, and destroy all sub-interpreters (see `Py_NewInterpreter()` below) that were created and not yet destroyed since the last call to `Py_Initialize()`. This is a no-op when called for a second time (without calling `Py_Initialize()` again first).

  Since this is the reverse of `Py_Initialize()`, it should be called in the same thread with the same interpreter active. That means the main thread and the main interpreter. This should never be called while `Py_RunMain()` is running.

  Normally the return value is `0`. If there were errors during finalization (flushing buffered data), `-1` is returned.

  Note that Python will do a best effort at freeing all memory allocated by the Python interpreter. Therefore, any C-Extension should make sure to correctly clean up all of the previously allocated PyObjects before using them in subsequent calls to `Py_Initialize()`. Otherwise it could introduce vulnerabilities and incorrect behavior.

  この関数が提供されている理由はいくつかあります。Python の埋め込みを行っているアプリケーションでは、アプリケーションを再起動することなく Python を再起動したいことがあります。また、動的ロード可能イブラリ (あるいは DLL) から Python インタプリタをロードするアプリケーションでは、DLL をアンロードする前に Python が確保したメモリを全て解放したいと考えるかもしれません。アプリケーション内で起きているメモリリークを追跡する際に、開発者は Python が確保したメモリをアプリケーションの終了前に解放させたいと思う場合もあります。

  Bugs and caveats: The destruction of modules and objects in modules is done in random order; this may cause destructors (`__del__()` methods) to fail when they depend on other objects (even functions) or modules. Dynamically loaded extension modules loaded by Python are not unloaded. Small amounts of memory allocated by the Python interpreter may not be freed (if you find a leak, please report it). Memory tied up in circular references between objects is not freed. Interned strings will all be deallocated regardless of their reference count. Some memory allocated by extension modules may not be freed. Some extensions may not work properly if their initialization routine is called more than once; this can happen if an application calls `Py_Initialize()` and `Py_FinalizeEx()` more than once. `Py_FinalizeEx()` must not be called recursively from within itself. Therefore, it must not be called by any code that may be run as part of the interpreter shutdown process, such as `atexit` handlers, object finalizers, or any code that may be run while flushing the stdout and stderr files.

  引数無しで 監査イベント `cpython._PySys_ClearAuditHooks` を送出します。

  Added in version 3.6.

void Py_Finalize()
  次に属します: Stable ABI.

  この関数は `Py_FinalizeEx()` の後方互換性バージョンで、戻り値がありません。

int Py_BytesMain(int argc, char **argv)
  次に属します: Stable ABI (バージョン 3.8 より).

  Similar to `Py_Main()` but argv is an array of bytes strings, allowing the calling application to delegate the text decoding step to the CPython runtime.

  Added in version 3.8.

int Py_Main(int argc, wchar_t **argv)
  次に属します: Stable ABI.

  The main program for the standard interpreter, encapsulating a full initialization/finalization cycle, as well as additional behaviour to implement reading configurations settings from the environment and command line, and then executing `__main__` in accordance with コマンドライン.

  This is made available for programs which wish to support the full CPython command line interface, rather than just embedding a Python runtime in a larger application.

  The argc and argv parameters are similar to those which are passed to a C program's `main()` function, except that the argv entries are first converted to `wchar_t` using `Py_DecodeLocale()`. It is also important to note that the argument list entries may be modified to point to strings other than those passed in (however, the contents of the strings pointed to by the argument list are not modified).

  The return value is `2` if the argument list does not represent a valid Python command line, and otherwise the same as `Py_RunMain()`.

  In terms of the CPython runtime configuration APIs documented in the runtime configuration section (and without accounting for error handling), `Py_Main` is approximately equivalent to:

      PyConfig config;
      PyConfig_InitPythonConfig(&config);
      PyConfig_SetArgv(&config, argc, argv);
      Py_InitializeFromConfig(&config);
      PyConfig_Clear(&config);

      Py_RunMain();

  In normal usage, an embedding application will call this function instead of calling `Py_Initialize()`, `Py_InitializeEx()` or `Py_InitializeFromConfig()` directly, and all settings will be applied as described elsewhere in this documentation. If this function is instead called after a preceding runtime initialization API call, then exactly which environmental and command line configuration settings will be updated is version dependent (as it depends on which settings correctly support being modified after they have already been set once when the runtime was first initialized).

int Py_RunMain(void)

  Executes the main module in a fully configured CPython runtime.

  Executes the command (`PyConfig.run_command`), the script (`PyConfig.run_filename`) or the module (`PyConfig.run_module`) specified on the command line or in the configuration. If none of these values are set, runs the interactive Python prompt (REPL) using the `__main__` module's global namespace.

  If `PyConfig.inspect` is not set (the default), the return value will be `0` if the interpreter exits normally (that is, without raising an exception), the exit status of an unhandled `SystemExit`, or `1` for any other unhandled exception.

  If `PyConfig.inspect` is set (such as when the `-i` option is used), rather than returning when the interpreter exits, execution will instead resume in an interactive Python prompt (REPL) using the `__main__` module's global namespace. If the interpreter exited with an exception, it is immediately raised in the REPL session. The function return value is then determined by the way the REPL session terminates: `0`, `1`, or the status of a `SystemExit`, as specified above.

  This function always finalizes the Python interpreter before it returns.

  See Python Configuration for an example of a customized Python that always runs in isolated mode using `Py_RunMain()`.

int PyUnstable_AtExit(PyInterpreterState *interp, void (*func)(void*), void *data)
  これは Unstable APIです。マイナーリリースで予告なく変更されることがあります。

  Register an `atexit` callback for the target interpreter interp. This is similar to `Py_AtExit()`, but takes an explicit interpreter and data pointer for the callback.

  There must be an attached thread state for interp.

  Added in version 3.13.

## Cautions regarding runtime finalization

In the late stage of interpreter shutdown, after attempting to wait for non-daemon threads to exit (though this can be interrupted by `KeyboardInterrupt`) and running the `atexit` functions, the runtime is marked as finalizing: `Py_IsFinalizing()` and `sys.is_finalizing()` return true. At this point, only the finalization thread that initiated finalization (typically the main thread) is allowed to acquire the GIL.

If any thread, other than the finalization thread, attempts to attach a thread state during finalization, either explicitly or implicitly, the thread enters a permanently blocked state where it remains until the program exits. In most cases this is harmless, but this can result in deadlock if a later stage of finalization attempts to acquire a lock owned by the blocked thread, or otherwise waits on the blocked thread.

Gross? Yes. This prevents random crashes and/or unexpectedly skipped C++ finalizations further up the call stack when such threads were forcibly exited here in CPython 3.13 and earlier. The CPython runtime thread state C APIs have never had any error reporting or handling expectations at thread state attachment time that would've allowed for graceful exit from this situation. Changing that would require new stable C APIs and rewriting the majority of C code in the CPython ecosystem to use those with error handling.

## プロセスワイドのパラメータ

void Py_SetProgramName(const wchar_t *name)
  次に属します: Stable ABI.

  This API is kept for backward compatibility: setting `PyConfig.program_name` should be used instead, see Python Initialization Configuration.

  This function should be called before `Py_Initialize()` is called for the first time, if it is called at all. It tells the interpreter the value of the `argv[0]` argument to the `main()` function of the program (converted to wide characters). This is used by `Py_GetPath()` and some other functions below to find the Python run-time libraries relative to the interpreter executable. The default value is `'python'`. The argument should point to a zero-terminated wide character string in static storage whose contents will not change for the duration of the program's execution. No code in the Python interpreter will change the contents of this storage.

  Use `Py_DecodeLocale()` to decode a bytes string to get a wchar_t* string.

  バージョン 3.11 で非推奨、バージョン 3.15 で削除予定.

wchar_t *Py_GetProgramName()
  次に属します: Stable ABI.

  Return the program name set with `PyConfig.program_name`, or the default. The returned string points into static storage; the caller should not modify its value.

  This function should not be called before `Py_Initialize()`, otherwise it returns `NULL`.

  バージョン 3.10 で変更: It now returns `NULL` if called before `Py_Initialize()`.

  バージョン 3.13 で非推奨、バージョン 3.15 で削除予定: Use `PyConfig_Get("executable")` (`sys.executable`) instead.

wchar_t *Py_GetPrefix()
  次に属します: Stable ABI.

  Return the prefix for installed platform-independent files. This is derived through a number of complicated rules from the program name set with `PyConfig.program_name` and some environment variables; for example, if the program name is `'/usr/local/bin/python'`, the prefix is `'/usr/local'`. The returned string points into static storage; the caller should not modify its value. This corresponds to the prefix variable in the top-level `Makefile` and the `--prefix` argument to the configure script at build time. The value is available to Python code as `sys.base_prefix`. It is only useful on Unix. See also the next function.

  This function should not be called before `Py_Initialize()`, otherwise it returns `NULL`.

  バージョン 3.10 で変更: It now returns `NULL` if called before `Py_Initialize()`.

  バージョン 3.13 で非推奨、バージョン 3.15 で削除予定: Use `PyConfig_Get("base_prefix")` (`sys.base_prefix`) instead. Use `PyConfig_Get("prefix")` (`sys.prefix`) if virtual environments need to be handled.

wchar_t *Py_GetExecPrefix()
  次に属します: Stable ABI.

  Return the exec-prefix for installed platform-dependent files. This is derived through a number of complicated rules from the program name set with `PyConfig.program_name` and some environment variables; for example, if the program name is `'/usr/local/bin/python'`, the exec-prefix is `'/usr/local'`. The returned string points into static storage; the caller should not modify its value. This corresponds to the exec_prefix variable in the top-level `Makefile` and the `--exec-prefix` argument to the configure script at build time. The value is available to Python code as `sys.base_exec_prefix`. It is only useful on Unix.

  Background: The exec-prefix differs from the prefix when platform dependent files (such as executables and shared libraries) are installed in a different directory tree. In a typical installation, platform dependent files may be installed in the `/usr/local/plat` subtree while platform independent may be installed in `/usr/local`.

  Generally speaking, a platform is a combination of hardware and software families, e.g. Sparc machines running the Solaris 2.x operating system are considered the same platform, but Intel machines running Solaris 2.x are another platform, and Intel machines running Linux are yet another platform. Different major revisions of the same operating system generally also form different platforms. Non-Unix operating systems are a different story; the installation strategies on those systems are so different that the prefix and exec-prefix are meaningless, and set to the empty string. Note that compiled Python bytecode files are platform independent (but not independent from the Python version by which they were compiled!).

  System administrators will know how to configure the mount or automount programs to share `/usr/local` between platforms while having `/usr/local/plat` be a different filesystem for each platform.

  This function should not be called before `Py_Initialize()`, otherwise it returns `NULL`.

  バージョン 3.10 で変更: It now returns `NULL` if called before `Py_Initialize()`.

  バージョン 3.13 で非推奨、バージョン 3.15 で削除予定: Use `PyConfig_Get("base_exec_prefix")` (`sys.base_exec_prefix`) instead. Use `PyConfig_Get("exec_prefix")` (`sys.exec_prefix`) if virtual environments need to be handled.

wchar_t *Py_GetProgramFullPath()
  次に属します: Stable ABI.

  Return the full program name of the Python executable; this is computed as a side-effect of deriving the default module search path from the program name (set by `PyConfig.program_name`). The returned string points into static storage; the caller should not modify its value. The value is available to Python code as `sys.executable`.

  This function should not be called before `Py_Initialize()`, otherwise it returns `NULL`.

  バージョン 3.10 で変更: It now returns `NULL` if called before `Py_Initialize()`.

  バージョン 3.13 で非推奨、バージョン 3.15 で削除予定: Use `PyConfig_Get("executable")` (`sys.executable`) instead.

wchar_t *Py_GetPath()
  次に属します: Stable ABI.

  Return the default module search path; this is computed from the program name (set by `PyConfig.program_name`) and some environment variables. The returned string consists of a series of directory names separated by a platform dependent delimiter character. The delimiter character is `':'` on Unix and macOS, `';'` on Windows. The returned string points into static storage; the caller should not modify its value. The list `sys.path` is initialized with this value on interpreter startup; it can be (and usually is) modified later to change the search path for loading modules.

  This function should not be called before `Py_Initialize()`, otherwise it returns `NULL`.

  バージョン 3.10 で変更: It now returns `NULL` if called before `Py_Initialize()`.

  バージョン 3.13 で非推奨、バージョン 3.15 で削除予定: Use `PyConfig_Get("module_search_paths")` (`sys.path`) instead.

const char *Py_GetVersion()
  次に属します: Stable ABI.

  Python インタプリタのバージョンを返します。バージョンは、次のような形式の文字列です

      "3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]"

  第一ワード (最初のスペース文字まで) は、現在の Python のバージョンです; 最初の文字は、ピリオドで区切られたメジャーバージョンとマイナーバージョンです。関数が返す文字列ポインタは静的な記憶領域を返します; 関数の呼び出し側はこの値を変更できません。この値は Python コードからは `sys.version` として利用できます。

  See also the `Py_Version` constant.

const char *Py_GetPlatform()
  次に属します: Stable ABI.

  現在のプラットフォームのプラットフォーム識別文字列を返します。Unixでは、オペレーティングシステムの "公式の" 名前を小文字に変換し、後ろにメジャーリビジョン番号を付けた構成になっています。例えば Solaris 2.x は、SunOS 5.x, としても知られていますが、`'sunos5'` になります。macOS では `'darwin'` です。Windows では `'win'` です。関数が返す文字列ポインタは静的な記憶領域を返します; 関数の呼び出し側はこの値を変更できません。この値は Python コードからは `sys.platform` として利用できます。

const char *Py_GetCopyright()
  次に属します: Stable ABI.

  現在の Python バージョンに対する公式の著作権表示文字列を返します。例えば

  `'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'`

  関数が返す文字列ポインタは静的な記憶領域を返します; 関数の呼び出し側はこの値を変更できません。この値は Python コードからは `sys.copyright` として利用できます。

const char *Py_GetCompiler()
  次に属します: Stable ABI.

  現在使っているバージョンの Python をビルドする際に用いたコンパイラを示す文字列を、角括弧で囲った文字列を返します。例えば:

      "[GCC 2.7.2.2]"

  関数が返す文字列ポインタは静的な記憶領域を返します; 関数の呼び出し側はこの値を変更できません。この値は Python コードからは `sys.version` の一部として取り出せます。

const char *Py_GetBuildInfo()
  次に属します: Stable ABI.

  Return information about the sequence number and build date and time of the current Python interpreter instance, for example

      "#67, Aug  1 1997, 22:34:28"

  関数が返す文字列ポインタは静的な記憶領域を返します; 関数の呼び出し側はこの値を変更できません。この値は Python コードからは `sys.version` の一部として取り出せます。

void PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
  次に属します: Stable ABI.

  This API is kept for backward compatibility: setting `PyConfig.argv`, `PyConfig.parse_argv` and `PyConfig.safe_path` should be used instead, see Python Initialization Configuration.

  argc および argv に基づいて `sys.argv` を設定します。これらの引数はプログラムの `main()` に渡した引数に似ていますが、最初の要素が Python インタプリタの宿主となっている実行形式の名前ではなく、実行されるスクリプト名を参照しなければならない点が違います。実行するスクリプトがない場合、 argv の最初の要素は空文字列にしてもかまいません。この関数が `sys.argv` の初期化に失敗した場合、致命的エラーを `Py_FatalError()` で知らせます。

  updatepath が 0 の場合、ここまでの動作がこの関数がすることの全てです。 updatepath が 0 でない場合、この関数は `sys.path` を以下のアルゴリズムに基づいて修正します:

  - 存在するスクリプトの名前が `argv[0]` に渡された場合、そのスクリプトがある場所の絶対パスを `sys.path` の先頭に追加します。

  - それ以外の場合 (argc が `0` だったり、 `argv[0]` が存在するファイル名を指していない場合)、 `sys.path` の先頭に空の文字列を追加します。 これは現在の作業ディレクトリ (`"."`) を先頭に追加するのと同じです。

  Use `Py_DecodeLocale()` to decode a bytes string to get a wchar_t* string.

  See also `PyConfig.orig_argv` and `PyConfig.argv` members of the Python Initialization Configuration.

  注釈

  It is recommended that applications embedding the Python interpreter for purposes other than executing a single script pass `0` as updatepath, and update `sys.path` themselves if desired. See CVE 2008-5983.

  3.1.3 より前のバージョンでは、 `PySys_SetArgv()` の呼び出しが完了した後に `sys.path` の先頭の要素を取り出すことで、同じ効果が得られます。例えばこのように使います:

      PyRun_SimpleString("import sys; sys.path.pop(0)\n");

  Added in version 3.1.3.

  バージョン 3.11 で非推奨、バージョン 3.15 で削除予定.

void PySys_SetArgv(int argc, wchar_t **argv)
  次に属します: Stable ABI.

  This API is kept for backward compatibility: setting `PyConfig.argv` and `PyConfig.parse_argv` should be used instead, see Python Initialization Configuration.

  この関数は、 python インタプリタが `-I` オプション付きで実行されている場合を除き `PySys_SetArgvEx()` の updatepath に `1` を設定したのと同じように動作します。

  Use `Py_DecodeLocale()` to decode a bytes string to get a wchar_t* string.

  See also `PyConfig.orig_argv` and `PyConfig.argv` members of the Python Initialization Configuration.

  バージョン 3.4 で変更: updatepath の値は `-I` オプションに依存します。

  バージョン 3.11 で非推奨、バージョン 3.15 で削除予定.

void Py_SetPythonHome(const wchar_t *home)
  次に属します: Stable ABI.

  This API is kept for backward compatibility: setting `PyConfig.home` should be used instead, see Python Initialization Configuration.

  Python の標準ライブラリがある、デフォルトの "home" ディレクトリを設定します。引数の文字列の意味については `PYTHONHOME` を参照してください。

  引数は静的なストレージに置かれてプログラム実行中に書き換えられないようなゼロ終端の文字列であるべきです。Python インタプリタはこのストレージの内容を変更しません。

  Use `Py_DecodeLocale()` to decode a bytes string to get a wchar_t* string.

  バージョン 3.11 で非推奨、バージョン 3.15 で削除予定.

wchar_t *Py_GetPythonHome()
  次に属します: Stable ABI.

  Return the default "home", that is, the value set by `PyConfig.home`, or the value of the `PYTHONHOME` environment variable if it is set.

  This function should not be called before `Py_Initialize()`, otherwise it returns `NULL`.

  バージョン 3.10 で変更: It now returns `NULL` if called before `Py_Initialize()`.

  バージョン 3.13 で非推奨、バージョン 3.15 で削除予定: Use `PyConfig_Get("home")` or the `PYTHONHOME` environment variable instead.