pydocstyle - クラウドでオンライン

プログラム：

NAME

pydocstyle - pydocstyle ドキュメント

(以前の pep257)

pydocstyle Python docstring への準拠をチェックするための静的分析ツールです
コンベンション。

pydocstyle ほとんどをサポートします PEP 257 箱から出してすぐに使えるものですが、
リファレンス実装。

1。 インストール

pip インストール pydocstyle

2。 実行

$ pydocstyle test.py
test.py:18 プライベートネストクラス `meta`:
D101: ドキュメント文字列がありません
test.py:22 パブリックメソッド `method`:
D102: ドキュメント文字列がありません
...

3. コードを修正します:)

内容：

USAGE

インストール
　 ピップ または easy_install:

pip インストール pydocstyle

また、 pydocstyle.py ソース ファイルを直接保存 - 自己完結型です。

Command LINE インタフェース
使用法
使用法: pydocstyle [オプション] [ ...]

オプション：
--versionshowプログラムのバージョン番号と終了
-h、-helpこのヘルプメッセージを表示して終了します
-e、-explain各エラーの説明を表示
-s、-source各エラーのソースを表示
-d、-debugデバッグ情報を出力します
-v、-verbose印刷ステータス情報
--countはstdoutへのエラーの総数を出力します
--select = 指定して、チェックされたエラーの基本リストを選択します
チェックするエラー（コンマのリスト付き-
分離されたエラーコード）。 例えば：
--select = D101、D202
--ignore = 指定して、チェックされたエラーの基本リストを選択します
無視するエラー（コンマ区切りのリスト付き）
エラーコード）。 例：-ignore = D101、D202
--convention = 指定して、チェックされたエラーの基本リストを選択します
既存の規則。 可能な規則：pep257
--add-select = 指定してチェックするエラーのリストを修正します
チェックするエラーコードが増えました。
--add-ignore = 指定してチェックするエラーのリストを修正します
無視するエラーコードが増えました。
--match = 完全に一致するファイルのみをチェックしてください通常
表現; デフォルトは--match = '（?! test _）。* \。py'です。
'test_'で始まらないが、終わるファイルに一致します
'.py'を使用
--match-dir =
完全に一致するdirのみを検索通常
表現; デフォルトは--match-dir = '[^ \。]。*'で、これは
ドットで始まらないすべてのdirに一致します

返品 Code
┌──┬─────────────────┐
│0│成功-違反なし│
§──┼─────────────────┤
│1│いくつかのコード違反が見つかりました│
§──┼─────────────────┤
│2│不正使用-エラーを参照│
││メッセージ│
━──┴─────────────────┘

　
pydocstyle サポート INI-設定ファイルのように。 のために pydocstyle それを使うには、それ
次のオプションのいずれかの名前を付け、 [pydocstyle] のセクションから無料でダウンロードできます。

· セットアップ.cfg

· tox.ini

· .pydocstyle

· .pydocstylerc

構成ファイルを検索する場合、 pydocstyle 指定されたファイルの XNUMX つを探します
上記の. in それ 正確な 注文。 設定ファイルが見つからなかった場合は、設定ファイルを探し続けます。
ディレクトリ ツリーが見つかるか、デフォルトの構成が使用されるまで、ディレクトリ ツリーを上に移動します。

注:
下位互換性を目的として、 pydocstyle という名前の設定ファイルをサポートします
.pep257、セクションヘッダーと同様に [pep257]。 ただし、これらは非推奨とみなされます
次のメジャー バージョンではサポートが削除されます。

利用できます オプション
すべての構成オプションが構成ファイルで使用できるわけではありません。 利用可能なオプション
には次の値があります:

· 大会

· select

· 無視する

· 追加選択

· 追加無視

· match

· match_dir

ジョブの設定方法については、 使用法 詳細については、セクションを参照してください。

継承
デフォルトでは、構成ファイルを見つけるときに、 pydocstyle 親を継承しようとします
ディレクトリの構成を作成し、それらをローカルの構成にマージします。

マージプロセスは次のとおりです。

・次のいずれか select, 無視する or 大会 子構成で指定されました-
親設定を無視し、チェックする新しいエラー コードを設定します。 それ以外の場合は、単に
親がチェックしたエラーコードをコピーします。

・ もしも 追加-無視 or 追加-選択 指定された、指定されたエラーコードを追加または削除する
チェックされたエラーコードリストから。

・ もしも match or マッチディレクトリ 指定されました-それらを使用してください。 それ以外の場合は、親を使用してください。

これを無効にするには（リポジトリのルートにある構成ファイルに便利です）、
単に追加します 継承= false 構成ファイルに追加します。

注:
のいずれか select, 無視する or 大会 CLIで指定された構成
ファイルは、チェックするエラーコードの選択には関与しません。 match と
マッチディレクトリ 引き続き有効になります。

例
[pydocstyle]
継承= false
無視= D100、D203、D405
一致= * .py

ERROR コード

グループ化
┌─────────────────────────┬──────────────────────── ───────────┐
│見つけて下さい Docstring ││
├─────────────────────────┼──────────────────────── ───────────┤
│D100│公共の場でdocstringがありません│
││モジュール│
├─────────────────────────┼──────────────────────── ───────────┤
│D101│公共の場でdocstringがありません│
││クラス│
├─────────────────────────┼──────────────────────── ───────────┤
│D102│公共の場でdocstringがありません│
││方法│
├─────────────────────────┼──────────────────────── ───────────┤
│D103│公共の場でdocstringがありません│
││機能│
├─────────────────────────┼──────────────────────── ───────────┤
│D104│公共の場でdocstringがありません│
││パッケージ│
├─────────────────────────┼──────────────────────── ───────────┤
│D105│魔法のdocstringがありません│
││方法│
├─────────────────────────┼──────────────────────── ───────────┤
│空白 問題 ││
├─────────────────────────┼──────────────────────── ───────────┤
│D200│XNUMX行のdocstringは│に収まる必要があります
││引用符付きのXNUMX行│
├─────────────────────────┼──────────────────────── ───────────┤
│D201│前に空白行は許可されていません│
││関数docstring│
├─────────────────────────┼──────────────────────── ───────────┤
│D202│後に空白行は許可されません│
││関数docstring│
├─────────────────────────┼──────────────────────── ───────────┤
│D203│前に1行の空白行が必要
││クラスdocstring│
├─────────────────────────┼──────────────────────── ───────────┤
│D204│の後に1行の空白行が必要
││クラスdocstring│
├─────────────────────────┼──────────────────────── ───────────┤
│D205│間に1行の空白行が必要
││要約行と説明│
└─────────────────────────┴──────────────────────── ───────────┘

│D206│Docstringはインデントする必要があります│
││タブではなくスペース付き│
├─────────────────────────┼──────────────────────── ───────────┤
│D207│Docstringがインデントされていない│
├─────────────────────────┼──────────────────────── ───────────┤
│D208│Docstringがインデントされすぎている│
├─────────────────────────┼──────────────────────── ───────────┤
│D209│複数行のドックストリングクロージング│
││引用符は別のものにする必要があります│
││ライン│
├─────────────────────────┼──────────────────────── ───────────┤
│D210│空白は使用できません│
││周囲のdocstringテキスト│
├─────────────────────────┼──────────────────────── ───────────┤
│D211│前に空白行は許可されていません│
││クラスdocstring│
├─────────────────────────┼──────────────────────── ───────────┤
│引用符 問題 ││
├─────────────────────────┼──────────────────────── ───────────┤
│D300│ "" "トリプルダブルクォート" ""を使用する│
├─────────────────────────┼──────────────────────── ───────────┤
│D301│バックスラッシュがある場合はr "" "を使用してください
││docstring│
├─────────────────────────┼──────────────────────── ───────────┤
│D302│Unicodedocstringにはu "" "を使用する│
├─────────────────────────┼──────────────────────── ───────────┤
│ドキュメンテーション文字列 コンテンツ 問題 ││
├─────────────────────────┼──────────────────────── ───────────┤
│D400│最初の行は│で終わる必要があります
││期間│
├─────────────────────────┼──────────────────────── ───────────┤
│D401│最初の行は│にあるべきです
││命令法│
├─────────────────────────┼──────────────────────── ───────────┤
│D402│最初の行は│であってはなりません
││関数の「署名」│
├─────────────────────────┼──────────────────────── ───────────┤
│D403 │ XNUMX行目の最初の単語 │
│ │ は適切に大文字にする必要があります │
└─────────────────────────┴──────────────────────── ───────────┘

デフォルト 小切手
デフォルトでは、すべてのエラーコードがチェックされるわけではありません。 デフォルトの動作はチェックのみです
の一部であるエラーコード PEP257 公式大会。

D203を除いて、上記のすべてのエラーコードがデフォルトでチェックされます。

pydocstyle は、Vladimir Keleshev によって作成されたプロジェクトである pep257 の名前変更および継続です。

AmirRachumによって保守されています。

onworks.net サービスを使用してオンラインで pydocstyle を使用する