Python 代碼智能感知 —— 類型標註與特殊的註釋(獻給所有的Python人)

来源:https://www.cnblogs.com/xiaokang2022/archive/2022/09/19/16709118.html
-Advertisement-
Play Games

【原文地址:https://xiaokang2022.blog.csdn.net/article/details/126936985】 ​ 一個不會寫好的類型標註和註釋的Python程式員,是讓使用TA的代碼的人都痛苦無比的事情…… —— 某某大佬 一、代碼智能感知 想必大部分現代的集成開發環境(I ...


【原文地址:https://xiaokang2022.blog.csdn.net/article/details/126936985


一個不會寫好的類型標註註釋的Python程式員,是讓使用TA的代碼的人都痛苦無比的事情……

—— 某某大佬

一、代碼智能感知

        想必大部分現代的集成開發環境(IDE)都有代碼智能感知功能吧!

        智能感知(IntelliSense),就是在我們寫代碼的時候,代碼編輯器自動彈出我們代碼中需要補全的部分,而這些補全的部分就是代碼編輯器通過智能感知得到的,最重要的是,代碼編輯器智能地感知補全的部分是通過代碼中的變數的類型來得到的。


說了這麼多之後,大家一定都清楚智能感知是什麼了,但有些時候,代碼卻沒有智能感知(如下)


當代碼量很大的時候,代碼的智能感知是十分重要的,它可以幫你迅速瞭解到這個變數那個變數是個什麼東西,以減少你生產BUG!

        寫一個好的註釋(或者類型標註),不僅僅是方便未來複用你代碼的人,也是為了自己,實際上,“為了自己”可不只是簡單的方便自己瞭解代碼,更多的是讓IDE智能地感知到你的代碼,IDE理解了你的代碼,它就會為你提供對應的信息(如代碼補全和提示作用),這對程式員是極其友好的!

通過瞭解後面的類型標註特殊的註釋,你將解決幾乎所有的智能感知失效的問題! 

二、類型標註

Python的類型標註有幾種,在下麵我給出我所知道的一些

函數參數的類型標註 

【簡單操作】

1 def function(num: int, string: str):
2     pass

在上面的代碼中,函數參數的後面跟了一個冒號和一個類名,代表參數的數據類型,這個類名可以是內置的類,如str、int、float等,也可以是自己定義的類、也可以是模塊、庫中的類,如tkinter.Tk

num參數是int類型的,string參數是str類型的,這些類型標註不僅僅在函數被定義的地方可以被看見,在調用該函數的時候也能通過IDE的智能感知而被看見(如下)


這個類型標註之後,並不會強制該參數使用該類型,它只是起提示作用,相當於註釋,同時,IDE會通過智能感知該類型標註,給出相應的代碼提示


【高級操作】

1 import typing
2 
3 def function(num: int,
4              lis: list[int],
5              key: typing.Literal[4, 5, 6],
6              string: str | None = '123'):
7     pass

上面的代碼中:

list[int] 的意思是,lis參數的數據類型為一個內含整數數據的列表類型

typing是一個官方的內置模塊,專門用於類型標註,typing.Literal[4, 5, 6] 表示參數key的預期值只能為4或者5或者6,也就是說,該函數接收的key參數,它只希望它是4、5或者6這三個值中的一個

str | None 的意思是,string參數的數據類型可以為str或者是None類型,此處說明一下,類型標註中用 “|” 代表或者的這種操作是在 Python3.10 的時候才加入的,在之前的版本中,這種用法只在 pyi 文件(Python存根文件)中可以用

下麵的代碼提示中,我們就能看到類似於上面的類型標註的作用


順便一提,那個省略號(三個連續的小數點)的意思的預設值(一般用於pyi存根文件中)

函數返回值的類型標註

1 def pow(m: int, n: int) -> int:
2     return m**n

函數返回值的類型標註類似於上面所說的參數類型標註,只不過這裡標註的類型只的是函數的返回值的數據類型,同樣的,只起提示作用,沒有強制效果

這個標註也有高級用法,與上面的完全,一樣,此處不再贅述

順便一提,list[int, int, int] 表示一個含有三個整數數據的列表類型

變數的類型標註

傳言有一種從天而降的寫法,不知大家見過沒有

1 key: int
2 key = 3
3 
4 """
5 或者這樣寫:
6 key: int = 3
7 """
8 
9 print(key) # 輸出3

這個變數名後面加一個冒號、再加一個類名的寫法也是類型標註的一種,只不過它不是函數的參數,而是一般變數而已,用法同上

那麼,這個類型標註有什麼用呢?直接賦值給該變數一個列表,那麼IDE不也能識別它麽?

這對於一般的變數確實沒啥用,但是,下麵的這種操作,你可看好了


上面的這種情況,當變數沒有提前做好類型標註時,後面寫代碼就因為沒有IDE的提示而極其麻煩

變數的類型標註還有一種方法,將在後面的 特殊的註釋 中講到

三、特殊的註釋

一段看似普通的註釋,實際也有著特殊的作用,就像C#中的特殊註釋一樣(三條斜杠“///”),Python也有著它特殊的註釋

【三引號註釋】

想必一個合格的Python程式員,都知道三引號註釋的特殊作用吧

它不僅僅是一段普通的註釋,它可以換行(都知道的),它寫在函數和類下麵表示幫助文檔等等……這裡就不再贅述了

【特殊的 # 註釋】

它只能單行註釋……除此之外難道它還有別的特性???對!別的特性!

當 # 註釋以這樣一種格式寫的時候,它有著和類型標註同樣的效果!!!

1 key = [] # type: list[float]

# 註釋後面寫上 type,再加一個冒號、然後加上數據類型,它就成了類型標註!!!


是不是大多數人都不知道這個特性呢?

四、特殊的類型

有一些比較特別的數據類型,有些不是內置的但又算是內置的,但你又不容易找到它,比如迭代器類型、生成器類型、函數類型(Python里函數實際也是個對象,也有類型)等等,下麵給出一個表格方便大家進行類型的標註

類型名稱 數據類型 引用方式
函數 function

function

types.FunctionType

方法 method

types.MethodType

迭代器 Iterator

typing.Iterator

collections.abc.Iterator

生成器 Generator

typing.Generator

collections.abc.Generator

序列 Sequence

typing.Sequence

collections.abc.Sequence


【看了這麼多,是不是感覺又漲知識了呢?那麼,你的贊呢?】 


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

-Advertisement-
Play Games
更多相關文章
  • 隨著需求開發迭代,代碼庫規模逐漸變大,新的團隊成員引入等諸多因素,系統起初制定的架構規則不可避免遭到破壞。不僅僅是破壞團隊的統一開發規範,更為重要的是隨著代碼庫規模逐漸增長,大大降低系統的可維護性、擴展性,增加評審複雜度和重構成本,也最終導致團隊生產力下降以及研發成本增長。 在敏捷開發環境下,系統... ...
  • 摘要:零售企業就需要安全、可信、開放、能力強大的PaaS集成平臺支撐自身的雲業務,同樣也需要一個強大的業務系統來承載業務。 疫情又來了,買買買,趕緊囤。 這麼快沒貨了? 疫情反覆態勢之下,消費者體驗到的商品到達速度和多樣的產品選擇,以及平臺面臨的跨區調貨和各種渠道的線上流量突增等現狀,使得消費品及零 ...
  • 限流:使用Redisson的RRateLimiter進行限流 多策略:map+函數式介面優化if判斷 自定義註解 /** * aop限流註解 */ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.R ...
  • 我的gRPC之旅。本節簡單介紹gRPC的四種通信模式。簡單通信模式、服務端流通信模式、客戶端流通信模式、雙向流通信模式。 ...
  • Nacos 英文全稱為 Dynamic Naming and Configuration Service,是一個由阿裡巴巴團隊使用 Java 語言開發的開源項目。 ...
  • 六大設計原則 單一職責原則 介面隔離原則 開閉原則 依賴倒置原則 里氏代換原則 迪米特法則 單一職責原則 我們分別看兩個案例,一個是遵守單一職責原則,另一個是違背。 違背的案例 class Computer { void calc() { System.out.println("計算數據"); // ...
  • 在我們日常的開發中,我們經常會遇到 NullPointerException。如何才能優雅的處理NPE?這裡告訴大家一個較為流行的方法 java.util.Optional 使用Optional來修飾對象,表示這個對象可能為null。在使用時,就要加以註意,必須要考慮該值為null的場景。 使用Op ...
  • 我的JSP&Servlet之旅。本節複習鞏固HTTP基礎知識,涉及URI編碼,Servlet &JSP的運作方式,Web開發模式架構。 ...
一周排行
    -Advertisement-
    Play Games
  • 一個自定義WPF窗體的解決方案,借鑒了呂毅老師的WPF製作高性能的透明背景的異形視窗一文,併在此基礎上增加了滑鼠穿透的功能。可以使得透明窗體的滑鼠事件穿透到下層,在下層窗體中響應。 ...
  • 在C#中使用RabbitMQ做個簡單的發送郵件小項目 前言 好久沒有做項目了,這次做一個發送郵件的小項目。發郵件是一個比較耗時的操作,之前在我的個人博客裡面回覆評論和友鏈申請是會通過發送郵件來通知對方的,不過當時只是簡單的進行了非同步操作。 那麼這次來使用RabbitMQ去統一發送郵件,我的想法是通過 ...
  • 當你使用Edge等瀏覽器或系統軟體播放媒體時,Windows控制中心就會出現相應的媒體信息以及控制播放的功能,如圖。 SMTC (SystemMediaTransportControls) 是一個Windows App SDK (舊為UWP) 中提供的一個API,用於與系統媒體交互。接入SMTC的好 ...
  • 最近在微軟商店,官方上架了新款Win11風格的WPF版UI框架【WPF Gallery Preview 1.0.0.0】,這款應用引入了前沿的Fluent Design UI設計,為用戶帶來全新的視覺體驗。 ...
  • 1.簡單使用實例 1.1 添加log4net.dll的引用。 在NuGet程式包中搜索log4net並添加,此次我所用版本為2.0.17。如下圖: 1.2 添加配置文件 右鍵項目,添加新建項,搜索選擇應用程式配置文件,命名為log4net.config,步驟如下圖: 1.2.1 log4net.co ...
  • 之前也分享過 Swashbuckle.AspNetCore 的使用,不過版本比較老了,本次演示用的示例版本為 .net core 8.0,從安裝使用開始,到根據命名空間分組顯示,十分的有用 ...
  • 在 Visual Studio 中,至少可以創建三種不同類型的類庫: 類庫(.NET Framework) 類庫(.NET 標準) 類庫 (.NET Core) 雖然第一種是我們多年來一直在使用的,但一直感到困惑的一個主要問題是何時使用 .NET Standard 和 .NET Core 類庫類型。 ...
  • WPF的按鈕提供了Template模板,可以通過修改Template模板中的內容對按鈕的樣式進行自定義。結合資源字典,可以將自定義資源在xaml視窗、自定義控制項或者整個App當中調用 ...
  • 實現了一個支持長短按得按鈕組件,單擊可以觸發Click事件,長按可以觸發LongPressed事件,長按鬆開時觸發LongClick事件。還可以和自定義外觀相結合,實現自定義的按鈕外形。 ...
  • 一、WTM是什麼 WalkingTec.Mvvm框架(簡稱WTM)最早開發與2013年,基於Asp.net MVC3 和 最早的Entity Framework, 當初主要是為瞭解決公司內部開發效率低,代碼風格不統一的問題。2017年9月,將代碼移植到了.Net Core上,併進行了深度優化和重構, ...