Python 3文档 - 功能注释

时间:2017-11-23 07:56:39

标签: python documentation

我使用以下格式来记录我的Python代码:

def my_function(param: str) -> dict:
   some code

我无法弄清楚如何记录传递给另一个函数的函数。

例如:

def my_function(my_other_function: ???) -> dict:
    some code

如何制作功能注释?

1 个答案:

答案 0 :(得分:3)

  

第一个想法:“python中的所有东西都是一个对象”

我在文档中找不到任何内容,但是everything in python is an object我会为object拍摄。

def my_function(my_other_function: object) -> dict:
    some code

要证明:

if isinstance(my_function, my_function, object):
    print("yes")
    >yes

无论如何,这可能不太明确,因此:

  

秒的想法:使用正确的类型提示

根据COLDSPEED评论的内容,更明确的类型提示将使用typing

import typing
def my_function(my_other_function:typing.Callable):->dict:
    pass
  

“注释对意义的唯一方式是它们被第三方库解释时”。这意味着,对于您的源代码本身,它不会改变任何东西。只是想提一下。