Как правильно именовать функции в Python

• 26.06.2023
• 1053
• Основы Python
• Функции

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

Базовые правила именования функций

В Python есть несколько простых правил, которые определяют, какие имена функций допустимы:

• Имя функции может состоять из букв (a-z, A-Z), цифр (0-9) и символа подчеркивания (_).
• Имя функции не может начинаться с цифры.
• Имена функций регистрозависимы. То есть my_function, My_Function и MY_FUNCTION будут разными функциями.
• Имя функции не может совпадать с зарезервированными словами Python.

Зарезервированные слова включают такие слова, как:

False, None, True, and, as, assert, async, await, break, class, continue, def, del, elif, else, except, finally, for, from, global, if, import, in, is, lambda, nonlocal, not, or, pass, raise, return, try, while, with, yield

# допустимые имена функций
def my_function():
    pass

def myFunction():
    pass

def function1():
    pass

def _private_function():
    pass

# недопустимые имена функций
def 1function():   # начинается с цифры
    pass

def my-function(): # содержит недопустимый символ "-"
    pass

def for():         # совпадает с зарезервированным словом
    pass

Стиль именования функций

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

Стиль lower_case_with_underscores

В соответствии со стандартом PEP 8, имена функций обычно пишутся в нижнем регистре, а слова разделяются символами подчеркивания. Этот стиль также называют «snake case».

def my_function():
    pass

def calculate_average():
    pass

Использование символа подчеркивания в начале имени

Символ подчеркивания в начале имени функции обычно используется для обозначения «приватных» функций или методов, которые не предназначены для использования за пределами модуля или класса. Однако Python не предоставляет строгого механизма контроля доступа, и такие функции все равно доступны для вызова.

def _my_private_function():
    pass

Стиль double_leading_and_trailing_underscore

Функции с двойными подчеркиваниями в начале и конце имени имеют особое значение в Python. Этот стиль используется для специальных методов, таких как __init__, __str__, __call__ и т.д. Использование этого стиля для собственных функций не рекомендуется.

class MyClass:
    def __init__(self):
        pass

    def __str__(self):
        return "MyClass instance"

Заключение

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