Сайт Александра Шпиндлера

Общий стиль кода

ПравилоПлохоХорошо
Полная форма слова предпочтительнее сокращения в случае, если сокращение не является общепринятым. Если используется сокращение, то необходимо добавить его на страницу Сокращения.resp = Response()response = Response()
object_identifier = uuid4()object_id = uuid4()
Имена переменных должны быть короткими и ясными.def get_objects():      response_with_objects = requests.get(‘/objects’)      objects_data = response_with_objects.json()      return objects_datadef get_objects():      response = requests.get(‘/objects’)      data = response.json()      return data
Если код может быть удален без каких-либо последствий, он должен быть удален.
Код, который не требует комментариев, предпочтительнее, чем тот, который требует.
Цифры предпочтительнее писать буквами.update_1st_objectupdate_first_object
Использовать единственное число для слов, являющихся частью составного выражения.objects_idsobject_ids
Явное лучше неявного.def calculate_salary(hours_worked):
   return hours_worked * 40		HOURLY_WAGE = 40 def calculate_salary(hours_worked):
   return hours_worked * HOURLY_WAGE
TODO должно содержать ссылку на соответствующую задачу в JIRA.# TODO: fixme# TODO: https://jira.cwes.local/browse/<TASK_NUMBER>
Только POST, PUT и PATCH HTTP методы могут содержать тело запроса.
Использовать как можно меньше зависимостей.

Alexander Shpindler

←
→

Оставьте комментарий