Pythonコーディングスタイルガイド

以下にいくつかの例を示します。

# example
def sample(random):
   # statement 1
   # statement 2
   # ...
   return random

PythonのデフォルトのUTF-8またはASCIIエンコーディング

PythonのデフォルトのUTF-8を使用する またはASCII エンコーディングは、国際的な環境のベストプラクティスです。

タプルの末尾のコンマ

タプルで末尾のコンマを使用することは、ベストプラクティスの1つです。ただし、必須ではありません。

# example
tup = (1, 2, 3,)

docstringの使用

docstringを使用する 関数とクラスで。 docstringには三重引用符を使用できます。以下のいくつかの例を参照してください。

def sample():
   """This is a function"""
   """
   This
   is
   a function
   """
class Smaple:
   """This is a class"""
   """
   This
   is
   a class
   """

1行に79文字を超えて書き込まないでください

PEP 8 では、1行に79文字を超える文字を書き込むことはお勧めしません。 スタイルガイド。 エスケープ文字（）を使用して行を複数の行に分割することにより、これを回避します 。以下の例を参照してください。

# example
def evaluate(a, b, c, d):
   return (2 ** (a + b) / (c // d) ** d + a - d * b) \ - (3 ** (a + b) / (c // d) ** d + a - d * b)

スペースの使用

オペレーターの前後にスペースを使用することは、ベストプラクティスの1つです。読みやすくするために、カンマの後にスペースも使用してください。

# example
import random
result = random.randint(1, 3) + random.randint(1, 2)

変数、定数、クラス、関数の命名

プログラム全体の変数、定数、クラス、および関数についても同じケースに従います。ほとんどのPythonユーザーはsnake_caseを使用します 関数と変数の命名およびPascalCase クラスの命名用。定数には、アンダースコアで区切られたすべての大文字を使用します（例：- PI_TWO 。

snake_case => this_is_function

PascalCase => ThisIsClass

CONSTANT => THIS_IS_CONSTANT

一度に1つのモジュールをインポートする

構文的には正しい場合でも、1つのモジュールで複数のモジュールをインポートしようとしないでください。以下の例を参照してください。

# don't
import math, random
# do
import math
import random

コメントの更新

コメントは常に最新の状態に保ってください。コードの更新中にコメントを更新することを忘れないでください。これは、コーディングで最も重要なことの1つです。そして、ほとんどのユーザーはそれを忘れます。これを覚えておいてください。

変数名として単独で使用してはならない文字

孤独な変数名として使用してはならない文字がいくつかあります。そして、それらはローマ字に似ているので、I（大文字のi）とl（小文字のL）です。

識別子にASCII文字を使用しないでください

ASCIIの使用 識別子の文字はまったく良い習慣ではありません。それらの使用は避けてください。