Pythonのライブラリを作成する際の命名規則について解説します。これらの規則はPythonのコーディング規約PEP8で定められています。
パッケージ名
パッケージ名は全小文字で、なるべく短く、アンダースコアは非推奨です。例えば、tqdm
やrequests
などがあります。
モジュール名
モジュール名も全小文字で、なるべく短く、アンダースコアを使用することができます。例えば、sys
やos
などがあります。
クラス名
クラス名は最初の文字が大文字のキャメルケース(CamelCase)を使用します。例えば、MyFavoriteClass
などがあります。
メソッド名と関数名
メソッド名と関数名は全小文字で、単語はアンダースコアで区切ります。例えば、my_favorite_method
やmy_favorite_function
などがあります。
変数名
変数名も全小文字で、単語はアンダースコアで区切ります。例えば、my_favorite_instance
などがあります。
定数名
定数名は全大文字で、単語はアンダースコアで区切ります。例えば、MY_FAVORITE_CONST
などがあります。
以上がPythonのライブラリで一般的に使用される命名規則です。これらの規則を守ることで、他の開発者があなたのコードを理解しやすくなります。