FastAPI - IDE 支持

Python 的类型提示功能最有效地用于几乎所有 IDE（集成开发环境），例如 PyCharm 和 VS Code，以提供动态自动完成功能。

让我们看看 VS Code 如何使用类型提示在编写代码时提供自动完成建议。在下面的示例中，定义了一个名为 sayhello 的函数，并将名称作为参数。该函数通过在名称参数之间添加一个空格将"Hello"连接起来，返回一个字符串。此外，需要确保名称的首字母大写。

Python 的 str 类有一个用于此目的的 capitalize() 方法，但如果在键入代码时不记得它，则必须在其他地方搜索它。如果你在名字后面加一个点，你会期待属性列表，但什么也没有显示，因为 Python 不知道名字变量的运行时类型。

在这里，类型提示就派上用场了。在函数定义中包括 str 作为名称的类型。现在，当您在名称后按点 (.) 时，会出现一个包含所有字符串方法的下拉列表，可以从中选择所需的方法（在本例中为 capitalize()）。

也可以对用户定义的类使用类型提示。在以下示例中，使用 __init__() 构造函数的参数类型提示定义了一个矩形类。

class rectangle:
   def __init__(self, w:int, h:int) ->None:
      self.width=w
      self.height=h

下面是一个函数，它使用上述矩形类的对象作为参数。声明中使用的类型提示是类的名称。

def area(r:rectangle)->int:
   return r.width*r.height
r1=rectangle(10,20)
print ("area = ", area(r1))

在这种情况下，IDE 编辑器也提供实例属性的自动完成支持提示列表。以下是 PyCharm 编辑器的屏幕截图。

FastAPI 广泛使用类型提示。这个功能随处可见，例如路径参数、查询参数、标头、正文、依赖项等，以及验证来自传入请求的数据。 OpenAPI 文档生成还使用了类型提示。

FastAPI 教程