Pythonコードの仕様

1: 背景

は、ocp pythonの開発を標準化するために使用され、コードのメンテナンスを容易にするためにPythonを使用して開発されたプログラムに統一スタイルを使用します

2: pythonスタイル仕様

• セミコロン: 行の末尾にセミコロンを追加しないでください。また、同じ行に 2 つのコマンドを置くためにセミコロンを使用しないでください。

• 括弧: 括弧は過剰に使用するのではなく、控えめに使用してください。行連結の実装に使用する場合を除き、return ステートメントまたは条件ステートメントでは括弧を使用しないでください。ただし、タプルの両側で括弧を使用することは許可されます

• インデント: コードをインデントする代わりに 4 つのスペースを使用します。タブを使用したり、タブとスペースを混在させたりしないでください。行連結の場合は、ラップされた要素を垂直方向に整列させるか、4 スペース分のぶら下げインデントを使用する必要があります (この場合、最初の行にはパラメーターはありません)

• 空行: 最上位の 定義間のスペース 2 つ関数やクラス定義などの行。メソッド定義、クラス定義、最初のメソッドの間には空白行が必要です。関数またはメソッドでは、適切と思われる場合は、いくつかの場所に空白行を残します。

• スペース: 標準の書式設定規則に従って、句読点の両側にスペースを使用します。括弧内にはスペースを入れないでください。カンマ、セミコロン、コロンの前にはスペースを追加しないでください(行末を除く)。パラメーター リスト、インデックス、またはスライスの左括弧にはスペースを追加しないでください。バイナリの演算子代入 (=)、比較 (==、<、>、!=、<>、<=、>=、in、not in など) の両側にスペースを追加します。 、は、ではありません)、ブール値 (および、または、ではありません)。四則演算子の両側のスペースの使い方については、ご自身で判断してください。ただし、両側が一貫している必要があります。キーワード パラメータまたはデフォルトのパラメータ値を示すために「=」を使用する場合は、複数行間のマークを垂直方向に揃えるためにスペースを使用しないでください。メンテナンスの問題 負担 (:、#、= などに適用)

• クラス: クラスが他の クラスから を継承しない場合、クラスは オブジェクト クラスから を明示的に継承します 文字列 :パラメータ すべて文字列です。% 演算子または format メソッド

  フォーマット文字列
を使用します。+ メソッドは使用しないでください

• Import メソッド: 各インポートには独自の行があります。インポートは常にファイルの先頭、モジュール コメント と docstring の後、モジュール グローバル

  変数
と
• 定数

  の前に配置する必要があります。インポートは、最も一般的なものから最も一般的ではないものの順に並べる必要があります。グループ: 標準ライブラリのインポート、アプリケーションプログラム指定のインポート、それぞれの完全なパッケージ パスに従って並べ替える必要があります。モジュール、無視される Case ステートメント: 通常、各ステートメントは独自の行になければなりません。テスト結果とテスト ステートメントが 1 行に収まる場合は、同じ行に配置できます。 if ステートメントの場合、これは

  else
なしでのみ実行できます。特に、try/excel は決して同じ行に置くことができないため、これを決して実行しないでください。

• Name: ob_module_name ob_package_name Ob

  Class
Name TestObClassName メソッド名 test_method_name
• Exception

  Name function_name GLOBAL_VAR_NAME instance_var_name function_parameter_name local_var_nameその他の点後で追加予定

• 3: 要件:

コードを変更した後、まず pylint を実行してからレビューを開始する必要があります。pylint の実行スコアは 90 以上に制御する必要があります。いくつかの明らかな不規則性は修正する必要があります

pylint の使用法: で tools/pylint を実行します。 obztools ディレクトリ .sh

file

• Four: 参照:

• PEP 8 – スタイルガイドPythonコード用: http://legacy.python.org/dev/peps/pep-0008/

• Pythonコーディングスタイルガイド中国語翻訳(Google SOC) :

  http://www.elias.cn/Python/PythonStyleGuide?from=Develop.PythonStyleGuide

以上がPythonコードの仕様の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。