Python项目中的Makefiles(以及如何开始)

大多数Python项目都依赖于分散的脚本和命令。了解MakeFiles如何将它们全部拉到一个干净,可重复的工作流程中。

来源:KDnuggets
作者的图像|意识形态图

#简介

图片以下图片:您正在研究一个Python项目,每次您要运行测试时,您都会键入Python3 -M Pytest Tests/ -verbose -Cov = SRC。当您要格式化代码时,它是黑色的。 && isort ..对于覆盖,您可以运行Flake8 SRC测试。在不知不觉中,您正在兼顾十几个不同的命令,而您的队友也略有不同。

python3 -m pytest Tests/ -verbose -cov = src div> 黑色。 && isort。 Flake8 SRC测试

这是Makefiles派上用场的地方。 Makefiles最初用于C和C ++项目,在Python开发中可能非常有用,这是标准化和自动化常见任务的简单方法。将Makefile视为一个单个地方,您可以重复为您反复做的所有事情定义快捷方式。

#为什么在Python项目中使用MakeFiles?

团队中的每个人都进行测试,而不是记住具有所有标志的确切的pytest命令时,您可以消除“我的机器上的作品”问题。新团队成员可以跳入并立即知道如何运行测试,格式代码或部署应用程序。

团队的一致性 进行测试

实际上类似于Unlike的读数文件的文档已过时,MakeFiles用作有用的文档。当某人跑步时,他们准确地看到了哪些任务以及如何使用它们。

实际工作的文档 提供帮助

简化复杂的工作流程任务需要多个步骤。也许您需要安装依赖项,运行迁移,测试数据,然后启动开发服务器。使用makefile,这将成为一个单个make dev命令。

简化的复杂工作流程 制作dev

#开始您的第一个Python Makefile

让我们逐步构建一个实用的makefile。在您的项目root中创建一个名为makefile(无扩展)的文件。

//基本结构和帮助命令

//

此代码为您的makefile创建一个自动帮助系统,该系统显示所有可用命令及其描述:

Grep awk dev