site —— 指定域的配置鉤子?

源代碼: Lib/site.py

這個模塊將在初始化時被自動導(dǎo)入。 此自動導(dǎo)入可以通過使用解釋器的 -S 選項來屏蔽。

導(dǎo)入此模塊將會附加域特定的路徑到模塊搜索路徑并且添加一些內(nèi)建對象，除非使用了 -S 選項。 那樣的話，模塊可以被安全地導(dǎo)入，而不會對模塊搜索路徑和內(nèi)建對象有自動的修改或添加。要明確地觸發(fā)通常域特定的添加，調(diào)用函數(shù) site.main()。

It starts by constructing up to four directories from a head and a tail part. For the head part, it uses sys.prefix and sys.exec_prefix; empty heads are skipped. For the tail part, it uses the empty string and then lib/site-packages (on Windows) or lib/pythonX.Y/site-packages (on Unix and macOS). For each of the distinct head-tail combinations, it sees if it refers to an existing directory, and if so, adds it to sys.path and also inspects the newly added path for configuration files.

如果名為 "pyvenv.cfg" 的文件存在于 sys.executable 之上的一個目錄中，則 sys.prefix 和 sys.exec_prefix 將被設(shè)置為該目錄，并且還會檢查 site-packages （ sys.base_prefix 和 sys.base_exec_prefix 始終是 Python 安裝的 "真實" 前綴）。 如果 "pyvenv.cfg" （引導(dǎo)程序配置文件）包含設(shè)置為非 "true"（不區(qū)分大小寫）的 "include-system-site-packages" 鍵，則不會在系統(tǒng)級前綴中搜索 site-packages；反之則會。

一個路徑配置文件是具有 name.pth 命名格式的文件，并且存在上面提到的四個目錄之一中；它的內(nèi)容是要添加到 sys.path 中的額外項目（每行一個）。不存在的項目不會添加到 sys.path，并且不會檢查項目指向的是目錄還是文件。項目不會被添加到 sys.path 超過一次。空行和由 # 起始的行會被跳過。以 import 開始的行（跟著空格或 TAB）會被執(zhí)行。

例如，假設(shè) sys.prefix 和 sys.exec_prefix 已經(jīng)被設(shè)置為 /usr/local。 Python X.Y 的庫之后被安裝為 /usr/local/lib/pythonX.Y。假設(shè)有一個擁有三個孫目錄 foo, bar 和 spam 的子目錄 /usr/local/lib/pythonX.Y/site-packages，并且有兩個路徑配置文件 foot.pth 和 bar.pth。假定 foo.pth 內(nèi)容如下:

# foo package configuration

foo
bar
bletch

并且 bar.pth 包含:

# bar package configuration

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 已被省略因為它在兩個路徑配置文件中都未被提及。

在這些路徑操作之后，會嘗試導(dǎo)入一個名為 sitecustomize 的模塊，它可以執(zhí)行任意站點專屬的定制。 它通常是由系統(tǒng)管理員在 site-packages 目錄下創(chuàng)建的。 如此此導(dǎo)入失敗并引發(fā) ImportError 或其子類異常，并且異常的 name 屬性等于 'sitecustomize'，則它會被靜默地忽略。 如果 Python 是在沒有可用輸出流的情況下啟動的，例如在 Windows 上使用 pythonw.exe (它默認被用于啟動 start IDLE)，則來自 sitecustomize 的輸出嘗試會被忽略。 任何其他異常都會導(dǎo)致靜默且可能令人迷惑不解的進程失敗。

在此之后，會嘗試導(dǎo)入一個名為 usercustomize 的模塊，它可以執(zhí)行任意用戶專屬的定制，如果 ENABLE_USER_SITE 為真值的話。 這個文件應(yīng)該在用戶的 site-packages 目錄中創(chuàng)建（見下文），該目錄是 sys.path 的組成部分，除非被 -s 所禁用。 如果此導(dǎo)入失敗并引發(fā) ImportError 或者其子類異常，并且異常的 name 屬性等于 'usercustomize'，它會被靜默地忽略。

請注意對于某些非 Unix 系統(tǒng)來說，sys.prefix 和 sys.exec_prefix 均為空值，并且路徑操作會被跳過；但是仍然會嘗試導(dǎo)入 sitecustomize 和 usercustomize。

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