Repolode
PyCQA

PyCQA/autoflake

pyflakesで検出した未使用のimportや変数をPythonコードから削除するコマンドラインツール。

スター
953
フォーク
100
未解決の Issue
54
最終コミット
3 日前

これは何?

autoflakeは、pyflakesが未使用と判定したimportや変数を削除して、Pythonのソースファイルを整理します。デフォルトでは未使用の標準ライブラリのimportだけを削除します。他のモジュールには副作用があり、自動削除が安全とは限らないためです。未使用の変数の削除とワイルドカードimportの展開は、オプションで有効にできます。

未使用のimportのほか、不要なpass文や重複した辞書キーも削除できます。ファイルやディレクトリを直接編集するほか、差分を表示したり、変更が必要な場合にエラーコードを返すチェックとして実行したりできます。設定はpyproject.tomlまたはsetup.cfgに保存でき、pre-commit hookも利用できます。

noqaコメントが付いた行は変更されず、ファイルの先頭にskip_fileコメントを記載すると、ファイル全体を処理対象から除外できます。

主な機能

  • 01未使用のimportを削除します。デフォルトでは標準ライブラリのimportのみが対象です。
  • 02オプションを指定すると、未使用の変数も削除できます。
  • 03ファイルの直接編集、差分の出力、CI向けのチェックモードに対応しています。
  • 04不要なpass文と重複した辞書キーを削除します。
  • 05pyproject.tomlまたはsetup.cfgで設定でき、pre-commitと連携します。

ユースケース

  • Pythonコードをコミットする前に、残ったimportを整理する。
  • CIパイプラインで未使用のimportをチェックする。
  • 大規模なレガシーPythonコードベースをまとめて整理する。
  • --importsオプションを使って、安全に削除できるサードパーティモジュールのimportを削除する。

クイックスタート

  1. 1

    PyPIからautoflakeをインストールする

    pip install --upgrade autoflake
  2. 2

    ファイル内の未使用のimportと変数をその場で削除する

    autoflake --in-place --remove-unused-variables example.py

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

  • デフォルトでは未使用の標準ライブラリのimportのみを削除します。他のモジュールには--importsオプションが必要です。

収録されている特集

トピック

よくある質問

autoflake とは?
pyflakesで検出した未使用のimportや変数をPythonコードから削除するコマンドラインツール。 autoflakeは、pyflakesが未使用と判定したimportや変数を削除して、Pythonのソースファイルを整理します。デフォルトでは未使用の標準ライブラリのimportだけを削除します。他のモジュールには副作用があり、自動削除が安全とは限らないためです。未使用の変数の削除とワイルドカードimportの展開は、オプションで有効にできます。
autoflake は無料で使えますか?ライセンスは?
autoflake は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
autoflake は今もメンテナンスされていますか?
活発にメンテナンス中。autoflake の最終コミットは 2026年11月4日 です。
autoflake は何に使えますか?
Pythonコードをコミットする前に、残ったimportを整理する。 CIパイプラインで未使用のimportをチェックする。 大規模なレガシーPythonコードベースをまとめて整理する。 --importsオプションを使って、安全に削除できるサードパーティモジュールのimportを削除する。
autoflake のインストール方法は?
PyPIからautoflakeをインストールする: pip install --upgrade autoflake ファイル内の未使用のimportと変数をその場で削除する: autoflake --in-place --remove-unused-variables example.py
autoflake はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/PyCQA/autoflake

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト