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

소스 코드: Lib/optparse.py

버전 3.2부터 폐지: optparse 모듈은 폐지되었으며 더는 개발되지 않습니다; 개발은 argparse 모듈로 계속될 것입니다.


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 객체의 어트리뷰트를 설정합니다. 이 명령 줄 구문 분석에서 parse_args()가 반환되면, options.filename"outfile"이 되고 options.verboseFalse가 됩니다. 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는 간단하고 전통적인 명령 줄 인터페이스를 갖는 프로그램을 만들 수 있도록 명시적으로 설계되었습니다. 이를 위해, 유닉스에서 전통적으로 사용되는 가장 일반적인 명령 줄 문법과 의미 체계만 지원합니다. 이러한 규칙에 익숙하지 않으면, 이 섹션을 읽고 숙지하십시오.

용어

인자(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)

명령 줄에서 제공해야 하는 옵션; 《필수 옵션》이라는 문구는 영어에서 모순된다는 점에 유의하십시오. optparse는 필수 옵션을 구현하는 것을 방해하지 않지만, 그다지 도움을 주지도 않습니다.

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

prog -v --report report.txt foo bar

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

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

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

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

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

cp SOURCE DEST
cp SOURCE ... DEST-DIR

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

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

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

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

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

자습서

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

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

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

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

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

각 옵션에는 -f--file과 같은 하나 이상의 옵션 문자열이 있고, 명령 줄에서 해당 옵션을 발견했을 때 optparse가 기대하는 것과 수행 할 작업을 알려주는 여러 옵션 어트리뷰트가 있습니다.

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

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

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

OptionParser.add_option()에 전달된 옵션 문자열은 해당 호출에 의해 정의된 옵션에 대한 레이블입니다. 간결함을 위해, 명령 줄에서 옵션을 만난다를 자주 언급할 것입니다; 실제로는, optparse옵션 문자열을 만나고 이것으로 옵션을 찾습니다.

일단 모든 옵션이 정의되면, optparse가 프로그램의 명령 줄을 구문 분석하도록 지시합니다:

(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")

이제 가짜 명령 줄을 만들고 optparse에게 구문 분석을 요청합시다:

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

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

optparse에서 지원하는 다른 옵션 형은 intfloat입니다. 정수 인자를 기대하는 옵션은 다음과 같습니다:

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

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

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

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

42를 인쇄합니다.

형을 지정하지 않으면, optparsestring을 가정합니다. 기본 액션이 store라는 사실과 결합하면, 첫 번째 예제를 훨씬 더 짧게 만들 수 있습니다:

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

대상을 제공하지 않으면, optparse는 옵션 문자열에서 합리적인 기본값을 추측합니다: 첫 번째 긴 옵션 문자열이 --foo-bar이면 기본 대상은 foo_bar입니다. 긴 옵션 문자열이 없으면, optparse는 첫 번째 짧은 옵션 문자열을 찾습니다: -f의 기본 대상은 f입니다.

optparse는 내장 complex 형도 포함합니다. 형 추가는 섹션 optparse 확장하기에서 다룹니다.

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

플래그 옵션(특정 옵션이 발견되면 변수를 참이나 거짓으로 설정합니다)은 매우 흔합니다. optparsestore_truestore_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.verboseTrue로 설정합니다; -q를 만나면 options.verboseFalse로 설정됩니다.

다른 액션들

optparse에서 지원하는 다른 액션은 다음과 같습니다:

"store_const"

상숫값을 저장합니다

"append"

이 옵션의 인자를 리스트에 추가합니다

"count"

카운터를 1씩 증가시킵니다

"callback"

지정된 함수를 호출합니다

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

기본값

위의 모든 예에는 특정 명령 줄 옵션을 볼 때 일부 변수 (《대상(destination)》) 설정이 수반됩니다. 이러한 옵션이 나타나지 않으면 어떻게 될까요? 기본값을 제공하지 않아서, 모두 None으로 설정됩니다. 이것은 일반적으로 괜찮지만, 때로는 더 많은 제어가 필요합니다. optparse는 각 대상에 대한 기본값을 제공할 수 있도록 하는데, 명령 줄이 구문 분석되기 전에 대입됩니다.

먼저, verbose/quiet 예를 고려하십시오. -q가 나타나지 않는 한 optparseverboseTrue로 설정하도록 하려면, 다음과 같이 할 수 있습니다:

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의 기능은 사용자 친화적인 명령 줄 인터페이스를 만드는 데 유용합니다. 각 옵션에 대해 help 값을 제공하고, 선택적으로 전체 프로그램에 대한 짧은 사용법 메시지를 제공하기만 하면 됩니다. 다음은 사용자에게 친숙한 (문서화된) 옵션으로 채워진 OptionParser입니다:

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]

(도움말 출력이 help 옵션으로 트리거 되면, optparse가 도움말 텍스트를 인쇄한 후 종료합니다.)

여기에는 optparse가 최상의 도움말 메시지를 생성하는 데 도움이 되는 많은 것들이 있습니다:

  • 스크립트는 자체 사용법 메시지를 정의합니다:

    usage = "usage: %prog [options] arg1 arg2"
    

    optparse는 사용법 문자열의 %prog를 현재 프로그램의 이름, 즉 os.path.basename(sys.argv[0])으로 확장합니다. 확장된 문자열은 자세한 옵션 도움말 앞에 인쇄됩니다.

    사용법 문자열을 제공하지 않으면, optparse는 단순하지만, 합리적인 기본값을 사용합니다: "Usage: %prog [options]", 이는 스크립트가 위치 인자를 취하지 않는다면 괜찮습니다.

  • 모든 옵션은 도움말 문자열을 정의하고, 줄 바꿈에 대해 걱정하지 않습니다—optparse는 줄 바꿈을 처리하고 도움말 출력을 보기 좋게 만듭니다.

  • 값을 취하는 옵션은 자동으로 생성된 도움말 메시지에 이 사실을 나타냅니다, 예를 들어 《mode》 옵션의 경우:

    -m MODE, --mode=MODE
    

    여기서, 《MODE》를 메타 변수(meta-variable)라고 합니다: 사용자가 -m/--mode에 제공할 것으로 기대되는 인자를 나타냅니다. 기본적으로, optparse는 대상 변수 이름을 대문자로 변환하고 이를 메타 변수에 사용합니다. 때로는, 이것이 여러분이 원하는 것이 아닙니다—예를 들어, --filename 옵션은 명시적으로 metavar="FILE"을 설정하여 다음과 같은 자동 생성 옵션 설명을 생성합니다:

    -f FILE, --filename=FILE
    

    이것은 공간을 절약하는 것 이상으로 중요합니다: 수동으로 작성된 도움말 텍스트는 메타 변수 FILE을 사용하여 반 형식 구문 -f FILE과 비형식적 의미 설명 《write output to FILE》 사이에 연결이 있다는 단서를 사용자에게 알려줍니다. 이는 최종 사용자에게 도움말 텍스트를 훨씬 더 명확하고 유용하게 만드는 간단하지만, 효과적인 방법입니다.

  • 기본값이 있는 옵션은 도움말 문자열에 %default를 포함할 수 있습니다—optparse는 이를 옵션 기본값의 str()로 대체합니다. 옵션에 기본값이 없으면 (또는 기본값이 None이면), %defaultnone으로 확장됩니다.

옵션 그룹화하기

많은 옵션을 다룰 때, 더 나은 도움말 출력을 위해 이러한 옵션을 그룹화하는 것이 편리합니다. 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을 반환합니다.

버전 문자열 인쇄하기

간단한 사용법 문자열과 유사하게, optparse는 프로그램의 버전 문자열을 인쇄 할 수도 있습니다. OptionParser에 version 인자로 문자열을 제공해야 합니다:

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

%progusage에서처럼 확장됩니다. 그 외에도, version은 원하는 무엇이든 포함할 수 있습니다. 이를 제공하면, optparse는 자동으로 구문 분석기에 --version 옵션을 추가합니다. 명령 줄에서 이 옵션을 발견하면, (%prog를 대체하여) version 문자열을 확장하고, stdout에 인쇄한 다음, 종료합니다.

예를 들어, 스크립트가 /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()과 같지만 인쇄하는 대신 버전 문자열을 반환합니다.

optparse가 에러를 처리하는 방법

optparse가 걱정해야 할 에러에는 두 가지가 있습니다: 프로그래머 에러와 사용자 에러. 프로그래머 에러는 일반적으로 OptionParser.add_option()에 대한 잘못된 호출입니다, 예를 들어 잘못된 옵션 문자열, 알 수 없는 옵션 어트리뷰트, 누락된 옵션 어트리뷰트 등. 이러한 에러는 일반적인 방식으로 처리됩니다: 예외(optparse.OptionErrorTypeError)를 발생시키고 프로그램이 충돌하도록 합니다.

사용자 에러를 처리하는 것은 훨씬 더 중요합니다, 코드가 아무리 안정적이더라도 발생하는 것이 보장되기 때문입니다. optparse는 잘못된 옵션 인자 (-n이 정수 인자를 취할 때 -n 4x 전달), 누락된 인자(-n이 모든 형의 인자를 취할 때, 명령 줄 끝의 -n)와 같은 일부 사용자 에러를 자동으로 감지할 수 있습니다. 또한, OptionParser.error()를 호출하여 응용 프로그램 정의 에러 조건을 알릴 수 있습니다:

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

두 경우 모두, optparse는 같은 방식으로 에러를 처리합니다: 프로그램의 사용법 메시지와 에러 메시지를 표준 에러에 인쇄하고 에러 상태 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-생성 에러 메시지는 항상 에러와 관련된 옵션을 언급하도록 주의를 기울입니다; 응용 프로그램 코드에서 OptionParser.error()를 호출할 때도 그래야 합니다.

optparse의 기본 에러 처리 동작이 여러분의 요구에 맞지 않으면, OptionParser를 서브 클래스 화하고 exit() 및/또는 error() 메서드를 재정의해야 합니다.

모두 합치기

일반적으로 optparse 기반 스크립트는 다음과 같습니다:

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()

레퍼런스 지침서

구문 분석기 만들기

optparse를 사용하는 첫 번째 단계는 OptionParser 인스턴스를 만드는 것입니다.

class optparse.OptionParser(...)

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

usage (기본값: "%prog [options]")

프로그램이 잘못 실행되거나 도움말(help) 옵션을 사용할 때 인쇄할 사용법 요약. optparse가 사용법 문자열을 인쇄할 때, %progos.path.basename(sys.argv[0])(또는 해당 키워드 인자를 전달한 경우 prog)으로 확장합니다. 사용법 메시지를 표시하지 않으려면, 특수 값 optparse.SUPPRESS_USAGE를 전달하십시오.

option_list (기본값: [])

구문 분석기를 채울 Option 객체 리스트. option_list의 옵션은 standard_option_list(OptionParser 서브 클래스에서 설정할 수 있는 클래스 어트리뷰트)의 모든 옵션 뒤에 추가되지만, 모든 버전(version) 또는 도움말(help) 옵션 앞에 추가됩니다. 폐지되었습니다; 대신 구문 분석기를 만든 후 add_option()을 사용하십시오.

option_class (기본값: optparse.Option)

add_option()에서 구문 분석기에 옵션을 추가할 때 사용할 클래스.

version (기본값: None)

사용자가 버전(version) 옵션을 제공할 때 인쇄 할 버전 문자열. version에 참값을 제공하면, optparse는 단일 옵션 문자열 --version으로 버전 옵션을 자동으로 추가합니다. 하위 문자열 %progusage와 마찬가지로 확장됩니다.

conflict_handler (기본값: "error")

충돌하는 옵션 문자열이 있는 옵션이 구문 분석기에 추가될 때 수행 할 작업을 지정합니다; 섹션 옵션 간의 충돌을 참조하십시오.

description (기본값: None)

프로그램에 대한 간략한 개요를 제공하는 텍스트 단락. optparse는 현재 터미널 너비에 맞게 이 단락을 다시 포맷하고 사용자가 도움말을 요청할 때 인쇄합니다 (usage 이후, 옵션 목록 이전).

formatter (기본값: 새 IndentedHelpFormatter)

도움말 텍스트를 인쇄하는 데 사용될 optparse.HelpFormatter의 인스턴스. optparse는 이 목적으로 두 개의 구상 클래스를 제공합니다: IndentedHelpFormatter 와 TitledHelpFormatter.

add_help_option (기본값: True)

참이면, optparse는 구문 분석기에 도움말 옵션(옵션 문자열 -h--help)을 추가합니다.

prog

usageversion에서 %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 인스턴스를 만드는 규범적 방법은 OptionParseradd_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 객체의 어트리뷰트를 정의합니다. 가장 중요한 옵션 어트리뷰트는 action이며, 전체적으로 어떤 어트리뷰트가 관련성이 있거나 필요한지를 결정합니다. 관련 없는 옵션 어트리뷰트를 전달하거나, 필수 어트리뷰트를 전달하지 못하면, optparse는 실수를 설명하는 OptionError 예외를 발생시킵니다.

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

"store"

이 옵션의 인자를 저장합니다 (기본값)

"store_const"

상숫값을 저장합니다

"store_true"

True를 저장합니다

"store_false"

False를 저장합니다

"append"

이 옵션의 인자를 리스트에 추가합니다

"append_const"

리스트에 상숫값을 추가합니다

"count"

카운터를 1씩 증가시킵니다

"callback"

지정된 함수를 호출합니다

"help"

모든 옵션과 해당 설명을 포함하는 사용법 메시지를 인쇄합니다

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

보시다시피, 대부분의 액션은 값을 어딘가에 저장하거나 갱신하는 것을 수반합니다. optparse는 항상 이를 위해 일반적으로 options(optparse.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"

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

옵션 어트리뷰트

다음 옵션 어트리뷰트는 OptionParser.add_option()에 키워드 인자로 전달될 수 있습니다. 특정 옵션과 관련이 없는 옵션 어트리뷰트를 전달하거나, 필수 옵션 어트리뷰트를 전달하지 못하면 optparseOptionError를 발생시킵니다.

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-barfoo_bar를 암시합니다). 긴 옵션 문자열이 없으면, optparse는 첫 번째 짧은 옵션 문자열에서 대상을 파생합니다 (예를 들어, -ff를 암시합니다).

    예:

    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]

    constdest에 저장됩니다.

    예:

    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]

    Truedest에 저장하는 "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에 추가됩니다.

    typedest의 기본값은 "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
    
    # usually, a help option is added automatically, but that can
    # be suppressed using the add_help_option argument
    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
    

    도움말 메시지를 인쇄한 후, optparsesys.exit(0)으로 프로세스를 종료합니다.

  • "version"

    OptionParser에 제공된 버전 번호를 stdout에 인쇄하고 종료합니다. 버전 번호는 실제로 OptionParser의 print_version() 메서드에 의해 포맷되고 인쇄됩니다. 일반적으로 version 인자가 OptionParser 생성자에 제공되는 경우에만 의미가 있습니다. help 옵션과 마찬가지로, optparse는 필요할 때 자동으로 추가하기 때문에, version 옵션을 거의 만들지 않습니다.

표준 옵션 형

optparse에는 다섯 가지 내장 옵션 형이 있습니다: "string", "int", "choice", "float""complex". 새로운 옵션 형을 추가해야 하면, 섹션 optparse 확장하기를 참조하십시오.

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

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

  • 숫자가 0x로 시작하면, 16진수로 구문 분석됩니다

  • 숫자가 0으로 시작하면, 8진수로 구문 분석됩니다

  • 숫자가 0b로 시작하면, 이진수로 구문 분석됩니다

  • 그렇지 않으면, 숫자는 10진수로 구문 분석됩니다

변환은 적절한 진수(2, 8, 10 또는 16)로 int()를 호출하여 수행됩니다. 이것이 실패하면, 더 유용한 에러 메시지를 제공하기는 하지만, optparse도 마찬가지로 실패합니다.

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

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

인자 구문 분석하기

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

(options, args) = parser.parse_args(args=None, values=None)

여기서 입력 매개 변수는

args

처리할 인자의 리스트 (기본값: sys.argv[1:])

values

옵션 인자를 저장할 optparse.Values 객체 (기본값: Values의 새 인스턴스) – 기존 객체를 제공하면, 옵션 기본값이 초기화되지 않습니다.

그리고 반환 값은

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)

OptionParseropt_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은 사용자가 해당 옵션을 활성화하는 유일한 방법입니다. 사용자가 help를 요청하면, 도움말 메시지에 이것이 반영됩니다:

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")    # overridden below
parser.add_option("--novice", action="store_const",
                  dest="mode", const="novice",
                  default="advanced")  # overrides above setting

이러한 혼동을 피하려면, 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의 내장 액션과 형이 여러분의 필요에 충분하지 않으면, 두 가지 선택이 있습니다: 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_argscallback_kwargs를 통해 지정하는 경우에만 추가 인자를 전달합니다. 따라서 최소 콜백 함수 서명은 다음과 같습니다:

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

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

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

type

일반적인 의미를 갖습니다: "store""append" 액션과 마찬가지로, optparse에게 하나의 인자를 소비하고 이를 type으로 변환하도록 지시합니다. 그러나 optparse는 변환된 값을 어딘가에 저장하는 대신 콜백 함수에 전달합니다.

nargs

역시 일반적인 의미를 갖습니다: 제공되고 > 1 이면, optparsenargs 인자를 소비하며 각 인자는 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

명령 줄에 나타난 이 옵션에 대한 인자입니다. optparsetype이 설정되었을 때만 인자를 기대합니다; value의 형은 옵션의 형이 암시하는 형입니다. 이 옵션의 typeNone(기대하는 인자 없음)이면, valueNone이 됩니다. nargs > 1 이면, value는 적절한 형의 값의 튜플이 됩니다.

parser

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

parser.largs

남은 인자의 현재 리스트, 즉, 소비되었지만 옵션이나 옵션 인자가 아닌 인자. 예를 들어 더 많은 인자를 추가하여, parser.largs를 자유롭게 수정하십시오. (이 리스트는 parse_args()의 두 번째 반환 값인 args가 됩니다.)

parser.rargs

나머지 인자의 현재 리스트, 즉, opt_strvalue(해당한다면)가 제거되고, 그 뒤에 오는 인자만 그대로 남아 있습니다. 예를 들어 더 많은 인자를 소비하여, parser.rargs를 자유롭게 수정하십시오.

parser.values

옵션값이 기본적으로 저장되는 객체 (optparse.OptionValues의 인스턴스). 이를 통해 콜백은 옵션값을 저장하기 위해 나머지 optparse와 같은 메커니즘을 사용할 수 있습니다; 전역이나 클로저를 엉망으로 만들 필요가 없습니다. 명령 줄에서 이미 발견된 모든 옵션의 값에 액세스하거나 수정할 수도 있습니다.

args

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

kwargs

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

콜백에서 에러 발생시키기

옵션이나 인자에 문제가 있으면 콜백 함수는 OptionValueError 를 발생시켜야 합니다. 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는 이것을 위한 내장 기능을 제공하지 않아서 콜백을 작성해야 합니다. 그리고 optparse가 일반적으로 처리하는 전통적인 유닉스 명령 줄 구문 분석의 복잡한 문제를 여러분이 처리해야 합니다. 특히, 콜백은 날(bare) --- 인자에 대한 전통적인 규칙을 구현해야 합니다:

  • ---는 옵션 인자가 될 수 있습니다

  • -- (어떤 옵션에 대한 인자가 아닌 경우): 명령 줄 처리를 중단하고 --를 버립니다

  • - (어떤 옵션에 대한 인자가 아닌 경우): 명령 줄 처리를 중지하지만 -는 유지합니다 (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:
        # stop on --foo like options
        if arg[:2] == "--" and len(arg) > 2:
            break
        # stop on -a, but not on -3 or -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가 명령 줄 옵션을 해석하는 방법의 두 가지 주요 제어 요소는 각 옵션의 액션과 형이므로, 확장 방향은 새 액션과 새 형을 추가하는 것입니다.

새로운 형 추가하기

새로운 형을 추가하려면, optparseOption 클래스의 여러분 자신의 서브 클래스를 정의해야 합니다. 이 클래스에는 optparse의 형을 정의하는 몇 가지 어트리뷰트가 있습니다: TYPESTYPE_CHECKER.

Option.TYPES

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

Option.TYPE_CHECKER

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

def check_mytype(option, opt, value)

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

형 검사 함수는 문제가 발생하면 OptionValueError 를 발생시켜야 합니다. OptionValueErrorOptionParsererror() 메서드에 있는 그대로 전달되는 단일 문자열 인자를 취하며, 이는 차례로 프로그램 이름과 문자열 "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_CHECKERcopy()를 만들지 않았다면, 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

항상 형을 취하는 액션(즉, 옵션이 항상 값을 취하는 액션)이 여기에 추가로 나열됩니다. 이것의 유일한 효과는 optparseALWAYS_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_ACTIONSTYPED_ACTIONS 모두에 들어갑니다.

  • optparse가 기본형 "string""extend" 액션에 대입하도록 하기 위해, 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)
    

    valuesattr 어트리뷰트가 존재하지 않거나 None이면, ensure_value()는 먼저 이를 value로 설정한 다음, value를 반환합니다. 이것은 "extend", "append""count"와 같은 액션에 매우 편리합니다. 이 액션들은 모두 변수에 데이터를 누적하고 해당 변수가 특정 형(처음 두 개는 리스트, 마지막은 정수)이 될 것으로 기대합니다. ensure_value()를 사용한다는 것은 액션을 사용하는 스크립트가 문제의 옵션 대상에 대한 기본값 설정에 대해 걱정할 필요가 없음을 의미합니다; 기본값을 None으로 그대로 둘 수 있으며 ensure_value()는 필요할 때 올바르게 처리합니다.