Те, кто смотрел моё выступление, заметили, что большую часть времени я говорил не о бутербродах, а о хорошем коде. Просто эта тема становится по-настоящему волнующей, когда приходится довольно много копаться в чужом коде. Так что вот пару простых правил (и инструментов), что делать, когда нужно из плохого кода сделать конфетку:
- Сначала натравите на код yapf, чтобы всё было в соответствии с PEP-8 или другими стайлгайдами.
- Создайте .editorconfig и прикрутите его к своей IDE, чтобы у всех код форматировался одинаково.
- Прикрутите flake8 к своей IDE, ну или хотя бы запускайте его перед каждым коммитом. И исправляйте каждый warning! Без вариантов. В каких-то редких случаях, когда нужно вот именно так и никак иначе, помечайте строку тегом noQA.
- Никогда не полагайтесь на yapf и прочие инструменты в плане форматирования вашего кода. Эти инструменты без души, им не понять как в каждом конкрентном случае будет наиболее удобочитаемо. Это всегда должно быть заботой разработчика.
- Комментарии, докстринги, тесты. Это главное.
Да прибудет с тобой чистый код.