關於python如何實現相對導入的信息

本文目錄一覽：

• 1、在vs上怎麼用python將一個程序引入另一個程序
• 2、python包相對導入陷阱？
• 3、python相對導入？
• 4、python 模塊相對導入
• 5、Python導入模塊或包需要注意哪些點

在vs上怎麼用python將一個程序引入另一個程序

python中調用另一個程序有多種不同方式，一種是調用本文件下的某個函數來實現調用，另一種是調用模塊或包文件下的函數實現調用，還有一種是通過類方法的方式調用類定義的某段程序。

自身函數的調用時相當方便的，在定義好了函數以後直接按定義的格式調用即可，出現的錯誤為參數數量不匹配。通過包或模塊調用相對自身函數調用比較複雜，需要提前導入包或模塊，常用的方法為import或者fromimport，導入成功的前提是對應的包或模塊在python路徑之下，可以通過sys.path（sys為系統內置模塊可以直接使用importsys導入）來查看python路徑。以導入第三方包文件requests為例。通過類方法的調用需要在調用之前，實例化一個類對象，通過這個類對象來調用類方法，注意第三個方法為私有方法，不允許類外部訪問。

python包相對導入陷阱？

包相對導入的陷阱:混合使用，相比於Python 2.X的隱式包相對導入,以及Python 2.X和3.X中的顯式包相對導入點號語法,有些時候從 sys.path上一個路徑出發的絕對包導入會是更推薦的選擇。這一問題可能看上去難以理解,但是當你開始編寫自己的包，可能就會變得更加重要了。 如前所述，Python 3.X的相對導入語法和默認絕對導入搜索規則，讓包內導入變得顯式從而使其更容易被注意和被維護,而且允許你在一些命名衝突的情況下顯式地進行選擇。然而，你也必須注意到該模型帶來的下面兩個結果:在Python 3.X和2.X中，包相對導入語句的使用會隱式地將一個文件與一個包目錄的角色進行綁定,並禁止該文件通過其他方式被使用。在Python 3.X中，新的相對導入搜索規則改變意味着一個文件不能像在2.X中那樣同時扮演腳本和包模塊的角色。這些約束的理由有些微妙，不過由於下面的兩條同時成立:Python 3.X和2.X不允許隨意使用from .的相對導入語法，除非發起導入的文件本身作為包的一部分（即該文件在其他地方被導入)。Python 3.X的導入不會搜索一個包模塊自身的路徑，除非使用了from .的相對導入語法(或該模塊位於當前工作路徑、頂層腳本的主目錄下)。使用相對導入會阻止你在2.X和3.X中創建同時扮演可執行程序和外部可導入包角色的目錄項。此外，一些文件在3.X中不能像在2.X中那樣同時扮演腳本和包模塊的角色。就導人語句來說，這些規則可以歸結為下面的兩行代碼的形式:前一行在Python 2.X和3.X中都只用於包模式,而後一行在3.X中只用於程序模式。最終的效果是不論2.X還是3.X中的文件，你都應該只選擇一種使用模式，即包模式（使用相對導入)或程序模式(使用簡單導入)，並將真正的包模塊文件單獨放到一個子目錄中，與頂層腳本文件隔離開來。另一方面，你可以嘗試手動改變sys.path(通常是一項脆弱並易出錯的任務）或總是通過絕對導入使用完整的包路徑，並且假定包的根目錄位於模塊搜索路徑上，來替代包相對導入語法或簡單導入。

python相對導入？

除了讓包內導入更加顯式，這個功能的一部分設計初衷是，為了幫助腳本解決同名文件出現在模塊搜索路徑上多個不同位置時的二義性。考慮包目錄，這定義了一個名為mypkg 的包，其中含有名為mypkg.main和mypkg.string 的模塊。現在，假設模塊main試圖導入名為string的模塊。在 Python 2.X和更早版本中，Python會先尋找mypkg目錄以執行相對導入。這會找到並導入位於該處的string.py文件，將其賦值給mypkg.main模塊命名空間內的名稱string。不過，這一導入的本意可能是要導入Python標準庫的string模塊。可惜的是，在這些Python版本中，無法直接忽略mypkg.string 去尋找位於模塊搜索路徑更右側的標準庫中的string模塊。此外，我們無法使用完整包導入路徑來解決這個問題，因為我們無法依賴在每台機器上的標準鏈接庫路徑。換句話說，包中的簡單導入可能具有二義性而且容易出錯。在包內，我們無法確定imports pam語句指的是包內的模塊還是包外的模塊。一種可能的後果是，一個局部的模塊或包會在不經意間隱藏了sys.path 上的另一個模塊。在實踐中，Python使用者可以避免為他們自己的模塊重複使用標準庫模塊的名稱（如果需要標準string庫，就不要把新的模塊命名為string)。但是，一個包還是有可能意外地隱藏標準庫模塊。再者，Python 以後可能新增標準庫模塊，而其名稱可能剛好就和自己的一個模塊同名。而依賴於沒有點號開頭相對導入的程序代碼同樣也不容易理解，因為讀者可能對希望使用哪個模塊而感到困惑。所以我們最好能在代碼中顯式地指出導入的解析過程。

python 模塊相對導入

ValueError: attempted relative import beyond top-level package

假設有如下層次包目錄

相對導入語法

相對導入與模塊 name 有關

相對導入只適用於包中的模塊，頂層的模塊中將不起作用

例子

Python導入模塊或包需要注意哪些點

Python是一種面向對象的編程語言，裡面包含有豐富強大的庫，想要學習Python開發，首先需要學習如何導入模塊或包。下面就跟大家一起討論下Python導入模塊的幾種方法：

常規導入

最常用的導入方式，大概是這樣的：

import sys

只需要使用 import ，然後指定希望導入的模塊或包即可。用這種方法導入的好處是可以一次性導入多個包或模塊：

import os, sys, time

雖然這節省了空間，但是卻違背了Python風格指南。 Python風格指南建議將每個導入語句單獨成行 。

有時在導入模塊時，你想要重命名這個模塊。這個功能很容易實現：

import sys as system

print(system.platform)

上面的代碼將我們導入的 sys 模塊重命名為 system 。我們可以按照和以前一樣的方式調用模塊的方法，但是可以用一個新的模塊名。也有某些子模塊必須要使用點標記法才能導入。

import urllib.error

這個情況不常見，但是對此有所了解總是沒有壞處的。

使用from語句導入

有時我們只想要導入一個模塊或庫中的某個部分。那麼Python是如何實現這點：

from functools import lru_cache

上面這行代碼可以讓你直接調用 lru_cache 。如果按常規方式導入 functools ，那麼就必須像這樣調用 lru_cache ：

functools.lru_cache(*args)

根據實際的使用場景，上面的做法可能是更好的。在複雜的代碼庫中，能夠看出某個函數是從哪裡導入的這點很有用的。不過，如果你的代碼維護的很好，模塊化程度高，那麼只從某個模塊中導入一部分內容也是非常方便和簡潔的。

當然，你還可以使用from方法導入模塊的全部內容，就像這樣：

from os import *

這種做法在少數情況下是挺方便的，但是這樣也會打亂你的命名空間。問題在於，你可能定義了一個與導入模塊中名稱相同的變量或函數，這時如果你試圖使用

os 模塊中的同名變量或函數，實際使用的將是你自己定義的內容。因此，你最後可能會碰到一個相當讓人困惑的邏輯錯誤。

標準庫中我唯一推薦全盤導入的模塊只有Tkinter 。

如果你正好要寫自己的模塊或包，有人會建議你在 __init__.py 文件中導入所有內容，讓模塊或者包使用起來更方便。我個人更喜歡顯示地導入，而非隱式地導入。

你也可以採取折中方案，從一個包中導入多個項：

from os import path, walk, unlinkfrom os import uname, remove

在上述代碼中，我們從 os 模塊中導入了5個函數。你可能注意到了，我們是通過多次從同一個模塊中導入實現的。當然，如果你願意的話，你也可以使用圓括號一次性導入多個項：

from os import (path, walk, unlink, uname,

remove, rename)

這是一個有用的技巧，不過你也可以換一種方式：

from os import path, walk, unlink, uname, \

remove, rename

上面的反斜杠是Python中的續行符，告訴解釋器這行代碼延續至下一行。

相對導入

PEP 328 介紹了引入相對導入的原因，以及選擇了哪種語法。具體來說，是使用句點來決定如何相對導入其他包或模塊。這麼做的原因是為了避免偶然情況下導入標準庫中的模塊產生衝突。這裡我們以PEP 328中給出的文件夾結構為例，看看相對導入是如何工作的：

my_package/

__init__.py

subpackage1/

__init__.py

module_x.py

module_y.py

subpackage2/

__init__.py

module_z.py

module_a.py

在本地磁盤上找個地方創建上述文件和文件夾。在頂層的 __init__.py 文件中，輸入以下代碼：

from . import subpackage1from . import subpackage2

接下來進入 subpackage1 文件夾，編輯其中的 __init__.py 文件，輸入以下代碼：

from . import module_xfrom . import module_y

現在編輯 module_x.py 文件，輸入以下代碼：

from .module_y import spam as ham

def main():

ham()

最後編輯 module_y.py 文件，輸入以下代碼：

def spam():

print(‘spam ‘ * 3)

打開終端， cd 至 my_package 包所在的文件夾，但不要進入 my_package 。在這個文件夾下運行Python解釋器。我使用的是IPython，因為它的自動補全功能非常方便：

In [1]: import my_package

In [2]: my_package.subpackage1.module_xOut[2]: module

‘my_package.subpackage1.module_x’ from

‘my_package/subpackage1/module_x.py’

In [3]: my_package.subpackage1.module_x.main()spam spam spam

相對導入適用於你最終要放入包中的代碼。如果你編寫了很多相關性強的代碼，那麼應該採用這種導入方式。

你會發現PyPI上有很多流行的包也是採用了相對導入 。還要注意一點，如果你想要跨越多個文件層級進行導入，只需要使用多個句點即可。不過， PEP

328建議相對導入的層級不要超過兩層 。

還要注意一點，如果你往 module_x.py 文件中添加了 if __name__ == ‘__main__’ ，然後試圖運行這個文件，你會碰到一個很難理解的錯誤。編輯一下文件，試試看吧！

from . module_y import spam as ham

def main():

ham()

if __name__ == ‘__main__’:

# This won’t work!

main()

現在從終端進入 subpackage1 文件夾，執行以下命令：

python module_x.py

如果你使用的是Python 2，你應該會看到下面的錯誤信息：

Traceback (most recent call last):

File “module_x.py”, line 1, in module

from . module_y import spam as hamValueError: Attempted relative import in non-package

如果你使用的是Python 3，錯誤信息大概是這樣的：

Traceback (most recent call last):

File “module_x.py”, line 1, in module

from . module_y import spam as hamSystemError: Parent module ” not loaded, cannot perform relative import

這指的是， module_x.py 是某個包中的一個模塊，而你試圖以腳本模式執行，但是 這種模式不支持相對導入 。

如果你想在自己的代碼中使用這個模塊，那麼你必須將其添加至Python的導入檢索路徑（import search path）。最簡單的做法如下：

import syssys.path.append(‘/path/to/folder/containing/my_package’)import my_package

注意，你需要添加的是 my_package 的上一層文件夾路徑，而不是 my_package 本身。原因是 my_package 就是我們想要使用的包，所以如果你添加它的路徑，那麼將無法使用這個包。

我們接下來談談可選導入。

可選導入（Optional imports）

如果你希望優先使用某個模塊或包，但是同時也想在沒有這個模塊或包的情況下有備選，你就可以使用可選導入這種方式。這樣做可以導入支持某個軟件的多種版本或者實現性能提升。以 github2包 中的代碼為例：

try:

# For Python 3

from http.client import responsesexcept ImportError: # For Python 2.5-2.7

try:

from httplib import responses # NOQA

except ImportError: # For Python 2.4

from BaseHTTPServer import BaseHTTPRequestHandler as _BHRH

responses = dict([(k, v[0]) for k, v in _BHRH.responses.items()])

lxml 包也有使用可選導入方式：

try:

from urlparse import urljoin

from urllib2 import urlopenexcept ImportError:

# Python 3

from urllib.parse import urljoin

from urllib.request import urlopen

正如以上示例所示， 可選導入的使用很常見，是一個值得掌握的技巧 。

局部導入

當你在局部作用域中導入模塊時，你執行的就是局部導入。如果你在Python腳本文件的頂部導入一個模塊，那麼你就是在將該模塊導入至全局作用域，這意味着之後的任何函數或方法都可能訪問該模塊。例如：

import sys # global scope

def square_root(a):

# This import is into the square_root functions local scope

import math

return math.sqrt(a)

def my_pow(base_num, power):

return math.pow(base_num, power)

if __name__ == ‘__main__’:

print(square_root(49))

print(my_pow(2, 3))

這裡，我們將 sys 模塊導入至全局作用域，但我們並沒有使用這個模塊。然後，在 square_root 函數中，我們將 math

模塊導入至該函數的局部作用域，這意味着 math 模塊只能在 square_root 函數內部使用。如果我們試圖在 my_pow 函數中使用

math ，會引發 NameError 。試着執行這個腳本，看看會發生什麼。

使用局部作用域的好處之一，是你使用的模塊可能需要很長時間才能導入，如果是這樣的話，將其放在某個不經常調用的函數中或許更加合理，而不是直接在全局作

用域中導入。老實說，我幾乎從沒有使用過局部導入，主要是因為如果模塊內部到處都有導入語句，會很難分辨出這樣做的原因和用途。

根據約定，所有的導入語句都應該位於模塊的頂部 。

導入注意事項

在導入模塊方面，有幾個程序員常犯的錯誤。這裡我們介紹兩個。

循環導入（circular imports）

覆蓋導入（Shadowed imports，暫時翻譯為覆蓋導入）

先來看看循環導入。

循環導入

如果你創建兩個模塊，二者相互導入對方，那麼就會出現循環導入。例如：

# a.pyimport b

def a_test():

print(“in a_test”)

b.b_test()

a_test()

然後在同個文件夾中創建另一個模塊，將其命名為 b.py 。

import a

def b_test():

print(‘In test_b”‘)

a.a_test()

b_test()

如果你運行任意一個模塊，都會引發 AttributeError 。這是因為這兩個模塊都在試圖導入對方。簡單來說，模塊 a 想要導入模塊 b

，但是因為模塊 b 也在試圖導入模塊 a （這時正在執行），模塊 a 將無法完成模塊 b

的導入。我看過一些解決這個問題的破解方法（hack），但是 一般來說，你應該做的是重構代碼，避免發生這種情況 。

覆蓋導入

當你創建的模塊與標準庫中的模塊同名時，如果你導入這個模塊，就會出現覆蓋導入。舉個例子，創建一個名叫 math.py 的文件，在其中寫入如下代碼：

import math

def square_root(number):

return math.sqrt(number)

square_root(72)

現在打開終端，試着運行這個文件，你會得到以下回溯信息（traceback）：

Traceback (most recent call last):

File “math.py”, line 1, in module

import math

File “/Users/michael/Desktop/math.py”, line 6, in module

square_root(72)

File “/Users/michael/Desktop/math.py”, line 4, in square_root

return math.sqrt(number)AttributeError: module ‘math’ has no attribute ‘sqrt’

這到底是怎麼回事？其實，你運行這個文件的時候，Python解釋器首先在當前運行腳本所處的的文件夾中查找名叫 math

的模塊。在這個例子中，解釋器找到了我們正在執行的模塊，試圖導入它。但是我們的模塊中並沒有叫 sqrt 的函數或屬性，所以就拋出了

AttributeError 。