4. Windows で Python を使う
***************************

このドキュメントは、 Python を Microsoft Windows で使うときに知ってお
くべき、 Windows 固有の動作についての概要を伝えることを目的としていま
す。

ほとんどの Unix システムとサービスとは違って、Windows には、システムが
サポートする Python インストールが含まれていません。Python を利用可能
にするために、CPython チームは長年の間、すべての リリース で Windows
インストーラをコンパイルしてきました。単独のユーザで使われるコアインタ
ープリターとライブラリをユーザーごとに追加する Python インストールを、
これらインストーラーは主として意図しています。インストーラでは単一マシ
ンのすべてのユーザ用にインストールすることもでき、また、これとは分離さ
れたアプリケーションローカルな配布物の ZIP ファイルも入手可能です。

**PEP 11** で明記しているとおり Python のリリースは、Microsoft が延長
サポート期間であるとしている Windows プラットフォームのみをサポートし
ます。 つまり Python 3.13 は Windows 8.1 とそれより新しい Windows をサ
ポートするということです。 Windows 7 サポートが必要な場合は、Python
3.8 をインストールしてください。

Windows で使えるインストーラには多くの様々なものがあり、それぞれが利点
と欠点を持っています。

完全版インストーラ には全てのコンポーネントが含まれており、 Python を
使う開発者がどんな種類のプロジェクトでも最適な選択肢です。

Microsoft ストアパッケージ は、スクリプトやパッケージの実行、 IDLE の
使用やその他開発環境に適したシンプルな構成の Python です。 Windows 10
以上が求められはしますが、他のプログラムを壊すことなく安全にインストー
ルできます。 Python やそのツールを起動する多くの便利なコマンドも提供し
ています。

nuget.org パッケージ は、継続的インテグレーションのための軽量なインス
トール構成です。 これは Python パッケージのビルドやスクリプトの実行に
も使えますが、アップデート可能ではなく、ユーザーインターフェイスツール
もありません。

埋め込み可能なパッケージ は、他の大きなアプリケーションに埋め込むのに
適した、 Python の最小パッケージです。


4.1. 完全版インストーラ
=======================


4.1.1. インストール手順
-----------------------

ダウンロードできる Python 3.13 のインストーラは 4 つあります。 インタ
プリタの 32 ビット版、64 ビット版がそれぞれ 2 つずつあります。 *WEB イ
ンストーラ* は最初のダウンロードサイズは小さく、必要なコンポーネントは
インストーラ実行時に必要に応じて自動的にダウンロードします。 *オフライ
ンインストーラ* にはデフォルトインストールに必要なコンポーネントが含ま
れていて、インターネット接続はオプショナルな機能のためにだけに必要とな
ります。 インストール時にダウンロードを避けるほかの方法については ダウ
ンロード不要なインストール を参照して下さい。

インストーラを開始すると、2つの選択肢からひとつを選べます:

[画像]

"Install Now" を選択した場合:

* 管理者権限は *不要です* (ただし C ランタイムライブラリのシステム更新
  が必要であったり、 Windows の Python ランチャ をすべてのユーザ向けに
  インストールする場合は必要です)。

* Python はあなたのユーザディレクトリにインストールされます。

* Windows の Python ランチャ はこのインストールウィザード最初のページ
  の下部のチェックボックス指定に従ってインストールされます。

* 標準ライブラリ、テストスイート、ランチャ、pip がインストールされます
  。

* このインストールウィザード最初の下部のチェックボックスをチェックすれ
  ば、環境変数 "PATH" にインストールディレクトリが追加されます。

* ショートカットはカレントユーザだけに可視になります。

"Customize installation" を選択すると、インストール場所、その他オプシ
ョンやインストール後のアクションの変更などのインストールの有りようを選
べます。デバッグシンボルやデバッグバイナリをインストールするならこちら
を選択する必要があるでしょう。

すべてのユーザのためのインストールのためには "Customize installation"
を選んでください。この場合:

* 管理者資格か承認が必要かもしれません。

* Python は Program Files ディレクトリにインストールされます。

* Windows の Python ランチャ は Windows ディレクトリにインストールされ
  ます。

* オプショナルな機能はインストール中に選択できます。

* 標準ライブラリをバイトコードにプリコンパイルできます。

* そう選択すれば、インストールディレクトリはシステム環境変数 "PATH" に
  追加されます。

* ショートカットがすべてのユーザで利用できるようになります。


4.1.2. MAX_PATH の制限を除去する
--------------------------------

Windows は歴史的にパスの長さが 260 文字に制限されています。 つまり、こ
れより長いパスは解決できず結果としてエラーになるということです。

Windows の最新版では、この制限は約 32,000 文字まで拡張できます。 管理
者が、グループポリシーの "Win32 の長いパスを有効にする (Enable Win32
long paths)" を有効にするか、レジストリキー
"HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem" の
"LongPathsEnabled" の値を "1" に設定する必要があります。

これにより、 "open()" 関数や "os" モジュール、他のほとんどのパスの機能
が 260 文字より長いパスを受け入れ、返すことができるようになります。

これらのオプションを変更したら、それ以上の設定は必要ありません。

バージョン 3.6 で変更: Python で長いパスのサポートが可能になりました。


4.1.3. インストーラの GUI なしでインストールする
------------------------------------------------

インストーラの GUI で利用できるすべてのオプションは、コマンドラインか
らも指定できます。これによりユーザとの対話なしで数多くの機器に同じイン
ストールを行うような、スクリプト化されたインストールを行うことができま
す。ちょっとしたデフォルトの変更のために、GUI を抑制することなしにこれ
らコマンドラインオプションをセットすることもできます。

インストーラーには、以下のオプション ("/?" でインストーラを実行するこ
とで確認できます) を渡すことができます:

+-----------------------+----------------------------------------------------------+
| 名前                  | 説明                                                     |
|=======================|==========================================================|
| /passive              | ユーザーの操作なしでも進捗を表示する                     |
+-----------------------+----------------------------------------------------------+
| /quiet                | UI を表示せずにインストール・アンインストールする        |
+-----------------------+----------------------------------------------------------+
| /simple               | ユーザーによるカスタマイズができないようにする           |
+-----------------------+----------------------------------------------------------+
| /uninstall            | (確認無しで) Python を削除する                           |
+-----------------------+----------------------------------------------------------+
| /layout [ディレクトリ | すべてのコンポーネントを事前にダウンロードする           |
| ]                     |                                                          |
+-----------------------+----------------------------------------------------------+
| /log [ファイル名]     | ログファイルの場所を指定する                             |
+-----------------------+----------------------------------------------------------+

ほかのすべてのオプションは "name=value" の形で渡します。value は大抵
"0" で機能を無効化、 "1" で機能を有効化、であるとかパスの指定です。利
用可能なオプションの完全なリストは以下の通りです。

+-----------------------------+----------------------------------------+----------------------------+
| 名前                        | 説明                                   | デフォルト                 |
|=============================|========================================|============================|
| InstallAllUsers             | システムワイドなインストールを実行する | 0                          |
|                             | 。                                     |                            |
+-----------------------------+----------------------------------------+----------------------------+
| TargetDir                   | インストール先ディレクトリ。           | InstallAllUsers に基いて選 |
|                             |                                        | 択されます。               |
+-----------------------------+----------------------------------------+----------------------------+
| DefaultAllUsersTargetDir    | すべてのユーザ向けインストールのための | "%ProgramFiles%\Python     |
|                             | デフォルトインストール先ディレク トリ  | X.Y" または "%ProgramFile  |
|                             | 。                                     | s(x86)%\Python X.Y"        |
+-----------------------------+----------------------------------------+----------------------------+
| DefaultJustForMeTargetDir   | 自分一人用インストールのためのデフォル | "%LocalAppData%\Programs\  |
|                             | トインストール先ディレクトリ。         | Python\PythonXY" または "  |
|                             |                                        | %LocalAppData%\Programs\P  |
|                             |                                        | ython\PythonXY-32" または  |
|                             |                                        | "%LocalAppData%\Programs\  |
|                             |                                        | Python\PythonXY-64"        |
+-----------------------------+----------------------------------------+----------------------------+
| DefaultCustomTargetDir      | カスタムインストールディレクトリとして | (空)                       |
|                             | デフォルトで GUI に表示される値 。     |                            |
+-----------------------------+----------------------------------------+----------------------------+
| AssociateFiles              | ランチャもインストールする場合に、ファ | 1                          |
|                             | イルの関連付けを行う。                 |                            |
+-----------------------------+----------------------------------------+----------------------------+
| CompileAll                  | すべての ".py" ファイルをバイトコンパ  | 0                          |
|                             | イルして ".pyc" を作る。               |                            |
+-----------------------------+----------------------------------------+----------------------------+
| PrependPath                 | "PATH" にインストールディレクトリと    | 0                          |
|                             | Scripts ディレクトリを先頭に追加し 、  |                            |
|                             | "PATHEXT" に ".PY" を追加する。        |                            |
+-----------------------------+----------------------------------------+----------------------------+
| AppendPath                  | "PATH" にインストールディレクトリと    | 0                          |
|                             | Scripts ディレクトリを追加し、         |                            |
|                             | "PATHEXT" に ".PY" を追加する。        |                            |
+-----------------------------+----------------------------------------+----------------------------+
| Shortcuts                   | インストールするインタプリタ、ドキュメ | 1                          |
|                             | ント、IDLE へのショートカットを 作る。 |                            |
+-----------------------------+----------------------------------------+----------------------------+
| Include_doc                 | Python マニュアルをインストールする。  | 1                          |
+-----------------------------+----------------------------------------+----------------------------+
| Include_debug               | デバッグバイナリをインストールする。   | 0                          |
+-----------------------------+----------------------------------------+----------------------------+
| Include_dev                 | 開発者用ヘッダーとライブラリをインスト | 1                          |
|                             | ールする。これを省略すると、使用 不可  |                            |
|                             | 能なインストールになる可能性があります |                            |
|                             | 。                                     |                            |
+-----------------------------+----------------------------------------+----------------------------+
| Include_exe                 | "python.exe" と関連するファイルをイン  | 1                          |
|                             | ストールする。これを省略すると、 使用  |                            |
|                             | 不可能なインストールになる可能性があり |                            |
|                             | ます。                                 |                            |
+-----------------------------+----------------------------------------+----------------------------+
| Include_launcher            | Windows の Python ランチャ をインスト  | 1                          |
|                             | ールする。                             |                            |
+-----------------------------+----------------------------------------+----------------------------+
| InstallLauncherAllUsers     | すべてのユーザーにランチャーをインスト | 1                          |
|                             | ールする。 "Include_launcher" が 1 に  |                            |
|                             | 設定されている必要があります。         |                            |
+-----------------------------+----------------------------------------+----------------------------+
| Include_lib                 | 標準ライブラリと拡張モジュールをインス | 1                          |
|                             | トールする。これを省略すると、使 用不  |                            |
|                             | 可能なインストールになる可能性がありま |                            |
|                             | す。                                   |                            |
+-----------------------------+----------------------------------------+----------------------------+
| Include_pip                 | バンドル版の pip と setuptools をイン  | 1                          |
|                             | ストールする。                         |                            |
+-----------------------------+----------------------------------------+----------------------------+
| Include_symbols             | デバッグシンボル ("*.pdb") をインスト  | 0                          |
|                             | ールする。                             |                            |
+-----------------------------+----------------------------------------+----------------------------+
| Include_tcltk               | Tcl/Tk サポートと IDLE をインストール  | 1                          |
|                             | する。                                 |                            |
+-----------------------------+----------------------------------------+----------------------------+
| Include_test                | 標準ライブラリのテストスイートをインス | 1                          |
|                             | トールする。                           |                            |
+-----------------------------+----------------------------------------+----------------------------+
| Include_tools               | ユーティリティスクリプトをインストール | 1                          |
|                             | する。                                 |                            |
+-----------------------------+----------------------------------------+----------------------------+
| LauncherOnly                | ランチャのみをインストールする。これは | 0                          |
|                             | 他のほとんどのオプションを上書き しま  |                            |
|                             | す。                                   |                            |
+-----------------------------+----------------------------------------+----------------------------+
| SimpleInstall               | 最大限のインストーラ GUI を無効にする  | 0                          |
|                             | 。                                     |                            |
+-----------------------------+----------------------------------------+----------------------------+
| SimpleInstallDescription    | 単純化されたインストーラ GUI を使う際  | (空)                       |
|                             | に表示するカスタムメッセージ。         |                            |
+-----------------------------+----------------------------------------+----------------------------+

例えばデフォルトでシステムワイドな Python インストレーションを静かに行
うには、以下コマンドを使えます (コマンドプロンプトより):

   python-3.9.0.exe /quiet InstallAllUsers=1 PrependPath=1 Include_test=0

テストスイートなしの Python のパーソナルなコピーのインストールをユーザ
に簡単に行わせるには、以下コマンドのショートカットを作れば良いです。こ
れはインストーラの最初のページを単純化して表示し、また、カスタマイズで
きないようにします:

   python-3.9.0.exe InstallAllUsers=0 Include_launcher=0 Include_test=0
       SimpleInstall=1 SimpleInstallDescription="Just for me, no test suite."

(ランチャのインストールを省略するとファイルの関連付けも省略されるので
、これはランチャインストールを含めたシステムワイドなインストールをした
場合のユーザごとインストールに限った場合のお勧めです。)

上でリストしたオプションは、実行ファイルと同じ場所の "unattend.xml" と
名付けられたファイルで与えることもできます。このファイルはオプションと
その値のリストを指定します。値がアトリビュートとして与えられた場合、そ
れは数値であれば数値に変換されます。エレメントテキストで与える場合は常
に文字列のままです。以下は、先の例と同じオプションをセットするファイル
の実例です:

   <Options>
       <Option Name="InstallAllUsers" Value="no" />
       <Option Name="Include_launcher" Value="0" />
       <Option Name="Include_test" Value="no" />
       <Option Name="SimpleInstall" Value="yes" />
       <Option Name="SimpleInstallDescription">Just for me, no test suite</Option>
   </Options>


4.1.4. ダウンロード不要なインストール
-------------------------------------

Python のいくつかの機能は最初にダウンロードしたインストーラには含まれ
ていないため、それらの機能をインストールしようと選択するとインターネッ
ト接続が必要になります。 インターネット接続が必要にならないように、全
てのコンポーネントをすぐにできる限りダウンロードして、完全な *配置構成
(layout)* を作成し、どんな機能が選択されたかに関わらず、それ以上インタ
ーネット接続を必要がないようにします。 この方法のダウンロードサイズは
必要以上に大きくなるかもしれませんが、たくさんの回数インストールしよう
とする場合には、ローカルにキャッシュされたコピーを持つことはとても有用
です。

コマンドプロンプトから以下のコマンドを実行して、必要なファイルをできる
限り全てダウンロードします。 "python-3.9.0.exe" 部分は実際のインストー
ラの名前に置き換え、同名のファイルどうしの衝突が起こらないように、個別
のディレクトリ内に配置構成を作るのを忘れないようにしてください。

   python-3.9.0.exe /layout [optional target directory]

進捗表示を隠すのに "/quiet" オプションを指定することもできます。


4.1.5. インストール後の変更
---------------------------

いったん Python がインストールされたら、Windows のシステム機能の「プロ
グラムと機能」ツールから機能の追加や削除ができます。Python のエントリ
を選択して「アンインストールと変更」を選ぶことで、インストーラをメンテ
ナンスモードで開きます。

インストーラ GUI で "Modify" を選ぶと、チェックボックスの選択を変える
ことで機能の追加削除ができます - チェックボックスの選択を変えなければ
、何かがインストールされたり削除されたりはしません。いくつかのオプショ
ンはこのモードでは変更することはできません。インストールディレクトリな
どです。それらを変えたいのであれば、完全に削除してから再インストールす
る必要があります。

"Repair" では、現在の設定で本来インストールされるべきすべてのファイル
を検証し、削除されていたり更新されていたりするファイルを修正します。

"Uninstall" は Python を完全に削除します。「プログラムと機能」内の自身
のエントリを持つ Windows の Python ランチャ の例外が起こります。


4.1.6. フリースレッドバイナリ (Free-threaded Binaries) のインストール
---------------------------------------------------------------------

Added in version 3.13: (実験的)

注釈:

  このセクションで説明されているすべての項目は実験的とみなされており、
  将来のリリースで変更される可能性があります。

To install pre-built binaries with free-threading enabled (see **PEP
703**), you should select "Customize installation". The second page of
options includes the "Download free-threaded binaries" checkbox.

[画像]

Selecting this option will download and install additional binaries to
the same location as the main Python install. The main executable is
called "python3.13t.exe", and other binaries either receive a "t"
suffix or a full ABI suffix. Python source files and bundled third-
party dependencies are shared with the main install.

The free-threaded version is registered as a regular Python install
with the tag "3.13t" (with a "-32" or "-arm64" suffix as normal for
those platforms). This allows tools to discover it, and for the
Windows の Python ランチャ to support "py.exe -3.13t". Note that the
launcher will interpret "py.exe -3" (or a "python3" shebang) as "the
latest 3.x install", which will prefer the free-threaded binaries over
the regular ones, while "py.exe -3.13" will not. If you use the short
style of option, you may prefer to not install the free-threaded
binaries at this time.

To specify the install option at the command line, use
"Include_freethreaded=1". See ダウンロード不要なインストール for
instructions on pre-emptively downloading the additional binaries for
offline install. The options to include debug symbols and binaries
also apply to the free-threaded builds.

Free-threaded binaries are also available on nuget.org.


4.2. Microsoft ストアパッケージ
===============================

Added in version 3.7.2.

Microsoft ストアパッケージは、例えば生徒が主に対話型で使うことを意図し
た簡単にインストールできる Python インタプリタです。

このパッケージをインストールするには、最新の Windows 10 のアップデート
になっていることを確認し、 Microsoft ストアアプリで "Python 3.13" と検
索します。 選んだアプリが Python Software Foundation が公開したもので
あることを確認して、インストールします。

警告:

  Python は常に Microsoft ストアで無料で利用できます。 もしお金を払う
  ように要求されたなら、正しいパッケージを選んでいません。

インストールした後は、スタートメニューから Python を見付けて起動するで
しょう。 あるいは、 "python" とタイプしてコマンドプロンプトや
PowerShell のセッションから使えるでしょう。 さらに、 "pip" や "idle"
とタイプして pip あるいは IDLE を利用できます。 IDLE はスタートメニュ
ーからも見付けられます。

All three commands are also available with version number suffixes,
for example, as "python3.exe" and "python3.x.exe" as well as
"python.exe" (where "3.x" is the specific version you want to launch,
such as 3.13). Open "Manage App Execution Aliases" through Start to
select which version of Python is associated with each command. It is
recommended to make sure that "pip" and "idle" are consistent with
whichever version of "python" is selected.

仮想環境は "python -m venv" で作成し、有効化して普通に使えます。

既に別のバージョンの Python をインストールして "PATH" 変数に追加してあ
る場合は、 Microsoft ストアのものではない "python.exe" として使えます
。 新しくインストールした Python にアクセスするには、 "python3.exe" あ
るいは "python3.x.exe" として使えます。

"py.exe" ランチャーはこの Python のインストールを見つけますが、従来の
インストーラーによるインストールを優先します。

Python を除去するには、「設定」を開き「アプリと機能」を使うか、「スタ
ート」にある Python を右クリックしてアンインストールします。 アンイン
ストールでは、この Python に直接インストールした全てのパッケージが除去
されますが、仮想環境はどれも除去されません。


4.2.1. 既知の問題
-----------------


4.2.1.1. Redirection of local data, registry, and temporary paths
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Microsoft ストアアプリの制限により、 Python スクリプトには "TEMP" やレ
ジストリのような共有の場所への完全な書き込み権限は無いでしょう。 その
代わり、個人用のところへ書き込みます。 スクリプトで共有の場所で変更し
なければならない場合は、完全版のインストーラでインストールする必要があ
ります。

At runtime, Python will use a private copy of well-known Windows
folders and the registry. For example, if the environment variable
"%APPDATA%" is "c:\Users\<user>\AppData\", then when writing to
"C:\Users\<user>\AppData\Local" will write to "C:\Users\<user>\AppDat
a\Local\Packages\PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0\Lo
calCache\Local\".

When reading files, Windows will return the file from the private
folder, or if that does not exist, the real Windows directory. For
example reading "C:\Windows\System32" returns the contents of
"C:\Windows\System32" plus the contents of "C:\Program
Files\WindowsApps\package_name\VFS\SystemX86".

You can find the real path of any existing file using
"os.path.realpath()":

   >>> import os
   >>> test_file = 'C:\\Users\\example\\AppData\\Local\\test.txt'
   >>> os.path.realpath(test_file)
   'C:\\Users\\example\\AppData\\Local\\Packages\\PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0\\LocalCache\\Local\\test.txt'

When writing to the Windows Registry, the following behaviors exist:

* Reading from "HKLM\\Software" is allowed and results are merged with
  the "registry.dat" file in the package.

* Writing to "HKLM\\Software" is not allowed if the corresponding
  key/value exists, i.e. modifying existing keys.

* Writing to "HKLM\\Software" is allowed as long as a corresponding
  key/value does not exist in the package and the user has the correct
  access permissions.

For more detail on the technical basis for these limitations, please
consult Microsoft's documentation on packaged full-trust apps,
currently available at docs.microsoft.com/en-us/windows/msix/desktop
/desktop-to-uwp-behind-the-scenes


4.3. nuget.org パッケージ
=========================

Added in version 3.5.2.

nuget.org パッケージはサイズを縮小した Python 環境で、システム全体で使
える Python が無い継続的インテグレーションやビルドシステムで使うことを
意図しています。 nuget は ".NET のためのパッケージマネージャ" ですが、
ビルド時に使うツールを含んだパッケージに対しても非常に上手く動作します
。

nuget の使用方法についての最新の情報を得るには nuget.org に行ってくだ
さい。 ここから先は Python 開発者にとって十分な要約です。

"nuget.exe" コマンドラインツールは、例えば curl や PowerShell を使って
"https://aka.ms/nugetclidl" から直接ダウンロードできるでしょう。 この
ツールを次のように使って、 64 bit あるいは 32 bit のマシン向けの最新バ
ージョンの Python がインストールできます:

   nuget.exe install python -ExcludeVersion -OutputDirectory .
   nuget.exe install pythonx86 -ExcludeVersion -OutputDirectory .

特定のバージョンを選択するには、 "-Version 3.x.y" を追加してください。
出力ディレクトリは "." から変更されることがあり、パッケージはサブディ
レクトリにインストールされます。 デフォルトではサブディレクトリはパッ
ケージと同じ名前になり、 "-ExcludeVersion" オプションを付けないとこの
名前はインストールされたバージョンを含みます。 サブディレクトリの中に
はインストールされた Python を含んでいる "tools" ディレクトリがありま
す:

   # Without -ExcludeVersion
   > .\python.3.5.2\tools\python.exe -V
   Python 3.5.2

   # With -ExcludeVersion
   > .\python\tools\python.exe -V
   Python 3.5.2

一般的には、 nuget パッケージはアップグレードできず、より新しいバージ
ョンは横並びにインストールされ、フルパスで参照されます。 そうする代わ
りに、手動で直接パッケージを削除し、再度インストールすることもできます
。 多くの CI システムは、ビルド間でファイルを保存しておかない場合、こ
の作業を自動的に行います。

"tools" ディレクトリと同じ場所に "build\native" ディレクトリがあります
。 このディレクトリは、インストールされた Python を参照する C++ プロジ
ェクトで使える MSBuild プロパティファイル "python.props" を含みます。
ここに設定を入れると自動的にヘッダを使い、ビルド時にライプラリをインポ
ートします。

The package information pages on nuget.org are
www.nuget.org/packages/python for the 64-bit version,
www.nuget.org/packages/pythonx86 for the 32-bit version, and
www.nuget.org/packages/pythonarm64 for the ARM64 version


4.3.1. フリースレッドパッケージ (Free-threaded packages)
--------------------------------------------------------

Added in version 3.13: (実験的)

注釈:

  このセクションで説明されているすべての項目は実験的とみなされており、
  将来のリリースで変更される可能性があります。

フリースレッドバイナリ (free-threaded binaries) を含むパッケージは、
64-bit 版では python-freethreaded 、 32-bit 版では
pythonx86-freethreaded 、 ARM64 版では pythonarm64-freethreaded と命名
されます。これらのパッケージはともに "python3.13t.exe" と "python.exe"
エントリーポイントを含み、どちらもフリースレッドで実行されます。


4.4. 埋め込み可能なパッケージ
=============================

Added in version 3.5.

埋め込み用の配布 (embedded distribution) は、最小限の Python 環境を含
んだ ZIP ファイルです。これは、エンドユーザから直接的にアクセスされる
のではなく何かアプリケーションの一部として動作することを意図したもので
す。

展開されると、埋め込み用の配布は、環境変数、システムレジストリの設定、
インストールされているパッケージといったユーザのシステムから (ほぼ) 完
全に独立しています。 ZIP 内には標準ライブラリがプリコンパイルにより最
適化された ".pyc" として含まれ、また、 "python3.dll", "python37.dll",
"python.exe", "pythonw.exe" のすべてが入っています。(IDLE のようなすべ
ての依存物を含む) Tcl/tk、pip、Python ドキュメントは含まれていません。

注釈:

  埋め込み用配布には Microsoft C Runtime は含まれません。これを提供す
  るのはアプリケーションのインストーラの責務です。そのランタイムは既に
  以前にユーザのシステムにインストール済みかもしれませんし、Windows
  Update により自動で更新されているかもしれません。このことはシステム
  ディレクトリに "ucrtbase.dll" があるか探せばわかります。

サードパーティのパッケージはアプリケーションのインストーラによって、埋
め込み用配布と同じ場所にインストールされるべきです。通常の Python イン
ストレーションのように依存性管理に pip を使うことは、この配布ではサポ
ートされません。ですが、ちょっとした注意を払えば、自動更新のために pip
を含めて利用することはできるかもしれません。一般的には、ユーザに更新を
提供する前に開発者が新しいバージョンとの互換性を保証できるよう、サード
パーティーのパッケージはアプリケーションの一部として扱われるべきです
("vendoring")。

この配布の 2 つのお勧めできるユースケースを、以下で説明します。


4.4.1. Python アプリケーション
------------------------------

Python で記述された、必ずしもユーザにその事実を意識させる必要のないア
プリケーションです。埋め込み用配布はこのケースで、インストールパッケー
ジ内に Python のプライベートバージョンを含めるのに使えるでしょう。その
事実がどのように透過的であるべきかに依存して (あるいは逆に、どのように
プロフェッショナルにみえるべきか)、2 つの選択肢があります。

ランチャとなる特別な実行ファイルを使うことはちょっとしたコーディングを
必要としますが、ユーザにとっては最も透過的なユーザ体験となります。カス
タマイズされたランチャでは、何もしなければ Python で実行されるプログラ
ムの明白な目印はありません; アイコンはカスタマイズし、会社名やバージョ
ン情報を指定し、ファイルの関連付けがそれに相応しく振舞うようにできます
。ほとんどのケースではカスタムランチャは、ハードコードされたコマンドラ
イン文字列で単純に "Py_Main" を呼び出すので済むはずです。

より簡単なアプローチは、 "python.exe" または "pythonw.exe" を必要なコ
マンドライン引数とともに直接呼び出すバッチファイルかショートカットを提
供することです。この場合、そのアプリケーションは実際の名前ではなく
Python であるようにみえるので、ほかに動作している Python プロセスやフ
ァイルの関連付けと区別するのにユーザが困るかもしれません。

後者のアプローチではパッケージは、パス上で利用可能であることを保証する
ために、Python 実行ファイルと同じディレクトリにインストールされるべき
です。特別なランチャの場合はアプリケーション起動前に検索パスを指定する
機会があるので、パッケージはほかの場所に配置できます。


4.4.2. Python の埋め込み
------------------------

ネイティブコードで書かれ、時々スクリプト言語のようなものを必要とするよ
うなアプリケーションです。Python 埋め込み用の配布はこの目的に使えます
。一般的に、アプリケーションの大半がネイティブコード内にあり、一部が
"python.exe" を呼び出すか、直接的に "python3.dll" を使います。どちらの
ケースでも、ロード可能な Python インタプリタを提供するのには、埋め込み
用の配布を展開してアプリケーションのインストレーションのサブディレクト
リに置くことで十分です。

アプリケーションが使うパッケージは、インタプリタ初期化前に検索パスを指
定する機会があるので、任意の場所にインストールできます。また、埋め込み
用配布を使うのと通常の Python インストレーションを使うのとでの根本的な
違いはありません。


4.5. 別のバンドル
=================

標準の CPython の配布物の他に、追加の機能を持っている修正されたパッケ
ージがあります。以下は人気のあるバージョンとそのキーとなる機能です:

ActivePython
   マルチプラットフォーム互換のインストーラー、ドキュメント、 PyWin32

Anaconda
   人気のある (numpy, scipy や pandas のような) 科学系モジュールと、パ
   ッケージマネージャ "conda" 。

Enthought Deployment Manager
   "次世代の Python 環境とパッケージマネージャー" ("The Next
   Generation Python Environment and Package Manager")。

   以前は Enthought が Canopy を提供していましたが、これは 2016 年にサ
   ポートが終了しました。

WinPython
   ビルド済みの科学系パッケージと、パッケージのビルドのためのツールを
   含む、Windows 固有のディストリビューション。

これらパッケージは Python や他のライブラリの最新バージョンが含まれると
は限りませんし、コア Python チームはこれらを保守もしませんしサポートも
しませんのでご理解ください。


4.6. Python を構成する
======================

コマンドプロンプトより便利に Python を実行するために、Windows のデフォ
ルトの環境変数をいくつか変えたいと思うかもしれません。インストーラは
"PATH" と "PATHEXT" 変数を構成させるオプションを提供してはいますが、こ
れは単独のシステムワイドなインストレーションの場合にだけ頼りになるもの
です。もしもあなたが定常的に複数バージョンの Python を使うのであれば、
Windows の Python ランチャ の利用を検討してください。


4.6.1. 補足: 環境変数の設定
---------------------------

Windows では、環境変数を恒久的にユーザレベルとシステムレベルの両方で設
定でき、あるいはコマンドプロンプトから一時的にも設定できます。

一時的に環境変数を設定するには、コマンドプロンプトを開き **set** コマ
ンドを使います:

   C:\>set PATH=C:\Program Files\Python 3.9;%PATH%
   C:\>set PYTHONPATH=%PYTHONPATH%;C:\My_python_lib
   C:\>python

これらの変更は、以降に実行される同じコンソール内で実行される任意のコマ
ンドに適用され、また、そのコンソールから開始するすべてのアプリケーショ
ンに引き継がれます。

パーセント記号で変数名を囲んだものは既存の変数の値で展開されるので、新
しい値を最初にも最後にも追加することができます。 **python.exe** が入っ
ているディレクトリを "PATH" に追加することは、Python の適切なバージョ
ンが起動するように保証するための一般的な方法です。

デフォルトの環境変数を恒久的に変更するには、「スタート」をクリックして
検索ボックスで「環境変数を編集」を検索するか、(コンピュータのプロパテ
ィなどから) システムの詳細設定 を開いて 環境変数の設定 ボタンをクリッ
クしてください。これで立ち上がるダイアログで、ユーザ環境変数とシステム
環境変数を追加したり修正したりできます。システム変数を変更するにはあな
たのマシンへの制限のないアクセス (つまり管理者権限) が必要です。

注釈:

  Windows はシステム変数の *後ろに* ユーザ変数を結合します。この振る舞
  いにより "PATH" の修正時に期待とは異なる結果になることがあります。
  "PYTHONPATH" 変数は Python のすべてのバージョンで使われるので、イン
  ストールされているすべての Python バージョンに互換性のあるコードだけ
  がパスの一覧に含まれているのでない限り、これは恒久的な設定をすべきで
  はありません。

参考:

  https://learn.microsoft.com/ja-jp/windows/win32/procthread
  /environment-variables
     Windows の環境変数の概要

  https://learn.microsoft.com/ja-jp/windows-server/administration
  /windows-commands/set_1
     一時的に環境変数を変更するための "set" コマンドについて

  https://learn.microsoft.com/ja-jp/windows-server/administration
  /windows-commands/setx
     恒久的に環境変数を変更するための "setx" コマンドについて。


4.6.2. Python 実行ファイルを見つける
------------------------------------

バージョン 3.5 で変更.

自動的に作成される Python インタープリタのスタートメニュー項目を使うだ
けでなく、Python をコマンドプロンプトから起動したいと思うかもしれませ
ん。 インストーラにはそのための設定を行うオプションがあります。

インストーラの最初のページに "Add Python to PATH" というラベルのオプシ
ョンがあり、これを選択するとインストーラはインストール場所を環境変数
"PATH" に追加します。 "Scripts\" フォルダの場所も追加されます。 これに
よりコマンドプロンプトから **python** とタイプしてインタプリタを起動し
たり、 **pip** とタイプしてパッケージインストーラを起動したりできます
。 コマンドラインからの起動なので、スクリプトをコマンドライン引数付き
で起動することもできます。 コマンドライン の文章を参照して下さい。

インストール時にこのオプションを有効にしていなかったとしても、インスト
ーラを再度実行して「Modify」を選んで、それを有効にし直せます。あるいは
そうせずとも、 "PATH" 変数は手動で修正できます。 補足: 環境変数の設定
を参照してください。環境変数 "PATH" には Python インストールディレクト
リを含む必要があります。ほかのエントリとはセミコロンで区切って繋いでく
ださい。これの実例は以下のようになります (以下最初の 2 つのエントリは
既に存在しているものと仮定しています):

   C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Python 3.9


4.7. UTF-8 モード
=================

Added in version 3.7.

Windows still uses legacy encodings for the system encoding (the ANSI
Code Page).  Python uses it for the default encoding of text files
(e.g. "locale.getencoding()").

This may cause issues because UTF-8 is widely used on the internet and
most Unix systems, including WSL (Windows Subsystem for Linux).

You can use the Python UTF-8 Mode to change the default text encoding
to UTF-8. You can enable the Python UTF-8 Mode via the "-X utf8"
command line option, or the "PYTHONUTF8=1" environment variable.  See
"PYTHONUTF8" for enabling UTF-8 mode, and 補足: 環境変数の設定 for how
to modify environment variables.

When the Python UTF-8 Mode is enabled, you can still use the system
encoding (the ANSI Code Page) via the "mbcs" codec.

Note that adding "PYTHONUTF8=1" to the default environment variables
will affect all Python 3.7+ applications on your system. If you have
any Python 3.7+ applications which rely on the legacy system encoding,
it is recommended to set the environment variable temporarily or use
the "-X utf8" command line option.

注釈:

  Even when UTF-8 mode is disabled, Python uses UTF-8 by default on
  Windows for:

  * Console I/O including standard I/O (see **PEP 528** for details).

  * The *filesystem encoding* (see **PEP 529** for details).


4.8. Windows の Python ランチャ
===============================

Added in version 3.3.

Windows の Python ランチャは、異なる Python のバージョンの位置の特定と
実行を助けるユーティリティです。スクリプト (またはコマンドライン) で特
定の Python のバージョンの設定を与えられると、位置を特定し、そのバージ
ョンを実行します。

環境変数 "PATH" による方法と違って、このランチャは Python の一番適切な
バージョンを、正しく選択します。このランチャはシステムワイドなものより
もユーザごとのインストレーションの方を優先し、また、新しくインストール
された順よりも言語のバージョンを優先します。

ランチャのオリジナルの仕様は **PEP 397** にあります。


4.8.1. 最初に
-------------


4.8.1.1. コマンドラインから起動する
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

バージョン 3.6 で変更.

Python 3.3 とそれ以降のシステムワイドなインストールでは、ランチャーが
"PATH" に追加されます。ランチャーは、入手可能なあらゆる Python のバー
ジョンに互換性があるため、実際にどのバージョンの Python がインストール
されているのかは重要ではありません。ランチャーが使えるかを確認するには
以下のコマンドをコマンドプロンプトで実行してください:

   py

インストールされている最新バージョンの Python が起動するはずです。 通
常どおりに終了することもできますし、追加のコマンドライン引数を指定して
直接 Python に渡すこともできます。

複数のバージョンの Python (たとえば 3.7 と 3.13) がインストールされて
いる場合は、Python 3.13 が起動することになります。Python 3.7 を起動し
たいなら、次のコマンドを実行してみてください:

   py -3.7

インストールしてある Python 2 の最新バージョンを起動したい場合は、次の
コマンドを実行してみてください:

   py -2

以下のようなエラーが出るようであれば、ランチャはインストールされていま
せん:

   'py' is not recognized as an internal or external command,
   operable program or batch file.

このコマンド:

   py --list

これは、現在インストールされている Python のバージョンを表示します。

The "-x.y" argument is the short form of the "-V:Company/Tag"
argument, which allows selecting a specific Python runtime, including
those that may have come from somewhere other than python.org. Any
runtime registered by following **PEP 514** will be discoverable. The
"--list" command lists all available runtimes using the "-V:" format.

When using the "-V:" argument, specifying the Company will limit
selection to runtimes from that provider, while specifying only the
Tag will select from all providers. Note that omitting the slash
implies a tag:

   # Select any '3.*' tagged runtime
   py -V:3

   # Select any 'PythonCore' released runtime
   py -V:PythonCore/

   # Select PythonCore's latest Python 3 runtime
   py -V:PythonCore/3

The short form of the argument ("-3") only ever selects from core
Python releases, and not other distributions. However, the longer form
("-V:3") will select from any.

The Company is matched on the full string, case-insenitive. The Tag is
matched oneither the full string, or a prefix, provided the next
character is a dot or a hyphen. This allows "-V:3.1" to match
"3.1-32", but not "3.10". Tags are sorted using numerical ordering
("3.10" is newer than "3.1"), but are compared using text ("-V:3.01"
does not match "3.1").


4.8.1.2. 仮想環境 (Virtual environments)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Added in version 3.5.

(標準ライブラリの "venv" モジュールか外部ツール "virtualenv" で作った)
仮想環境がアクティブな状態で Python の明示的なバージョンを指定せずにラ
ンチャを起動すると、ランチャはグローバルなインタプリタではなくその仮想
環境のものを実行します。グローバルなほうのインタプリタを実行するには、
仮想環境の動作を停止するか、または明示的にグローバルな Python バージョ
ンを指定してください。


4.8.1.3. スクリプトから起動する
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

テスト用の Python スクリプトを作成しましょう。"hello.py" という名前で
以下の内容のファイルを作成してください

   #! python
   import sys
   sys.stdout.write("hello from Python %s\n" % (sys.version,))

hello.py が存在するディレクトリで、下記コマンドを実行してください:

   py hello.py

インストールされている最新の Python 2.x のバージョン番号が表示されるは
ずです。では、1行目を以下のように変更してみてください:

   #! python3

コマンドを再実行すると、今度は最新の Python 3.x の情報が表示されるはず
です。これまでのコマンドラインの例と同様に、より細かいバージョン修飾子
を指定することもできます。Python 3.7 がインストールされている場合、最
初の行を "#! python3.7" に変更すると、3.7 のバージョン情報が表示される
はずです。

コマンドからの呼び出しとは異なり、後ろに何もつかない "python" はインス
トールされている Python2.x の最新バージョンを利用することに注意してく
ださい。これは後方互換性と、 "python" が一般的に Python 2 を指すUnix
との互換性のためです。


4.8.1.4. ファイルの関連付けから起動する
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

インストール時に、ランチャは Python ファイル (すなわち ".py", ".pyw",
".pyc" ファイル) に関連付けられたはずです。そのため、これらのファイル
を Windows のエクスプローラーでダブルクリックした際はランチャが使われ
、上で述べたのと同じ機能を使ってスクリプトが使われるべきバージョンを指
定できるようになります。

このことによる重要な利点は、単一のランチャが先頭行の内容によって複数の
Python バージョンを同時にサポートできることです。


4.8.2. シェバン (shebang) 行
----------------------------

スクリプトファイルの先頭の行が "#!" で始まっている場合は、その行はシェ
バン (shebang) 行として知られています。 Linux や他の Unix 系 OS はこう
した行をもともとサポートしているため、それらのシステムでは、スクリプト
がどのように実行されるかを示すために広く使われます。 Windows の Python
ランチャは、Windows 上の Python スクリプトが同じ機能を使用できるように
し、上の例ではそれらの機能の使用法を示しています。

Python スクリプトのシェバン行を Unix-Windows 間で移植可能にするため、
このランチャは、どのインタプリタが使われるかを指定するための大量の '仮
想' コマンドをサポートしています。サポートされる仮想コマンドには以下の
ものがあります:

* "/usr/bin/env"

* "/usr/bin/python"

* "/usr/local/bin/python"

* "python"

具体的に、もしスクリプトの1行目が

   #! /usr/bin/python

で始まっていたら、デフォルトの Python またはアクティブな仮想環境の位置
が特定され、使用されます。多くの Unix 上で動作する Python スクリプトに
はすでにこの行が存在する傾向がありますので、ランチャによりそれらのスク
リプトを修正なしで使うことができるはずです。あなたが新しいスクリプトを
Windows 上で書いていて、Unix 上でも有用であってほしいと思うなら、シェ
バン行のうち "/usr" で始まるものを使用すべきです。

上記のどの仮想コマンドでも、(メジャーバージョンだけや、メジャー・マイ
ナーバージョンの両方で) 明示的にバージョンを指定できます。 さらに、
"-32" をマイナーバージョンの後ろに追加して 32-bit 版を要求できます。
例えば、 "/usr/bin/python3.7-32" は 32-bit の Python 3.7 を使うよう要
求します。仮想環境がアクティブになっている場合は、バージョンは無視され
、その環境が使用されます。

Added in version 3.7: python ランチャの 3.7 からは、末尾に "-64" を付
けて 64-bit 版を要求できます。 さらに、マイナーバージョン無しのメジャ
ーバージョンとアーキテクチャだけ (例えば、 "/usr/bin/python3-64") で指
定できます。

バージョン 3.11 で変更: The "-64" suffix is deprecated, and now
implies "any architecture that is not provably i386/32-bit". To
request a specific environment, use the new "-V:*TAG*" argument with
the complete tag.

バージョン 3.13 で変更: Virtual commands referencing "python" now
prefer an active virtual environment rather than searching "PATH".
This handles cases where the shebang specifies "/usr/bin/env python3"
but "python3.exe" is not present in the active environment.

The "/usr/bin/env" form of shebang line has one further special
property. Before looking for installed Python interpreters, this form
will search the executable "PATH" for a Python executable matching the
name provided as the first argument. This corresponds to the behaviour
of the Unix "env" program, which performs a "PATH" search. If an
executable matching the first argument after the "env" command cannot
be found, but the argument starts with "python", it will be handled as
described for the other virtual commands. The environment variable
"PYLAUNCHER_NO_SEARCH_PATH" may be set (to any value) to skip this
search of "PATH".

Shebang lines that do not match any of these patterns are looked up in
the "[commands]" section of the launcher's .INI file. This may be used
to handle certain commands in a way that makes sense for your system.
The name of the command must be a single argument (no spaces in the
shebang executable), and the value substituted is the full path to the
executable (additional arguments specified in the .INI will be quoted
as part of the filename).

   [commands]
   /bin/xpython=C:\Program Files\XPython\python.exe

Any commands not found in the .INI file are treated as **Windows**
executable paths that are absolute or relative to the directory
containing the script file. This is a convenience for Windows-only
scripts, such as those generated by an installer, since the behavior
is not compatible with Unix-style shells. These paths may be quoted,
and may include multiple arguments, after which the path to the script
and any additional arguments will be appended.


4.8.3. シェバン行の引数
-----------------------

シェバン行では Python インタプリタに渡される追加の引数を指定することも
できます。たとえば、シェバン行に以下のように書かれているとしましょう:

   #! /usr/bin/python -v

この場合、Python は "-v" オプション付きで起動するでしょう


4.8.4. カスタマイズ
-------------------


4.8.4.1. INI ファイルによるカスタマイズ
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

ランチャは2つの .ini ファイルを探しに行きます。具体的には、現在のユー
ザーのアプリケーションデータディレクトリ ("%LOCALAPPDATA%" または
"$env:LocalAppData") の "py.ini" と、ランチャと同じディレクトリにある
"py.ini" です。'コンソール' 版のランチャ (つまり py.exe) と 'Windows'
版のランチャ (つまり pyw.exe) は同一の .ini ファイルを使用します。

"application data" ディレクトリで指定された設定は、実行ファイルの隣に
あるものより優先されます。そのため、ランチャの隣にある .ini ファイルへ
の書き込みアクセスができないユーザは、グローバルな .ini ファイル内のコ
マンドを上書き (override) できます。


4.8.4.2. デフォルトのPythonバージョンのカスタマイズ
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

どのバージョンの Python をコマンドで使用するかを定めるため、バージョン
修飾子がコマンドに含められることがあります。 バージョン修飾子はメジャ
ーバージョン番号で始まり、オプションのピリオド ('.') とマイナーバージ
ョン指定子がそれに続きます。 さらに、 "-32" や "-64" を追記して 32-bit
あるいは 64-bit のどちらの実装が要求されるかを指示できます。

たとえば、"#!python" というシェバン行はバージョン修飾子を含みませんが
、"#!python3" はメジャーバージョンを指定するバージョン修飾子を含みます
。

コマンドにバージョン修飾子が見つからない場合、環境変数 "PY_PYTHON" を
設定して、デフォルトのバージョン修飾子を指定できます。 設定されていな
い場合、デフォルト値は "3" です。 この変数には "3", "3.7", "3.7-32",
"3.7-64" のような任意の値をコマンドラインから指定できます。 ("-64" オ
プションは Python 3.7 以降のランチャでしか使えないことに注意してくださ
い。)

マイナーバージョン修飾子が見つからない場合、環境変数
"PY_PYTHON{major}" (ここで "{major}" は、上記で決定された現在のメジャ
ーバージョン修飾子) を設定して完全なバージョンを指定することができます
。そういったオプションが見つからなければ、ランチャはインストール済みの
Python バージョンを列挙して、見つかったそのメジャーバージョン向けマイ
ナーリリースのうち最新のものを使用します。保証されているわけではありま
せんが、通常はそのメジャーバージョン系で最も後にインストールしたバージ
ョンになります。

64-bit Windows で、同一の (major.minor) Python バージョンの 32-bit と
64-bit の両方の実装がインストールされていた場合、64-bit バージョンのほ
うが常に優先されます。これはランチャが 32-bit と 64-bit のどちらでも言
えることで、32-bit のランチャは、指定されたバージョンが使用可能であれ
ば、64-bit の Python を優先して実行します。これは、どのバージョンが PC
にインストールされているかのみでランチャの挙動を予見でき、それらがイン
ストールされた順番に関係なくなる (つまり最後にインストールされた
Python とランチャが 32-bit か 64-bit かを知らなくともよい) ようにする
ためです。上に記したとおり、オプションの "-32", "-64" サフィックスでこ
の挙動を変更できます。

例:

* 関連するオプションが設定されていない場合、"python" および "python2"
  コマンドはインストールされている最新の Python 2.x バージョンを使用し
  、"python3" コマンドはインストールされている最新の Python 3.x を使用
  します。

* "python3.7" コマンドは、バージョンが完全に指定されているため、全くオ
  プションを参照しません。

* "PY_PYTHON=3" の場合、"python" および "python3" コマンドはともにイン
  ストールされている最新の Python 3 を使用します。

* "PY_PYTHON=3.7-32" の場合、"python" コマンドは 32-bit 版の 3.7 を使
  用しますが、"python3" コマンドはインストールされている最新の Python
  を使用します (メジャーバージョンが指定されているため、PY_PYTHON は全
  く考慮されません。)

* "PY_PYTHON=3" で "PY_PYTHON3=3.7" の場合、"python" および "python3"
  はどちらも 3.7 を使用します

環境変数に加え、同じ設定をランチャが使う INI ファイルで構成することが
できます。INI ファイルの該当するセクションは "[defaults]" と呼ばれ、キ
ー名は環境変数のキー名から "PY_" という接頭辞を取ったものと同じです
(INI ファイルのキー名は大文字小文字を区別しないことにご注意ください)。
環境変数の内容は INI ファイルでの指定を上書きします。

例えば:

* "PY_PYTHON=3.7" と設定することは、INI ファイルに下記が含まれることと
  等価です:

   [defaults]
   python=3.7

* "PY_PYTHON=3" と "PY_PYTHON3=3.7" を設定することは、INI ファイルに下
  記が含まれることと等価です:

   [defaults]
   python=3
   python3=3.7


4.8.5. 診断
-----------

環境変数 "PYLAUNCHER_DEBUG" が設定されていたら (設定値が何であっても)
、ランチャは診断情報を stderr (つまりコンソール) に出力します。この情
報のメッセージは詳細で *しかも* きついものですが、どういったバージョン
の Python が検知されたか、なぜ特定のバージョンが選択されたか、そして、
対象の Python を実行するのに使われた正確なコマンドラインを教えてくれま
す。これは主にテストやデバッグのためのものです。


4.8.6. Dry Run
--------------

If an environment variable "PYLAUNCHER_DRYRUN" is set (to any value),
the launcher will output the command it would have run, but will not
actually launch Python. This may be useful for tools that want to use
the launcher to detect and then launch Python directly. Note that the
command written to standard output is always encoded using UTF-8, and
may not render correctly in the console.


4.8.7. Install on demand
------------------------

If an environment variable "PYLAUNCHER_ALLOW_INSTALL" is set (to any
value), and the requested Python version is not installed but is
available on the Microsoft Store, the launcher will attempt to install
it. This may require user interaction to complete, and you may need to
run the command again.

An additional "PYLAUNCHER_ALWAYS_INSTALL" variable causes the launcher
to always try to install Python, even if it is detected. This is
mainly intended for testing (and should be used with
"PYLAUNCHER_DRYRUN").


4.8.8. Return codes
-------------------

The following exit codes may be returned by the Python launcher.
Unfortunately, there is no way to distinguish these from the exit code
of Python itself.

The names of codes are as used in the sources, and are only for
reference. There is no way to access or resolve them apart from
reading this page. Entries are listed in alphabetical order of names.

+---------------------+---------+-------------------------------------------------+
| 名前                | 値      | 説明                                            |
|=====================|=========|=================================================|
| RC_BAD_VENV_CFG     | 107     | A "pyvenv.cfg" was found but is corrupt.        |
+---------------------+---------+-------------------------------------------------+
| RC_CREATE_PROCESS   | 101     | Failed to launch Python.                        |
+---------------------+---------+-------------------------------------------------+
| RC_INSTALLING       | 111     | An install was started, but the command will    |
|                     |         | need to be re-run after it completes.           |
+---------------------+---------+-------------------------------------------------+
| RC_INTERNAL_ERROR   | 109     | Unexpected error. Please report a bug.          |
+---------------------+---------+-------------------------------------------------+
| RC_NO_COMMANDLINE   | 108     | Unable to obtain command line from the          |
|                     |         | operating system.                               |
+---------------------+---------+-------------------------------------------------+
| RC_NO_PYTHON        | 103     | Unable to locate the requested version.         |
+---------------------+---------+-------------------------------------------------+
| RC_NO_VENV_CFG      | 106     | A "pyvenv.cfg" was required but not found.      |
+---------------------+---------+-------------------------------------------------+


4.9. モジュールの検索
=====================

These notes supplement the description at sys.path モジュール検索パス
の初期化 with detailed Windows notes.

"._pth" ファイルが見付からなかったときは、 Windows では "sys.path" は
次のように設定されます:

* 最初に空のエントリが追加されます。これはカレントディレクトリを指して
  います。

* その次に、 "PYTHONPATH" 環境変数が存在するとき、 環境変数 で解説され
  ているように追加されます。 Windows ではドライブ識別子 ("C:\" など)と
  区別するために、この環境変数に含まれるパスの区切り文字はセミコロンで
  なければならない事に注意してください。

* 追加で "アプリケーションのパス" を "HKEY_CURRENT_USER" か
  "HKEY_LOCAL_MACHINE" の中の
  "\SOFTWARE\Python\PythonCore{version}\PythonPath" のサブキーとして登
  録することができます。サブキーはデフォルト値としてセミコロンで区切ら
  れたパス文字列を持つことができ、書くパスが "sys.path" に追加されます
  。 (既存のインストーラーはすべて HKLM しか利用しないので、 HKCU は通
  常空です)

* "PYTHONHOME" が設定されている場合、それが "Python Home" として扱われ
  ます。 それ以外の場合、 "Python Home" を推定するために Python の実行
  ファイルのパスから "目印ファイル" ("Lib\os.py" または
  "pythonXY.zip") が探されます。 Python home が見つかった場合、そこか
  らいくつかのサブディレクトリ ("Lib", "plat-win" など) が "sys.path"
  に追加されます。 見つからなかった場合、コアとなる Python path はレジ
  ストリに登録された PythonPath から構築されます。

* Python Home が見つからず、環境変数 "PYTHONPATH" が指定されず、レジス
  トリエントリが見つからなかった場合、関連するデフォルトのパスが利用さ
  れます (例: ".\Lib;.\plat-win" など)。

メインの実行ファイルと同じ場所か一つ上のディレクトリに "pyvenv.cfg" が
ある場合、以下の異なった規則が適用されます:

* "PYTHONHOME" が設定されておらず、 "home" が絶対パスの場合、home 推定
  の際メインの実行ファイルから推定するのではなくこのパスを使います。

結果としてこうなります:

* "python.exe" かそれ以外の Python ディレクトリにある .exe ファイルを
  実行したとき (インストールされている場合でも PCbuild から直接実行さ
  れている場合でも) core path が利用され、レジストリ内の core path は
  無視されます。それ以外のレジストリの "application paths" は常に読み
  込まれます。

* Python が他の .exe ファイル (他のディレクトリに存在する場合や、COM経
  由で組み込まれる場合など) にホストされている場合は、 "Python Home"
  は推定されず、レジストリにある core path が利用されます。それ以外の
  レジストリの "application paths" は常に読み込まれます。

* Python がその home を見つけられず、レジストリの値もない場合 (これは
  いくつかのとてもおかしなインストレーションセットアップの凍結された
  .exe)、パスは最小限のデフォルトとして相対パスが使われます。

自身のアプリケーションや配布物に Python をバンドルしたい場合には、以下
の助言 (のいずれかまたは組合せ) によりほかのインストレーションとの衝突
を避けることができます:

* Include a "._pth" file alongside your executable containing the
  directories to include. This will ignore paths listed in the
  registry and environment variables, and also ignore "site" unless
  "import site" is listed.

* If you are loading "python3.dll" or "python37.dll" in your own
  executable, explicitly set "PyConfig.module_search_paths" before
  "Py_InitializeFromConfig()".

* 自身のアプリケーションから "python.exe" を起動する前に、
  "PYTHONPATH" をクリアしたり上書きし、 "PYTHONHOME" をセットしてくだ
  さい。

* If you cannot use the previous suggestions (for example, you are a
  distribution that allows people to run "python.exe" directly),
  ensure that the landmark file ("Lib\os.py") exists in your install
  directory. (Note that it will not be detected inside a ZIP file, but
  a correctly named ZIP file will be detected instead.)

これらはシステムワイドにインストールされたファイルが、あなたのアプリケ
ーションにバンドルされた標準ライブラリのコピーに優先しないようにします
。これをしなければあなたのアプリケーションのユーザは、何かしら問題を抱
えるかもしれません。上で列挙した最初の提案が最善です。ほかのものはレジ
ストリ内の非標準のパスやユーザの site-packages の影響を少し受けやすい
からです。

バージョン 3.6 で変更: Add "._pth" file support and removes "applocal"
option from "pyvenv.cfg".

バージョン 3.6 で変更: Add "python*XX*.zip" as a potential landmark
when directly adjacent to the executable.

バージョン 3.6 で非推奨: Modules specified in the registry under
"Modules" (not "PythonPath") may be imported by
"importlib.machinery.WindowsRegistryFinder". This finder is enabled on
Windows in 3.6.0 and earlier, but may need to be explicitly added to
"sys.meta_path" in the future.


4.10. 追加のモジュール
======================

Python は全プラットフォーム互換を目指していますが、 Windows にしかない
ユニークな機能もあります。標準ライブラリと外部のライブラリの両方で、幾
つかのモジュールと、そういった機能を使うためのスニペットがあります。

Windows 固有の標準モジュールは、 MS Windows 固有のサービス に書かれて
います。


4.10.1. PyWin32
---------------

The PyWin32 module by Mark Hammond is a collection of modules for
advanced Windows-specific support.  This includes utilities for:

* Component Object Model (COM)

* Win32 API 呼び出し

* レジストリ

* イベントログ

* Microsoft Foundation Classes (MFC) ユーザーインターフェイス

PythonWin は PyWin32 に付属している、サンプルのMFCアプリケーションです
。これはビルトインのデバッガを含む、組み込み可能なIDEです。

参考:

  Win32 How Do I...?
     by Tim Golden

  Python and COM
     by David and Paul Boddie


4.10.2. cx_Freeze
-----------------

cx_Freeze wraps Python scripts into executable Windows programs
("***.exe" files).  When you have done this, you can distribute your
application without requiring your users to install Python.


4.11. Windows 上で Python をコンパイルする
==========================================

CPython を自分でコンパイルしたい場合、最初にすべきことは ソース を取得
することです。最新リリース版のソースか、新しい チェックアウト をダウン
ロードできます。

ソースツリーには Microsoft Visual Studio でのビルドのソリューションフ
ァイルとプロジェクトファイルが含まれていて、これが公式の Python リリー
スに使われているコンパイラです。これらファイルは "PCbuild" ディレクト
リ内にあります。

ビルドプロセスについての一般的な情報は、"PCbuild/readme.txt" にありま
す。

拡張モジュールについては、 Windows 上での C および C++ 拡張モジュール
のビルド を参照してください。


4.12. ほかのプラットフォーム
============================

Python の継続的な開発の中で、過去にサポートされていた幾つかのプラット
フォームが (ユーザーや開発者の不足のために) サポートされなくなっていま
す。すべてのサポートされないプラットフォームについての詳細は **PEP
11** をチェックしてください。

* Windows CE is no longer supported since Python 3 (if it ever was).

* The Cygwin installer offers to install the Python interpreter as
  well

コンパイル済みインストーラが提供されているプラットフォームについての詳
細な情報は Python for Windows を参照してください。
