Соглашения об именовании

Урок 3 из 28 курса Clean Code — пишите код лучше на Python на Coddy.

Именование — важная часть написания кода. Вы даёте имена 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())

Обратите внимание на все различные типы здесь!