Argparse는 파이썬 표준 라이브러리에 포함된 모듈로, 명령행 인자를 쉽게 처리할 수 있는 도구입니다. 이번 포스트에서는 Argparse를 사용하여 주석과 문서화를 어떻게 추가할 수 있는지 알아보겠습니다.

Argparse 기본 사용법

먼저 Argparse를 사용하기 위해 argparse 모듈을 임포트해야 합니다.

import argparse

다음으로 ArgumentParser 객체를 생성하여 명령행 인자 파싱에 대한 정보를 설정합니다.

parser = argparse.ArgumentParser(description='My awesome program')

description 매개변수는 프로그램에 대한 간단한 설명을 제공하는 문자열입니다.

그리고 명령행 인자를 추가할 수 있습니다. 가장 간단한 형태는 add_argument() 메서드를 사용하는 것입니다.

parser.add_argument('filename', help='the input filename')

위의 코드는 “filename” 이라는 위치 인자를 추가하고, 해당 인자에 대한 설명을 제공합니다.

명령행 인자는 -- 혹은 -로 시작하는 옵션으로도 추가할 수 있습니다. add_argument() 메서드의 dest 매개변수에 저장될 변수명을 지정해야 합니다.

parser.add_argument('-v', '--verbose', dest='verbose', action='store_true',
                    help='enable verbose logging')

위의 코드는 “-v” 혹은 “–verbose” 옵션을 추가하고, 해당 옵션이 주어지면 verbose 변수에 True 값을 저장합니다. 옵션이 주어지지 않으면 False 로 설정됩니다.

주석 추가하기

Argparse를 사용할 때, 주석을 추가하면 코드를 이해하기 쉽고 가독성을 높일 수 있습니다. 파이썬에서는 # 기호를 사용하여 한 줄 주석을 작성할 수 있습니다.

parser = argparse.ArgumentParser(description='My awesome program')

위의 코드는 ArgumentParser 객체를 생성하고, 해당 객체에 대한 주석을 작성한 예입니다.

한 줄 주석 외에도 여러 줄 주석을 작성할 수도 있습니다. 여러 줄 주석은 ''' 혹은 """로 시작하고 끝나는 문자열로 작성됩니다.

"""
This is a multi-line comment
that provides more details about
the purpose of the program.
"""

위의 코드는 여러 줄의 주석을 작성한 예시입니다.

문서화 추가하기

Argparse를 사용하여 명령행 인자를 처리하는 코드를 다른 사람들과 공유하거나 문서화해야 할 때, 도움말 옵션을 추가하는 것이 유용합니다. 도움말 옵션은 기본적으로 -h 혹은 --help로 제공되며, 프로그램의 사용법과 명령행 인자에 대한 정보를 출력합니다.

Argparse는 add_help=True로 설정된 기본 도움말 옵션을 제공합니다. 따라서 별도로 도움말 옵션을 추가할 필요는 없습니다.

parser = argparse.ArgumentParser(description='My awesome program', add_help=True)

위의 코드는 기본 도움말 옵션을 추가한 예시입니다.

명령행 인자에 대한 추가적인 정보를 제공하려면 add_argument() 메서드의 help 매개변수에 해당 내용을 작성하면 됩니다.

parser.add_argument('filename', help='the input filename')

위의 코드는 “filename” 이라는 위치 인자에 대한 도움말을 추가한 예시입니다.

결론

Argparse는 파이썬에서 명령행 인자 처리를 간편하게 도와주는 라이브러리입니다. 주석과 문서화를 함께 사용하면 다른 개발자들이 코드를 이해하고 사용할 때 도움이 되며, 프로그램의 사용법을 명확하게 전달할 수 있습니다. Argparse의 다양한 기능을 사용하여 명령행 인자 처리를 자유롭게 활용해보세요!