如何知道函数的返回类型和参数类型？

虽然我知道Python的鸭子式概念，但有时我会为函数的参数类型或函数的返回值类型而苦恼。

现在，如果我自己编写函数，那么我确实知道类型。但是，如果有人想使用并调用我的函数，他/她应该如何知道类型呢？我通常将类型信息放入函数的文档字符串中（例如："...the id argument should be an integer..."和"... the function will return a (string, [integer]) tuple."）

但是，查找文档字符串中的信息（并将其作为编码器放置在其中）是否确实是应该完成的方式？

编辑：虽然大多数答案似乎都指向“是的，文档！” 我觉得对于“复杂”类型这并不总是那么容易。
例如：如何在文档字符串中简明地描述一个函数返回一个元组列表，每个元组的形式为（node_id，node_name，uptime_minutes），并且元素分别是字符串，字符串和整数？
docstring PEP文档未对此提供任何指导。
我想反驳的是在那种情况下应该使用类，但是我发现python非常灵活，因为它允许使用列表和元组（即没有类）传递这些东西。

自2011年以来情况发生了一些变化！现在，Python 3.5中提供了类型提示，可用于注释参数并返回函数的类型。例如：

def greeting(name):
  return 'Hello, {}'.format(name)

现在可以这样写：

def greeting(name: str) -> str:
  return 'Hello, {}'.format(name)

正如您现在看到的类型一样，存在一些可选的静态类型检查，这将帮助您和您的类型检查器研究代码。

有关更多解释，我建议看一下PyCharm博客中有关类型提示的博客文章。

这就是动态语言的工作方式。不过，这并不总是一件好事，尤其是在文档不多的情况下-是否有人尝试使用文档不充分的python框架？有时您必须恢复阅读源代码。

以下是一些避免鸭类输入出现问题的策略：

• 为您的问题域创建语言
• 这将帮助您正确命名东西
• 使用类型来表示您的领域语言中的概念
• 使用领域语言词汇命名功能参数

另外，最重要的一点之一是：

• 保持数据尽可能本地！

应该只传递一些定义明确并记录在案的类型。通过查看代码，其他任何事情都应该显而易见：不要从遥远的地方找到怪异的参数类型，而不能通过查看代码附近来弄清楚...

相关（也与文档字符串相关），python中有一种称为的技术doctests。使用它来记录如何使用您的方法-同时具有良好的单元测试范围！

是的，您应该使用文档字符串使您的类和函数对其他程序员更友好：

更多：http : //www.python.org/dev/peps/pep-0257/#what-is-a-docstring

一些编辑器允许您在键入时查看文档字符串，因此确实使工作变得更容易。

我参加了一个课程课程，其中有一堂课，我们被教导有关设计配方的知识。

在docstring格式以下，我发现petety有用。

def面积（基准，高度）：
    '''（数字，数字）->数字＃** TypeContract **
    返回维数为＃**描述**的区域
    和高度

    >>>区域（10,5）＃**示例**
    25.0
    >>面积（2.5,3）
    3.75
    '''
    返回（基数*高度）/ 2 

我认为，如果以这种方式编写文档字符串，则可能对开发人员有很大帮助。

链接到视频[观看视频]：https : //www.youtube.com/watch?v=QAPg6Vb_LgI

是的。

在Python中，函数不必总是返回相同类型的变量（尽管如果函数总是返回相同类型，则代码将更具可读性）。这意味着您不能为该函数指定单个返回类型。

同样，参数也不一定总是相同的类型。

例如：如何在文档字符串中简明地描述一个函数返回一个元组列表，每个元组的形式为（node_id，node_name，uptime_minutes），并且元素分别是字符串，字符串和整数？

嗯...对此没有“简洁”的描述。这很复杂。您已将其设计为复杂的。并且它需要在文档字符串中包含复杂的文档。

对不起，但是复杂性很复杂。

是的，因为它是一种动态类型的语言;）

阅读以供参考：PEP 257

文档字符串（和一般文档）。如PEP 3107中所述，Python 3引入了（可选）函数注释（但请不要忽略文档字符串）