Перейти до змісту

Іменування функцій

Стиль іменування функцій в Python такий самий, якк і стиль іменування змінних: snake_case. Але при виборі самих слів є важлива відмінність.

Функція — це дія. Виклик функції — це як вказівка виконати якусь команду: «сходи», «візьми», «виведи», «поклади» і так далі.

Змінна — це сутність. Змінна пов'язана з якимись даними: «довжина сторони трикутника», «кількість котиків на підвіконні», «ставка ПДВ», «текст статті», «зображення» тощо.

Візміть собі за правило: функція — це дієслово, змінна — це іменник.

Приклади функцій:

  • print()
  • say_hello()
  • get_string()
  • read_file()

Приклади змінних:

  • number_of_cats
  • tax_rate
  • article_text
  • unregistered_user
  • user_name
  • user_password

Звісно що як і усих правил можуть бути вийнятки. Наприклад, функцію, яка повертає довжину символьного рядка, згідно правила варто було б назвати

get_string_length()

або хоча б

get_length()

Але ця функція використовується відносно часто, і тому її назву скоротили до наступної:

len()

Для більшості математичних функцій збережено їх "математичні" імена, наприклад abs() — функція, яка повертає абсолютне значення числа.

Є вид функцій, які називають предикатами.

Предикат — стверджувальне питання, на яке можна відповісти "так" або "ні".

Функція-предикат має повертати значення типу bool.

Для підвищення читабельності коду предикати прийнято іменувати особливим способом. В Python, як правило, предикати починаються з префікса is або has:

  • is_adult() — чи є повнолітнім?
  • has_children() — чи має дітей?
  • is_empty() — чи пустий?
  • is_file_exists() — чи файл існує?
  • has_errors() — чи містить помилки?

При виборі імен функцій і змінних користуємось не тільки усим вищенаведеним, а й контекстом і здоровим глуздом.