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


Пример 1

В данном контексте Person ничего полезного не добавляет. Работник и так является человеком, персоной. Кроме того, [[Не читается по-английски|для английского языка такое словосочетание является неествественным]].

Плохо:


class EmployeePerson:
...

Хорошо:


class Employee:
...


Пример 2

Со временем, набор аргументов может измениться, и название, в связи с этим, станет неактуальным.

Плохо:


url_args = parser.parse_args()
url = url_args.url

Хорошо:


args = parser.parse_args()
url = args.url


Пример 3

Плохо:


args = parser.parse_args()
parsed_url = urlparse(args.url)
link_without_protocol = f'{parsed_url.netloc}{parsed_url.path}'

Хорошо:


args = parser.parse_args()
parsed_url = urlparse(args.url)
netloc_path = f'{parsed_url.netloc}{parsed_url.path}'


Пример 4

Плохо:


def get_hh_salary_statistics(all_vacancies):
average_salary_result = {}
...

Хорошо:


def get_hh_salary_statistics(all_vacancies):
average_salary = {}
...


Пример 5

Плохо:


def calculate_total_sum_of_prices(prices):
total_price = sum(prices)
return total_price

Хорошо:


def calculate_total_price(prices):
total_price = sum(prices)
return total_price


Пример 6

В данном случае, MAX_ в начале уже само по себе говорит о неком разрешённом лимите, и слово ALLOWED_ явно лишнее.

Плохо:


MAX_BG_APPS_ALLOWED_FOR_STEP_CHANGE = 10

Хорошо:


MAX_BG_APPS_FOR_STEP_CHANGE = 10