PyCQA/docformatter

これは何？

主な機能

• 01PEP 257の引用符とレイアウトの規則に沿ってdocstringを整形します。
• 02--blackオプションでblack互換の出力に対応します。
• 03Epytext形式およびSphinx形式のフィールドリストを整形します。
• 04--in-placeを使ってファイルを直接編集できます。
• 05pyproject.tomlから設定を読み込みます。

ユースケース

• Pythonプロジェクト全体でdocstringの書式を統一する。
• pre-commitフックやCIチェックでdocstringの一貫性を自動的に保つ。
• 引用符やインデントにばらつきのあるレガシーコードを整理する。

クイックスタート

1. 1

   pipでPyPIからdocformatterをインストールする

   pip install --upgrade docformatter
2. 2

   ファイルのdocstringをその場で整形する

   docformatter --in-place example.py

収録されている特集

トピック

よくある質問

docformatter とは？

PEP 257の規約に沿ってdocstringを自動整形するPython用コマンドラインツール。 docformatterは、PEP 257の規約の一部に沿うよう、Pythonのdocstringを書き換えるコマンドラインツールです。引用符のスタイルを統一し、複数行のdocstringでは閉じ引用符を独立した行に移動し、要約と説明の間に空行を挿入します。また、不要なインデントや末尾の空白も取り除きます。

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

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

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

活発にメンテナンス中。docformatter の最終コミットは 2026年11月3日 です。

docformatter は何に使えますか？

Pythonプロジェクト全体でdocstringの書式を統一する。 pre-commitフックやCIチェックでdocstringの一貫性を自動的に保つ。 引用符やインデントにばらつきのあるレガシーコードを整理する。

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

pipでPyPIからdocformatterをインストールする: pip install --upgrade docformatter ファイルのdocstringをその場で整形する: docformatter --in-place example.py

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

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