Azureパイプライン上のPythonコードフォーマットのチェック

こんにちは!私はザビエルJouveNoteと、この小さなポストでは、私はあなたのPythonコードがAzureパイプラインでよくフォーマットされているかどうかを自動的にチェックする方法を説明するつもりです.
セルフプロモーション:ここでは、私に従うことができますし、プログラマや作家として私の仕事をチェックするいくつかのソーシャルネットワークです😉
personal website , , , CodeNewbie , Medium , GitHub

問題

今日、私たちは、あなたがversioningしているPythonコードがよくフォーマットされるならば、我々が自動的にチェックする方法に集中するつもりです、そして、より具体的に、どのように、あなたはazureパイプラインをそうすることができますか.このプロセスを自動化するには、あなたのチームをより効率的にし、コードをより一貫したコードにします.
あなたがコードをフォーマットしなければならないと確信していないならば、私はあなたが本当に私がした前の記事を見に行くのを奨励しますFormatting and Automation , あなたがコードを定義して、自動的にそれをするならば、あなたがコードをより読みやすくして、あなたのチームをより生産的にする理由について、私は詳細に行きますSpaces VS Tabs .

解決策

短い答えは、全体の記事を読むしたくない人々のために😆) 次の手順をazureパイプラインプロセスに挿入します.

- script: |
    pip3 install black
displayName: Installs the latest version of black
- script: |
    black --check .
displayName: Checks if the python scripts are formatted properly with black

あなたが私の前の記事を持っているならば"Formatting Python – Why and How !" , あなたはすでに名前のツールについて知っている可能性がありますblack . 知らない人にとっては、これは以下のように作者によって記述されたコードフォーマッタです.それを使用することで、手の書式設定のminutiae以上の制御を拒否することに同意します.その代わりに、ブラックはあなたに、速度、決定論、および自由にPyCodeStyleからの自由をフォーマットについて話します.あなたはより重要な事柄のための時間と精神的なエネルギーを節約します.
上記の手順では、このツールをインストールしますpython package manager pip . それから私は走るblack フォルダのルートで、それが倉庫ですべてのPythonファイルを見つけるつもりであることを意味して、我々が旗を使っている時から--check , よくフォーマットされているかどうかを確認します.つのPythonファイルが正しくフォーマットされていない場合、黒コマンドはエラーを返し、azureパイプラインの対応するステップが失敗します.
必要に応じて、すべてのリポジトリを再帰的にスキャンできるようにする代わりに、Pythonファイルのリストを直接指定することができます.😉
最後に、それらのステップがazureパイプラインで利用できるどんな環境ででも使用できることに注意するのはおもしろいです.私は実際に利用可能なすべての環境で前に説明した手順を実行するazureパイプラインを設定githubリポジトリを作った.ご覧くださいhere 新しい環境がAzureパイプラインで利用できるとき、私はそれを更新します😉
この記事を読んでくれてありがとう、次の記事まで、素晴らしい一日を😉

面白い関連

GitHub repository with the actual working code up to date , とAzure Pipelines jobs runned

Azure pipelines Microsoft-hosted agents

black GitHub repository , documentation and python package

Python website

pip website

10xlearner website , , , CodeNewbie , Medium , GitHub