python限定方法參數類型、返回值類型、變量類型等


typing模塊的作用

自python3.5開始,PEP484為python引入了類型注解(type hints)

  • 類型檢查,防止運行時出現參數和返回值類型、變量類型不符合。
  • 作為開發文檔附加說明,方便使用者調用時傳入和返回參數類型。
  • 該模塊加入后並不會影響程序的運行,不會報正式的錯誤,只有提醒pycharm目前支持typing檢查,參數類型錯誤會黃色提示

官網typing詳細說明
typing類型標注

常用類型

  • int,long,float: 整型,長整形,浮點型

  • bool,str: 布爾型,字符串類型

  • List, Tuple, Dict, Set:列表,元組,字典, 集合

  • Iterable,Iterator:可迭代類型,迭代器類型

  • Generator:生成器類型

基本類型指定

  • 示例
def test(a:int, b:str) -> str:
    print(a, b)
    return 1000

if __name__ == '__main__':
    test('test', 'abc')
函數test,
a:int  指定了輸入參數a為int類型,
b:str  b為str類型,
-> str  返回值為srt類型。

可以看到,
在方法中,我們最終返回了一個int,此時pycharm就會有警告;
當我們在調用這個方法時,參數a我們輸入的是字符串,此時也會有警告;
但非常重要的一點是,pycharm只是提出了警告,但實際上運行是不會報錯,畢竟python的本質還是動態語言

復雜的類型標注

  • 示例1
from typing import List
Vector = List[float]

def scale(scalar: float, vector: Vector) -> Vector:
    return [scalar * num for num in vector]

# typechecks; a list of floats qualifies as a Vector.
new_vector = scale(2.0, [1.0, -4.2, 5.4])

  • 示例2
from typing import Dict, Tuple, Sequence

ConnectionOptions = Dict[str, str]
Address = Tuple[str, int]
Server = Tuple[Address, ConnectionOptions]

def broadcast_message(message: str, servers: Sequence[Server]) -> None:
    ...

# The static type checker will treat the previous type signature as
# being exactly equivalent to this one.
def broadcast_message(
    message: str,
    servers: Sequence[Tuple[Tuple[str, int], Dict[str, str]]]) -> None:
    ...
):
    ...

這里需要注意,元組這個類型是比較特殊的,因為它是不可變的。
所以,當我們指定Tuple[str, str]時,就只能傳入長度為2,
並且元組中的所有元素都是str類型

泛型指定

  • 示例
from typing import Sequence, TypeVar, Union

T = TypeVar('T')      # Declare type variable

def first(l: Sequence[T]) -> T:   # Generic function
    return l[0]

T = TypeVar('T')  # Can be anything
A = TypeVar('A', str, bytes)  # Must be str or bytes
A = Union[str, None] # Must be str or None

創建變量時的類型指定

from typing import NamedTuple

class Employee(NamedTuple):
    name: str
    id: int = 3

employee = Employee('Guido')
assert employee.id == 3

不足之處

  • 示例
from typing import List

def test(b: List[int]) -> str:
    print(b)
    return 'test'


if __name__ == '__main__':
    test([1, 'a'])
從這個例子可以看出來,雖然我們指定了List[int]即由int組成的列表,
但是,實際中,只要這個列表中存在nt(其他的可以為任何類型),就不會出現警告


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM