Когда мы пишем код, наши мысли почти всегда заняты исключительно правильностью его работы. Мы очень редко обращаем внимание на то, как именно его пишем. Выбор оформления и применения определенных элементов языка может влиять на восприятие вашего кода коллегами. Поэтому для эффективной работы в команде необходимо поддерживать единый стиль кода. В этом докладе я постараюсь рассказать, какие средства для этого можно использовать и что делать, если их не хватает.

2. Контроль за
стилем кода
PEP8, pyflakes и все-все-все.

3. Здравствуйте :)
Борисов Кирилл, разработчик
6 лет профессионального программирования
Python, C/C++, Java
Работал над АСУ, учетными системами

4. Теория

5. Возникающие проблемы
Ручная проверка чревата ошибками.
Люди ленятся проверять сами.
Контролировать манеру написания кода.
“Особые” правила.

6. Как это делается в Python?
PEP8 - базовый свод рекомендаций по
оформлению кода.
Инструменты:
pep8 - соблюдение правил PEP8.
pylint - именование элементов кода и т.д.
pyflakes - логические ошибки в коде.
flake8 - pep8 + pyflakes + плагины

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

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

9. Git pre-commit hook

10. Jenkins
Интеграция через связку плагинов analysis-core
+ warnings
Запуск на каждый коммит pep8, pyflakes, …
Графики трендов
“Ломать” сборку при превышении количества
предупреждений

11. Case study

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

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

14. Яндекс.Паспорт
Интегрированные pep8 в IDE
Git pre-commit hooks:
– flake8
– flake8-debug
– flake8-print
– flake8-passport
imhotep + github-webhook-wrapper

15. Что ещё проверять?
Отладочный код (pdb, ipdb…)
Цикломатическая сложность
Копипаста
Неоптимальные конструкции в коде

16. Практика: расширяем flake8

17. flake8-todo

18. flake8-commas

19. flake8-print

20. Вопросы?

21. Спасибо!

22. Полезные ссылки
PEP8
https://www.python.org/dev/peps/pep-0008
pep8
https://pypi.python.org/pypi/pep8
pyflakes
https://pypi.python.org/pypi/pyflakes
flake8
https://gitlab.com/pycqa/flake8

23. Полезные ссылки
imhotep
https://github.com/justinabrahms/imhotep
github-webhook-wrapper
https://github.com/datafolklabs/github-webhook-wrapper
Jenkins warnings plugin
https://wiki.jenkins-ci.org/display/JENKINS/Warnings+Plugin
Jenkins + flake8 + tox
http://www.mediawiki.org/wiki/Continuous_integration/Tutorials/
Test_your_python