openstack/hacking

これは何？

主な機能

• 01flake8プラグインを通じてOpenStackのPythonスタイルガイドを適用します。
• 02依存関係を固定してPyPIからインストールでき、CIのゲートを安定させます。
• 03maintenanceリリースでは新しいチェック項目が追加されないため、minorバージョンを安全に固定できます。
• 04デフォルトで無効になっているチェック項目をtox.iniで有効化できます。
• 05tox.iniに登録したプロジェクト固有のチェック項目に対応します。

ユースケース

• OpenStackプロジェクトのコードレビューでスタイル上の細かな指摘を自動検出し、マージ判定のゲートとして使う。
• 多くの開発者が参加する大規模なコードベースで、Pythonのスタイルを統一する。
• 標準のOpenStackチェックに加えて、プロジェクト独自のlintルールを追加する。

クイックスタート

1. 1

   PyPIからhackingをインストールします

   pip install hacking

使う前に知っておきたいこと

• !Hackingは依存関係のバージョンを固定するため、環境内の新しいバージョンのflake8やプラグインと競合することがあります。
• !多くのチェック項目はOpenStack固有で、他のプロジェクトではデフォルトで無効になっています。

収録されている特集

トピック

よくある質問

hacking とは？

OpenStackのスタイルガイドに沿ってPythonコードをチェックするflake8プラグイン集。 Hackingは、OpenStackのPythonスタイルガイドを適用するflake8プラグイン集です。コードレビューで手作業で確認するimportの順序やdocstringのルール、組み込み名のシャドーイングなど、OpenStackコミュニティがリスクのあるパターンと見なす記述を自動でチェックします。

hacking は無料で使えますか？ライセンスは？

hacking は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

hacking は今もメンテナンスされていますか？

半年以内に更新あり。hacking の最終コミットは 2026年9月14日 です。

hacking は何に使えますか？

OpenStackプロジェクトのコードレビューでスタイル上の細かな指摘を自動検出し、マージ判定のゲートとして使う。 多くの開発者が参加する大規模なコードベースで、Pythonのスタイルを統一する。 標準のOpenStackチェックに加えて、プロジェクト独自のlintルールを追加する。

hacking のインストール方法は？

PyPIからhackingをインストールします: pip install hacking

hacking はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/openstack/hacking