파이썬 명령줄 도구 설계하기: argparse, main(), 종료 코드

목표

셸 스크립트, CI 작업, 에이전트가 다룰 수 있는 명령줄 도구를 만듭니다: 예측 가능한 인자, 그 자체가 문서 역할을 하는 도움말, 구조화된 종료 코드, 깨끗한 스트림.

전제 조건

pyproject.toml을 갖춘 패키지(패키징에 관한 글 참고)로, 로직은 인자 처리와 분리된, 임포트 가능한 함수 안에 있어야 합니다.

단계

1. def main(argv: list[str] | None = None) -> int를 작성합니다. 이 함수는 파서를 만들고, argv를 파싱하며(없으면 sys.argv[1:]를 대신 사용), 종료 코드를 반환합니다. [project.scripts] tool = "pkg.cli:main"으로 등록하고 if __name__ == "__main__": sys.exit(main())을 추가합니다. 그러면 테스트에서 main(["--flag", "x"])를 호출해 반환값과 캡처된 출력을 검사할 수 있습니다.
2. prog, description, 예시를 담은 epilog로 파서를 구성합니다. 잘못된 값이 사용법 오류로 보고되도록 type= 변환기(int, pathlib.Path, 또는 ArgumentTypeError를 발생시키는 함수)를 쓰고, 닫힌 값 집합에는 choices=를, 여러 하위 명령이 있는 도구에는 add_subparsers(dest="command", required=True)를 씁니다.
3. sys.exit 문서가 설명하는 관례를 따릅니다: 유닉스 프로그램은 일반적으로 명령줄 구문 오류에는 2를, 그 외 모든 오류에는 1을 쓰고, 0은 성공을 뜻합니다. argparse는 인자가 잘못되면 이미 상태 코드 2로 종료합니다. sysexits.h의 추가 코드(EX_USAGE 64, EX_NOINPUT 66, EX_UNAVAILABLE 69, EX_TEMPFAIL 75)는 --help에 문서화되어 있는 경우에만 사용합니다.
4. 결과는 stdout에, 진단 메시지는 stderr에 씁니다. 다른 프로그램이 출력을 소비하는 경우에는 --json을 제공하고, 여기저기 print를 흩뿌리는 대신 로깅 레벨을 설정하는 --verbose/--quiet를 둡니다.
5. 예상되는 실패(FileNotFoundError, 연결 오류, 도메인 예외)는 main 안에서 잡아 stderr에 한 줄을 출력하고 문서화된 코드를 반환합니다. 예상치 못한 예외는 그대로 전파시켜, 트레이스백과 종료 코드 1이 보존되게 합니다.
6. KeyboardInterrupt는 정리 작업을 한 뒤 130을 반환하는 방식으로 처리합니다. 이는 셸의 관례인 '128 더하기 시그널 번호'와 일치합니다. 또한 stdout에서 BrokenPipeError를 흡수해, tool | head가 조용히 끝나도록 합니다.
7. 도움말이 사실과 다르지 않도록 유지합니다: 읽기 쉬운 플레이스홀더를 위한 metavar, 기본값이 표시되도록 하는 ArgumentDefaultsHelpFormatter, 그리고 --help가 0으로 종료되는지 확인하는 테스트.

기대 결과

tool --help가 인터페이스 전체를 문서화하고, tool --bad; echo $?는 2를 출력하며, 입력에 문제가 있으면 stderr에 한 줄과 문서화된 코드가 나오고, 호출하는 쪽은 텍스트를 파싱하지 않고도 코드로 분기할 수 있습니다.

한계와 검증 근거

sys.exit 문서는 대부분의 시스템에서 종료 코드가 0에서 127 범위여야 한다고 밝히고 있습니다. 그 이상의 값은 셸의 시그널 인코딩과 충돌합니다. exit_on_error=False로 설정하면 파서가 종료하는 대신 ArgumentError를 발생시키는데, 이는 다른 프로그램에 내장하기에는 적합하지만 별도의 오류 처리가 필요합니다. 관례는 인용된 문서를 따른 것이며, 사용성에 대한 어떠한 측정도 주장하지 않습니다.

Ctrl-C 이후 종료하기

셸은 인터럽트가 감싸고 있는 스크립트까지 멈춰야 하는지를, 종료 코드를 읽어서가 아니라 자식 프로세스가 SIGINT로 죽었는지를 확인해서 판단합니다. 따라서 KeyboardInterrupt를 잡아 130을 반환하는 도구는 정상 종료처럼 보이게 되고, for f in *; do tool "$f"; done은 Ctrl-C를 누를 때마다 다음 파일로 계속 넘어가 버립니다. 정리 작업을 한 다음, 처리되지 않은 인터럽트가 그렇게 하듯 프로세스를 끝내십시오(파이썬은 3.8부터 이를 스스로 수행합니다):

except KeyboardInterrupt:
    cleanup()
    signal.signal(signal.SIGINT, signal.SIG_DFL)
    os.kill(os.getpid(), signal.SIGINT)

이렇게 해도 $?는 여전히 130으로 읽히며, 프로세스를 기다리는 부모는 시그널에 의한 종료를 보게 됩니다. return 130은 코드만 읽는다고 알려진 호출자를 위해 남겨 두십시오.