Python怎样构建命令行工具？click库最佳实践

click

argparse

import click

@click.command()
@click.argument('name')
@click.option('--greeting', default='Hello', help='A custom greeting.')
def greet(name, greeting):
    """
    一个简单的问候工具。
    """
    click.echo(f"{greeting}, {name}!")

if __name__ == '__main__':
    greet()

python your_script.py John

python your_script.py --greeting "你好" Alice

click.argument

click.option

parser.add_argument

click.group

git commit

git push

import click

@click.group()
def cli():
    """一个简单的CLI工具集。"""
    pass

@cli.command()
@click.argument('name')
def create(name):
    """创建一个新条目。"""
    click.echo(f"正在创建: {name}...")

@cli.command()
@click.argument('name')
@click.option('--force', is_flag=True, help='强制删除。')
def delete(name, force):
    """删除一个条目。"""
    if force:
        click.echo(f"强制删除: {name}!")
    else:
        click.echo(f"删除: {name}...")

if __name__ == '__main__':
    cli()

python your_script.py create item1

python your_script.py delete item2 --force

click.MissingParameter

import click

@click.command()
@click.option('--count', type=int, help='一个整数计数。')
def process(count):
    if count is None:
        click.echo("没有提供计数。")
    else:
        click.echo(f"计数是: {count}")

if __name__ == '__main__':
    process()

python your_script.py --count abc

ValueError

try-except

callback

import click

def validate_port(ctx, param, value):
    if not 1024 <= value <= 65535:
        raise click.BadParameter('端口号必须在1024到65535之间。')
    return value

@click.command()
@click.option('--port', type=int, callback=validate_port, help='一个有效的端口号。')
def start_server(port):
    click.echo(f"服务器正在端口 {port} 上启动...")

if __name__ == '__main__':
    start_server()

validate_port

--port

start_server

click.confirm

click.prompt

@cli.command()

cli.add_command()

click.Group.add_command()

cli

users.py

projects.py

main.py

import click
from .commands import users, projects # 假设commands是一个包

@click.group()
@click.version_option(version='1.0.0')
def cli():
    """我的超级命令行工具。"""
    pass

cli.add_command(users.users_group) # users_group可能是users.py里的一个click.Group
cli.add_command(projects.projects_group)

if __name__ == '__main__':
    cli()

commands/users.py

import click

@click.group(name='users')
def users_group():
    """管理用户。"""
    pass

@users_group.command(name='add')
@click.argument('username')
def add_user(username):
    """添加一个新用户。"""
    click.echo(f"添加用户: {username}")

@users_group.command(name='list')
def list_users():
    """列出所有用户。"""
    click.echo("列出所有用户...")

Context

@click.pass_context

ctx.obj

import click

@click.group()
@