FastAPI - IDE 支持


Python 的类型提示功能在几乎所有IDE(集成开发环境)(例如PyCharmVS Code )中最有效地使用,以提供动态自动完成功能。

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

Python 的str类有一个Capitalize()方法用于此目的,但如果在键入代码时不记得它,则必须在其他地方搜索它。如果在名称后面加一个点,则您期望看到属性列表,但不会显示任何内容,因为 Python 不知道名称变量的运行时类型是什么。

FastAPI IDE 支持

在这里,类型提示很方便。在函数定义中包含 str 作为名称类型。现在,当您在名称后面按点 (.) 时,会出现所有字符串方法的下拉列表,可以从中选择所需的方法(在本例中为 Capitalize())。

FastAPI IDE 支持

还可以将类型提示与用户定义的类一起使用。在以下示例中,使用__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 IDE 支持

FastAPI广泛使用类型提示。此功能随处可见,例如路径参数、查询参数、标头、主体、依赖项等,以及验证传入请求中的数据。OpenAPI 文档生成也使用类型提示。