命名規則
Coddyの「Clean Code - Pythonでより良いコードを書く」コースのレッスン 3/28。
命名はコードを書く上で重要な部分です。variable、関数、class などに名前を付けます……
Python では、いくつかの推奨される命名スタイルが導入されています。
| 種類 | 規則 | 例 |
|---|---|---|
| Variable | スネークケース | x、index、max_number |
| 関数 | スネークケース | calculate、convert_to_int |
| class | パスカルケース | Person、JavaCompiler |
| メソッド | スネークケース | print、make_sound |
| 定数 | スネークケース(すべて大文字) | PI、MAX_TIMEOUT、MIN_AGE |
| モジュール | スネークケース | script.py、my_app.py |
| パッケージ | スネークケース(アンダースコアなし) | package、mypackage |
- スネークケース(snake_case)- 小文字を使い、単語をアンダースコアで区切ります。
- パスカルケース(PascalCase)- 単語の先頭を大文字にします。
すべてを一緒に使う、より詳しい例です。
import my_module
class ImportantClass:
MY_CONSTANT = 3.14
def good_function(self, variable):
return variable
def better_function(self):
return MY_CONSTANT
def __name__ == '__main__':
var = my_module.secret()
important_class = ImportantClass()
important_class.good_function(var)
print(important_class.better_function())
ここでは、さまざまな種類が使われていることに注目してください。
ご存じでしたか?関数とメソッドの違いは、メソッドがオブジェクトまたは class に関連付けられた関数であることです。
自分で試してみよう
このレッスンにはコードチャレンジは含まれていません。
Clean Code - Pythonでより良いコードを書くのすべてのレッスン
自分で練習してみよう: Pythonオンラインコンパイラ