pep257-クラウドでのオンライン

プログラム：

NAME

pep257-pep257ドキュメント

pep257 Pythonへの準拠をチェックするための静的分析ツールです PEP 257.

内容：

USAGE

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

オプション：
--versionshowプログラムのバージョン番号と終了
-h、-helpこのヘルプメッセージを表示して終了します
-e、-explain各エラーの説明を表示
-s、-source各エラーのソースを表示
--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に一致します
-d、-debugデバッグ情報を出力します
-v、-verbose印刷ステータス情報
--countはstdoutへのエラーの総数を出力します

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

　
pep257 サポート INI-設定ファイルのように。 のために pep257 それを使用するには、
命名 セットアップ.cfg, tox.ini or .pep257 と持っている [pep257] のセクションから無料でダウンロードできます。

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

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

· 大会

· select

· 無視する

· 追加選択

· 追加無視

· match

· match_dir

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

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

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

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

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

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

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

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

例
[pep257]
継承= 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│最初の行は│であってはなりません
││関数の「署名」│
└─────────────────────────┴──────────────────────── ───────────┘

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

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

ウラジミールケレシェフによって作成されました。

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

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