site --- サイト固有の設定フック

ソースコード: Lib/site.py

このモジュールは初期化中に自動的にインポートされます。 自動インポートはインタプリタの -S オプションで禁止できます。

Importing this module normally appends site-specific paths to the module search path and adds callables, including help() to the built-in namespace. However, Python startup option -S blocks this and this module can be safely imported with no automatic modifications to the module search path or additions to the builtins. To explicitly trigger the usual site-specific additions, call the main() function.

バージョン 3.3 で変更: 以前は -S を使っているときでも、モジュールをインポートするとパス変更が起動されていました。

まず、先頭部分と末尾部分を組み合わせて、最大四つのディレクトリを構成します。 先頭部分には sys.prefix と sys.exec_prefix を使い、空のものは省きます。 末尾部分には、空文字列と、Windows では lib/site-packages、Unix と macOS では lib/pythonX.Y[t]/site-packages を使います。 (省略可能な接尾辞 "t" は フリースレッドビルド を表し、sys.abiflags 定数に "t" が含まれる場合に付けます。) 先頭と末尾の異なる組み合わせごとに、ディレクトリが存在するかを調べます。 存在すれば sys.path に追加し、追加したパスに設定ファイルがあるかも調べます。

バージョン 3.5 で変更: "site-python" ディレクトリのサポートは削除されました。

バージョン 3.13 で変更: Unix では、フリースレッド の Python インストールは、lib/python3.13t/ のように、バージョン別ディレクトリ名の接尾辞 "t" で識別します。

バージョン 3.14 で変更: 仮想環境 で sys.prefix と sys.exec_prefix を更新する処理は、site の役割ではなくなりました。 現在は パスの初期化 中に行います。 その結果、仮想環境 の sys.prefix と sys.exec_prefix は site の初期化に依存しなくなり、-S の影響を受けなくなりました。

When running under a virtual environment, the pyvenv.cfg file in sys.prefix is checked for site-specific configurations. If the include-system-site-packages key exists and is set to true (case-insensitive), the system-level prefixes will be searched for site-packages, otherwise they won't.

A path configuration file is a file whose name has the form name.pth and exists in one of the four directories mentioned above; its contents are additional items (one per line) to be added to sys.path. Non-existing items are never added to sys.path, and no check is made that the item refers to a directory rather than a file. No item is added to sys.path more than once. Blank lines and lines beginning with # are skipped. Lines starting with import (followed by space or tab) are executed.

注釈

An executable line in a .pth file is run at every Python startup, regardless of whether a particular module is actually going to be used. Its impact should thus be kept to a minimum. The primary intended purpose of executable lines is to make the corresponding module(s) importable (load 3rd-party import hooks, adjust PATH etc). Any other initialization is supposed to be done upon a module's actual import, if and when it happens. Limiting a code chunk to a single line is a deliberate measure to discourage putting anything more complex here.

バージョン 3.13 で変更: .pth ファイルは、最初に UTF-8 で、失敗した場合は locale encoding でデコードされるようになります。

For example, suppose sys.prefix and sys.exec_prefix are set to /usr/local. The Python X.Y library is then installed in /usr/local/lib/pythonX.Y. Suppose this has a subdirectory /usr/local/lib/pythonX.Y/site-packages with three subsubdirectories, foo, bar and spam, and two path configuration files, foo.pth and bar.pth. Assume foo.pth contains the following:

# foo パッケージの設定

foo
bar
bletch

また、 bar.pth には:

# bar パッケージの設定

bar

が記載されているとします。そのとき、次のバージョンごとのディレクトリが sys.path へこの順番で追加されます:

/usr/local/lib/pythonX.Y/site-packages/bar
/usr/local/lib/pythonX.Y/site-packages/foo

bletch は存在しないため省略されるということに注意してください。 bar ディレクトリは foo ディレクトリの前に来ます。なぜなら、 bar.pth がアルファベット順で foo.pth の前に来るからです。また、 spam はどちらのパス設定ファイルにも記載されていないため、省略されます。

sitecustomize

After these path manipulations, an attempt is made to import a module named sitecustomize, which can perform arbitrary site-specific customizations. It is typically created by a system administrator in the site-packages directory. If this import fails with an ImportError or its subclass exception, and the exception's name attribute equals 'sitecustomize', it is silently ignored. If Python is started without output streams available, as with pythonw.exe on Windows (which is used by default to start IDLE), attempted output from sitecustomize is ignored. Any other exception causes a silent and perhaps mysterious failure of the process.

usercustomize

その後、ENABLE_USER_SITE が真の場合は、ユーザ固有の任意のカスタマイズを行う usercustomize モジュールのインポートを試みます。 このファイルは、下記のユーザ site-packages ディレクトリに作成することを想定しています。 このディレクトリは、-s で無効にしない限り sys.path に含まれます。 インポートが ImportError またはそのサブクラスの例外で失敗し、例外の name 属性が 'usercustomize' の場合は、通知せずに無視します。

一部の非 Unix システムでは、sys.prefix と sys.exec_prefix が空のため、パスの変更は行いません。 ただし、sitecustomize と usercustomize のインポートは試みます。

readline の設定

readline に対応するシステムで、-S オプションなしで Python を 対話モード で起動した場合、このモジュールは rlcompleter のインポートと設定も行います。 デフォルトではタブ補完を有効にし、履歴の保存先として ~/.python_history を使います。 無効にするには、sitecustomize、usercustomize、または PYTHONSTARTUP のファイルで sys.__interactivehook__ 属性を削除するか置き換えてください。

バージョン 3.4 で変更: rlcompleter とhistory のアクティベーションが自動で行われるようになりました。

モジュールの内容

site.PREFIXES

siteパッケージディレクトリのprefixのリスト。

site.ENABLE_USER_SITE

ユーザサイトディレクトリのステータスを示すフラグ。 True の場合、ユーザサイトディレクトリが有効で sys.path に追加されていることを意味しています。 False の場合、ユーザによるリクエスト(オプション -s か PYTHONNOUSERSITE)によって、 None の場合セキュリティ上の理由(ユーザまたはグループIDと実効IDの間のミスマッチ)あるいは管理者によって、ユーザサイトディレクトリが無効になっていることを示しています。

site.USER_SITE

実行中の Python のユーザ site-packages ディレクトリへのパスです。 getusersitepackages() をまだ呼び出していない場合は None のこともあります。 デフォルトは、UNIX と非フレームワークの macOS ビルドでは ~/.local/lib/pythonX.Y[t]/site-packages、macOS のフレームワークビルドでは ~/Library/Python/X.Y/lib/python/site-packages、Windows では %APPDATA%\Python\PythonXY\site-packages です。 省略可能な "t" はフリースレッドビルドを示します。 これはサイトディレクトリなので、内部の .pth ファイルは処理されます。

site.USER_BASE

ユーザの site-packages のベースとなるディレクトリへのパスです。 getuserbase() がまだ呼び出されていなければ None かもしれません。デフォルト値は UNIX と frameworkなしの macOS ビルドでは ~/.local 、macOS framework ビルドでは ~/Library/Python/X.Y 、Windows では %APPDATA%\Python です。この値は、スクリプト、データファイル、Python モジュールなどのインストール先のディレクトリを ユーザーインストールスキーム で計算するのに使われます。 PYTHONUSERBASE も参照してください。

site.main()

モジュール検索パスに標準のサイト固有ディレクトリを追加します。この関数は、Python インタプリタが -S で開始されていない限り、このモジュールインポート時に自動的に呼び出されます。

バージョン 3.3 で変更: この関数は以前は無条件に呼び出されていました。

site.addsitedir(sitedir, known_paths=None)

Add a directory to sys.path and process its .pth files. Typically used in sitecustomize or usercustomize (see above).

site.getsitepackages(prefixes=None)

全てのグローバルな site-packages ディレクトリのリストを返します。

prefixes に指定した各ディレクトリ (None の場合は PREFIXES) について、システム環境に応じた site-packages サブディレクトリを計算し、そのフルパスのリストを返します。 パスが存在するかどうかは確認しません。

Added in version 3.2.

バージョン 3.3 で変更: 省略可能な prefixes 引数が追加されました。

site.getuserbase()

ユーザのベースディレクトリへのパス USER_BASE を返します。未初期化であればこの関数は PYTHONUSERBASE を参考にして、設定もします。

Added in version 3.2.

site.getusersitepackages()

ユーザ固有の site パッケージのディレクトリへのパス USER_SITE を返します。未初期化であればこの関数は USER_BASE を参考にして、設定もします。 ユーザ固有の site パッケージが sys.path に追加されたかどうかを確認するには ENABLE_USER_SITE を使ってください。

Added in version 3.2.

コマンドライン・インターフェース

site モジュールは、コマンドラインからユーザディレクトリを取得する方法も提供しています。

$ python -m site --user-site
/home/user/.local/lib/python3.11/site-packages

引数なしで呼び出された場合、sys.path の中身を表示し、続けて USER_BASE とそのディレクトリが存在するかどうか、 USER_SITE とそのディレクトリが存在するかどうか、最後に ENABLE_USER_SITE の値を、標準出力に出力します。

--user-base

ユーザのベースディレクトリを表示します。

--user-site

ユーザの site-packages ディレクトリを表示します。

両方のオプションが指定された場合、ユーザのベースとユーザの site が(常にこの順序で) os.pathsep 区切りで表示されます。

いずれかのオプションが与えられた場合に、このスクリプトは次のいずれかの終了コードで終了します: ユーザの site-packages が有効ならば 0 、ユーザにより無効にされていれば 1 、セキュリティ的な理由あるいは管理者によって無効にされている場合 2 、そして何かエラーがあった場合は 2 より大きな値。

参考