Pythonプロジェクトは、コードを送信する前にチェックツールを自動(dòng)的に実行できるため、事前コミットを必要とし、形式や構(gòu)文などの低レベルエラーを傍受できます。コミット前のフックは、GITコミット中にブラック、Flake8、ISORT、MyPy、その他のツールを自動(dòng)的に実行でき、事前に問題を発見し、再作業(yè)時(shí)間を節(jié)約できます。構(gòu)成手順には、事前コミットのインストール、構(gòu)成ファイルの作成、ツールの追加、フックのインストールが含まれます。一般的なツールには、ブラックフォーマットコード、FLAKE8検査仕様、ISORTの輸入注文の整理、およびMyPyタイプのチェックが含まれます。使用する場(chǎng)合は、あまりにも多くのフックを避け、バージョンを定期的に更新し、さまざまな構(gòu)成を區(qū)別できるように注意してください。 git commit-no-verifyは、一時(shí)的な送信時(shí)にチェックをスキップするために使用できます。

コードを書くとき、オンラインになるまで発見すべきではない問題が常にいくつかあります。たとえば、テストが失敗した場(chǎng)合のフォーマットエラー、構(gòu)文エラー、または送信。この時(shí)點(diǎn)で、コミット前のフックが便利です。 GITがこれらの低レベルエラーを傍受できるようにコミットすると、いくつかのチェックツールを自動(dòng)的に実行できます。これは、Pythonプロジェクトのほぼ標(biāo)準(zhǔn)です。

Pythonプロジェクトに事前コミットが必要な理由

Pythonは柔軟な構(gòu)文を備えた動(dòng)的言語ですが、実行時(shí)にエラーを報(bào)告するコードを簡(jiǎn)単に記述することも簡(jiǎn)単です。たとえば、インデントが正しくない場(chǎng)合、変數(shù)が未定義であり、形式が混亂している場(chǎng)合、人間の肉の検査だけに頼ることで見逃すのは簡(jiǎn)単です。コミット前のフックは、事前に問題を見つけるのに役立つコードを送信する前に、Flake8、Black、Isort、MyPy、その他のツールを自動(dòng)的に実行できます。

そして、それはあなたのプロセスを中斷することはありません、それはコミットしながらさらに數(shù)秒待つだけですが、それはその後の再加工時(shí)間を大幅に節(jié)約することができます。

一般的に使用されるツールが推奨されます

あなたがPython開発者である場(chǎng)合、これらのツールは基本的に避けられません。

• ブラック：コードを自動(dòng)的にフォーマットし、スタイルを統(tǒng)合します
• FLAKE8 ：コード仕様と潛在的なエラーを確認(rèn)します
• ISORT ：インポートオーダーを自動(dòng)的に整理します
• mypy ：靜的タイプのチェック、事前にタイプエラーを発見する
• Prettier （オプション）：プロジェクトにフロントエンドコードがある場(chǎng)合は、追加することもできます

これらのツールは問題ありませんが、手動(dòng)で実行するたびに面倒です。事前コミットの利點(diǎn)は、これらのツールをまとめて、コミットするときに自動(dòng)的に実行することです。

事前コミットを構(gòu)成する方法

インストールと構(gòu)成は実際には非常に簡(jiǎn)単であり、ほんの數(shù)ステップでそれを行うことができます。

1. 事前コミットのインストール： pip install pre-commit
2. プロジェクトルートディレクトリに.pre-commit-config.yamlファイルを作成します
3. 実行するツールとバージョンを追加します
4. フックのインストール： pre-commit install

一般的な構(gòu)成の例は次のとおりです。

レポス：
   - レポ：https：//github.com/pre-commit/pre-commit-hooks
    Rev：v4.4.0
    フック：
       -  ID：Trailing-WhiteSpace
       -  ID：ファイルの終了裝置

   - レポ：https：//github.com/psf/black
    Rev：23.1.0
    フック：
       -  ID：黒

  -repo：https：//github.com/pycqa/flake8
    Rev：6.0.0
    フック：
       -  ID：Flake8

   - レポ：https：//github.com/timothycrosley/isort
    Rev：5.12.0
    フック：
       -  ID：ISORT

この構(gòu)成は、スペースを自動(dòng)的にクリーンアップし、コードをフォーマットし、仕様をチェックし、送信時(shí)にインポートをソートします。

無視できるいくつかの小さな詳細(xì)

• あまりにも多くのフックを使用しないでください：多くのツールがありますが、より良いです。特にMyPyのような長(zhǎng)期的なチェックの場(chǎng)合、CIでのみ実行することを検討できます。
• バージョンを更新することを忘れないでください：ツールバージョンを定期的に更新する必要があります。そうしないと、固定バグを見逃す可能性があります。
• さまざまなプロジェクトの構(gòu)成は異なります。たとえば、一部のプロジェクトは古いコードであり、黒で直接フォーマットすることはできません。最初にオフにするか、 --diffモードを使用して影響を確認(rèn)できます。
• チェックをスキップすることは悪いことではありません。一時(shí)的にコミットするだけで、 git commit --no-verifyは覚えておいてください。

基本的にそれだけです。事前コミットは複雑ではありませんが、特にチームで作業(yè)する場(chǎng)合、統(tǒng)一されたスタイルが特に重要であることが特に重要です。一度構(gòu)成すると、將來送信するたびに、より安心感があります。

以上がPythonプロジェクト用の事前コミットフックの詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語 Web サイトの他の関連記事を參照してください。