使用 Python 和 Typer 构建命令行待办事项应用程序

好的！该应用程序具有用户友好的 CLI，允许您设置待办事项数据库。在那里，您可以使用适当的命令、参数和选项添加、删除和完成待办事项。如果您遇到困难，那么您可以使用--help带有适当参数的选项寻求帮助。

你想开始这个待办应用项目吗？凉爽的！在下一部分中，您将计划如何构建项目的布局以及将使用哪些工具来构建它。

第 1 步：设置待办事项项目

要开始编写待办事项应用程序，您需要设置一个工作 Python 环境，其中包含您将在此过程中使用的所有工具、库和依赖项。然后你需要给项目一个连贯的 Python应用程序布局。这就是您将在以下小节中执行的操作。

要下载您将在本节中创建的所有文件和项目结构，请单击下面的链接并转到source_code_step_1/目录：

设置工作环境

在本节中，您将创建一个Python 虚拟环境来处理您的待办事项项目。为每个独立项目使用虚拟环境是 Python 编程的最佳实践。它允许您隔离项目的依赖项，而不会弄乱您的系统 Python 安装或破坏使用相同工具和库的不同版本的其他项目。

要创建 Python 虚拟环境，请移至您喜欢的工作目录并创建一个名为rptodo_project/. 然后启动终端或命令行并运行以下命令：

$ cd rptodo_project/
$ python -m venv ./venv
$ source venv/bin/activate
(venv) $

在这里，您首先rptodo_project/使用cd. 该目录将是您项目的根目录。然后使用venv标准库创建一个 Python 虚拟环境。to 的参数venv是托管虚拟环境的目录的路径。通常的做法是调用该目录venv，.venv或者env，根据自己的喜好。

第三个命令激活您刚刚创建的虚拟环境。您知道环境处于活动状态，因为您的提示更改为类似(venv) $.

c:\> python -m venv venv
c:\> venv\Scripts\activate.bat

现在您有了一个工作的虚拟环境，您需要安装 Typer来创建 CLI 应用程序和pytest来测试应用程序的代码。要安装 Typer 及其所有当前可选依赖项，请运行以下命令：

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

此命令安装 Typer 及其所有推荐的依赖项，例如Colorama，以确保颜色在您的命令行窗口中正常工作。

要安装 pytest（稍后您将使用它来测试待办事项应用程序），请运行以下命令：

(venv) $ python -m pip install pytest==6.2.4

rptodo_project/
│
├── rptodo/
│   ├── __init__.py
│   ├── __main__.py
│   ├── cli.py
│   ├── config.py
│   ├── database.py
│   └── rptodo.py
│
├── tests/
│   ├── __init__.py
│   └── test_rptodo.py
│
├── README.md
└── requirements.txt

该README.md文件将提供项目的描述以及安装和运行应用程序的说明。向README.md您的项目添加描述性和详细的文件是编程的最佳实践，尤其是当您计划将项目作为开源发布时。

该requirements.txt文件将为您的待办事项应用程序提供依赖项列表。继续填写以下内容：

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

现在您的用户可以通过运行以下命令自动安装列出的依赖项：

(venv) $ python -m pip install -r requirements.txt

提供这样的一个requirements.txt可确保您的用户将安装您用于构建项目的依赖项的确切版本，从而避免意外问题和行为。

除了requirements.txt，此时您的所有项目文件都应该是空的。在本教程中，您将使用必要的内容填充每个文件。在下一节中，您将使用 Python 和 Typer 对应用程序的 CLI 进行编码。

第 2 步：使用 Python 和 Typer 设置 To-Do CLI 应用程序

此时，您的待办事项应用程序应该有一个完整的项目布局。您还应该有一个可运行的 Python 虚拟环境，其中包含所有必需的工具和库。在此步骤结束时，您将拥有一个功能强大的 Typer CLI 应用程序。然后，您将能够在其最小功能的基础上进行构建。

您可以通过单击下面的链接并转到source_code_step_2/目录来下载将在此部分中添加的代码、单元测试和资源：

启动您的代码编辑器并__init__.py从rptodo/目录中打开文件。然后在其中添加以下代码：

"""Top-level package for RP To-Do."""
# rptodo/__init__.py

__app_name__ = "rptodo"
__version__ = "0.1.0"

(
    SUCCESS,
    DIR_ERROR,
    FILE_ERROR,
    DB_READ_ERROR,
    DB_WRITE_ERROR,
    JSON_ERROR,
    ID_ERROR,
) = range(7)

ERRORS = {
    DIR_ERROR: "config directory error",
    FILE_ERROR: "config file error",
    DB_READ_ERROR: "database read error",
    DB_WRITE_ERROR: "database write error",
    ID_ERROR: "to-do id error",
}

在这里，您首先定义两个模块级名称来保存应用程序的名称和版本。然后，你定义一系列的返回值和错误代码和整型的号码给他们使用range()。ERROR是一个将错误代码映射到人类可读的错误消息的字典。您将使用这些消息告诉用户应用程序发生了什么。

有了这些代码，您就可以创建 Typer CLI 应用程序的框架了。这就是您将在下一节中执行的操作。

创建 Typer CLI 应用程序