給函式新增元資料（python）

你寫好了乙個函式，然後想為這個函式的引數增加一些額外的資訊，這樣的話其他使用者就能清楚的知道這個函式應該怎麼使用。

使用函式引數註解是乙個很好的辦法，它能提示程式設計師應該怎樣正確使用這個函式。例如，下面有乙個被註解了的函式：

def add(x:int, y:int) -> int:
return x + y

python直譯器不會對這些註解新增任何的語義。它們不會被型別檢查，執行時跟沒有加註解之前的效果也沒有任何差距。然而，對於那些閱讀原始碼的人來講就很有幫助啦。第三方工具和框架可能會對這些註解新增語義。同時它們也會出現在文件中。

>>> help(add)
help on function add in module __main__:
add(x: int, y: int) -> int
>>>

儘管你可以使用任意型別的物件給函式新增註解(例如數字，字串，物件例項等等)，不過通常來講使用類或者字串會比較好點。

函式註解只儲存在函式的__annotations__屬性中。例如：

>>> add.__annotations__

儘管註解的使用方法可能有很多種，但是它們的主要用途還是文件。因為python並沒有型別宣告，通常來講僅僅通過閱讀原始碼很難知道應該傳遞什麼樣的引數給這個函式。這時候使用註解就能給程式設計師更多的提示，讓他們可以正確的使用函式。

參考：