Обманчивое сокращение
Анти-паттерн
Сокращенные названия должны быть общеприняты, ясны, однозначны, недвусмысленны.
Пример 1¶
Обманчивое, неоднозначное, неочевидное, двусмысленное сокращение.
Плохо:
temp = ...
Хорошо:
temperature = ...
Пример 2¶
Неочевидное и неоднозначное сокращение.
Плохо:
def create_client_rep(request, order_id):
...
return response
Хорошо:
def create_client_report(request, order_id):
...
return response
Пример 3¶
Непонятные сокращения.
Плохо:
class Product:
def __init__(self, name, prc, qnt):
self.name = name
self.prc = prc
self.qnt = qnt
Хорошо:
class Product:
def __init__(self, name, price, quantity):
self.name = name
self.price = price
self.quantity = quantity
Пример 4¶
Непонятное и непринятое сокращение.
Плохо:
for vac in vacancies:
...
Хорошо:
for vacancy in vacancies:
...
Пример 5¶
Непонятное и непринятое сокращение импорта.
Плохо:
import requests as rq
Хорошо:
import requests