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

源代碼: Lib/site.py

這個(gè)模塊將在初始化時(shí)被自動(dòng)導(dǎo)入。 此自動(dòng)導(dǎo)入可以通過(guò)使用解釋器的 -S 選項(xiàng)來(lái)屏蔽。

導(dǎo)入此模塊將會(huì)附加域特定的路徑到模塊搜索路徑并且添加一些內(nèi)建對(duì)象，除非使用了 -S 選項(xiàng)。 那樣的話，模塊可以被安全地導(dǎo)入，而不會(huì)對(duì)模塊搜索路徑和內(nèi)建對(duì)象有自動(dòng)的修改或添加。要明確地觸發(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 之上的一個(gè)目錄中，則 sys.prefix 和 sys.exec_prefix 將被設(shè)置為該目錄，并且還會(huì)檢查 site-packages （ sys.base_prefix 和 sys.base_exec_prefix 始終是 Python 安裝的 "真實(shí)" 前綴）。 如果 "pyvenv.cfg" （引導(dǎo)程序配置文件）包含設(shè)置為非 "true"（不區(qū)分大小寫）的 "include-system-site-packages" 鍵，則不會(huì)在系統(tǒng)級(jí)前綴中搜索 site-packages；反之則會(huì)。

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

例如，假設(shè) sys.prefix 和 sys.exec_prefix 已經(jīng)被設(shè)置為 /usr/local。 Python X.Y 的庫(kù)之后被安裝為 /usr/local/lib/pythonX.Y。假設(shè)有一個(gè)擁有三個(gè)孫目錄 foo, bar 和 spam 的子目錄 /usr/local/lib/pythonX.Y/site-packages，并且有兩個(gè)路徑配置文件 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

請(qǐng)注意 bletch 已被省略因?yàn)樗⒉淮嬖冢?code class="file docutils literal notranslate">bar 目前在 foo 目錄之前因?yàn)?bar.pth 按字母順序排在 foo.pth 之前；而 spam 已被省略因?yàn)樗趦蓚€(gè)路徑配置文件中都未被提及。

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

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

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

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