# 4. Windows で Python を使う

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

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

PEP 11 で明記しているとおり Python のリリースは、Microsoft が延長サポート期間であるとしている Windows プラットフォームのみをサポートします。 つまり Python 3.10 は 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.10 のインストーラは 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 を抑制することなしにこれらコマンドラインオプションをセットすることもできます。

To completely hide the installer UI and install Python silently, pass the `/quiet` option. To skip past the user interaction but still display progress and errors, pass the `/passive` option. The `/uninstall` option may be passed to immediately begin removing Python - no confirmation prompt will be displayed.

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

名前 | 説明 | デフォルト
--- | --- | ---
InstallAllUsers | システムワイドなインストールを実行する。 | 0
TargetDir | インストール先ディレクトリ。 | InstallAllUsers に基いて選択されます。
DefaultAllUsersTargetDir | すべてのユーザ向けインストールのためのデフォルトインストール先ディレクトリ。 | `%ProgramFiles%\Python X.Y` または `%ProgramFiles(x86)%\Python X.Y`
DefaultJustForMeTargetDir | 自分一人用インストールのためのデフォルトインストール先ディレクトリ。 | `%LocalAppData%\Programs\Python\PythonXY` または `%LocalAppData%\Programs\Python\PythonXY-32` または `%LocalAppData%\Programs\Python\PythonXY-64`
DefaultCustomTargetDir | カスタムインストールディレクトリとしてデフォルトで GUI に表示される値。 | (空)
AssociateFiles | ランチャもインストールする場合に、ファイルの関連付けを行う。 | 1
CompileAll | すべての `.py` ファイルをバイトコンパイルして `.pyc` を作る。 | 0
PrependPath | `PATH` にインストールディレクトリと Scripts ディレクトリを追加し、 `PATHEXT` に `.PY` を追加する。 | 0
Shortcuts | インストールするインタプリタ、ドキュメント、IDLE へのショートカットを作る。 | 1
Include_doc | Python マニュアルをインストールする。 | 1
Include_debug | デバッグバイナリをインストールする。 | 0
Include_dev | 開発者用ヘッダーとライブラリをインストールする。これを省略すると、使用不可能なインストールになる可能性があります。 | 1
Include_exe | `python.exe` と関連するファイルをインストールする。これを省略すると、使用不可能なインストールになる可能性があります。 | 1
Include_launcher | Windows の Python ランチャ をインストールする。 | 1
InstallLauncherAllUsers | すべてのユーザーにランチャーをインストールする。 `Include_launcher` が 1 に設定されている必要があります。 | 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.2. Microsoft ストアパッケージ

バージョン 3.7.2 で追加.

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

このパッケージをインストールするには、最新の Windows 10 のアップデートになっていることを確認し、 Microsoft ストアアプリで "Python 3.10" と検索します。 選んだアプリが 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.10). 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>\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0\LocalCache\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 パッケージ

バージョン 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` を含みます。 ここに設定を入れると自動的にヘッダを使い、ビルド時にライプラリをインポートします。

nuget.org にあるパッケージ情報のページは、 64-bit バージョンが www.nuget.org/packages/python 、 32-bitバージョンが www.nuget.org/packages/pythonx86 です。

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

バージョン 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 モード

バージョン 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.getpreferredencoding()`).

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 ランチャ

バージョン 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.10) がインストールされている場合は、Python 3.10 が起動することになります。Python 3.7 を起動したいなら、次のコマンドを実行してみてください:

    py -3.7

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

    py -2

最新バージョンの Python 3.x が起動するのがわかるはずです。

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

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

ユーザごとの Python インストレーションでは、インストール時にオプションで指定しない限り、ランチャは `PATH` に追加されません。

このコマンド:

    py --list

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

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

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

Re-executing the command should now print the latest Python 3.x information. As with the above command-line examples, you can specify a more explicit version qualifier. Assuming you have Python 3.7 installed, try changing the first line to `#! python3.7` and you should find the 3.7 version information printed.

コマンドからの呼び出しとは異なり、後ろに何もつかない "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 python`

- `/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 を使うよう要求します。

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

`/usr/bin/env` 形式のシェバン行にはもう一つ更に特別な特性があります。インストールされている Python を探す前に、この形式は Python 実行ファイルを `PATH` から検索します。これは Unix の `env` プログラムに対応する振る舞いで、これも `PATH` からの検索をするものです。

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

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

    #! /usr/bin/python -v

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

### 4.8.4. カスタマイズ

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

ランチャは2つの .ini ファイルを探しに行きます。具体的には、現在のユーザーの "application data" ディレクトリ (つまり、 Windows の関数 `SHGetFolderPath` に `CSIDL_LOCAL_APPDATA` を与えて呼ぶと返ってくるディレクトリ) の `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. 診断

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

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

Python は通常そのライブラリ (と site-packages フォルダ) をインストールしたディレクトリに格納します。そのため、 Python を `C:\Python\` ディレクトリにインストールしたとすると、デフォルトのライブラリは `C:\Python\Lib\` に存在し、サードパーティーのモジュールは `C:\Python\Lib\site-packages\` に格納することになります。

`sys.path` を完全に上書きするには、 DLL と同じ名前 (`python37._pth`) か実行可能ファイル (`python._pth`) と同じ名前の `._pth` ファイルを作成し、1行につき1つのパスを指定して `sys.path` に追加されるようにしてください。 DLL 名に基づいたファイルは実行可能ファイル名に基づいたファイルを上書きします。これにより、望むならば、ランタイムを読み込むどんなプログラムもパスで制限できます。

ファイルが存在したときは、全てのレジストリと環境変数は無視され、隔離モードになり、そのファイルに `import site` と指定していない限りは `site` がインポートできなくなります。 空行と `#` で始まる行は無視されます。 それぞれのパスはファイルの場所を指す絶対パスあるいは相対パスです。 `site` 以外のインポート文は許可されておらず、任意のコードも書けません。

`import site` を指定したときは、(アンダースコアが前に付かない) `.pth` ファイルは `site` モジュールにより通常通り処理されることに注意してください。

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

- `python3.dll` や `python37.dll` を自身の実行ファイルからロードするのであれば、 `Py_Initialize()` 呼び出しに先立って、 `Py_SetPath()` か (最低でも) `Py_SetProgramName()` を明示的に呼び出してください。

- 自身のアプリケーションから `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 で変更:

> - Adds `._pth` file support and removes `applocal` option from `pyvenv.cfg`.

> - Adds `pythonXX.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

Mark Hammond によって開発された PyWin32 モジュールは、進んだ Windows 専用のサポートをするモジュール群です。このモジュールは以下のユーティリティを含んでいます:

- 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 is a `distutils` extension (see Distutilsの拡張) which 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 を参照してください。