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

В Python существует набор правил и соглашений, которые мы используем при именовании классов, методов и атрибутов. Эти соглашения важны, потому что они обеспечивают последовательность в вашем коде, делая его более легким для чтения и понимания. Соблюдение этих соглашений также является профессиональной лучшей практикой.

Имена классов

В Python имена классов следуют соглашению CapWords, также известному как PascalCase. В этом стиле первая буква каждого слова пишется с заглавной буквы, и между словами нет подчёркиваний (_):

class MyClass:  # Имя класса начинается с заглавной буквы
    pass        # Используем "pass", когда не хотим, чтобы класс что-либо делал

Термин PascalCase происходит от языка программирования Pascal, где использовалось такое соглашение написания. CapWords — термин, используемый в официальном руководстве по стилю Python (PEP 8), и по сути он совпадает с PascalCase.

Имена методов

Имена методов должны быть написаны строчными буквами, слова разделяются подчёркиваниями для улучшения читаемости. Это также известно как snake_case. Вот пример:

class MyClass:
    def my_method(self):  # Имя метода полностью в нижнем регистре
        pass              # Слова разделены подчёркиваниями

Имена атрибутов

Имена атрибутов следуют тому же соглашению, что и имена методов: они пишутся строчными буквами, а слова разделены подчёркиваниями для улучшения читаемости.

class MyClass:
    def __init__(self):
        self.my_attribute = 'some value'  # Имя атрибута полностью в нижнем регистре,
                                          # слова разделены подчёркиваниями

В этом коде мы определили атрибут my_attribute внутри метода __init__. Метод __init__ — это специальный метод в классах Python, который автоматически вызывается при создании нового экземпляра класса.

Давайте рассмотрим полный пример класса, его методов и атрибутов:

class MyCar:                              # имя класса использует CapWords
    def __init__(self):
        self.car_model = 'Tesla Model 3'  # имя атрибута использует snake_case

    def start_engine(self):               # имя метода использует snake_case
        print('Engine started!')

Хотя Python не строго навязывает эти соглашения об именовании, их соблюдение делает ваш код более профессиональным, читаемым и последовательным. Поэтому в сообществе Python это считается хорошей практикой.