跳至内容

教程 - 用户指南 - 简介

Python 类型

如果您需要复习有关如何使用 Python 类型提示的信息,请查看 FastAPI 的 Python 类型简介 的第一部分。

您还可以查看 mypy 备忘单

简而言之(非常简短),您可以声明一个带有以下参数的函数

from typing import Optional

def type_example(name: str, formal: bool = False, intro: Optional[str] = None):
    pass

您的编辑器(和 Typer)将知道

  • name 的类型为 str,并且是必需的参数。
  • formalbool,并且默认为 False
  • intro 是一个可选的 str,默认为 None

这些类型提示为您在编辑器中提供自动完成功能和其他一些功能。

Typer 基于这些类型提示。

简介

本教程将逐步向您展示如何使用 Typer 及其所有功能。

每个部分逐渐建立在前面的部分之上,但其结构是将主题分开,以便您可以直接转到任何特定主题来解决您的特定 CLI 需求。

它还被构建为将来参考。

因此,您可以回来确切地查看您需要的内容。

运行代码

所有代码块都可以直接复制并使用(它们是经过测试的 Python 文件)。

要运行任何示例,请将代码复制到文件 main.py 中,然后运行它

$ python main.py

✨ The magic happens here ✨

强烈建议你编写或复制代码,编辑它并在本地运行它。

在编辑器中使用它可以真正让你看到 Typer 的好处,了解你必须编写的代码很少,所有类型检查、自动完成功能等。

运行示例可以真正帮助你理解发生了什么。

通过运行一些示例并对其进行操作,你可以学到比阅读此处所有文档更多的东西。


安装 Typer

第一步是安装 Typer

$ pip install typer
---> 100%
Successfully installed typer click shellingham rich

默认情况下,typer 附带 richshellingham

注意

如果你是一个高级用户,并且希望选择不使用这些默认额外依赖项,则可以改为安装 typer-slim

pip install typer

...包含与

pip install "typer-slim[standard]"