如何用 GitHub Actions 寫出高質(zhì)量的 Python代碼?

“

閱讀本文大概需要 13 分鐘。

這篇博文將與你分享如何在 Python 項(xiàng)目中搭建起 GitHub Actions 工作流，以確保你寫出的代碼既優(yōu)雅，又符合所有最佳實(shí)踐，且已經(jīng)過完備測(cè)試。

作者 |?Wojciech Krzywiec

譯者 |?香檳超新星，責(zé)編 | 郭芮

出品 | CSDN（ID：CSDNnews）

以下為譯文：

如何確保我的代碼是高質(zhì)量的？如何確保我的代碼風(fēng)格與官方指南PEP 8一致？以及如何檢查代碼的測(cè)試是否完備？

• 如何集成 CodeFactor——一個(gè)可以在你的代碼中發(fā)現(xiàn)潛在bug的工具；

• 如何設(shè)置 wemake-python-styleguide GitHub Actions 工作流（用以檢查你的代碼是否符合 PEP 8）；

• 如何運(yùn)行單元測(cè)試并通過 Codecov 報(bào)告覆蓋范圍。

在接下來的步驟中，我默認(rèn)你已經(jīng)在 GitHub 上有一個(gè) Python 項(xiàng)目了。如果你沒有的話，就請(qǐng)先創(chuàng)建一個(gè)吧。

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/[email protected]        continue-on-error: true        with:          reporter: 'github-pr-review'        env:          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

• actions / checkout @ v1——必須讓 GitHub Actions 工作流知道它可以使用庫中的代碼

• 使用 actions/setup-python@master 的 Set up Python 配置好一個(gè) Python 版本，在本例中為使用的是 python-version: 3.8。

• Run unit tests 將運(yùn)行位于項(xiàng)目中的所有單元測(cè)試。為此，我使用的是 pytest，首先需要安裝 pip install pytest，以便可以運(yùn)行下一個(gè)命令 pytest。如果這一步上有任何一個(gè)測(cè)試失敗，則下一個(gè)測(cè)試將不會(huì)運(yùn)行。

• Wemake Python Styleguide 的這一個(gè)步驟是我們最感興趣的。它使用wemake-services/[email protected] 操作，這是工作流的基本組成單位。你可以在GitHub Marketplace上找到它們

  （https://github.com/marketplace?type=actions）

  就像上述提到的一樣（https://github.com/marketplace/actions/wemake-python-styleguide）。將此代碼配置為（with 語句）以使用github-pr-review reporter，就可以在 code review 中啟用內(nèi)聯(lián)注釋了。在官方網(wǎng)站上可以找到更多受支持的 reporter 選項(xiàng)。最后，此工作流需要傳遞你的 GIHUB_TOKEN，這就是添加 env 語句的原因。

為了測(cè)試它的運(yùn)行，你需要?jiǎng)?chuàng)建一個(gè)新的 branch，提交一些更改并將其推送到 GitHub。然后創(chuàng)建一個(gè)? pull request，就能觸發(fā)此工作流了。要檢查它，請(qǐng)轉(zhuǎn)到項(xiàng)目中的“Actions”選項(xiàng)，如果一切順利則應(yīng)如下圖所示：

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

• uses: actions/checkout@v1——這個(gè)步驟，跟上次一樣，也只是為了告訴 GitHub Actions 我們要使用當(dāng)前庫里的文件

• uses: actions/setup-python@master——這個(gè)步驟之前也提到過，這里我們?cè)O(shè)置的 Python?版本是 3.8

• 然后是一個(gè)新步驟，負(fù)責(zé)生成覆蓋率報(bào)告（Generate coverage report）；這包含一系列腳本，涵蓋了安裝 pytests（pip install pytest），pytest-cov（pip install pytest-cov）和運(yùn)行實(shí)際測(cè)試（pytest-cov =./-cov-report = xml），

• 最終，生成的測(cè)試覆蓋率報(bào)告可以上傳到 Codecov（Upload coverage to Codecov）。在這里我們使用 uses: codecov / codecov-action @ v1（https://github.com/marketplace/actions/codecov）。在其中，我們提供 3 個(gè)參數(shù)：token: ${{ secrets.CODECOV_TOKEN }}，取值自我們放置在 GitHub Secrets 保管庫的文件，（之前的步驟生成的）測(cè)試覆蓋率報(bào)告的位置是file：./coverage.xml，而 flags：unittests 是對(duì)我們的單元測(cè)試進(jìn)行分組的標(biāo)志。

要進(jìn)行測(cè)試，你需要將一些提交 push 到 master branch。這可以直接在你的本地庫中完成，也可以通過合并一個(gè) pull request 完成。如果一切順利，那頁面應(yīng)該是像這樣的：

崔慶才

靜覓博客博主，《Python3網(wǎng)絡(luò)爬蟲開發(fā)實(shí)戰(zhàn)》作者

隱形字

個(gè)人公眾號(hào)：進(jìn)擊的Coder

長按識(shí)別二維碼關(guān)注

推薦閱讀

1

孫楊一夜之間風(fēng)評(píng)變差，從數(shù)據(jù)上看是真的嗎？

2

進(jìn)來看看你中了幾條

3

如何實(shí)現(xiàn)本地代碼和遠(yuǎn)程的實(shí)時(shí)同步

4??

如何用一條命令將網(wǎng)頁轉(zhuǎn)成電腦 App