`optparse` — 명령 줄 옵션용 구문 분석기¶

인자 파싱 라이브러리 선택하기¶

표준 라이브러리에는 세 가지 인자 파싱 라이브러리가 포함되어 있습니다.

getopt: 절차적 C getopt API를 밀접하게 반영하는 모듈입니다. 파이썬 1.0 초기 출시 전부터 표준 라이브러리에 포함되어 왔습니다.
optparse: 각 애플리케이션이 자체적인 절차적 옵션 파싱 로직을 구현할 필요 없이 동일한 기능을 제공하는 getopt 의 선언적 대체재입니다. 파이썬 2.3 출시 이후부터 표준 라이브러리에 포함되었습니다.
argparse: 인자가 처리되는 방식을 정밀하게 제어하는 애플리케이션의 유연성을 다소 희생하는 대신, 기본적으로 더 많은 기능을 제공하는 optparse 의 보다 확고한 의견을 반영한 대안입니다. 파이썬 2.7 및 파이썬 3.2 출시 이후부터 표준 라이브러리에 포함되었습니다.

더 구체적인 인자 파싱 설계 제약이 없는 경우, 최소한의 애플리케이션 레벨 코드로 최고 수준의 기본 기능을 제공하는 argparse 가 명령 줄 애플리케이션을 구현하기 위한 권장 선택입니다.

getopt`은 거의 전적으로 하위 호환성을 위해 유지됩니다. 하지만 이는 또한 ``getopt` 기반의 C 애플리케이션에서 명령 줄 인자 처리를 프로토타이핑하고 테스트하기 위한 도구로서 틈새 사례(niche use case)로 활용되기도 합니다.

다음과 같은 경우에 optparse 를 argparse 의 대안으로 고려할 수 있습니다.

애플리케이션이 이미 optparse 를 사용하고 있으며, argparse 로 마이그레이션할 때 발생할 수 있는 미묘한 동작 변화의 위험을 감수하고 싶지 않은 경우
애플리케이션이 명령 줄에서 옵션과 위치 매개변수가 혼합되는 방식에 대해 추가적인 제어(혼합 기능의 완전한 비활성화 포함)를 필요로 하는 경우
애플리케이션이 명령 줄 요소의 점진적(incremental) 파싱에 대해 추가적인 제어를 필요로 하는 경우(argparse 도 이를 지원하지만, 실제 작동 방식이 일부 사용 사례에서 바람직하지 않은 경우)
애플리케이션이 - 으로 시작할 수 있는 매개변수 값을 수용하는 옵션의 처리에 대해 추가적인 제어를 필요로 하는 경우(호출된 서브프로세스에 전달될 위임된 옵션 등)
애플리케이션이 argparse 는 지원하지 않지만 optparse 가 제공하는 더 낮은 수준의 인터페이스를 통해 구현할 수 있는 다른 명령 줄 매개변수 처리 동작을 필요로 하는 경우

이러한 고려 사항들은 또한 제3자(third-party) 명령 줄 인자 처리 라이브러리를 작성하는 라이브러리 저자들에게 optparse 가 더 나은 기반을 제공할 가능성이 높음을 의미합니다.

구체적인 예로, 첫 번째는 optparse 를 사용하고 두 번째는 argparse 를 사용하는 다음 두 가지 명령 줄 인자 파싱 구성을 고려해 보십시오.

import optparse

if __name__ == '__main__':
    parser = optparse.OptionParser()
    parser.add_option('-o', '--output')
    parser.add_option('-v', dest='verbose', action='store_true')
    opts, args = parser.parse_args()
    process(args, output=opts.output, verbose=opts.verbose)

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-o', '--output')
    parser.add_argument('-v', dest='verbose', action='store_true')
    parser.add_argument('rest', nargs='*')
    args = parser.parse_args()
    process(args.rest, output=args.output, verbose=args.verbose)

가장 명백한 차이점은 optparse 버전에서 옵션이 아닌 인자들이 옵션 처리가 완료된 후 애플리케이션에 의해 별도로 처리되는 반면, argparse 버전에서는 위치 인자가 이름이 지정된 옵션과 동일한 방식으로 선언되고 처리된다는 것입니다.

그러나 argparse 버전은 일부 매개변수 조합을 optparse 버전과 다르게 처리합니다. 예를 들어(다른 차이점들 중 하나로):

-o -v 를 제공할 때 optparse 를 사용하면 output="-v" 와 verbose=False 가 되지만, argparse 에서는 오류가 발생합니다(-v 가 –verbosity 플래그로 해석되므로 -o/--output 에 대한 값이 제공되지 않았다고 불평함)
마찬가지로 -o -- 를 제공할 때 optparse 를 사용하면 output="--" 와 args=() 가 되지만, argparse 에서는 오류가 발생합니다(-- 가 옵션 처리를 종료하고 나머지 모든 값을 위치 인자로 처리하는 것으로 해석되므로 -o/--output 에 대한 값이 제공되지 않았다고 불평함)
-o=foo 를 제공할 때 optparse 를 사용하면 output="=foo" 가 되지만, argparse 에서는 output="foo" 가 됩니다(= 가 옵션 매개변수 값의 대체 구분자로 특별하게 처리되므로)

argparse 버전에서의 이러한 차이 나는 동작들이 바람직한 것인지 아니면 문제인지는 구체적인 명령 줄 애플리케이션 사용 사례에 따라 달라질 것입니다.

click`은 제3자 인자 처리 라이브러리(원래 ``optparse` 기반)로, 명령 줄 애플리케이션을 데코레이터가 적용된 일련의 명령어 구현 함수로 개발할 수 있게 해줍니다.

typer 또는 msgspec-click 과 같은 다른 제3자 라이브러리들은 파이썬 타입 어노테이션의 정적 검사와 더 효과적으로 통합되는 방식으로 명령 줄 인터페이스를 지정할 수 있게 해줍니다.

소개¶

optparse 는 최소한의 기능을 제공하는 getopt 모듈보다 명령 줄 옵션을 구문 분석하기 위한 더 편리하고 유연하며 강력한 라이브러리입니다. optparse 는 더 선언적인 스타일의 명령 줄 구문 분석을 사용합니다. 즉, OptionParser 인스턴스를 생성하고 옵션으로 채운 다음 명령 줄을 구문 분석합니다. optparse 를 사용하면 사용자가 전통적인 GNU/POSIX 문법으로 옵션을 지정할 수 있으며, 추가로 사용법과 도움말 메시지를 자동으로 생성해 줍니다.

다음은 간단한 스크립트에서 optparse 를 사용하는 예입니다:

from optparse import OptionParser
...
parser = OptionParser()
parser.add_option("-f", "--file", dest="filename",
                  help="write report to FILE", metavar="FILE")
parser.add_option("-q", "--quiet",
                  action="store_false", dest="verbose", default=True,
                  help="don't print status messages to stdout")

(options, args) = parser.parse_args()

이 몇 줄의 코드로, 스크립트 사용자는 이제 명령 줄에서 “일반적인 작업”을 수행 할 수 있습니다, 예를 들면:

<yourscript> --file=outfile -q

명령 줄을 구문 분석할 때, optparse 는 사용자가 제공한 명령 줄 값을 기반으로 parse_args() 에서 반환된 options 객체의 속성(attribute)을 설정합니다. 이 명령 줄 구문 분석 결과로 parse_args() 가 반환될 때, options.filename 은 "outfile" 이 되고 options.verbose 는 False 가 됩니다. optparse 는 긴 옵션과 짧은 옵션을 모두 지원하며, 짧은 옵션들을 하나로 병합할 수 있고, 다양한 방식으로 옵션을 인자와 연결할 수 있습니다. 따라서 다음 명령 줄들은 모두 위의 예와 동일하게 처리됩니다:

<yourscript> -f outfile --quiet
<yourscript> --quiet --file outfile
<yourscript> -q -foutfile
<yourscript> -qfoutfile

또한, 사용자는 다음 중 하나를 실행할 수 있습니다

<yourscript> -h
<yourscript> --help

그리고 optparse 는 스크립트 옵션에 대한 간략한 요약을 출력합니다:

Usage: <yourscript> [options]

Options:
  -h, --help            show this help message and exit
  -f FILE, --file=FILE  write report to FILE
  -q, --quiet           don't print status messages to stdout

여기서 yourscript의 값은 (일반적으로 sys.argv[0]에서) 실행 시간에 결정됩니다.

배경¶

optparse`는 C 개발자들이 사용할 수 있는 :c:func:!getopt` 함수 계열이 정립한 관례를 따르며 직관적인 명령 줄 인터페이스를 가진 프로그램을 만들도록 명시적으로 설계되었습니다. 이를 위해, 유닉스 환경에서 전통적으로 사용되는 가장 일반적인 명령 줄 문법과 의미 체계만 지원합니다. 이러한 관례에 익숙하지 않다면 이 섹션을 읽음으로써 관련 지식을 습득할 수 있습니다.

용어¶

인자(argument)

명령 줄에 입력하고, 셸에서 execl()이나 execv()로 전달한 문자열. 파이썬에서, 인자는 sys.argv[1:]의 요소입니다 (sys.argv[0]은 실행 중인 프로그램의 이름입니다). 유닉스 셸은 “워드(word)”라는 용어도 사용합니다.

때때로 sys.argv[1:] 이외의 인자 리스트로 대체하는 것이 바람직해서, “인자”를 “sys.argv[1:]이나 sys.argv[1:]의 대체로 제공된 다른 리스트의 요소”로 읽어야 합니다.

옵션(option)

프로그램의 실행을 안내하거나 사용자 정의하기 위해 추가 정보를 제공하는 데 사용되는 인자입니다. 옵션에는 다양한 문법이 있는데, 전통적인 유닉스 문법은 하이픈(“-”) 뒤에 단일 문자가 오는 형태(예: -x 또는 -F)입니다. 또한, 전통적인 유닉스 문법에서는 여러 옵션을 하나의 인자로 병합할 수 있으며, 예를 들어 -x -F 는 -xF 와 동일합니다. GNU 프로젝트는 하이픈으로 구분된 일련의 단어들이 이어지는 -- 를 도입했으며(예: --file 또는 --dry-run), 이 두 가지가 optparse 에서 제공하는 유일한 옵션 문법입니다.

세상에 등장했던 다른 옵션 문법은 다음과 같습니다:

몇 개의 문자가 뒤따르는 하이픈, 예를 들어 -pf (이것은 하나의 인자로 병합된 여러 옵션과 같은 것이 아닙니다)
전체 단어가 뒤따르는 하이픈, 예를 들어 -file (기술적으로 이전 문법과 동등하지만, 일반적으로 같은 프로그램에서 등장하지 않습니다)
단일 문자나 몇 개의 문자 또는 단어가 뒤따르는 더하기 기호, 예를 들어 +f, +rgb
단일 문자나 몇 개의 문자 또는 단어가 뒤따르는 슬래시, 예를 들어 /f, /file

이러한 옵션 문법들은 optparse 에서 지원되지 않으며 앞으로도 지원될 예정이 없습니다. 이는 의도된 사항입니다. 처음 세 가지는 어떤 환경에서도 표준이 아니며, 마지막은 오직 윈도우나 특정 레거시 플랫폼(예: VMS, MS-DOS)만을 대상으로 하는 경우에만 의미가 있기 때문입니다.

옵션 인자(option argument)

옵션 뒤에 오며 해당 옵션과 밀접하게 연관된 인자로, 해당 옵션이 선택되었을 때 인자 목록에서 소모됩니다. optparse 를 사용하면 옵션 인자가 해당 옵션과 별개의 인자로 존재할 수 있습니다:

-f foo
--file foo

또는 같은 인자에 포함될 수 있습니다:

-ffoo
--file=foo

일반적으로 특정 옵션은 인자를 취하거나 그렇지 않거나 둘 중 하나입니다. 많은 사람이 “선택적 옵션 인자” 기능을 원하며, 이는 일부 옵션이 인자가 있을 경우에만 이를 수용하는 것을 의미합니다. 그러나 이 기능은 구문 분석을 모호하게 만들기 때문에 다소 논란의 여지가 있습니다. 만약 -a 가 선택적 인자를 취하고 -b 가 완전히 다른 옵션이라면, -ab 를 어떻게 해석해야 할까요? 이러한 모호성 때문에 optparse 는 이 기능을 지원하지 않습니다.

위치 인자(positional argument)

옵션이 구문 분석된 후, 즉 옵션과 해당 인자가 구문 분석되고 인자 목록에서 제거된 후 인자 목록에 남은 것.

필수 옵션(required option)

명령 줄에서 반드시 제공되어야 하는 옵션입니다. 참고로 영어에서 “required option(필수 옵션)”이라는 문구는 자체 모순적인 표현입니다. optparse 가 필수 옵션을 구현하는 것을 막지는 않지만, 이를 위한 특별한 도움을 제공하지도 않습니다.

예를 들어, 다음 가상 명령 줄을 고려하십시오:

prog -v --report report.txt foo bar

-v와 --report는 둘 다 옵션입니다. --report가 하나의 인자를 취한다고 가정하면, report.txt는 옵션 인자입니다. foo와 bar는 위치 인자입니다.

옵션은 무엇을 위한 것입니까?¶

옵션은 프로그램 실행을 조정하거나 사용자 정의하기 위한 추가 정보를 제공하는 데 사용됩니다. 명확하지 않은 경우, 옵션은 일반적으로 선택적입니다. 프로그램은 어떤 옵션도 없이 잘 실행될 수 있어야 합니다. (유닉스나 GNU 도구 집합에서 임의의 프로그램을 선택하십시오. 옵션 없이도 실행될 수 있으며 여전히 의미가 있습니까? 주요 예외는 find, tar 및 dd입니다 — 모두 비표준 문법과 혼란스러운 인터페이스 때문에 올바로 비판을 받은 돌연변이 괴짜입니다.)

많은 사람이 프로그램에 “필수 옵션”이 있기를 원합니다. 생각해보십시오. 필수라면, 그것은 선택적(optional)이 아닙니다! 당신의 프로그램이 성공적으로 실행하기 위해 절대적으로 필요한 정보가 있다면, 그것이 바로 위치 인자의 목적입니다.

좋은 명령 줄 인터페이스 설계의 예로, 파일 복사를 위한 겸손한 cp 유틸리티를 고려하십시오. 대상과 하나 이상의 소스를 제공하지 않고 파일을 복사하는 것은 의미가 없습니다. 따라서, 인자 없이 실행하면 cp가 실패합니다. 그러나 옵션이 전혀 필수로 요구하지 않는 유연하고 유용한 문법을 갖습니다:

cp SOURCE DEST
cp SOURCE ... DEST-DIR

그것만으로도 꽤 멀리 갈 수 있습니다. 대부분의 cp 구현은 파일이 복사되는 방식을 정확하게 조정할 수 있는 여러 옵션을 제공합니다: 모드 및 수정 시간을 보존하고, 심볼릭 링크를 따르지 않고, 기존 파일을 건드리기 전에 물을 수 있습니다. 하지만 이 중 어느 것도 한 파일을 다른 파일로 복사하거나 여러 파일을 다른 디렉터리로 복사하는 cp의 핵심 임무를 방해하지 않습니다.

위치 인자는 무엇을 위한 것입니까?¶

위치 인자는 프로그램이 실행하기 위해 절대적으로 필요로하는 정보를 위한 것입니다.

좋은 사용자 인터페이스에는 가능한 한 적은 절대 요구 사항이 있어야 합니다. 프로그램을 성공적으로 실행하기 위해 17개의 개별 정보를 요구한다면, 사용자로부터 해당 정보를 어떻게 얻는지는 중요하지 않습니다—대부분의 사람은 프로그램을 성공적으로 실행하기 전에 포기하고 떠납니다. 이것은 사용자 인터페이스가 명령 줄이든, 구성 파일이든, GUI이든 상관없이 적용됩니다: 사용자에게 그렇게 많은 요구를 하면, 대부분은 단순히 포기할 것입니다.

요컨대, 사용자가 절대적으로 제공해야 하는 정보의 양을 최소화하십시오—가능할 때마다 합리적인 기본값을 사용하십시오. 물론, 프로그램을 합리적으로 유연하게 만들고 싶기도 합니다. 그것이 바로 옵션이 있는 이유입니다. 다시 말하지만, 구성 파일의 항목인지, GUI의 “기본 설정” 대화 상자에 있는 위젯인지, 명령 줄 옵션인지는 중요하지 않습니다—구현하는 옵션이 많을수록, 프로그램이 더 유연해지고, 구현은 더 복잡해집니다. 물론 유연성이 너무 많으면 단점도 있습니다; 너무 많은 옵션은 사용자를 압도하고 코드 유지 관리를 훨씬 더 어렵게 만들 수 있습니다.

자습서¶

optparse`는 매우 유연하고 강력할 뿐만 아니라 대부분의 경우 사용법도 간단합니다. 이 섹션에서는 모든 :mod:!optparse` 기반 프로그램에 공통적인 코드 패턴을 다룹니다.

먼저, OptionParser 클래스를 임포트 해야 합니다; 그런 다음 메인 프로그램의 초기에, OptionParser 인스턴스를 만듭니다:

from optparse import OptionParser
...
parser = OptionParser()

그런 다음 옵션 정의를 시작할 수 있습니다. 기본 문법은 다음과 같습니다:

parser.add_option(opt_str, ...,
                  attr=value, ...)

각 옵션은 -f 또는 --file 과 같은 하나 이상의 옵션 문자열을 가지며, 명령 줄에서 해당 옵션을 발견했을 때 optparse 가 무엇을 예상하고 어떻게 처리해야 하는지 알려주는 여러 옵션 속성(attribute)을 가집니다.

일반적으로, 각 옵션에는 하나의 짧은 옵션 문자열과 하나의 긴 옵션 문자열이 있습니다, 예를 들어:

parser.add_option("-f", "--file", ...)

전체적으로 적어도 하나의 옵션 문자열이 있는 한 원하는 만큼 짧은 옵션 문자열과 긴 옵션 문자열을 (없는 것도 포함합니다) 자유롭게 정의 할 수 있습니다.

The option strings passed to OptionParser.add_option() are effectively labels for the option defined by that call. For brevity, we will frequently refer to encountering an option on the command line; in reality, optparse encounters option strings and looks up options from them.

Once all of your options are defined, instruct optparse to parse your program’s command line:

(options, args) = parser.parse_args()

(원한다면, 사용자 정의 인자 리스트를 parse_args()에 전달할 수 있지만, 거의 필요하지 않습니다: 기본적으로 sys.argv[1:]을 사용합니다.)

parse_args()는 두 가지 값을 반환합니다:

options, 모든 옵션에 대한 값을 포함하는 객체—예를 들어 --file이 단일 문자열 인자를 취하면, options.file은 사용자가 제공한 파일명이거나, 사용자가 해당 옵션을 제공하지 않으면 None입니다.
args, 옵션 구문 분석 후 남은 위치 인자 리스트

이 자습서 섹션에서는 가장 중요한 4가지 옵션 어트리뷰트만 다룹니다: action, type, dest (destination) 및 help만 다룹니다. 이 중, action이 가장 기본입니다.

옵션 액션의 이해¶

액션은 명령 줄에서 옵션을 만났을 때 optparse 가 무엇을 해야 하는지 알려줍니다. optparse 내부에는 고정된 액션 집합이 하드 코딩되어 있으며, 새로운 액션 추가는 optparse 확장하기 섹션에서 다루는 고급 주제입니다. 대부분의 액션은 optparse 에게 어떤 변수에 값을 저장하도록 지시합니다. 예를 들어, 명령 줄에서 문자열을 가져와 options 의 속성에 저장하는 식입니다.

옵션 액션을 지정하지 않으면, optparse 는 store 를 기본값으로 사용합니다.

store 액션¶

가장 흔한 옵션 액션은 store 이며, 이는 optparse 에게 다음 인자(또는 현재 인자의 나머지)를 가져와 올바른 유형인지 확인한 후, 사용자가 지정한 대상에 저장하도록 지시합니다.

예를 들면:

parser.add_option("-f", "--file",
                  action="store", type="string", dest="filename")

Now let’s make up a fake command line and ask optparse to parse it:

args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)

optparse`가 옵션 문자열 `-f``\를 만나면, 다음 인자인 foo.txt\를 소비하고, options.filename\에 저장합니다. 따라서 이 parse_args() 호출을 완료한 후, options.filename\는 "foo.txt"\입니다.

optparse`가 지원하는 다른 옵션 유형으로는 ``int`\와 float\가 있습니다. 정수 인자를 예상하는 옵션은 다음과 같습니다:

parser.add_option("-n", type="int", dest="num")

이 옵션에는 긴 옵션 문자열이 없는데, 완벽하게 허용됩니다. 또한, 기본값이 store이기 때문에 명시적인 액션이 없습니다.

다른 가짜 명령 줄을 구문 분석해 봅시다. 이번에는, 옵션 인자를 옵션 바로 다음에 붙일 것입니다: -n42(하나의 인자)는 -n 42(두 개의 인자)와 동등하므로, 다음 코드는

(options, args) = parser.parse_args(["-n42"])
print(options.num)

42를 인쇄합니다.

유형을 지정하지 않으면, optparse 는 string \으로 가정합니다. 기본 액션이 store 라는 사실과 결합하면, 첫 번째 예제가 훨씬 더 간결해질 수 있습니다:

parser.add_option("-f", "--file", dest="filename")

대상을 지정하지 않으면, optparse`는 옵션 문자열에서 합리적인 기본값을 추측합니다. 즉, 첫 번째 긴 옵션 문자열이 `–foo-bar``\라면, 기본 대상은 foo_bar\입니다. 긴 옵션 문자열이 없는 경우, optparse`는 첫 번째 짧은 옵션 문자열을 확인합니다. `-f``\의 기본 대상은 f\입니다.

optparse`는 내장 ``complex`\ 유형도 포함하고 있습니다. 유형 추가는 optparse 확장하기 섹션에서 다룹니다.

불리언 (플래그) 옵션 처리하기¶

플래그 옵션(특정 옵션이 발견될 때 변수를 참이나 거짓으로 설정하는 것)은 매우 흔하게 사용됩니다. optparse`는 ``store_true`\와 store_false\라는 두 개의 별도 액션으로 이를 지원합니다. 예를 들어, -v\로 켜고 -q\로 끄는 verbose 플래그가 있을 수 있습니다:

parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose")

여기에 대상이 같은 두 가지 옵션이 있는데, 완벽하게 괜찮습니다. (단지 기본값을 설정할 때 약간 주의해야 함을 뜻합니다—아래를 참조하십시오.)

optparse`가 명령 줄에서 `-v``\를 만나면, options.verbose\를 True\로 설정하고; -q\를 만나면, options.verbose\는 False\로 설정됩니다.

다른 액션들¶

Some other actions supported by optparse are:

"store_const": Option.const를 통해 미리 설정된 상숫값을 저장합니다.
"append": 이 옵션의 인자를 리스트에 추가합니다
"count": 카운터를 1씩 증가시킵니다
"callback": 지정된 함수를 호출합니다

이들은 섹션 레퍼런스 지침서와 섹션 옵션 콜백에서 다룹니다.

기본값¶

All of the above examples involve setting some variable (the “destination”) when certain command-line options are seen. What happens if those options are never seen? Since we didn’t supply any defaults, they are all set to None. This is usually fine, but sometimes you want more control. optparse lets you supply a default value for each destination, which is assigned before the command line is parsed.

먼저, verbose/quiet 예시를 고려해 보겠습니다. 만약 -q\가 발견되지 않는 한 optparse`가 ``verbose`\를 True\로 설정하도록 하려면, 다음과 같이 할 수 있습니다:

parser.add_option("-v", action="store_true", dest="verbose", default=True)
parser.add_option("-q", action="store_false", dest="verbose")

기본값은 특정 옵션이 아닌 대상(destination)에 적용되고, 이 두 옵션은 같은 대상을 갖기 때문에, 다음과 정확히 동등합니다:

parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose", default=True)

이걸 생각해봅시다:

parser.add_option("-v", action="store_true", dest="verbose", default=False)
parser.add_option("-q", action="store_false", dest="verbose", default=True)

다시, verbose의 기본값은 True입니다: 특정 대상에 대해 제공되는 마지막 기본값이 사용되는 값입니다.

기본값을 지정하는 더 명확한 방법은 OptionParser의 set_defaults() 메서드인데, parse_args()를 호출하기 전에 언제든지 호출할 수 있습니다:

parser.set_defaults(verbose=True)
parser.add_option(...)
(options, args) = parser.parse_args()

이전과 마찬가지로, 주어진 옵션 대상에 대해 지정된 마지막 값이 사용됩니다. 명확성을 위해, 둘 다가 아닌 한 가지 방법을 사용하여 기본값을 설정하십시오.

도움말 생성하기¶

optparse’s ability to generate help and usage text automatically is useful for creating user-friendly command-line interfaces. All you have to do is supply a help value for each option, and optionally a short usage message for your whole program. Here’s an OptionParser populated with user-friendly (documented) options:

usage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)
parser.add_option("-v", "--verbose",
                  action="store_true", dest="verbose", default=True,
                  help="make lots of noise [default]")
parser.add_option("-q", "--quiet",
                  action="store_false", dest="verbose",
                  help="be vewwy quiet (I'm hunting wabbits)")
parser.add_option("-f", "--filename",
                  metavar="FILE", help="write output to FILE")
parser.add_option("-m", "--mode",
                  default="intermediate",
                  help="interaction mode: novice, intermediate, "
                       "or expert [default: %default]")

optparse`가 명령줄에서 `-h``\ 또는 --help\를 만나거나, parser.print_help()\를 호출하면, 다음 내용을 표준 출력에 인쇄합니다:

Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
                        expert [default: intermediate]

(If the help output is triggered by a help option, optparse exits after printing the help text.)

There’s a lot going on here to help optparse generate the best possible help message:

스크립트는 자체 사용법 메시지를 정의합니다:
```
usage = "usage: %prog [options] arg1 arg2"
```
optparse expands %prog in the usage string to the name of the current program, i.e. os.path.basename(sys.argv[0]). The expanded string is then printed before the detailed option help.

If you don’t supply a usage string, optparse uses a bland but sensible default: "Usage: %prog [options]", which is fine if your script doesn’t take any positional arguments.
every option defines a help string, and doesn’t worry about line-wrapping—optparse takes care of wrapping lines and making the help output look good.
값을 취하는 옵션은 자동으로 생성된 도움말 메시지에 이 사실을 나타냅니다, 예를 들어 “mode” 옵션의 경우:
```
-m MODE, --mode=MODE
```
Here, “MODE” is called the meta-variable: it stands for the argument that the user is expected to supply to -m/--mode. By default, optparse converts the destination variable name to uppercase and uses that for the meta-variable. Sometimes, that’s not what you want—for example, the --filename option explicitly sets metavar="FILE", resulting in this automatically generated option description:
```
-f FILE, --filename=FILE
```
이것은 공간을 절약하는 것 이상으로 중요합니다: 수동으로 작성된 도움말 텍스트는 메타 변수 FILE을 사용하여 반 형식 구문 -f FILE과 비형식적 의미 설명 “write output to FILE” 사이에 연결이 있다는 단서를 사용자에게 알려줍니다. 이는 최종 사용자에게 도움말 텍스트를 훨씬 더 명확하고 유용하게 만드는 간단하지만, 효과적인 방법입니다.
options that have a default value can include %default in the help string—optparse will replace it with str() of the option’s default value. If an option has no default value (or the default value is None), %default expands to none.

옵션 그룹화하기¶

많은 옵션을 다룰 때, 더 나은 도움말 출력을 위해 이러한 옵션을 그룹화하는 것이 편리합니다. OptionParser에는 여러 옵션 그룹이 포함될 수 있으며 각 그룹에는 여러 옵션이 포함될 수 있습니다.

옵션 그룹은 클래스 OptionGroup을 사용하여 얻습니다:

class optparse.OptionGroup(parser, title, description=None)¶

여기서

parser는 그룹이 삽입될 OptionParser 인스턴스입니다
title은 그룹 제목입니다
description(선택 사항)은 그룹에 대한 자세한 설명입니다

OptionGroup은 (OptionParser 처럼) OptionContainer에서 상속되므로 add_option() 메서드를 사용하여 그룹에 옵션을 추가할 수 있습니다.

일단 모든 옵션이 선언되면, OptionParser 메서드 add_option_group()을 사용하여 그룹이 이전에 정의된 구문 분석기에 추가됩니다.

이전 섹션에서 정의한 구문 분석기로 계속 진행하면, 구문 분석기에 OptionGroup을 쉽게 추가할 수 있습니다:

group = OptionGroup(parser, "Dangerous Options",
                    "Caution: use these options at your own risk.  "
                    "It is believed that some of them bite.")
group.add_option("-g", action="store_true", help="Group option.")
parser.add_option_group(group)

그러면 다음과 같은 도움말이 출력됩니다:

Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
                        expert [default: intermediate]

  Dangerous Options:
    Caution: use these options at your own risk.  It is believed that some
    of them bite.

    -g                  Group option.

좀 더 완전한 예는 둘 이상의 그룹을 수반할 수 있습니다: 여전히 이전 예를 확장합니다:

group = OptionGroup(parser, "Dangerous Options",
                    "Caution: use these options at your own risk.  "
                    "It is believed that some of them bite.")
group.add_option("-g", action="store_true", help="Group option.")
parser.add_option_group(group)

group = OptionGroup(parser, "Debug Options")
group.add_option("-d", "--debug", action="store_true",
                 help="Print debug information")
group.add_option("-s", "--sql", action="store_true",
                 help="Print all SQL statements executed")
group.add_option("-e", action="store_true", help="Print every action done")
parser.add_option_group(group)

다음과 같은 출력을 줍니다:

Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or expert
                        [default: intermediate]

  Dangerous Options:
    Caution: use these options at your own risk.  It is believed that some
    of them bite.

    -g                  Group option.

  Debug Options:
    -d, --debug         Print debug information
    -s, --sql           Print all SQL statements executed
    -e                  Print every action done

특히 옵션 그룹을 프로그래밍 방식으로 작업할 때, 또 다른 흥미로운 메서드는 다음과 같습니다:

OptionParser.get_option_group(opt_str)¶: 짧거나 긴 옵션 문자열 opt_str(예를 들어 '-o'나 '--option')이 속한 OptionGroup을 반환합니다. 그러한 OptionGroup이 없으면, None을 반환합니다.

버전 문자열 인쇄하기¶

Similar to the brief usage string, optparse can also print a version string for your program. You have to supply the string as the version argument to OptionParser:

parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")

%prog is expanded just like it is in usage. Apart from that, version can contain anything you like. When you supply it, optparse automatically adds a --version option to your parser. If it encounters this option on the command line, it expands your version string (by replacing %prog), prints it to stdout, and exits.

예를 들어, 스크립트가 /usr/bin/foo로 호출되면:

$ /usr/bin/foo --version
foo 1.0

다음 두 가지 메서드를 사용하여 version 문자열을 인쇄하고 가져올 수 있습니다:

OptionParser.print_version(file=None)¶: 현재 프로그램의 버전 메시지(self.version)를 file(기본값은 표준 출력)로 인쇄합니다. print_usage()와 마찬가지로, self.version에 등장하는 %prog는 현재 프로그램의 이름으로 대체됩니다. self.version이 비어 있거나 정의되지 않았으면 아무 작업도 수행하지 않습니다.

OptionParser.get_version()¶: print_version()과 같지만 인쇄하는 대신 버전 문자열을 반환합니다.

How `optparse` handles errors¶

There are two broad classes of errors that optparse has to worry about: programmer errors and user errors. Programmer errors are usually erroneous calls to OptionParser.add_option(), e.g. invalid option strings, unknown option attributes, missing option attributes, etc. These are dealt with in the usual way: raise an exception (either optparse.OptionError or TypeError) and let the program crash.

Handling user errors is much more important, since they are guaranteed to happen no matter how stable your code is. optparse can automatically detect some user errors, such as bad option arguments (passing -n 4x where -n takes an integer argument), missing arguments (-n at the end of the command line, where -n takes an argument of any type). Also, you can call OptionParser.error() to signal an application-defined error condition:

(options, args) = parser.parse_args()
...
if options.a and options.b:
    parser.error("options -a and -b are mutually exclusive")

In either case, optparse handles the error the same way: it prints the program’s usage message and an error message to standard error and exits with error status 2.

사용자가 정수를 취하는 옵션에 4x를 전달하는 위의 첫 번째 예를 고려하십시오:

$ /usr/bin/foo -n 4x
Usage: foo [options]

foo: error: option -n: invalid integer value: '4x'

또는 사용자가 값을 전혀 전달하지 못하는 경우:

$ /usr/bin/foo -n
Usage: foo [options]

foo: error: -n option requires an argument

optparse-generated error messages take care always to mention the option involved in the error; be sure to do the same when calling OptionParser.error() from your application code.

If optparse’s default error-handling behaviour does not suit your needs, you’ll need to subclass OptionParser and override its exit() and/or error() methods.

모두 합치기¶

Here’s what optparse-based scripts usually look like:

from optparse import OptionParser
...
def main():
    usage = "usage: %prog [options] arg"
    parser = OptionParser(usage)
    parser.add_option("-f", "--file", dest="filename",
                      help="read data from FILENAME")
    parser.add_option("-v", "--verbose",
                      action="store_true", dest="verbose")
    parser.add_option("-q", "--quiet",
                      action="store_false", dest="verbose")
    ...
    (options, args) = parser.parse_args()
    if len(args) != 1:
        parser.error("incorrect number of arguments")
    if options.verbose:
        print("reading %s..." % options.filename)
    ...

if __name__ == "__main__":
    main()

레퍼런스 지침서¶

구문 분석기 만들기¶

The first step in using optparse is to create an OptionParser instance.

class optparse.OptionParser(...)¶

OptionParser 생성자에는 필수 인자가 없지만, 여러 선택적 키워드 인자가 있습니다. 이들을 항상 키워드 인자로 전달해야 합니다, 즉, 인자가 선언된 순서에 의존하지 마십시오.

usage (기본값: "%prog [options]"): The usage summary to print when your program is run incorrectly or with a help option. When optparse prints the usage string, it expands %prog to os.path.basename(sys.argv[0]) (or to prog if you passed that keyword argument). To suppress a usage message, pass the special value optparse.SUPPRESS_USAGE.
option_list (기본값: []): 구문 분석기를 채울 Option 객체 리스트. option_list의 옵션은 standard_option_list(OptionParser 서브 클래스에서 설정할 수 있는 클래스 어트리뷰트)의 모든 옵션 뒤에 추가되지만, 모든 버전(version) 또는 도움말(help) 옵션 앞에 추가됩니다. 폐지되었습니다; 대신 구문 분석기를 만든 후 add_option()을 사용하십시오.
option_class (기본값: optparse.Option): add_option()에서 구문 분석기에 옵션을 추가할 때 사용할 클래스.
version (기본값: None): A version string to print when the user supplies a version option. If you supply a true value for version, optparse automatically adds a version option with the single option string --version. The substring %prog is expanded the same as for usage.
conflict_handler (기본값: "error"): 충돌하는 옵션 문자열이 있는 옵션이 구문 분석기에 추가될 때 수행 할 작업을 지정합니다; 섹션 옵션 간의 충돌을 참조하십시오.
description (기본값: None): A paragraph of text giving a brief overview of your program. optparse reformats this paragraph to fit the current terminal width and prints it when the user requests help (after usage, but before the list of options).
formatter (기본값: 새 IndentedHelpFormatter): 도움말 텍스트를 출력하는 데 사용될 optparse.HelpFormatter 인스턴스입니다. optparse 는 이 목적을 위해 IndentedHelpFormatter와 TitledHelpFormatter라는 두 개의 구체적인 클래스를 제공합니다.
add_help_option (기본값: True): 참(True)이면, optparse`가 파서에 도움말 옵션(옵션 문자열 `-h`` 및 --help)을 추가합니다.
prog: usage와 version에서 %prog를 확장할 때 os.path.basename(sys.argv[0]) 대신 사용할 문자열.
epilog (기본값: None): 옵션 도움말 다음에 인쇄할 도움말 텍스트 단락.

구문 분석기 채우기¶

구문 분석기를 옵션으로 채우는 방법에는 여러 가지가 있습니다. 선호되는 방법은 섹션 자습서에 표시된 대로, OptionParser.add_option()을 사용하는 것입니다. add_option()은 다음 두 가지 방법의 하나로 호출 할 수 있습니다:

(make_option()에서 반환되는 것과 같은) Option 인스턴스를 전달합니다
make_option()(즉, Option 생성자)에 허용되는 위치와 키워드 인자의 조합을 전달합니다, 그러면 Option 인스턴스를 만듭니다

다른 대안은 다음과 같이 미리 생성된 Option 인스턴스 리스트를 OptionParser 생성자에 전달하는 것입니다:

option_list = [
    make_option("-f", "--filename",
                action="store", type="string", dest="filename"),
    make_option("-q", "--quiet",
                action="store_false", dest="verbose"),
    ]
parser = OptionParser(option_list=option_list)

(make_option() 은 Option 인스턴스를 생성하기 위한 팩토리 함수이며, 현재는 Option 생성자의 별칭입니다. 향후 버전의 optparse 에서 Option이 여러 클래스로 분할될 수 있으며, 이 경우 make_option() 이 인스턴스화할 적절한 클래스를 선택하게 됩니다. Option을 직접 인스턴스화하지 마십시오.)

옵션 정의하기¶

각 Option 인스턴스는 동의어 명령 줄 옵션 문자열 집합을 나타냅니다, 예를 들어 -f와 --file. 짧거나 긴 옵션 문자열을 얼마든지 지정할 수 있지만, 전체적으로 옵션 문자열을 적어도 하나 지정해야 합니다.

Option 인스턴스를 만드는 규범적 방법은 OptionParser의 add_option() 메서드를 사용하는 것입니다.

OptionParser.add_option(option)¶

OptionParser.add_option(*opt_str, attr=value, ...)

짧은 옵션 문자열로만 옵션을 정의하려면:

parser.add_option("-f", attr=value, ...)

그리고 긴 옵션 문자열로만 옵션을 정의하려면:

parser.add_option("--foo", attr=value, ...)

키워드 인자는 새로운 Option 객체의 속성을 정의합니다. 가장 중요한 옵션 속성은 관련 없는 옵션 속성을 전달하거나 필요한 속성을 누락하면, :mod:!optparse`는 오류 내용을 설명하는 OptionError 예외를 발생시킵니다.

옵션의 action 은 명령줄에서 해당 옵션을 만났을 때 optparse 가 수행하는 동작을 결정합니다. optparse 에 하드 코딩된 표준 옵션 액션은 다음과 같습니다.

"store": 이 옵션의 인자를 저장합니다 (기본값)
"store_const": Option.const를 통해 미리 설정된 상숫값을 저장합니다.
"store_true": True를 저장합니다
"store_false": False를 저장합니다
"append": 이 옵션의 인자를 리스트에 추가합니다
"append_const": 리스트에 상숫값을 추가합니다, Option.const로 사전 설정
"count": 카운터를 1씩 증가시킵니다
"callback": 지정된 함수를 호출합니다
"help": 모든 옵션과 해당 설명을 포함하는 사용법 메시지를 인쇄합니다

(액션을 제공하지 않으면, 기본값은 "store"입니다. 이 액션의 경우, type과 dest 옵션 어트리뷰트도 제공할 수 있습니다; 표준 옵션 액션을 참조하십시오.)

보시다시피, 대부분의 액션은 값을 어딘가에 저장하거나 업데이트하는 것을 포함합니다. optparse 는 이를 위해 항상 관례적으로 options 라고 불리는 특수 객체를 생성하며, 이는 optparse.Values 의 인스턴스입니다.

class optparse.Values¶: 파싱된 인수 이름과 값을 속성으로 보유하는 객체입니다. 일반적으로 OptionParser.parse_args() 를 호출할 때 생성되며, OptionParser.parse_args() 의 values 인자에 전달되는 사용자 정의 하위 클래스로 대체할 수 있습니다(인자 구문 분석하기 에서 설명한 바와 같음).

옵션 인자(및 기타 다양한 값)는 dest (destination) 옵션 어트리뷰트에 따라, 이 객체의 어트리뷰트로 저장됩니다.

예를 들어, 다음과 같이 호출할 때

parser.parse_args()

optparse`가 수행하는 첫 번째 작업 중 하나는 ``options` 객체를 생성하는 것입니다:

options = Values()

이 구문 분석기의 옵션 중 하나가 다음과 같이 정의되었으면:

parser.add_option("-f", "--file", action="store", type="string", dest="filename")

그리고 구문 분석 중인 명령 줄에는 다음 중 하나가 포함되면:

-ffoo
-f foo
--file=foo
--file foo

그다음 optparse 는 이 옵션을 발견하면 다음과 같은 동작을 수행합니다:

options.filename = "foo"

type과 dest 옵션 어트리뷰트는 action만큼 중요하지만, action은 모든 옵션에 적합한 유일한 어트리뷰트입니다.

옵션 어트리뷰트¶

class optparse.Option¶: 생성자에 여러 속성이 키워드로 전달되는 단일 명령줄 인자입니다. 일반적으로 직접 생성하지 않고 OptionParser.add_option() 을 통해 생성하며, OptionParser 의 option_class 인자를 통해 사용자 정의 클래스로 대체할 수 있습니다.

다음 옵션 속성들을 OptionParser.add_option() 에 키워드 인자로 전달할 수 있습니다. 특정 옵션과 관련 없는 속성을 전달하거나 필요한 속성을 누락하면 optparse 가 OptionError 를 발생시킵니다.

Option.action¶

(기본값: "store")

이 옵션이 명령줄에서 나타날 때 optparse 의 동작을 결정합니다. 사용 가능한 옵션들은 여기 에 설명되어 있습니다.

Option.type¶

(기본값: "string")

이 옵션이 기대하는 인자 형 (예를 들어, "string"이나 "int"); 사용 가능한 옵션 형은 여기에 설명되어 있습니다.

Option.dest¶

(기본값: 옵션 문자열에서 파생됩니다)

옵션의 액션이 값을 어딘가에 쓰거나 수정하는 것을 의미하는 경우, 이 속성은 optparse 에게 어디에 쓸지 알려줍니다. dest 는 명령줄을 파싱할 때 optparse 가 빌드하는 options 객체의 속성 이름을 지정합니다.

Option.default¶: 옵션이 명령 줄에서 보이지 않으면 이 옵션의 대상에 사용할 값. OptionParser.set_defaults()도 참조하십시오.

Option.nargs¶

(기본값: 1)

이 옵션이 보일 때 소비되어야 하는 type 형식의 인자 개수입니다. 1보다 크면 optparse 는 값들의 튜플을 dest 에 저장합니다.

Option.const¶: 상숫값을 저장하는 액션의 경우, 저장할 상숫값.

Option.choices¶: "choice" 형 옵션의 경우, 사용자가 이 중에서 선택할 수 있는 문자열 리스트.

Option.callback¶: 액션 "callback"이 있는 옵션의 경우, 이 옵션이 보일 때 호출 할 콜러블. 콜러블에 전달된 인자에 대한 자세한 내용은 섹션 옵션 콜백을 참조하십시오.

Option.callback_args¶
Option.callback_kwargs¶: 4개의 표준 콜백 인자 다음에 callback에 전달할 추가 위치와 키워드 인자.

Option.help¶: 사용자가 help 옵션을 제공한 (가령 --help) 후 사용 가능한 모든 옵션을 나열할 때 이 옵션에 대해 인쇄할 도움말 텍스트. 도움말 텍스트가 제공되지 않으면, 옵션이 도움말 텍스트 없이 나열됩니다. 이 옵션을 숨기려면, 특수 값 optparse.SUPPRESS_HELP를 사용하십시오.

Option.metavar¶

(기본값: 옵션 문자열에서 파생됩니다)

도움말 텍스트를 인쇄할 때 사용할 옵션 인자를 나타냅니다. 예제는 섹션 자습서를 참조하십시오.

표준 옵션 액션¶

다양한 옵션 액션은 각각 약간씩 다른 요구 사항과 효과를 가집니다. 대부분의 액션은 optparse 의 동작을 안내하기 위해 지정할 수 있는 몇 가지 관련 옵션 속성을 가지고 있으며, 일부는 해당 액션을 사용하는 모든 옵션에 대해 반드시 지정해야 하는 필수 속성을 포함합니다.

"store" [연관된 옵션: type, dest, nargs, choices]

옵션 뒤에 인자가 와야 하며, 인자는 type에 따라 값으로 변환되고, dest에 저장됩니다. nargs > 1 이면, 명령 줄에서 여러 인자가 소비됩니다; 모두 type에 따라 변환되고 dest에 튜플로 저장됩니다. 표준 옵션 형 섹션을 참조하십시오.

choices가 제공되면 (문자열 리스트나 튜플), 형의 기본값은 "choice"입니다.

type이 제공되지 않으면, 기본값은 "string"입니다.

dest 가 제공되지 않으면, optparse 는 첫 번째 긴 옵션 문자열에서 목적지를 유도합니다(예: --foo-bar 는 foo_bar 를 의미함). 긴 옵션 문자열이 없는 경우, optparse 는 첫 번째 짧은 옵션 문자열에서 목적지를 유도합니다(예: -f 는 f 를 의미함).

예:
```
parser.add_option("-f")
parser.add_option("-p", type="float", nargs=3, dest="point")
```
다음과 같은 명령 줄을 구문 분석할 때
```
-f foo.txt -p 1 -3.5 4 -fbar.txt
```
optparse 가 다음을 설정합니다
```
options.f = "foo.txt"
options.point = (1.0, -3.5, 4.0)
options.f = "bar.txt"
```

"store_const" [필수 옵션: const; 연관된 옵션: dest]

값 const는 dest에 저장됩니다.

예:

parser.add_option("-q", "--quiet",
                  action="store_const", const=0, dest="verbose")
parser.add_option("-v", "--verbose",
                  action="store_const", const=1, dest="verbose")
parser.add_option("--noisy",
                  action="store_const", const=2, dest="verbose")

--noisy 가 보이면 optparse 가 다음과 같이 설정합니다

options.verbose = 2

"store_true" [연관된 옵션: dest]

True를 dest에 저장하는 "store_const"의 특별한 경우.

"store_false" [연관된 옵션: dest]

"store_true"와 비슷하지만, False를 저장합니다.

예:

parser.add_option("--clobber", action="store_true", dest="clobber")
parser.add_option("--no-clobber", action="store_false", dest="clobber")

"append" [연관된 옵션: type, dest, nargs, choices]

옵션 뒤에는 인자가 따라와야 하며, 이는 dest 의 리스트에 추가됩니다. dest 에 대한 기본값이 제공되지 않으면, optparse 가 명령줄에서 이 옵션을 처음 만날 때 빈 리스트를 자동으로 생성합니다. nargs 가 1보다 크면 여러 인자가 소비되며, nargs 길이의 튜플이 dest 에 추가됩니다.

type과 dest의 기본값은 "store" 액션의 경우와 같습니다.

예:
```
parser.add_option("-t", "--tracks", action="append", type="int")
```
명령줄에서 -t3 가 보이면 optparse 는 다음을 수행합니다:
```
options.tracks = []
options.tracks.append(int("3"))
```
잠시 후, --tracks=4가 보이면, 다음을 수행합니다:
```
options.tracks.append(int("4"))
```
append 액션은 옵션의 현재 값에 대해 append 메서드를 호출합니다. 이는 지정된 모든 기본값에 append 메서드가 있어야 함을 의미합니다. 또한, 기본값이 비어 있지 않으면, 기본 요소가 옵션의 구문 분석된 값에 존재하며, 명령 줄의 모든 값이 기본값 뒤에 추가됨을 의미합니다:
```
>>> parser.add_option("--files", action="append", default=['~/.mypkg/defaults'])
>>> opts, args = parser.parse_args(['--files', 'overrides.mypkg'])
>>> opts.files
['~/.mypkg/defaults', 'overrides.mypkg']
```
"append_const" [필수 옵션: const; 연관된 옵션: dest]

"store_const"와 비슷하지만, const 값이 dest에 추가됩니다; "append"와 마찬가지로, dest의 기본값은 None이며, 옵션이 처음 발견될 때 빈 리스트가 자동으로 만들어집니다.
"count" [연관된 옵션: dest]

dest에 저장된 정수를 증가시킵니다. 기본값이 제공되지 않으면, dest는 처음으로 증가하기 전에 0으로 설정됩니다.

예:
```
parser.add_option("-v", action="count", dest="verbosity")
```
명령줄에서 -v 가 처음 보일 때 optparse 는 다음을 수행합니다:
```
options.verbosity = 0
options.verbosity += 1
```
이후에 -v가 나타날 때마다 다음과 같이 합니다
```
options.verbosity += 1
```
"callback" [필수 옵션: callback; 연관된 옵션: type, nargs, callback_args, callback_kwargs]

callback으로 지정된 함수를 호출합니다, 이 함수는 다음과 같이 호출됩니다
```
func(option, opt_str, value, parser, *args, **kwargs)
```
자세한 내용은 섹션 옵션 콜백을 참조하십시오.
"help"

현재 옵션 구문 분석기의 모든 옵션에 대한 전체 도움말 메시지를 인쇄합니다. 도움말 메시지는 OptionParser의 생성자에 전달된 usage 문자열과 모든 옵션에 전달된 help 문자열로 구성됩니다.

옵션에 help 문자열이 제공되지 않아도, 도움말 메시지에 나열됩니다. 옵션을 완전히 생략하려면, 특수 값 optparse.SUPPRESS_HELP를 사용하십시오.

optparse 가 모든 OptionParser에 help 옵션을 자동으로 추가하므로, 일반적으로 생성할 필요가 없습니다.

예:
```
from optparse import OptionParser, SUPPRESS_HELP

# 일반적으로, 도움말 옵션은 자동으로 추가되지만, add_help_option 인자를
# 사용하여 억제할 수 있습니다
parser = OptionParser(add_help_option=False)

parser.add_option("-h", "--help", action="help")
parser.add_option("-v", action="store_true", dest="verbose",
                  help="Be moderately verbose")
parser.add_option("--file", dest="filename",
                  help="Input file to read data from")
parser.add_option("--secret", help=SUPPRESS_HELP)
```
optparse 가 명령줄에서 -h 또는 --help 를 감지하면, 다음과 유사한 도움말 메시지를 표준 출력(stdout)에 인쇄합니다(sys.argv[0] 이 "foo.py" 라고 가정할 때):
```
Usage: foo.py [options]

Options:
  -h, --help        Show this help message and exit
  -v                Be moderately verbose
  --file=FILENAME   Input file to read data from
```
도움말 메시지를 인쇄한 후 optparse 는 sys.exit(0) 으로 프로세스를 종료합니다.
"version"

OptionParser에 제공된 버전 번호를 표준 출력(stdout)에 인쇄하고 종료합니다. 버전 번호는 실제로는 OptionParser의 print_version() 메서드에 의해 포맷되고 인쇄됩니다. 일반적으로 이는 OptionParser 생성자에 version 인자가 제공되는 경우에만 관련이 있습니다. help 옵션과 마찬가지로, optparse`가 필요할 때 자동으로 추가하므로 ``version` 옵션을 직접 만드는 경우는 드뭅니다.

표준 옵션 형¶

optparse 는 "string", "int", "choice", "float" 및 "complex" 의 다섯 가지 내장 옵션 형을 제공합니다. 새로운 옵션 형을 추가해야 하는 경우 섹션 optparse 확장하기 를 참조하십시오.

문자열 옵션에 대한 인자는 어떤 방식으로도 검사되거나 변환되지 않습니다: 명령 줄의 텍스트는 있는 그대로 대상에 저장(또는 콜백에 전달)됩니다.

정수 인자("int" 형)는 다음과 같이 구문 분석됩니다:

숫자가 0x로 시작하면, 16진수로 구문 분석됩니다
숫자가 0으로 시작하면, 8진수로 구문 분석됩니다
숫자가 0b로 시작하면, 이진수로 구문 분석됩니다
그렇지 않으면, 숫자는 10진수로 구문 분석됩니다

변환은 적절한 진수(2, 8, 10 또는 16)를 사용하여 int`을 호출함으로써 수행됩니다. 이것이 실패하면 :mod:()!optparse`도 실패하지만, 이때는 더 유용한 오류 메시지가 표시됩니다.

"float"와 "complex" 옵션 인자는 유사한 에러 처리로 float()와 complex()로 직접 변환됩니다.

"choice" 옵션은 "string" 옵션의 서브 형입니다. choices 옵션 어트리뷰트(문자열 시퀀스)는 허용되는 옵션 인자 집합을 정의합니다. optparse.check_choice()는 사용자가 제공한 옵션 인자를 이 마스터 리스트와 비교하고 유효하지 않은 문자열이 주어지면 OptionValueError 를 발생시킵니다.

인자 구문 분석하기¶

OptionParser를 만들고 채우는 것의 요점은 parse_args() 메서드를 호출하는 것입니다.

OptionParser.parse_args(args=None, values=None)¶

args 에서 발견된 명령줄 옵션을 파싱합니다.

입력 매개 변수는

args: 처리할 인자의 리스트 (기본값: sys.argv[1:])
values: 옵션 인자를 저장할 Values 객체 (기본값: Values의 새 인스턴스) – 기존 객체를 제공하면, 옵션 기본값이 초기화되지 않습니다.

그리고 반환 값은 쌍 (options, args)이고

options: values 로 전달된 것과 동일한 객체 또는 optparse 가 생성한 optparse.Values 인스턴스
args: 모든 옵션이 처리된 후 남은 위치 인자

가장 일반적인 사용법은 두 키워드 인자 중 어느 것도 제공하지 않는 것입니다. values를 제공하면, 반복된 setattr() 호출(옵션 대상에 저장된 모든 옵션 인자에 대해 대략 하나씩)로 수정되고, parse_args()에서 반환됩니다.

parse_args()가 인자 리스트에서 에러를 만나면, 적절한 최종 사용자 에러 메시지와 함께 OptionParser의 error() 메서드를 호출합니다. 이는 궁극적으로 종료 상태 2(명령 줄 에러에 대한 전통적인 유닉스 종료 상태)로 프로세스를 종료합니다.

옵션 구문 분석기를 조회하고 조작하기¶

옵션 구문 분석기의 기본 동작은 약간 사용자 정의 할 수 있으며, 옵션 구문 분석기를 들여다보고 거기에 무엇이 있는지 볼 수도 있습니다. OptionParser는 다음과 같은 몇 가지 메서드를 제공합니다:

OptionParser.disable_interspersed_args()¶

첫 번째 옵션이 아닌 항목에서 구문 분석을 중단하도록 설정합니다. 예를 들어, -a 와 -b 가 모두 인자를 받지 않는 단순한 옵션인 경우 optparse 는 일반적으로 다음과 같은 구문을 허용합니다:

prog -a arg1 -b arg2

그리고 다음과 동등하게 취급합니다

prog -a -b arg1 arg2

이 기능을 비활성화하려면, disable_interspersed_args()를 호출하십시오. 이렇게 하면 옵션 구문 분석이 첫 번째 옵션이 아닌 인자에서 중지되는, 전통적인 유닉스 문법이 복원됩니다.

자체 옵션이 있는 다른 명령을 실행하는 명령 프로세서가 있고 이러한 옵션이 혼동되지 않도록 하려면 이것을 사용하십시오. 예를 들어, 각 명령에는 다른 옵션 집합이 있을 수 있습니다.

OptionParser.enable_interspersed_args()¶: 첫 번째 옵션이 아닌 것에서 구문 분석이 중지되지 않도록 설정하여, 명령 인자와 스위치를 분산시킬 수 있도록 합니다. 이것이 기본 동작입니다.

OptionParser.get_option(opt_str)¶: 옵션 문자열 opt_str을 갖는 Option 인스턴스를 반환합니다, 또는 해당 옵션 문자열을 갖는 옵션이 없으면 None을 반환합니다.

OptionParser.has_option(opt_str)¶: OptionParser에 옵션 문자열 opt_str을 갖는 옵션이 있으면 True를 반환합니다 (예를 들어, -q나 --verbose).

OptionParser.remove_option(opt_str)¶: OptionParser에 opt_str에 해당하는 옵션이 있으면, 해당 옵션이 제거됩니다. 해당 옵션이 다른 옵션 문자열을 제공하면, 해당 옵션 문자열은 모두 유효하지 않게 됩니다. 이 OptionParser에 속하는 옵션에서 opt_str이 등장하지 않으면, ValueError를 발생시킵니다.

옵션 간의 충돌¶

주의하지 않으면, 충돌하는 옵션 문자열을 갖는 옵션을 정의하기 쉽습니다:

parser.add_option("-n", "--dry-run", ...)
...
parser.add_option("-n", "--noisy", ...)

(일부 표준 옵션을 사용하여 자체 OptionParser 서브 클래스를 정의한 경우 특히 그렇습니다.)

옵션을 추가할 때마다 optparse 는 기존 옵션과의 충돌 여부를 확인합니다. 충돌이 발견되면 현재의 충돌 처리 메커니즘을 호출합니다. 충돌 처리 메커니즘은 생성자에서 설정할 수 있습니다:

parser = OptionParser(..., conflict_handler=handler)

또는 별도의 호출로 가능합니다:

parser.set_conflict_handler(handler)

사용 가능한 충돌 처리기는 다음과 같습니다:

"error" (기본값)
옵션 충돌이 프로그래밍 에러라고 가정하고 OptionConflictError 를 발생시킵니다

"resolve"
옵션 충돌을 지능적으로 해결합니다 (아래를 참조하십시오)

예를 들어, 충돌을 지능적으로 해결하고 OptionParser를 정의하고 충돌하는 옵션을 추가해 보겠습니다:

parser = OptionParser(conflict_handler="resolve")
parser.add_option("-n", "--dry-run", ..., help="do no harm")
parser.add_option("-n", "--noisy", ..., help="be noisy")

이 시점에서 optparse 는 이전에 추가된 옵션이 이미 -n 옵션 문자열을 사용하고 있음을 감지합니다. conflict_handler 가 "resolve" 이므로, 이전 옵션의 옵션 문자열 리스트에서 -n 을 제거하여 상황을 해결합니다. 이제 사용자가 해당 옵션을 활성화할 수 있는 유일한 방법은 --dry-run 입니다. 사용자가 도움말을 요청하면 도움말 메시지에 이 내용이 반영됩니다:

Options:
  --dry-run     do no harm
  ...
  -n, --noisy   be noisy

이전에 추가된 옵션의 옵션 문자열을 모두 제거하여 사용자가 명령줄에서 해당 옵션을 호출할 방법이 없게 만들 수 있습니다. 이 경우 optparse 는 해당 옵션을 완전히 삭제하며, 도움말 텍스트나 다른 곳에 나타나지 않게 됩니다. 기존 OptionParser를 계속 사용하여:

parser.add_option("--dry-run", ..., help="new dry-run option")

이 시점에서 원래의 -n/--dry-run 옵션에 더 이상 접근할 수 없으므로 optparse 가 이를 제거하고 다음 도움말 텍스트를 남깁니다:

Options:
  ...
  -n, --noisy   be noisy
  --dry-run     new dry-run option

정리¶

OptionParser 인스턴스에는 여러 순환 참조가 있습니다. 이것은 파이썬의 가비지 수거기에선 문제가 되지 않지만, 작업이 끝나면 OptionParser에서 destroy()를 호출하여 순환 참조를 명시적으로 끊을 수 있습니다. 이것은 OptionParser에서 큰 객체 그래프에 도달할 수 있는 장기 실행 응용 프로그램에서 특히 유용합니다.

기타 메서드¶

OptionParser는 몇 가지 다른 공용 메서드를 지원합니다:

OptionParser.set_usage(usage)¶: usage 생성자 키워드 인자에 대해 위에서 설명한 규칙에 따라 사용법 문자열을 설정합니다. None을 전달하면 기본 사용법 문자열이 설정됩니다; 사용법 메시지를 억제하려면 optparse.SUPPRESS_USAGE를 사용하십시오.

OptionParser.print_usage(file=None)¶: 현재 프로그램의 사용법 메시지(self.usage)를 file(기본값 stdout)로 인쇄합니다. self.usage에 등장하는 문자열 %prog는 현재 프로그램의 이름으로 대체됩니다. self.usage가 비어 있거나 정의되지 않았으면 아무 작업도 수행하지 않습니다.

OptionParser.get_usage()¶: print_usage()와 같지만 인쇄하는 대신 사용법 문자열을 반환합니다.

OptionParser.set_defaults(dest=value, ...)¶

한 번에 여러 옵션 대상에 대한 기본값을 설정합니다. 여러 옵션이 같은 대상을 공유 할 수 있기 때문에, set_defaults()를 사용하여 옵션의 기본값을 설정하는 것이 좋습니다. 예를 들어, 여러 “mode” 옵션이 모두 같은 대상을 설정하면, 그중 하나가 기본값을 설정할 수 있으며 마지막 옵션이 이깁니다:

parser.add_option("--advanced", action="store_const",
                  dest="mode", const="advanced",
                  default="novice")    # 아래에서 재정의됩니다
parser.add_option("--novice", action="store_const",
                  dest="mode", const="novice",
                  default="advanced")  # 위의 설정을 재정의합니다

이러한 혼동을 피하려면, set_defaults()를 사용하십시오:

parser.set_defaults(mode="advanced")
parser.add_option("--advanced", action="store_const",
                  dest="mode", const="advanced")
parser.add_option("--novice", action="store_const",
                  dest="mode", const="novice")

옵션 콜백¶

optparse`의 내장 액션과 타입만으로 요구 사항을 충족할 수 없는 경우 두 가지 선택지가 있습니다. :mod:!optparse`를 확장하거나 콜백 옵션을 정의하는 것입니다. optparse 확장은 더 포괄적이지만 많은 단순한 사례에서는 과도한 방법일 수 있습니다. 종종 단순한 콜백만으로 충분합니다.

콜백 옵션을 정의하는 두 단계가 있습니다:

"callback" 액션을 사용하여 옵션 자체를 정의합니다
콜백을 작성합니다; 이것은 아래에 설명된 대로, 최소한 4개의 인자를 취하는 함수(또는 메서드)입니다

콜백 옵션 정의하기¶

항상 그렇듯이, 콜백 옵션을 정의하는 가장 쉬운 방법은 OptionParser.add_option() 메서드를 사용하는 것입니다. action과 별도로 지정해야 하는 유일한 옵션 어트리뷰트는 호출할 함수인 callback입니다:

parser.add_option("-c", action="callback", callback=my_callback)

callback 은 함수(또는 다른 호출 가능한 객체)이므로, 이 콜백 옵션을 생성할 때 my_callback() 을 이미 정의해야 합니다. 이러한 단순한 경우, optparse 는 -c 가 인자를 받는지 여부조차 알지 못하며, 이는 보통 해당 옵션이 인자를 받지 않음을 의미합니다. 즉, 명령줄에 -c 가 존재하는 것만으로 충분합니다. 그러나 어떤 경우에는 콜백이 임의의 수의 명령줄 인자를 소비하기를 원할 수도 있습니다. 이 부분이 콜백 작성이 까다로워지는 지점이며, 이 섹션 후반부에서 다룹니다.

optparse 는 콜백에 항상 4개의 특정 인자를 전달하며, callback_args 및 callback_kwargs 를 통해 지정한 경우에만 추가 인자를 전달합니다. 따라서 최소 콜백 함수 시그니처는 다음과 같습니다:

def my_callback(option, opt, value, parser):

콜백에 대한 네 가지 인자가 아래에 설명되어 있습니다.

콜백 옵션을 정의할 때 제공할 수 있는 몇 가지 다른 옵션 어트리뷰트가 있습니다:

type: 일반적인 의미를 가집니다. "store" 또는 "append" 액션과 마찬가지로, optparse 에게 한 개의 인자를 소비하고 이를 type 으로 변환하도록 지시합니다. 다만, optparse 는 변환된 값을 어딘가에 저장하는 대신 콜백 함수에 전달합니다.
nargs: 또한 일반적인 의미를 가집니다. 이 값이 제공되고 1보다 크면, optparse 는 nargs 개의 인자를 소비하며, 각 인자는 type 으로 변환 가능해야 합니다. 그런 다음 변환된 값의 튜플을 콜백에 전달합니다.
callback_args: 콜백에 전달할 추가 위치 인자의 튜플
callback_kwargs: 콜백에 전달할 추가 키워드 인자의 딕셔너리

콜백이 호출되는 방법¶

모든 콜백은 다음과 같이 호출됩니다:

func(option, opt_str, value, parser, *args, **kwargs)

여기서

option

콜백을 호출하는 Option 인스턴스입니다

opt_str

콜백을 트리거 하는 명령 줄에 나타나는 옵션 문자열입니다. (축약된 긴 옵션이 사용되면, opt_str은 완전한, 규범적인 옵션 문자열이 됩니다—예를 들어 사용자가 --foobar의 약어로 명령 줄에 --foo를 입력하면, opt_str은 "--foobar"가 됩니다.)

value

명령 줄에서 확인되는 이 옵션의 인자입니다. optparse 는 type 이 설정된 경우에만 인자를 기대하며, value 의 형은 옵션의 형이 암시하는 형이 됩니다. 만약 이 옵션의 type 이 None (인자 없음)이면, value 는 None 이 됩니다. nargs 가 1보다 크면, value 는 적절한 형을 가진 값들의 튜플이 됩니다.

parser

모든 것을 구동하는 OptionParser 인스턴스입니다, 인스턴스 어트리뷰트를 통해 다른 흥미로운 데이터에 액세스 할 수 있어서 주로 유용합니다:

parser.largs: 남은 인자의 현재 리스트, 즉, 소비되었지만 옵션이나 옵션 인자가 아닌 인자. 예를 들어 더 많은 인자를 추가하여, parser.largs를 자유롭게 수정하십시오. (이 리스트는 parse_args()의 두 번째 반환 값인 args가 됩니다.)
parser.rargs: 나머지 인자의 현재 리스트, 즉, opt_str과 value(해당한다면)가 제거되고, 그 뒤에 오는 인자만 그대로 남아 있습니다. 예를 들어 더 많은 인자를 소비하여, parser.rargs를 자유롭게 수정하십시오.
parser.values: 옵션 값이 기본적으로 저장되는 객체(optparse.OptionValues의 인스턴스)입니다. 이를 통해 콜백은 옵션 값을 저장할 때 다른 optparse 구성 요소들과 동일한 메커니즘을 사용할 수 있으며, 전역 변수나 클로저를 복잡하게 다룰 필요가 없습니다. 또한 명령 줄에서 이미 발견된 모든 옵션의 값에 접근하거나 수정할 수 있습니다.

args

callback_args 옵션 어트리뷰트를 통해 제공되는 임의의 위치 인자의 튜플입니다.

kwargs

callback_kwargs를 통해 제공된 임의의 키워드 인자의 딕셔너리입니다.

콜백에서 에러 발생시키기¶

옵션이나 인자에 문제가 있는 경우 콜백 함수는 OptionValueError`를 발생시켜야 합니다. :mod:!optparse`가 이를 포착하여 프로그램을 종료하고 사용자가 제공한 에러 메시지를 stderr에 출력합니다. 메시지는 명확하고 간결하며 정확해야 하며, 문제가 발생한 옵션을 언급해야 합니다. 그렇지 않으면 사용자가 무엇을 잘못했는지 파악하기 어려울 수 있습니다.

콜백 예제 1: 간단한 콜백¶

다음은 인자를 취하지 않고, 단순히 옵션이 발견되었음을 기록하는 콜백 옵션의 예입니다:

def record_foo_seen(option, opt_str, value, parser):
    parser.values.saw_foo = True

parser.add_option("--foo", action="callback", callback=record_foo_seen)

물론 "store_true" 액션으로 그렇게 할 수 있습니다.

콜백 예제 2: 옵션 순서 확인¶

여기에 약간 더 흥미로운 예가 있습니다: -a가 발견되었다는 사실을 기록하지만, 명령 줄에서 -b 뒤에 오면 폭발합니다.

def check_order(option, opt_str, value, parser):
    if parser.values.b:
        raise OptionValueError("can't use -a after -b")
    parser.values.a = 1
...
parser.add_option("-a", action="callback", callback=check_order)
parser.add_option("-b", action="store_true", dest="b")

콜백 예제 3: 옵션 순서 확인 (일반화)¶

이 콜백을 몇 가지 유사한 옵션에 다시 사용하려면 (플래그를 설정하지만, -b가 이미 보였으면 폭발함), 약간의 작업이 필요합니다: 에러 메시지와 설정하는 플래그를 일반화해야 합니다.

def check_order(option, opt_str, value, parser):
    if parser.values.b:
        raise OptionValueError("can't use %s after -b" % opt_str)
    setattr(parser.values, option.dest, 1)
...
parser.add_option("-a", action="callback", callback=check_order, dest='a')
parser.add_option("-b", action="store_true", dest="b")
parser.add_option("-c", action="callback", callback=check_order, dest='c')

콜백 예제 4: 임의 조건 확인¶

물론, 여기에 어떤 조건도 넣을 수 있습니다—이미 정의된 옵션의 값을 확인하는 데 국한되지 않습니다. 예를 들어, 만월일 때 호출해서는 안 되는 옵션이 있으면, 다음과 같이 하면 됩니다:

def check_moon(option, opt_str, value, parser):
    if is_moon_full():
        raise OptionValueError("%s option invalid when moon is full"
                               % opt_str)
    setattr(parser.values, option.dest, 1)
...
parser.add_option("--foo",
                  action="callback", callback=check_moon, dest="foo")

(is_moon_full()의 정의는 독자를 위한 연습 문제로 남겨 둡니다.)

콜백 예제 5: 고정 인자¶

고정된 수의 인자를 사용하는 콜백 옵션을 정의하면 상황이 약간 더 흥미로워집니다. 콜백 옵션이 인자를 받도록 지정하는 것은 "store"나 "append" 옵션을 정의하는 것과 유사합니다: type을 정의하면, 옵션은 해당 형으로 변환 할 수 있어야 하는 하나의 인자를 취합니다; nargs를 추가로 정의하면, 옵션은 nargs 인자를 취합니다.

다음은 표준 "store" 액션을 흉내 내는 예입니다:

def store_value(option, opt_str, value, parser):
    setattr(parser.values, option.dest, value)
...
parser.add_option("--foo",
                  action="callback", callback=store_value,
                  type="int", nargs=3, dest="foo")

optparse 가 3개의 인자를 소비하고 이를 정수로 변환하는 작업을 대신 처리하므로, 여러분은 그 값들을 저장하기만 하면 됩니다. (또는 다른 처리를 해도 무관합니다; 당연히 이 예제에서는 콜백이 필요하지 않습니다.)

콜백 예제 6: 가변 인자¶

옵션이 가변적인 수의 인자를 처리해야 하는 경우 상황이 복잡해집니다. 이 경우 optparse`는 관련 내장 기능을 제공하지 않으므로 콜백을 작성해야 합니다. 또한, 평소에는 :mod:!optparse`가 자동으로 처리해주던 전통적인 유닉스 명령 줄 구문 분석의 몇몇 까다로운 부분들을 직접 처리해야 합니다. 특히, 콜백은 단독 -- 및 - 인자에 대한 표준 규칙을 구현해야 합니다.

--나 -는 옵션 인자가 될 수 있습니다
날 -- (어떤 옵션에 대한 인자가 아닌 경우): 명령 줄 처리를 중단하고 --를 버립니다
날 - (어떤 옵션에 대한 인자가 아닌 경우): 명령 줄 처리를 중지하지만 -는 유지합니다 (parser.largs에 추가합니다)

가변적인 수의 인자를 받는 옵션을 구현하려면 몇 가지 미묘하고 까다로운 문제들을 고려해야 합니다. 선택하는 정확한 구현 방식은 애플리케이션을 위해 어떤 부분을 절충할 것인지에 따라 달라집니다(이것이 optparse 가 이러한 기능을 직접 지원하지 않는 이유입니다).

그런데도, 가변 인자가 있는 옵션에 대한 콜백에는 가시가 있습니다:

def vararg_callback(option, opt_str, value, parser):
    assert value is None
    value = []

    def floatable(str):
        try:
            float(str)
            return True
        except ValueError:
            return False

    for arg in parser.rargs:
        # --foo 와 같은 옵션에서 멈춥니다
        if arg[:2] == "--" and len(arg) > 2:
            break
        # -a 에서 멈추지만, -3 이나 -3.0 에서는 멈추지 않습니다
        if arg[:1] == "-" and len(arg) > 1 and not floatable(arg):
            break
        value.append(arg)

    del parser.rargs[:len(value)]
    setattr(parser.values, option.dest, value)

...
parser.add_option("-c", "--callback", dest="vararg_attr",
                  action="callback", callback=vararg_callback)

`optparse` 확장하기¶

optparse 가 명령 줄 옵션을 해석할 때 결정적인 역할을 하는 두 가지 요소는 각 옵션의 액션과 타입이므로, 가장 일반적인 확장 방향은 새로운 액션과 타입을 추가하는 것입니다.

새로운 형 추가하기¶

새로운 타입을 추가하려면 optparse 의 Option 클래스의 서브클래스를 정의해야 합니다. 이 클래스는 optparse 의 타입들을 정의하는 몇 가지 어트리뷰스인 TYPES 와 TYPE_CHECKER 를 가지고 있습니다.

Option.TYPES¶: 형 이름의 튜플; 여러분의 서브 클래스에서, 표준 튜플을 기반으로 하는 새 튜플 TYPES를 정의하십시오.

Option.TYPE_CHECKER¶

형 이름을 형 검사 함수에 매핑하는 딕셔너리. 형 검사 함수는 다음과 같은 서명을 갖습니다:

def check_mytype(option, opt, value)

여기서 option은 Option 인스턴스이고, opt는 옵션 문자열(예를 들어, -f)이며, value는 검사되고 원하는 형으로 변환되어야 하는 명령 줄의 문자열입니다. check_mytype()은 가상의 형 mytype의 객체를 반환해야 합니다. 형 검사 함수가 반환한 값은 OptionParser.parse_args()에서 반환한 OptionValues 인스턴스에 포함되거나 value 매개 변수로 콜백에 전달됩니다.

형 검사 함수는 문제가 발생하면 OptionValueError 를 발생시켜야 합니다. OptionValueError 는 OptionParser의 error() 메서드에 있는 그대로 전달되는 단일 문자열 인자를 취하며, 이는 차례로 프로그램 이름과 문자열 "error:"를 앞에 붙이고 프로세스를 종료하기 전에 모든 것을 stderr에 인쇄합니다.

다음은 명령 줄에서 파이썬 스타일의 복소수를 구문 분석하기 위해 "complex" 옵션 타입을 추가하는 예시입니다. (optparse 1.3부터 복소수에 대한 기본 지원이 추가되어 현재로서는 다소 우스꽝스러운 예가 되었지만, 일단 무시하셔도 좋습니다.)

첫째, 필요한 임포트:

from copy import copy
from optparse import Option, OptionValueError

나중에 (Option 서브 클래스의 TYPE_CHECKER 클래스 어트리뷰트에서) 참조되므로, 형 검사기를 먼저 정의해야 합니다:

def check_complex(option, opt, value):
    try:
        return complex(value)
    except ValueError:
        raise OptionValueError(
            "option %s: invalid complex value: %r" % (opt, value))

마지막으로, Option 서브 클래스:

class MyOption (Option):
    TYPES = Option.TYPES + ("complex",)
    TYPE_CHECKER = copy(Option.TYPE_CHECKER)
    TYPE_CHECKER["complex"] = check_complex

(만약 Option.TYPE_CHECKER 의 copy() 를 생성하지 않았다면, optparse 의 Option 클래스에 있는 TYPE_CHECKER 어트리뷰스를 수정하게 되었을 것입니다. 파이썬에서는 예의와 상식 외에는 이를 막을 수 있는 것이 없습니다.)

끝났습니다! 이제 OptionParser가 Option 대신 MyOption을 사용하도록 설정하는 것만 제외하면, 다른 optparse 기반 스크립트와 동일하게 새로운 옵션 타입을 사용하는 스크립트를 작성할 수 있습니다.

parser = OptionParser(option_class=MyOption)
parser.add_option("-c", type="complex")

또는, 여러분 자신만의 옵션 목록을 만들어 OptionParser에 전달할 수 있습니다; 위의 방법으로 add_option()을 사용하지 않으면, OptionParser에 사용할 옵션 클래스를 알려줄 필요가 없습니다:

option_list = [MyOption("-c", action="store", type="complex", dest="c")]
parser = OptionParser(option_list=option_list)

새로운 액션 추가하기¶

새로운 액션을 추가하는 것은 조금 더 까다롭습니다. 왜냐하면 optparse 가 액션에 대해 몇 가지 분류를 가지고 있음을 이해해야 하기 때문입니다.

“저장” 액션: optparse 가 현재 OptionValues 인스턴스의 어트리뷰트에 값을 저장하게 하는 액션입니다. 이러한 옵션들은 Option 생성자에 dest 어트리뷰스를 제공해야 합니다.
“형이 있는” 액션: 명령 줄에서 값을 취하고 이것이 특정 형일 것으로 기대하는 액션; 또는, 특정 형으로 변환할 수 있는 문자열. 이러한 옵션을 사용하려면 Option 생성자에 type 어트리뷰트를 제공해야 합니다.

이들은 겹치는 집합입니다: 일부 기본 “저장” 액션은 "store", "store_const", "append" 및 "count"이고, 기본 “형이 있는” 액션은 "store", "append" 및 "callback"입니다.

액션을 추가할 때, Option의 다음 클래스 어트리뷰트 중 하나 이상에 나열하여 분류해야 합니다 (모두 문자열 리스트입니다):

Option.ACTIONS¶: 모든 액션은 ACTIONS에 나열되어야 합니다.

Option.STORE_ACTIONS¶: “저장” 액션이 여기에 추가로 나열됩니다.

Option.TYPED_ACTIONS¶: “형이 있는” 액션이 여기에 추가로 나열됩니다.

Option.ALWAYS_TYPED_ACTIONS¶: 항상 타입을 가지는(즉, 옵션이 항상 값을 포함하는) 액션들이 여기에 추가로 나열됩니다. 이것의 유일한 효과는 optparse 가 ALWAYS_TYPED_ACTIONS 에 나열된 액션 중 명시적인 타입이 없는 경우 기본값인 "string" 을 할당한다는 것입니다.

새 액션을 실제로 구현하려면, Option의 take_action() 메서드를 재정의하고 액션을 인식하는 케이스를 추가해야 합니다.

예를 들어, "extend" 액션을 추가해 보겠습니다. 이것은 표준 "append" 액션과 유사하지만, 명령 줄에서 단일 값을 취해서 기존 리스트에 추가하는 대신, "extend"는 단일 쉼표로 구분된 문자열에서 여러 값을 취해서 기존 리스트를 확장합니다. 즉, --names가 "string" 형의 "extend" 옵션이면, 다음과 같은 명령 줄은

--names=foo,bar --names blah --names ding,dong

다음과 같은 리스트를 만듭니다

["foo", "bar", "blah", "ding", "dong"]

다시 Option의 서브 클래스를 정의합니다:

class MyOption(Option):

    ACTIONS = Option.ACTIONS + ("extend",)
    STORE_ACTIONS = Option.STORE_ACTIONS + ("extend",)
    TYPED_ACTIONS = Option.TYPED_ACTIONS + ("extend",)
    ALWAYS_TYPED_ACTIONS = Option.ALWAYS_TYPED_ACTIONS + ("extend",)

    def take_action(self, action, dest, opt, value, values, parser):
        if action == "extend":
            lvalue = value.split(",")
            values.ensure_value(dest, []).extend(lvalue)
        else:
            Option.take_action(
                self, action, dest, opt, value, values, parser)

참고할만한 특징:

"extend"는 명령 줄에서 값을 기대하기도 하고 그 값을 어딘가에 저장하기도 하므로, STORE_ACTIONS와 TYPED_ACTIONS 모두에 들어갑니다.
optparse 가 "extend" 액션에 기본값인 "string" 을 할당하도록 보장하기 위해, ALWAYS_TYPED_ACTIONS 에도 "extend" 액션을 포함합니다.
MyOption.take_action() 은 이 새로운 액션 하나만 구현하며, 표준 optparse 액션의 경우에는 제어를 Option.take_action() 으로 다시 전달합니다.
values는 매우 유용한 ensure_value() 메서드를 제공하는 optparse_parser.Values 클래스의 인스턴스입니다. ensure_value()는 본질적으로 안전밸브가 있는 getattr()입니다; 다음과 같이 호출됩니다
```
values.ensure_value(attr, value)
```
values의 attr 어트리뷰트가 존재하지 않거나 None이면, ensure_value()는 먼저 이를 value로 설정한 다음, value를 반환합니다. 이것은 "extend", "append" 및 "count"와 같은 액션에 매우 편리합니다. 이 액션들은 모두 변수에 데이터를 누적하고 해당 변수가 특정 형(처음 두 개는 리스트, 마지막은 정수)이 될 것으로 기대합니다. ensure_value()를 사용한다는 것은 액션을 사용하는 스크립트가 문제의 옵션 대상에 대한 기본값 설정에 대해 걱정할 필요가 없음을 의미합니다; 기본값을 None으로 그대로 둘 수 있으며 ensure_value()는 필요할 때 올바르게 처리합니다.

예외¶

exception optparse.OptionError¶: 유효하지 않거나 일관성이 없는 인자로 Option 인스턴스가 생성될 때 발생합니다.

exception optparse.OptionConflictError¶: OptionParser 에 상충하는 옵션이 추가될 때 발생합니다.

exception optparse.OptionValueError¶: 명령 줄에서 잘못된 옵션 값이 발견될 때 발생합니다.

exception optparse.BadOptionError¶: 명령줄에서 잘못된 옵션이 전달되면 발생합니다.

exception optparse.AmbiguousOptionError¶: 명령 줄에 모호한 옵션이 전달될 때 발생합니다.