피드로 돌아가기
Dev.toBackend
원문 읽기
AI 생성 스크립트를 견고한 Production CLI로 변환하는 10가지 엔지니어링 체크리스트
I Shipped One Messy Python Script. Here's the 10-Point Checklist That Got It There.
AI 요약
Context
AI가 생성한 Python 스크립트는 단일 실행에는 성공하나 하드코딩된 경로, 예외 처리 부재, 비원자적 쓰기 등의 결함으로 인해 협업 및 배포 단계에서 런타임 오류가 빈번히 발생함. 이는 단순한 코드 작동과 실제 엔지니어링 수준의 소프트웨어 품질 사이의 간극으로 인한 시스템 불안정성 초래.
Technical Solution
- Bare except 제거 및 특정 Exception 클래스(AppError) 정의를 통한 계층적 에러 핸들링 구조 설계
- 하드코딩된 설정을 argparse 기반 CLI 인터페이스로 전환하여 외부 주입 가능한 Config 구조 구축
- csv.reader에서 csv.DictReader로 전환하여 인덱스 기반 접근의 취약성을 제거하고 컬럼명 기반의 데이터 유효성 검증 강화
- 표준 출력(stdout)과 진단 로그(stderr)를 분리하는 Logging Level 체계 도입으로 관측 가능성 확보
- pyproject.toml 정의 및 Entry Point 설정을 통해 단순 스크립트를 설치 가능한 패키지 형태로 구조화
- Pytest를 이용한 Happy Path 및 최소 3가지 Failure Mode 검증으로 코드의 신뢰성 정량화
실천 포인트
1. 하드코딩된 경로/키를 Env 또는 CLI Argument로 대체했는가
2. 구체적인 Exception을 캐치하고 Non-zero Exit Code를 반환하는가
3. DictReader 등을 사용하여 입력 데이터의 구조적 변경에 유연하게 대응하는가
4. Logging Level을 구분하여 사용자 출력과 디버그 로그를 분리했는가
5. pyproject.toml 기반의 설치 경로와 Entry Point가 정의되었는가