3. Windows で Python を使う

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

3.1. Python のインストール

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

3.1.1. サポートされているバージョン

As specified in PEP 11, a Python release only supports a Windows platform while Microsoft considers the platform under extended support. This means that Python 3.6 supports Windows Vista and newer. If you require Windows XP support then please install Python 3.4.

3.1.2. インストール手順

Four Python 3.6 installers are available for download - two each for the 32-bit and 64-bit versions of the interpreter. The web installer is a small initial download, and it will automatically download the required components as necessary. The offline installer includes the components necessary for a default installation and only requires an internet connection for optional features. See ダウンロード不要なインストール for other ways to avoid downloading during installation.

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

../_images/win_installer.png

“Install Now” を選択した場合:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3.1.3. Removing the MAX_PATH Limitation

Windows historically has limited path lengths to 260 characters. This meant that paths longer than this would not resolve and errors would result.

In the latest versions of Windows, this limitation can be expanded to approximately 32,000 characters. Your administrator will need to activate the “Enable Win32 long paths” group policy, or set the registry value HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem@LongPathsEnabled to 1.

This allows the open() function, the os module and most other path functionality to accept and return paths longer than 260 characters when using strings. (Use of bytes as paths is deprecated on Windows, and this feature is not available when using bytes.)

After changing the above option, no further configuration is required.

バージョン 3.6 で変更: Support for long paths was enabled in Python.

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

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

完全にインストーラの GUI を隠して Python を静かにインストールするには、 /quiet オプションを渡してください。対話的に設定するのはスキップしつつも進捗とエラーの表示は行いたいなら、 /passive オプションを渡してください。 /uninstall オプションも渡せます。これはプロンプトの表示なしに、即座に Python の削除を開始します。

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

名前

説明

デフォルト

InstallAllUsers

システムワイドなインストールを実行する。

0
TargetDir

インストール先ディレクトリ。

InstallAllUsers に基いて選択されます。

DefaultAllUsersTargetDir

すべてのユーザ向けインストールのためのデフォルトインストール先ディレクトリ。

%ProgramFiles%\Python X.Y または %ProgramFiles(x86)%\Python X.Y

DefaultJustForMeTargetDir

自分一人用インストールのためのデフォルトインストール先ディレクトリ。

%LocalAppData%\Programs\PythonXY または %LocalAppData%\Programs\PythonXY-32

DefaultCustomTargetDir

カスタムインストールディレクトリとしてデフォルトで GUI に表示される値。

(空)

AssociateFiles

ランチャもインストールする場合に、ファイルの関連付けを行う。

1
CompileAll

すべての .py ファイルをバイトコンパイルして .pyc を作る。

0
PrependPath

環境変数 PATH にインストールディレクトリとスクリプトディレクトリを、また、環境変数 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

Windows の Python ランチャ をすべてのユーザにインストールする。

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.6.0.exe /quiet InstallAllUsers=1 PrependPath=1 Include_test=0

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

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

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

Python のいくつかの機能については最初にダウンロードするインストーラには含まれないので、それらを選択するとインターネット接続が必要になります。これの必要性を避けるために、選択機能によらずインターネット接続がもう必要がないような完全な layout を作るために、オンデマンドに取りうるすべてのコンポーネントをダウンロードできます。これは必要とするものよりも大きなダウンロードになるかもしれませんが、色んな場所にインストレーションを行おうとする場合にはローカルにキャッシュされたコピーを持つことはとても有用です。

Execute the following command from Command Prompt to download all possible required files. Remember to substitute python-3.6.0.exe for the actual name of your installer, and to create layouts in their own directories to avoid collisions between files with the same name.

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

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

3.1.6. インストール後の変更

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

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

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

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

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

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

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

参考

Python on XP
“7 Minutes to “Hello World!”” by Richard Dooling, 2006
Installing on Windows
in “Dive into Python: Python from novice to pro” by Mark Pilgrim, 2004, ISBN 1-59059-356-1
For Windows users
in “Installing Python” in “A Byte of Python” by Swaroop C H, 2003

3.2. 別のバンドル

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

ActivePython

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

Anaconda

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

Canopy

「包括的な Python 解析環境 (comprehensive Python analysis environment)」で、エディタとほかの開発ツールを含みます。

WinPython

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

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

3.3. Python を構成する

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

3.3.1. 補足: 環境変数の設定

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

環境変数を一時的にセットするには、コマンドプロンプトを開いて set コマンドを使います:

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

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

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

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

注釈

Windows はシステム変数の 後ろに ユーザ変数を結合します。この振る舞いにより PATH の修正時に期待とは異なる結果になることがあります。

PYTHONPATH 変数は Python 2 と Python 3 のすべてのバージョンで使われるので、インストールされているすべての Python バージョンで互換なコードだけを使うのでない限り、この環境変数は恒久的な設定をすべきではありません。

参考

https://support.microsoft.com/kb/100843

Windows NT の環境変数

https://technet.microsoft.com/en-us/library/cc754250.aspx

一時的に環境変数を変更するための SET コマンドについて。

https://technet.microsoft.com/en-us/library/cc755104.aspx

恒久的に環境変数を変更するための SETX コマンドについて。

https://support.microsoft.com/kb/310519

Windows XP での環境変数の管理方法

https://www.chem.gla.ac.uk/~louis/software/faq/q1.html

Louis J. Farrugia による、環境変数の設定についての説明。

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

バージョン 3.5 で変更.

Besides using the automatically created start menu entry for the Python interpreter, you might want to start Python in the command prompt. The installer has an option to set that up for you.

On the first page of the installer, an option labelled “Add Python to PATH” may be selected to have the installer add the install location into the PATH. The location of the Scripts\ folder is also added. This allows you to type python to run the interpreter, and pip for the package installer. Thus, you can also execute your scripts with command line options, see コマンドライン documentation.

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

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

3.4. Windows の Python ランチャ

バージョン 3.3 で追加.

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

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

3.4.1. 最初に

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

バージョン 3.6 で変更.

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

py

You should find that the latest version of Python you have installed is started - it can be exited as normal, and any additional command-line arguments specified will be sent directly to Python.

If you have multiple versions of Python installed (e.g., 2.7 and 3.6) you will have noticed that Python 3.6 was started - to launch Python 2.7, try the command:

py -2.7

If you want the latest version of Python 2.x you have installed, try the command:

py -2

You should find the latest version of Python 2.x starts.

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

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

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

3.4.1.2. 仮想環境 (Virtual environments)

バージョン 3.5 で追加.

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

3.4.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.3 の情報が表示されるはずです。これまでのコマンドラインの例と同様に、より細かいバージョン修飾子を指定することもできます。Python 2.6 がインストールされている場合、最初の行を #! python2.6 に変更すると、2.6 のバージョン情報が表示されるはずです。

Note that unlike interactive use, a bare “python” will use the latest version of Python 2.x that you have installed. This is for backward compatibility and for compatibility with Unix, where the command python typically refers to Python 2.

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

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

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

3.4.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 で始まるものを使用すべきです。

上記の仮想コマンドのいずれでも、明示的にバージョンを指定できます (メジャーバージョンだけでも、メジャー・マイナーバージョン両方でも) - 例えば /usr/bin/python2.7 のように - これによりその特定のバージョンが特定されて使われます。

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

3.4.3. シェバン行の引数

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

#! /usr/bin/python -v

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

3.4.4. カスタマイズ

3.4.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) することができます

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

どのバージョンの Python をコマンドで使用するかを定めるため、バージョン修飾子がコマンドに含められることがあります。バージョン修飾子はメジャーバージョン番号で始まり、オプションのピリオド (‘.’) とマイナーバージョン指定子がそれに続きます。もしマイナー修飾子が指定されれば、オプションでさらに “-32” を続けて、そのバージョンの 32-bit の実装が使われることを示すことができます。

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

コマンドにバージョン修飾子が見つからない場合、環境変数 PY_PYTHON を設定してデフォルトバージョン修飾子を指定することができます。デフォルト値は “2” になっています。この値は、単にメジャーバージョン (例えば “2”) にすることも、major.minor 修飾子 (例えば “2.6”) にすることも、さらには major.minor-32 にすることもできます。

マイナーバージョン修飾子が見つからない場合、環境変数 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” サフィックスでこの挙動を変更できます。

例:

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

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

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

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

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

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

例えば:

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

[defaults]
python=3.1
  • PY_PYTHON=3PY_PYTHON3=3.1 を設定することは、INI ファイルに下記が含まれることと等価です:

[defaults]
python=3
python3=3.1

3.4.5. 診断

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

3.5. モジュールの検索

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

To completely override sys.path, create a ._pth file with the same name as the DLL (python36._pth) or the executable (python._pth) and specify one line for each path to add to sys.path. The file based on the DLL name overrides the one based on the executable, which allows paths to be restricted for any program loading the runtime if desired.

When the file exists, all registry and environment variables are ignored, isolated mode is enabled, and site is not imported unless one line in the file specifies import site. Blank paths and lines starting with # are ignored. Each path may be absolute or relative to the location of the file. Import statements other than to site are not permitted, and arbitrary code cannot be specified.

Note that .pth files (without leading underscore) will be processed normally by the site module.

When no ._pth file is found, this is how sys.path is populated on Windows:

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

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

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

  • If the environment variable PYTHONHOME is set, it is assumed as “Python Home”. Otherwise, the path of the main Python executable is used to locate a “landmark file” (either Lib\os.py or pythonXY.zip) to deduce the “Python Home”. If a Python home is found, the relevant sub-directories added to sys.path (Lib, plat-win, etc) are based on that folder. Otherwise, the core Python path is constructed from the PythonPath stored in the registry.
  • 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 python36.dll in your own executable, explicitly call Py_SetPath() or (at least) Py_SetProgramName() before Py_Initialize().
  • 自身のアプリケーションから 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.

3.6. 追加のモジュール

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

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

3.6.1. PyWin32

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

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

参考

Win32 How Do I...?
by Tim Golden
Python and COM
by David and Paul Boddie

3.6.2. cx_Freeze

cx_Freezedistutils 拡張 (Distutilsの拡張 を参照) で、 Python スクリプトを Windows 実行可能プログラム (*.exe ファイル) にラップします。これを使えば、ユーザーに Python のインストールをさせなくても、アプリケーションを配布することができます。

3.6.3. WConio

Python の進んだターミナル制御レイヤである curses は、 Unix ライクシステムでしか使うことができません。逆に Windows 専用のライブラリ、 Windows Console I/O for Python があります。

WConio は Turbo-C の CONIO.H のラッパーで、テキストユーザーインタフェースを作成するために利用することができます。

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

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

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

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

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

参考

Python + Windows + distutils + SWIG + gcc MinGW
or “Creating Python extensions in C/C++ with SWIG and compiling them with MinGW gcc under Windows” or “Installing Python extension with distutils and without Microsoft Visual C++” by Sébastien Sauvage, 2003
MingW – Python extensions
by Trent Apted et al, 2007

3.8. Python 埋め込みのための配布

バージョン 3.5 で追加.

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

When extracted, the embedded distribution is (almost) fully isolated from the user’s system, including environment variables, system registry settings, and installed packages. The standard library is included as pre-compiled and optimized .pyc files in a ZIP, and python3.dll, python36.dll, python.exe and pythonw.exe are all provided. Tcl/tk (including all dependants, such as Idle), pip and the Python documentation are not included.

注釈

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

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

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

3.8.1. Python アプリケーション

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

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

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

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

3.8.2. Python の埋め込み

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

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

3.9. その他のリソース

参考

Python Programming On Win32
“Help for Windows Programmers” by Mark Hammond and Andy Robinson, O’Reilly Media, 2000, ISBN 1-56592-621-8
A Python for Windows Tutorial
by Amanda Birmingham, 2004
PEP 397 - Python launcher for Windows

Python の配布物へのランチャ同梱の提案。