这篇博文将与你分享怎样在Python项目中搭建起GitHubActions工作流，以确保你写出的代码既甜美，又符合所有最佳实践，且早已过完备测试。

作者|WojciechKrzywiec

译者|香槟超新星，责编|郭芮

头图|CSDN下载自东方IC

出品|CSDN（ID：CSDNnews）

以下为译文：

近来，我决定开始学习Python了。现在它已位列最流行的编程语言之一，因而作出尝试一下的决定并没有哪些困难的。尤其是我对自己的算法水平一直不满意，所以我希望才能一石二鸟——学习Python，并用一些算法题目来练手。

为此，我在GitHub上创建了AlgorithmsPython项目，我会在里面发布一些自己认为有趣的问题的答案。

然而在练习过程中，我遇见了一个问题。

怎么确保我的代码是高质量的？

怎么确保我的代码风格与官方手册PEP8一致？

以及怎样检测代码的测试是否完备？

虽然是有解决方案的！那就是GitHubActions！

然而我想实现的到底是哪些？

我将向你展示：

在接出来的步骤中，我默认你已然在GitHub上有一个Python项目了。假如你没有的话，就请先创建一个吧。

CodeFactor

这是一个十分简约的工具，可以拿来检测你的代码质量。它可以免费用于所有的公共库，以及1个私有库。

首先ubuntu github 使用，请先去官方网站，并通过GitHub登陆，创建一个新帐号。（要完成此操作的）图标应当是坐落主页的右上角。

注册后，单击右上角的减号，将1个库添加到你的控制面板。

从列表中选中你要剖析的库，之后单击页面顶部的import。

之后就好啦！如今你应当早已转入一个包含着已发觉的所有问题的列表的控制面板了。太棒了！

wemake-python-styleguide

让我们接着讲第二个工具。这个工具才能检测代码是否符合官方Python风格手册。

此次我们不用在任何Web服务中创建新帐号。我们将搭建起一个GitHubActions工作流，每每一个pullrequest被创建下来时，该工作流就会被触发，并会在发觉潜在问题时添加评论。

给这些还不了解GitHubActions的人介绍一下：它是GitHub上的一项新功能，可以实现许多任务的手动化，一般被视为CI/CD工具（ContinuousIntegration/ContinuousDeployment，持续集成/持续布署），才能进行测试，进行质量检测，之后布署。但这还不是它的惟一目标。

开始时，首先在项目的根文件夹中创建一个.github/workflows文件夹，你的工作流的定义将会被放到这儿。

之后创建一个新文件，命名为workflow-pr.yaml。

name: Python Pull Request Workflowon: [pull_request]jobs:
 qa: name: Quality check runs-on: ubuntu-18.04 steps: - uses: actions/checkout@v1 - name: Set up Python uses: actions/setup-python@master with: python-version: 3.8 - name: Run unit tests run: | pip install pytest pytest - name: Wemake Python Stylguide uses: wemake-services/wemake-python-styleguide@0.13.4 continue-on-error: true with: reporter: 'github-pr-review' env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

这是一个极其简单的工作流，全名为PythonPullRequestWorkflow。每位pullrequest都能触发它，因而无论何时创建新的或更新现有的作业，就会运行。

里面的工作流仅包含一个qa工作，分为4个步骤：

为了测试它的运行，你须要创建一个新的branchlinux环境配置，递交一些修改并将其推送到GitHub。之后创建一个pullrequest，才能触发此工作流了。要检测它，请转入项目中的“Actions”选项，倘若一切顺利则应如右图所示：

假如单击“Rununittests”，则在consolelog中，你将见到测试报告：

假如返回到Pullrequestlinux系统官网，则应当见到添加的注释。如同这儿那样：

Codecov

最后，我们想要一份囊括范围的测试报告。因此，我们再度使用pytest库，它将为我们生成报告，之后我们将其上传到Codecov，后续的可视化就由它完成。

在定义一个新的工作流之前，你首先须要先创建一个Codecov帐号。因而，你须要先单击右上角的“SignUp”按钮转入。

之后选择GitHub注册。

之后，你将被带到GitHub项目的控制面板，之后须要单击Addnewrepository按键。

一个列表将出现，包含所有的项目，你可以从中选择一个来剖析。

之后会出现一个带有令牌（token）的页面。把它保存出来，由于下一步中会用到。

如今回到GitHub的项目上，之后单击其“Settings”按钮。单击“Secrets”，之后添加一个新的secret，这时就可以用上你在Codecov网站上生成的令牌了。要完成这一步，单击Addsecret。

好的，一切都已设置好了，接出来就可以继续定义GitHub工作流了。

name: Python Master Workflowon: push: branches: - 'master'jobs: codecov: name: Codecov Workflow runs-on: ubuntu-18.04 steps: - uses: actions/checkout@v1 - name: Set up Python uses: actions/setup-python@master with: python-version: 3.8 - name: Generate coverage report run: | pip install pytest pip install pytest-cov pytest --cov=./ --cov-report=xml - name: Upload coverage to Codecov uses: codecov/codecov-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} file: ./coverage.xml flags: unittests

再度，我们创建一个单独的文件，命名为workflow-master.yaml，由于此次我们不想在创建pullrequest时触发此工作流。这个工作流仅当在masterbranch上推送了新的递交时才能运行。

在jobs部份中，只有一个名为codecov的作业，包括四步：

要进行测试，你须要将一些递交push到masterbranch。这可以直接在你的本地库中完成，也可以通过合并一个pullrequest完成。倘若一切顺利，那页面应当是像这样的：

如今，假如你回到Codecov，回到你的项目控制面板，你应当能见到类似的输出：

好的，我们做到了！（Cheers!）

在结尾之前，我想告诉你的是，能帮你写出更高质量代码的工具并非只有CodeFactor，Codecov或wemake-python-styleguide。实际上，这样的工具有好多，比如SonarCloud，Pylint，Coveralls，DeepSource等等。其中一些可以在GitHubMarketplace上找到，假如你不喜欢我提议的这几个工具ubuntu github 使用，这么最好从那前面的地方为起点开始找寻。

推论

希望通过这篇博文，你可以了解到，要怎么设置GitHub库来确保写出高质量的代码。有了这样的工具集合，你可以找到所有的弱点和bug，但要记住，不是每位bug和每位问题都值得去滥情思。有时侯，最好是更专注于实际工作，而不是整理这些臭代码库。（wink）

原文：@

wkrzywiec/how-to-write-good-quality-python-code-with-github-actions-2f635a2ab09a

作者：WojciechKrzywiec，Java开发工程师，DevOps菜鸟，终身学习者。

本文原创地址：//lrxjmw.cn/usypxmzdjggz.html编辑：刘遄，审核员：暂无