Python-ネーミング仕様
2436 ワード
作者:chen_hマイクロ信号&QQ:862251340マイクロ信号公衆番号:coderpai
ファイル名
全小文字、下線使用可能
パッケージ
短い、小文字の名前のはずです.下線が可読性を改善できる場合はmy_などを追加できます.package.
モジュール
パッケージの仕様と同じです.例えばmy_module.
クラス#クラス#
常に頭文字の大文字の単語列を使用します.MyClassのようです.内部クラスでは、追加のプリアンブル下線を使用できます.
関数&メソッド
関数名は小文字で、下線スタイルの単語で可読性を高めることができます.例:my_function,my_example_function. 注:ブレンド大文字と小文字は、後方互換性を維持するために、このスタイルが優位に立っている場合にのみ使用できます.
関数とメソッドのパラメータ
インスタンスメソッドの最初のパラメータとして常にselfを使用します.クラスメソッドの最初のパラメータとして常にclsを使用します.関数のパラメータ名が保持されているキーワードと競合する場合、通常、接尾辞の下線を使用すると、略語や奇妙なスペルを使用するよりも良いです.
グローバル変数
from M import*インポート文の場合、インポートモジュール内のグローバル変数をブロックするには、古い仕様を使用して、グローバル変数に先頭の下線を付けることができます.注意:グローバル変数は使用しないでください
変数＃ヘンスウ＃
変数名はすべて小文字で、下線で各単語を接続します.カラー=WHITE,this_is_a_variable=1注意:1.クラスメンバー変数でもグローバル変数でも、mまたはg接頭辞は使用されません.2.プライベートクラスメンバーは、単一の下線接頭辞を使用して識別され、公開メンバーを多く定義し、プライベートメンバーを少なく定義します.3.Pythonは動的タイプ言語であるため、変数名にタイプ情報を持たないでください.例えばiValue、names_list、dict_objなどは悪いネーミングです.
定数
定数名はすべて大文字で、MAX_などの各単語を下線で接続します.OVERFLOW,TOTAL.
異常
「Error」を接尾辞とする.
略語
名前はできるだけ全スペルの単語を使うべきで、略語の情況は以下の2種類があります:1.XML、IDなど、よく使われる略語は、XmlParserなどの頭文字だけで命名する必要があります.2.ネーミングには長い単語が含まれ、ある単語を省略します.この場合、約定された俗っぽい略語を使うべきだ.例えば、functionをfn text、txt object、obj count、cnt number、numなどと略す.プリアンブル接尾辞下線プリアンブル下線:非公有を表します.接尾辞の下線:キーワードの競合を回避します.2つのプリアンブル下線:クラス属性の名前を付けて名前の競合を引き起こす場合に使用します.2つのプリアンブルと接尾辞の下線:「魔」(特殊な図面がある)オブジェクトまたは属性、例えばinitまたはfile.決してこのような名前を作らないで、ただそれらを使うだけです.注意:下線の使用についていくつかの議論があります.
特定のネーミング方法
主にxxx形式のシステム保持字命名法を指す.プロジェクトでは、この名前を使用することもできます.この形式の変数は読み取り専用であり、この形式のクラスメンバー関数はできるだけ再ロードしないことを意味します.のように
ここでid,parent,messageはいずれもシステム保持字命名法を採用している.
付:Google Pythonネーミング仕様module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.
ファイル名
全小文字、下線使用可能
パッケージ
短い、小文字の名前のはずです.下線が可読性を改善できる場合はmy_などを追加できます.package.
モジュール
パッケージの仕様と同じです.例えばmy_module.
クラス#クラス#
常に頭文字の大文字の単語列を使用します.MyClassのようです.内部クラスでは、追加のプリアンブル下線を使用できます.
関数&メソッド
関数名は小文字で、下線スタイルの単語で可読性を高めることができます.例:my_function,my_example_function. 注:ブレンド大文字と小文字は、後方互換性を維持するために、このスタイルが優位に立っている場合にのみ使用できます.
関数とメソッドのパラメータ
インスタンスメソッドの最初のパラメータとして常にselfを使用します.クラスメソッドの最初のパラメータとして常にclsを使用します.関数のパラメータ名が保持されているキーワードと競合する場合、通常、接尾辞の下線を使用すると、略語や奇妙なスペルを使用するよりも良いです.
グローバル変数
from M import*インポート文の場合、インポートモジュール内のグローバル変数をブロックするには、古い仕様を使用して、グローバル変数に先頭の下線を付けることができます.注意:グローバル変数は使用しないでください
変数＃ヘンスウ＃
変数名はすべて小文字で、下線で各単語を接続します.カラー=WHITE,this_is_a_variable=1注意:1.クラスメンバー変数でもグローバル変数でも、mまたはg接頭辞は使用されません.2.プライベートクラスメンバーは、単一の下線接頭辞を使用して識別され、公開メンバーを多く定義し、プライベートメンバーを少なく定義します.3.Pythonは動的タイプ言語であるため、変数名にタイプ情報を持たないでください.例えばiValue、names_list、dict_objなどは悪いネーミングです.
定数
定数名はすべて大文字で、MAX_などの各単語を下線で接続します.OVERFLOW,TOTAL.
異常
「Error」を接尾辞とする.
略語
名前はできるだけ全スペルの単語を使うべきで、略語の情況は以下の2種類があります:1.XML、IDなど、よく使われる略語は、XmlParserなどの頭文字だけで命名する必要があります.2.ネーミングには長い単語が含まれ、ある単語を省略します.この場合、約定された俗っぽい略語を使うべきだ.例えば、functionをfn text、txt object、obj count、cnt number、numなどと略す.プリアンブル接尾辞下線プリアンブル下線:非公有を表します.接尾辞の下線:キーワードの競合を回避します.2つのプリアンブル下線:クラス属性の名前を付けて名前の競合を引き起こす場合に使用します.2つのプリアンブルと接尾辞の下線:「魔」(特殊な図面がある)オブジェクトまたは属性、例えばinitまたはfile.決してこのような名前を作らないで、ただそれらを使うだけです.注意:下線の使用についていくつかの議論があります.
特定のネーミング方法
主にxxx形式のシステム保持字命名法を指す.プロジェクトでは、この名前を使用することもできます.この形式の変数は読み取り専用であり、この形式のクラスメンバー関数はできるだけ再ロードしないことを意味します.のように
class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# … ここでid,parent,messageはいずれもシステム保持字命名法を採用している.
付:Google Pythonネーミング仕様module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.