[轉載]Python中單、雙下劃線的區別總結

来源:https://www.cnblogs.com/icris/archive/2019/03/13/10526631.html
-Advertisement-
Play Games

前言 Python 的代碼風格由 PEP 8 描述。這個文檔描述了 Python 編程風格的方方面面。在遵守這個文檔的條件下,不同程式員編寫的 Python 代碼可以保持最大程度的相似風格。這樣就易於閱讀,易於在程式員之間交流。 我們大家在學習Python的時候,好像很多人都不理解為什麼在方法(me ...


前言

Python 的代碼風格由 PEP 8 描述。這個文檔描述了 Python 編程風格的方方面面。在遵守這個文檔的條件下,不同程式員編寫的 Python 代碼可以保持最大程度的相似風格。這樣就易於閱讀,易於在程式員之間交流。

我們大家在學習Python的時候,好像很多人都不理解為什麼在方法(method)前面會加好幾個下劃線,有時甚至兩邊都會加,比如像__this__這種。在我看到上面的文章之前,我一直以為Python中這些下劃線的作用就像Golang中方法/函數的大小寫一樣,或是一些其他語言中的private、public的作用一樣,但仔細深究,這不全是Python這樣設計的初衷。

下麵我們具體分析,話不多說了,來一起看看吧。

單下劃線開頭

我們經常看到方法或者屬性前面加了單下劃線,並認為它表示該方法或者屬性是該類型(Python和Golang一樣,不光類可以有方法,很多類型甚至基本類型也可以定義方法)的私有方法或屬性。但其實在Python中不存在真正意義上的私有方法或者屬性,前面加單下劃線_只是表示你不應該去訪問這個方法或者屬性,因為它不是API的一部分。

舉個例子:

Python
class BaseForm(StrAndUnicode):
 ...

 def _get_errors(self):
 "Returns an ErrorDict for the data provided for the form"
 if self._errors is None:
 self.full_clean()
 return self._errors

 errors = property(_get_errors)

該代碼片段來自Django源碼(django/forms/forms.py)。這段代碼的設計就是errors屬性是對外API的一部分,如果你想獲取錯誤詳情,應該訪問errors屬性,而不是(也不應該)訪問_get_errors方法。

雙下劃線開頭

之前很多人跟我說Python中雙下劃線開頭表示私有,我在很多地方也見到這樣的說法。這樣理解可能也不能說錯,但這不是Python設計雙下劃線開頭的初衷和目的,Python設計此的真正目的僅僅是為了避免子類覆蓋父類的方法。

我們看個例子:

class A(object):
 
 def __method(self):
 print("I'm a method in class A")

 def method_x(self):
 print("I'm another method in class A\n")

 def method(self):
 self.__method()
 self.method_x()

class B(A):
 
 def __method(self):
 print("I'm a method in class B")

 def method_x(self):
 print("I'm another method in class B\n")


if __name__ == '__main__':
 
 print("situation 1:")
 a = A()
 a.method()

 b = B()
 b.method()

 print("situation 2:")
 # a.__method()
 a._A__method() 

執行結果:

situation 1:
I'm a method in class A
I'm another method in class A

I'm a method in class A
I'm another method in class B

situation 2:
I'm a method in class A

這裡有兩個點需要註意:

A類中我們定義了__method()、method_x和method()三個方法;然後我們重新定義一個類B,繼承自A,並且在B類中覆寫(override)了其父類的__method()和method_x方法,但是從輸出結果看,B對象調用method()方法時調用了其父類A的__method()方法和自己的method_x()方法。也就是說,__method()覆寫沒有生效,而method_x()覆寫生效了。而這也正是Python設計雙下劃線開頭的唯一目的。

這一點也可在Python官方說明中得到答案:https://www.python.org/dev/peps/pep-0008/#method-names-and-instance-variables

前面我們就說了,Python中不存在真正意義上的私有變數。對於雙下劃線開頭的方法和屬性雖然我們不能直接引用,那是因為Python預設在其前面加了首碼_類名,所以就像situation 2下麵的代碼,雖然我們不能用a直接訪問__method(),但卻可以加上首碼去訪問,即_A__method()。

開頭結尾雙下劃線

一般來說像__this__這種開頭結尾都加雙下劃線的方法表示這是Python自己調用的,你不要調用。比如我們可以調用len()函數來求長度,其實它後臺是調用了__len__()方法。一般我們應該使用len,而不是直接使用__len__():

a = [1, 2, 3]
print(len(a)) 
print(a.__len__()) # 和上面等效

num = 10
print(num + 10)
print(num.__add__(10)) # 和上面等效

我們一般稱__len__()這種方法為magic methods,一些操作符後臺調用的也是也是這些magic methods,比如+後臺調用的是__add__,-調用的是__sub__,所以這種機制使得我們可以在自己的類中覆寫操作符(見後面例子)。另外,有的時候這種開頭結尾雙下劃線方法僅僅是某些特殊場景的回調函數,比如__init__()會在對象的初始化時調用,__new__()會在構建一個實例的時候調用等等。下麵我們看兩個例子:

class CrazyNumber(object):
 def __init__(self, n): 
 self.n = n 
 def __add__(self, other): 
 return self.n - other 
 def __sub__(self, other): 
 return self.n + other 
 def __str__(self): 
 return str(self.n) 

num = CrazyNumber(10) 
print(num) # output is: 10
print(num + 5) # output is: 5
print(num - 20) # output is: 30

在上面這個例子中,我們覆寫了+和-操作符,將他們的功能交換了。再看個例子:

class Room(object):
 def __init__(self): 
 self.people = [] 
 def add(self, person): 
 self.people.append(person) 
 def __len__(self): 
 return len(self.people)
 
room = Room() 
room.add("Igor") 
print len(room) # output is: 1

這個例子中,因為我們實現了__len__(),所以Room對象也可以使用len函數了。

所有此類的方法都在這裡有說明:documentation.

結論

  • 使用單下劃線(_one_underline)開頭表示方法不是API的一部分,不要直接訪問(雖然語法上訪問也沒有什麼問題)。
  • 使用雙下劃線開頭(__two_underlines)開頭表示子類不能覆寫該方法。除非你真的知道你在乾什麼,否則不要使用這種方式。
  • 當你想讓自己定義的對象也可以像Python內置的對象一樣使用Python內置的一些函數或操作符(比如len、add、+、-、==等)時,你可以定義該類方法。
  • 當然還有些屬性只在末尾加了但下劃線,這僅僅是為了避免我們起的一些名字和Python保留關鍵字衝突,沒有特殊含義。

註:本文大部分內容參考自Difference between _ , and __xx in Python .

        http://igorsobreira.com/2010/09/16/difference-between-one-underline-and-two-underlines-in-python.html


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

-Advertisement-
Play Games
更多相關文章
  • 一、JDBC的問題 為什麼我們要使用mybatis,是因為JDBC存在以下問題 1、 資料庫連接創建、釋放頻繁造成系統資源浪費,從而影響系統性能。如果使用資料庫連接池可解決此問題。 2、 Sql語句在代碼中硬編碼,造成代碼不易維護,實際應用中sql變化的可能較大,sql變動需要改變java代碼。 3 ...
  • 1.Scrapy框架介紹 主要介紹,spiders,engine,scheduler,downloader,Item pipeline scrapy常見命令如下: 對應在scrapy文件中有,自己增加爬蟲文件,系統生成items,pipelines,setting的配置文件就這些。 items寫需要 ...
  • 超簡單Python將指定數據插入到docx模板渲染並生成 最近有一個需求,製作勞動合同表,要從excel表格中將每個人的數據導入到docx勞動合同中,重覆量很大,因此可以使用python高效解決。為了讓模板內容不變動,這裡使用了類似jinja2的渲染引擎,使用{{ }}插值表達式把數據插入進去。也可 ...
  • 前言 上一篇[面試官問我,使用Dubbo有沒有遇到一些坑?我笑了。]之後,又有一位粉絲和我說在面試過程中被虐了.鑒於這位粉絲是之前肥朝的粉絲,而且周一又要開啟新一輪的面試,為了回饋他長期以來的支持,所以連夜寫了本篇,希望能對他接下來的面試有所幫助. 真實案例 Redis分散式鎖的正確姿勢 據肥朝瞭解 ...
  • 恢復內容開始 用Python中的turtle庫畫一個愛心 這個學期,我學了Python語言,並學到其中的一個庫:turtle庫。用turtle庫可以畫一些你想畫的圖片,所以我就想畫一個愛心(耶耶耶耶)。 愛心的代碼如下: 運行結果圖如下: 這就是我畫的愛心!!! 恢復內容結束 ...
  • 1、什麼是Mybatis? (1)Mybatis是一個半ORM(對象關係映射)框架,它內部封裝了JDBC,開發時只需要關註SQL語句本身,不需要花費精力去處理載入驅動、創建連接、創建statement等繁雜的過程。程式員直接編寫原生態sql,可以嚴格控制sql執行性能,靈活度高。 (2)MyBati ...
  • 0.前言 前段時間在做javafx的應用程式,遇到一些坑。以本文記錄之。(如有更好的解決辦法歡迎評論,本人小白,輕噴) 1.問題 按照官方的中文文檔,成功的運行了單一界面的表單登錄。於是想自己試試多界面跳轉,給按鈕添加事件響應。可是怎麼操作都報錯,百度了許久沒有解決辦法。後來Google後找到了一個 ...
  • 題意 "鏈接" Sol 生成函數題都好神仙啊qwq 我們考慮枚舉一個長度$len$。有一個結論是如果我們按$N len$的餘數分類,若同一組內的全為$0$或全為$1$(?不算),那麼存在一個長度為$len$的border。 有了這個結論後我們考慮這樣一種做法:把序列看成兩個串$a, b$,若$a_i ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...