Python學習:import的正確用法

来源:https://www.cnblogs.com/python1111/archive/2022/09/02/16651298.html
-Advertisement-
Play Games

import語句用來導入其他python文件(稱為模塊module),使用該模塊里定義的類、方法或者變數,從而達到代碼復用的目的。 將要建立文件的結構為: Tree |____ m1.py |____ m2.py |____ Branch |____m3.py |____m4.py 首先,先建立一個 ...


import語句用來導入其他python文件(稱為模塊module),使用該模塊里定義的類、方法或者變數,從而達到代碼復用的目的。

將要建立文件的結構為:

Tree
|____ m1.py
|____ m2.py
|____ Branch
     |____m3.py
     |____m4.py

首先,先建立一個文件夾Tree作為工作目錄,併在其內建立兩個文件m1.py和m2.py,在m1.py寫入代碼:

import os
import m2
m2.printSelf()

在m2.py寫入代碼:

def printSelf():
	print('In m2')

打開命令行,進入到Tree目錄下,敲下python m1.py運行,發現沒有報錯,且列印出In m2,說明這樣使用import沒有問題。由此我們總結出import語句的第一種用法。

  • import module_name。即import後直接接模塊名。在這種情況下,Python會在兩個地方尋找這個模塊,第一是sys.path(通過運行代碼import sys; print(sys.path)查看),os這個模塊所在的目錄就在列表sys.path中,一般安裝的Python庫的目錄都可以在sys.path中找到(前提是要將Python的安裝目錄添加到電腦的環境變數),所以對於安裝好的庫,我們直接import即可。第二個地方就是運行文件(這裡是m1.py)所在的目錄,因為m2.py和運行文件在同一目錄下,所以上述寫法沒有問題。

用上述方法導入原有的sys.path中的庫沒有問題。但是,最好不要用上述方法導入同目錄下的文件!因為這可能會出錯。演示這個錯誤需要用到import語句的第二種寫法,所以先來學一學import的第二種寫法。在Tree目錄下新建一個目錄Branch,在Branch中新建文件m3.py,m3.py的內容如下:

def printSelf():
	print('In m3')

如何在m1中導入m3.py呢,請看更改後的m1.py:

from Branch import m3
m3.printSelf()

總結import語句的第二種用法:

  • from package_name import module_name。一般把模塊組成的集合稱為包(package)。與第一種寫法類似,Python會在sys.path和運行文件目錄這兩個地方尋找包,然後導入包中名為module_name的模塊。

現在我們來說明為什麼不要用import的第一種寫法來導入同目錄下的文件。在Branch目錄下新建m4.py文件,m4.py的內容如下:

def printSelf():
	print('In m4')

然後我們在m3.py中直接導入m4,m3.py變為:

import m4
def printSelf():
	print('In m3')

這時候運行m1.py就會報錯了,說沒法導入m4模塊。為什麼呢?我們來看一下導入流程:m1使用from Branch import m3導入m3,然後在m3.py中用import m4導入m4。看出問題了嗎?m4.py和m1.py不在同一目錄,怎麼能直接使用import m4導入m4呢。(可以試試直接在Tree目錄下新建另一個m4.py文件,你會發現再運行m1.py就不會出錯了,只不過導入的是第二個m4.py了)

面對上面的錯誤,使用python2運行m1.py就不會報錯,因為在python2中,上面提到的import的兩種寫法都屬於相對導入,而在python3中,卻屬於絕對導入。話說到了這裡,就要牽扯到import中最關鍵的部分了——相對導入和絕對導入。

我們還是談論python3的import用法。上面提到的兩種寫法屬於絕對導入,即用於導入sys.path中的包和運行文件所在目錄下的包。對於sys.path中的包,這種寫法毫無問題;導入自己寫的文件,如果是非運行入口文件(上面的m1.py是運行入口文件,可以使用絕對導入),則需要相對導入。

比如對於非運行入口文件m3.py,其導入m4.py需要使用相對導入:

from . import m4
def printSelf():
	print('In m3')

這時候再運行m1.py就ok了。列舉一下相對導入的寫法:

  • from . import module_name。導入和自己同目錄下的模塊。
  • from .package_name import module_name。導入和自己同目錄的包的模塊。
  • from .. import module_name。導入上級目錄的模塊。
  • from ..package_name import module_name。導入位於上級目錄下的包的模塊。
  • 當然還可以有更多的.,每多一個點就多往上一層目錄。

不知道你有沒有留神上面的一句話——“上面的m1.py是運行入口文件,可以使用絕對導入”,這句話是沒問題的,也和我平時的做法一致。那麼,運行入口文件可不可以使用相對導入呢?比如m1.py內容改成:

from .Branch import m3
m3.printSelf()

答案是可以,但不能用python m1.py命令,而是需要進入到Tree所在的目錄,使用python -m Tree.m1來運行。為什麼?關於前者,PEP 328提案中的一段文字好像給出了原因:

Relative imports use a module's _name_ attribute to determine that
module's position in the package hierarchy. If the module's name does
not contain any package information (e.g. it is set to '__main__')
then relative imports are resolved as if the module were a top level
module, regardless of where the module is actually located on the file
system.

我們應該見過下麵一段代碼:

if __name__ == '__main__':
	main()

意思是如果運行了當前文件,則__name__變數會置為__main__,然後會執行main函數,如果當前文件是被其他文件作為模塊導入的話,則__name__為模塊名,不等於__main__,就不會執行main函數。比如對於上述更改後的m1.py,執行python m1.py命令後,會報如下錯誤:

Traceback (most recent call last): 
File "m1.py", line 1, in from .Branch import m3 ModuleNotFoundError: 
No module named '_main_.Branch'; 
'__main__' is not a package

據此我猜測執行python m1.py命令後,當前目錄所代表的包'.'變成了__main__

那為什麼python -m Tree.m1就可以呢?

執行指令中的-m是為了讓Python預先import你要的package或module給你,然後再執行script。

即不把m1.py當作運行入口文件,而是也把它當作被導入的模塊,這就和非運行入口文件有一樣的表現了。

註意,在Tree目錄下運行python -m m1是不可以的,會報 ImportError: attempted relative import with no known parent package的錯誤。因為m1.py中的from .Branch import m3中的. ,解釋器並不知道是哪一個package。使用python -m Tree.m1,解釋器就知道.對應的是Tree這個package。

那反過來,如果m1.py使用絕對導入(from Branch import m3),能使用python -m m1運行嗎?我試了一下,如果當前目錄是Tree就可以。如果在其他目錄下運行,比如在Tree所在的目錄(使用python -m Tree.m1運行),就不可以。這可能還是與絕對導入相關。

(之前看到了一個大型項目,其運行入口文件有一大堆的相對導入,我還傻乎乎地用python直接運行它。之後看到他給的樣例運行命令是帶了-m參數的。現在才恍然大悟。)

理解import的難點差不多就這樣了。

下麵說一說import的其他簡單但實用的用法。

  • import moudle_name as alias。有些module_name比較長,之後寫它時較為麻煩,或者module_name會出現名字衝突,可以用as來給它改名,如import numpy as np。
  • from module_name import function_name, variable_name, class_name。上面導入的都是整個模塊,有時候我們只想使用模塊中的某些函數、某些變數、某些類,用這種寫法就可以了。使用逗號可以導入模塊中的多個元素。
  • 有時候導入的元素很多,可以使用反斜杠來換行,官方推薦使用括弧。
from Tkinter import Tk, Frame, Button, Entry, Canvas, Text, \
    LEFT, DISABLED, NORMAL, RIDGE, END	# 反斜杠換行
from Tkinter import (Tk, Frame, Button, Entry, Canvas, Text,
    LEFT, DISABLED, NORMAL, RIDGE, END)	# 括弧換行(推薦)

說到這感覺import的核心已經說完了。再跟著上面的博客說一說使用import可能碰到的問題吧。

問題1描述:ValueError: attempted relative import beyond top-level package。直面問題的第一步是去瞭解熟悉它,最好是能復現它,將錯誤暴露在陽光之下。仍然是上面四個文件,稍作修改,四個文件如下:

# m1.py
from Branch import m3
m3.printSelf()
# m2.py
def printSelf():
	print('module2')
# m3.py
from .. import m2 # 復現的關鍵在這 #
print(__name__)
def printSelf():
	print('In m3')
# m4.py
def printSelf():
	print('In m4')

運行python m1.py,就會出現該問題。問題何在?我猜測,運行m1.py後,m1代表的模塊就是頂層模塊(參見上面PEP 328的引用),而m3.py中嘗試導入的m2模塊所在的包(即Tree目錄代表的包)比m1的層級更高,所以會報出這樣的錯誤。怎麼解決呢?將m1.py的所有導入改為相對導入,然後進入m1.py的上層目錄,運行python -m Tree.m1即可。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • JavaScript 函數 函數概念 函數:就是封裝了一段可以被重覆執行調用的代碼塊,目的就是讓大量的代碼重覆使用 函數的使用 函數的使用 分兩步:聲明函數和調用函數 //1.聲明函數 //function 函數名() { //函數體 //} function sayHi(){ console.lo ...
  • Vue路由跳轉的四種方式用法及區別 點擊打開視頻講解更加詳細 一、router-link <router-link :to="{name:'home'}"> <router-link :to="{path:'/home'}"> //name,path都行, 建議用name // 註意:router- ...
  • 作為一名H5開發人員可以使用hbuilder或apicloud。但是,到打包和發佈時,被申請ios證書和上架ipa文件給了困難。由於官方提供的方法,申請證書需要使用Mac電腦然後使用Mac電腦中的密鑰鏈訪問,去申請證書csr文件。然後再去蘋果開發者中心申請。 但是,Mac或未使用的Mac朋友都被 ...
  • 蒼穹之邊,浩瀚之摯,眰恦之美; 悟心悟性,善始善終,惟善惟道! —— 朝槿《朝槿兮年說》 寫在開頭 提起Java領域中的鎖,是否有種“道不盡紅塵奢戀,訴不完人間恩怨“的”感同身受“之感?細數那些個“玩意兒”,你對Java的熱情是否還如初戀般“人生若只如初見”? Java中對於鎖的實現真可謂是“百花齊 ...
  • 定義:建造者模式也稱為生成器模式,將一個個簡單對象一步步構造成一個複雜的對象,將複雜對象的構建和它的表示分離,使得同樣的構建過程有不同的表示; 主要解決:系統中複雜對象的創建過程,通常由各個部分的子對象採用一定的演算法構成;由於需求的變化 ,這個複雜對象的各個部分通常面臨著劇烈的變化,但是將他們組合在 ...
  • Serverless 架構將成為未來雲計算領域重要的技術架構,將會被更多的業務所採納。進一步深究,Serverless 架構在什麼場景下有優秀的表現,在什麼場景下可能表現得並不是很理想呢?或者說,有哪些場景更適合 Serverless 架構呢? ...
  • 集合和數組的區別 共同點:都是存儲數據的容器 不同點:數組的容量是固定的,集合的容量是可變的 ArrayList的構造方法和添加方法 public ArrayList() 創建一個空的集合對象 構造一個初始容量為 10 的空列表。 public boolean add(E element) 將指定的 ...
  • 目錄 一.OpenGL ES 圖像伽馬線 1.原始圖片 2.效果演示 二.OpenGL ES 圖像伽馬線源碼下載 三.猜你喜歡 零基礎 OpenGL ES 學習路線推薦 : OpenGL ES 學習目錄 >> OpenGL ES 基礎 零基礎 OpenGL ES 學習路線推薦 : OpenGL ES ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...