Стремление каждого разработчика ПО — писать код. Всё, что от этого кода требуется — работать без ошибок и соответствовать задумке. Не секрет, что для более-менее сложного продукта требуется объединить несколько программистов в одну команду и заставить их работать вместе... И вот тут начинаются проблемы: каждый пишет по-своему и затрудняется понять код коллеги. Что в итоге? Падает эффективность, снижается качество продукта, увеличивается время вхождения для новых разработчиков. Решить эти проблемы помогает контроль за стилем кода. В этом докладе я расскажу про то, какие практики вам могут пригодиться на выбранном пути и какие средства для этого есть в экосистеме Python.

2. Здравствуйте :)

3. Контроль за
стилем кода
Борисов Кирилл, PyCon BY 2015

4. Контроль за
стилем качеством кода
Борисов Кирилл, PyCon BY 2015

5. Теория

6. Типичная ситуация
Команда разработчиков (3-5 человек)
Общий репозитарий
Что-то покрыто тестами
Времени на “излишества” нет
Жизнь потихонечку идет

7. Возникающие проблемы
Каждый пишет по-своему
Каждый знает, что его код - правильный
Каждый верит, что остальные поймут…
…или простят

8. Растет время code review
Сложно править чужой код
Споры о вкусах
Рабочее время тратится зря
Возникающие проблемы

9. Все плохо.

10. Чем спасаться?
Style guide
Автоматические проверки
Процедура разрешения конфликтов
Code Review
Готовность к изменениям

11. Практика

12. Как это делается в Python?
PEP8 - базовый свод рекомендаций по
оформлению кода.
PEP257 - набор рекомендаций по
оформлению docstring’ов
Множество инструментов:
pep8, pep257, pyflakes, pylint, pychecker…

13. Инструменты
autopep8
https://github.com/hhatto/autopep8
Автоматически правит ошибки PEP8
Может быть не тем, что вы ожидали :(
Очень консервативен

14. Инструменты
frosted
https://github.com/timothycrosley/frosted
Форк pyflakes
“Более открыт к изменениям”
Больше проверок
Python 2.6 - 3.4

15. Инструменты
pyroma
https://bitbucket.org/regebro/pyroma
Проверка стандартов упаковки кода:
PyPi, Distribute, pip…
Ставит оценку вашему коду, сравнивает его с
сыром

16. Инструменты
pyroma
https://bitbucket.org/regebro/pyroma
Проверка стандартов упаковки кода:
PyPi, Distribute, pip…
Ставит оценку вашему коду, сравнивает его с
сыром

17. Инструменты
isort
https://pypi.python.org/pypi/isort
Сортировка импортов
Автоматически правит код
Git-хук в комплекте

18. Инструменты
prospector
https://github.com/landscapeio/prospector
pylint + pep8 + pyflakes + mccabe + dodgy
Очень прост в использовании
Адаптируется под Django и Celery
Активно развивается

19. Наш выбор
flake8
https://gitlab.com/pycqa/flake8
Три в одном: pep8, pyflakes, mccabe
Часто обновляется
Легко расширяется
Много готовых плагинов

20. Где проверять?
Интеграция с IDE (PyCharm, Emacs, vi)
VCS pre-commit hooks (git, Mercurial, SVN)
CI (Jenkins, TeamCity)
Внешние средства (imhotep, landscape.io,…)

21. Git pre-commit hook

22. Внешние средства: landscape.io
landscape.io
https://landscape.io
Онлайн-версия prospector
Интегрируется с GitHub
Бесплатен для open-source
Графики, метрики, значки

23. Case study

24. Яндекс.Паспорт
Интегрированный pep8 в IDE

25. Яндекс.Паспорт
Интегрированный pep8 в IDE
Git pre-commit hooks:
– flake8
– flake8-debugger
– flake8-print

26. Яндекс.Паспорт
Интегрированный pep8 в IDE
Git pre-commit hooks:
– flake8
– flake8-debugger
– flake8-print
– forgetmenot
– passport-isort

27. Собственные инструменты
forgetmenot
<однажды на GitHub>
Поиск TODO/FIXME
Определение автора, времени
Подсветка и оформление
Не блокирует процесс коммита

28. Что ещё проверять?
Забытые пароли, ключи и т.д.
Сложность кода
Совместимость его с разными версия Python
TODO, FIXME
Метрики

29. A foolish consistency is
the hobgoblin of little
minds.
PEP8

30. Вопросы?

31. Спасибо!
@lensvol borisov.kir@gmail.com