Прекрасный код на Python

За последние годы я написал много кода на Python (grail, grailkit, osc) и вывел для себя определенные правила как писать код так что бы потом было приятней к нему возвращаться.

Главный принцип — писать так чтобы было приятно снова возвращаться к работе. 

я

Зен Пайтон

Самы правильный набор правил существует достаточно давно это Zen of Python, который является официальным PEP, оригинал.

  1. Красивое лучше, чем уродливое.
  2. Явное лучше, чем неявное.
  3. Простое лучше, чем сложное.
  4. Сложное лучше, чем запутанное.
  5. Плоское лучше, чем вложенное.
  6. Разреженное лучше, чем плотное.
  7. Читаемость имеет значение.
  8. Особые случаи не настолько особые, чтобы нарушать правила.
  9. При этом практичность важнее безупречности.
  10. Ошибки никогда не должны замалчиваться.
  11. Если они не замалчиваются явно.
  12. Встретив двусмысленность, отбрось искушение угадать.
  13. Должен существовать один и, желательно, только один очевидный способ сделать это.
  14. Хотя он поначалу может быть и не очевиден, если вы не голландец.
  15. Сейчас лучше, чем никогда.
  16. Хотя никогда зачастую лучше, чем прямо сейчас.
  17. Если реализацию сложно объяснить — идея плоха.
  18. Если реализацию легко объяснить — идея, возможно, хороша.
  19. Пространства имён — отличная штука! Будем делать их больше!

Порядок методов в классе

Я использую такой порядок методов и свойств, просто для того чтобы было понятно где что искать.

  1. Магические методы: __init__, __len__ и т.д.
  2. Свойства: @property, @name.setter
  3. Методы изменяющие свойства: set_spacing, set_location
  4. Обычные методы: append, close, move
  5. Обработчики событий: on_click, on_resize
  6. Скрытые методы: _render, _handle
  7. Приватные методы: __event, __parse
  8. Статические методы класса: @classmethod
  9. Абстрактные статические методы: @staticmethod