Python 스크립트의 커맨드라인 실행 및 옵션 상세 설명

import sys

if __name__ == "__main__":
    print("Script name:", sys.argv[0])
    print("Arguments:", sys.argv[1:])

Script name: script.py
Arguments: ['arg1', 'arg2']

import argparse

if __name__ == "__main__":
    # ArgumentParser 객체 생성
    parser = argparse.ArgumentParser(description="기본적인 인수 분석 예시")

    # 인수 추가
    parser.add_argument("name", help="사용자 이름을 지정해주세요")
    parser.add_argument("--age", type=int, help="나이를 지정해주세요")

    # 인수 분석
    args = parser.parse_args()

    # 결과 출력
    print(f"Hello, {args.name}!")
    if args.age:
        print(f"Your age is {args.age}.")

python script.py Alice --age 30

Hello, Alice!
Your age is 30.

import argparse

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="옵션 인수의 기본 예시")

    # 옵션 인수 추가
    parser.add_argument("--verbose", action="store_true", help="자세한 정보를 출력합니다.")
    parser.add_argument("--output", type=str, help="출력 파일명을 지정합니다.")

    args = parser.parse_args()

    if args.verbose:
        print("Verbose 모드가 활성화되었습니다.")
    if args.output:
        print(f"출력 파일: {args.output}")

python script.py --verbose --output result.txt

Verbose 모드가 활성화되었습니다.
출력 파일: result.txt

parser.add_argument("--count", type=int, help="처리할 횟수를 지정합니다.")

parser.add_argument("--level", type=int, default=1, help="처리 수준을 지정합니다 (기본값: 1)")

parser.add_argument("--config", required=True, help="설정 파일을 지정해주세요.")

parser.add_argument("--debug", action="store_true", help="디버그 모드를 활성화합니다.")

import argparse

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="필수 인수 예시")

    # 필수 옵션 추가
    parser.add_argument("--config", required=True, help="설정 파일을 지정해주세요.")

    args = parser.parse_args()
    print(f"설정 파일: {args.config}")

python script.py

usage: script.py --config CONFIG
script.py: error: the following arguments are required: --config

python script.py --config settings.json
설정 파일: settings.json

import argparse

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="기본값 예시")

    # 기본값이 있는 옵션
    parser.add_argument("--log-level", default="INFO", help="로그 수준을 설정합니다 (기본값: INFO)")

    args = parser.parse_args()
    print(f"로그 레벨: {args.log_level}")

python script.py
로그 레벨: INFO

python script.py --log-level DEBUG
로그 레벨: DEBUG

parser.add_argument("filename", help="대상 파일명을 지정해주세요.")

import argparse

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="도움말 메시지 예시")
    parser.add_argument("--input", help="입력 파일을 지정합니다.")
    parser.add_argument("--output", help="출력 파일을 지정합니다.")
    parser.add_argument("--verbose", action="store_true", help="자세한 모드를 활성화합니다.")

    args = parser.parse_args()

python script.py --help

usage: script.py [-h] [--input INPUT] [--output OUTPUT] [--verbose]

도움말 메시지 예시

options:
  -h, --help       이 도움말 메시지를 표시하고 종료합니다.
  --input INPUT    입력 파일을 지정합니다.
  --output OUTPUT  출력 파일을 지정합니다.
  --verbose        자세한 모드를 활성화합니다.

parser = argparse.ArgumentParser(description="이 스크립트는 파일을 처리합니다.")

parser.add_argument("--input", help="처리할 입력 파일을 지정합니다.")

parser = argparse.ArgumentParser(
    description="도움말 메시지 예시",
    epilog="예: python script.py --input file.txt --output result.txt"
)

import argparse

if __name__ == "__main__":
    parser = argparse.ArgumentParser(
        description="파일을 처리하는 스크립트입니다.",
        epilog="예: python script.py --input in.txt --output out.txt"
    )
    parser.add_argument("--input", required=True, help="입력 파일을 지정해주세요.")
    parser.add_argument("--output", required=True, help="출력 파일을 지정해주세요.")
    parser.add_argument("--verbose", action="store_true", help="자세한 정보를 출력합니다.")

    args = parser.parse_args()

usage: script.py [-h] --input INPUT --output OUTPUT [--verbose]

파일을 처리하는 스크립트입니다.

options:
  -h, --help       이 도움말 메시지를 표시하고 종료합니다.
  --input INPUT    입력 파일을 지정해주세요.
  --output OUTPUT  출력 파일을 지정해주세요.
  --verbose        자세한 정보를 출력합니다.

예: python script.py --input in.txt --output out.txt

import argparse

if __name__ == "__main__":
    # 메인 ArgumentParser 객체 생성
    parser = argparse.ArgumentParser(description="서브 커맨드 예시")

    # 서브 커맨드를 관리하는 subparsers 생성
    subparsers = parser.add_subparsers(dest="command", help="사용 가능한 커맨드")

    # 'add' 서브 커맨드 정의
    parser_add = subparsers.add_parser("add", help="항목을 추가합니다.")
    parser_add.add_argument("item", help="추가할 항목의 이름")

    # 'delete' 서브 커맨드 정의
    parser_delete = subparsers.add_parser("delete", help="항목을 삭제합니다.")
    parser_delete.add_argument("item", help="삭제할 항목의 이름")

    # 인수 분석
    args = parser.parse_args()

    # 서브 커맨드별 처리
    if

 args.command == "add":
        print(f"항목 '{args.item}' 추가됨")
    elif args.command == "delete":
        print(f"항목 '{args.item}' 삭제됨")
    else:
        parser.print_help()

python script.py add "Task 1"

항목 'Task 1' 추가됨

python script.py delete "Task 1"

항목 'Task 1' 삭제됨

# 'add' 서브 커맨드에 설명을 추가하는 옵션
parser_add.add_argument("--description", help="항목 설명을 지정합니다.")

# 'delete' 서브 커맨드에 확인용 플래그 추가
parser_delete.add_argument("--force", action="store_true", help="확인 없이 삭제합니다.")

python script.py add "Task 2" --description "This is a new task"

python script.py delete "Task 2" --force

pip install click

import click

@click.command()
@click.option("--name", prompt="Your name", help="사용자 이름을 지정합니다.")
@click.option("--age", default=25, help="나이를 지정합니다 (기본값: 25)")
def greet(name, age):
    """인사 메시지를 출력합니다"""
    click.echo(f"Hello, {name}! You are {age} years old.")

if __name__ == "__main__":
    greet()

python script.py --name Alice --age 30

Hello, Alice! You are 30 years old.

import click

@click.group()
def cli():
    """여러 커맨드를 관리합니다"""
    pass

@click.command()
@click.argument("item")
def add(item):
    """항목을 추가합니다"""
    click.echo(f"항목 '{item}' 추가됨")

@click.command()
@click.argument("item")
def delete(item):
    """항목을 삭제합니다"""
    click.echo(f"항목 '{item}' 삭제됨")

cli.add_command(add)
cli.add_command(delete)

if __name__ == "__main__":
    cli()

python script.py add "Task 1"
python script.py delete "Task 1"

항목 'Task 1' 추가됨  
항목 'Task 1' 삭제됨

@click.command()
@click.argument("number", type=int)
def square(number):
    """지정된 숫자의 제곱을 계산합니다"""
    if number < 0:
        raise click.BadParameter("양의 수를 지정해주세요.")
    click.echo(f"{number}의 제곱은 {number**2}입니다.")

if __name__ == "__main__":
    square()

tool.py add "task name" --priority high
tool.py delete "task name" --force

parser = argparse.ArgumentParser(
    description="작업 관리 도구",
    epilog="사용 예시: python tool.py add 'task' --priority high"
)

@click.command()
@click.argument("number", type=int)
def square(number):
    if number < 0:
        raise click.BadParameter("음수는 지원되지 않습니다.")
    click.echo(f"{number}의 제곱은 {number**2}입니다.")

project/
├── cli.py        # 커맨드라인 인터페이스
├── commands/
│   ├── add.py    # 'add' 커맨드
│   ├── delete.py # 'delete' 커맨드
│   └── __init__.py
├── utils.py      # 보조 함수
└── main.py       # 엔트리 포인트

from click.testing import CliRunner
from my_tool import cli

def test_add_command():
    runner = CliRunner()
    result = runner.invoke(cli, ["add", "Task 1"])
    assert result.exit_code == 0
    assert "Task 1 추가됨" in result.output

from setuptools import setup

setup(
    name="my_tool",
    version="1.0",
    py_modules=["tool"],
    install_requires=["click"],
    entry_points={
        "console_scripts": [
            "tool=tool:cli",
        ],
    },
)