Typer vs传统CLI:Python开发者的新选择与最佳实践

import typerdef main(name: str, count: int = 1):    """问候指定次数"""    for _ in range(count):        typer.echo(f"Hello, {name}!")if __name__ == "__main__":    typer.run(main)

# 基础安装pip install typer# 完整安装（包括所有依赖）pip install "typer[all]"

# main.pyimport typerdef main(name: str):    """一个简单的问候程序"""    typer.echo(f"你好, {name}!")if __name__ == "__main__":    typer.run(main)

# 查看帮助python main.py --help# 执行命令python main.py 张三

from typer import Typerapp = Typer()@app.command()def hello(name: str):    """问候命令"""    typer.echo(f"Hello, {name}!")@app.command()def bye(name: str, formal: bool = False):    """告别命令"""    if formal:        typer.echo(f"Goodbye, Ms. {name}.")    else:        typer.echo(f"Bye, {name}!")if __name__ == "__main__":    app()

@app.command()def process_file(filename: str):    """处理指定文件"""    typer.echo(f"正在处理: {filename}")

@app.command()def serve(    host: str = typer.Option("127.0.0.1", help="服务器地址"),    port: int = typer.Option(8000, help="端口号"),    debug: bool = typer.Option(False, help="调试模式")):    """启动服务器"""    typer.echo(f"启动服务器: {host}:{port}, 调试={debug}")

from typing import List, Optionalfrom pathlib import Path@app.command()def analyze(    files: List[Path] = typer.Argument(..., help="要分析的文件列表"),    output: Optional[Path] = typer.Option(None, help="输出文件"),    verbose: int = typer.Option(0, "--verbose", "-v", count=True)):    """分析文件"""    for file in files:        typer.echo(f"分析: {file}")

# 主应用main_app = Typer(help="我的工具集")# 数据库子命令组db_app = Typer(help="数据库操作")main_app.add_typer(db_app, name="db")@db_app.command()def init():    """初始化数据库"""    typer.echo("数据库初始化完成")@db_app.command()def migrate():    """执行数据库迁移"""    typer.echo("数据库迁移完成")# 用户子命令组user_app = Typer(help="用户管理")main_app.add_typer(user_app, name="user")@user_app.command()def create(username: str):    """创建用户"""    typer.echo(f"用户 {username} 创建成功")if __name__ == "__main__":    main_app()

from typer import Typerfrom rich.console import Consolefrom rich.table import Tablefrom rich.progress import Progressapp = Typer()console = Console()@app.command()def show_data():    """以表格形式展示数据"""    table = Table(title="项目列表")    table.add_column("名称", style="cyan")    table.add_column("状态", style="magenta")    table.add_column("进度", justify="right", style="green")    table.add_row("项目A", "进行中", "75%")    table.add_row("项目B", "已完成", "100%")    table.add_row("项目C", "待开始", "0%")    console.print(table)@app.command()def process():    """带进度条的处理"""    with Progress() as progress:        task = progress.add_task("[green]处理中...", total=100)        while not progress.finished:            progress.update(task, advance=1)    console.print("[bold green]处理完成![/bold green]")

import argparseparser = argparse.ArgumentParser(description='文件处理工具')parser.add_argument('input_file', help='输入文件')parser.add_argument('--output', '-o', help='输出文件', default=None)parser.add_argument('--verbose', '-v', action='store_true', help='详细模式')args = parser.parse_args()if args.verbose:    print(f"处理文件: {args.input_file}")if args.output:    print(f"输出到: {args.output}")

import typerdef process(    input_file: str,    output: str = typer.Option(None, "--output", "-o"),    verbose: bool = typer.Option(False, "--verbose", "-v")):    """处理文件"""    if verbose:        typer.echo(f"处理文件: {input_file}")    if output:        typer.echo(f"输出到: {output}")if __name__ == "__main__":    typer.run(process)

from typer import Typerfrom typing import Listimport pandas as pdapp = Typer(help="数据处理工具")@app.command()def process_csv(    input_file: str,    output_file: str,    columns: List[str] = typer.Option(None, "--col", help="选择列"),    filter_col: str = typer.Option(None, help="过滤列"),    filter_value: str = typer.Option(None, help="过滤值")):    """处理CSV文件"""    df = pd.read_csv(input_file)    if columns:        df = df[columns]    if filter_col and filter_value:        df = df[df[filter_col] == filter_value]    df.to_csv(output_file, index=False)    typer.echo(f"处理完成，输出到: {output_file}")

from typer import Typer, Contextfrom pathlib import Pathimport subprocessapp = Typer(help="部署工具")@app.callback()def callback(ctx: Context, env: str = "dev"):    """全局配置"""    ctx.ensure_object(dict)    ctx.obj['env'] = env@app.command()def build(ctx: Context):    """构建项目"""    env = ctx.obj['env']    typer.echo(f"在 {env} 环境下构建...")    # 执行构建命令    subprocess.run(["docker", "build", "-t", f"myapp:{env}", "."])@app.command()def deploy(ctx: Context, server: str = typer.Option(..., help="目标服务器")):    """部署项目"""    env = ctx.obj['env']    typer.echo(f"部署到 {env} 环境的 {server} 服务器...")    # 执行部署逻辑    pass@app.command()def rollback(ctx: Context, version: str = typer.Option(..., help="回滚版本")):    """回滚版本"""    env = ctx.obj['env']    typer.echo(f"在 {env} 环境下回滚到版本 {version}...")    # 执行回滚逻辑    pass

from typer import Typerimport requestsapp = Typer(help="API客户端工具")BASE_URL = "https://api.example.com"@app.command()def list_users(limit: int = 10):    """列出用户"""    response = requests.get(f"{BASE_URL}/users", params={"limit": limit})    users = response.json()    for user in users:        typer.echo(f"ID: {user['id']}, Name: {user['name']}")@app.command()def get_user(user_id: int):    """获取用户详情"""    response = requests.get(f"{BASE_URL}/users/{user_id}")    user = response.json()    typer.echo(f"用户: {user['name']}")    typer.echo(f"邮箱: {user['email']}")@app.command()def create_user(name: str, email: str):    """创建用户"""    response = requests.post(        f"{BASE_URL}/users",        json={"name": name, "email": email}    )    user = response.json()    typer.echo(f"用户创建成功: ID {user['id']}")

my-cli-tool/├── my_cli/│   ├── init.py│   ├── main.py          # 主入口│   ├── commands/        # 命令模块│   │   ├── init.py│   │   ├── db.py        # 数据库命令│   │   └── user.py      # 用户命令│   ├── utils.py         # 工具函数│   └── config.py        # 配置管理├── tests/               # 测试├── setup.py             # 安装配置└── README.md            # 文档

from typer import Exit@app.command()def risky_operation(force: bool = False):    """有风险的操作"""    try:        # 执行操作        pass    except FileNotFoundError:        typer.echo("错误: 文件不存在", err=True)        raise Exit(code=1)    except PermissionError:        typer.echo("错误: 权限不足", err=True)        if not force:            raise Exit(code=1)        # 强制执行

from typer.testing import CliRunnerfrom my_cli.main import apprunner = CliRunner()def test_hello():    result = runner.invoke(app, ["hello", "张三"])    assert result.exit_code == 0    assert "Hello, 张三!" in result.stdoutdef test_bye_formal():    result = runner.invoke(app, ["bye", "李四", "--formal"])    assert result.exit_code == 0    assert "Goodbye, Ms. 李四." in result.stdout

def validate_age(value: int):    if value < 0 or value > 120:        raise typer.BadParameter("年龄必须在 0-120 之间")    return value@app.command()def register(age: int = typer.Option(..., callback=validate_age)):    """注册用户"""    typer.echo(f"注册成功，年龄: {age}")

def check_options(ctx: typer.Context):    if ctx.obj.get("verbose"):        typer.echo("详细模式已启用")@app.command()def process(    verbose: bool = typer.Option(False, callback=check_options)):    """处理数据"""    typer.echo("处理完成")

# Bashpython main.py --install-completion bash# Zshpython main.py --install-completion zsh# Fishpython main.py --install-completion fish

@app.command()def greet(    name: str,    lang: str = typer.Option("zh", help="语言: zh/en/es")):    """多语言问候"""    greetings = {        "zh": f"你好, {name}!",        "en": f"Hello, {name}!",        "es": f"¡Hola, {name}!"    }    typer.echo(greetings.get(lang, greetings["zh"]))

# setup.pyfrom setuptools import setup, find_packagessetup(    name="my-cli-tool",    version="0.1.0",    packages=find_packages(),    install_requires=[        "typer[all]>=0.7.0",    ],    entry_points={        "console_scripts": [            "mycli=my_cli.main:app",        ],    },)

import configparserfrom pathlib import Pathdef load_config():    config = configparser.ConfigParser()    config_path = Path.home() / ".config" / "mycli" / "config.ini"    if config_path.exists():        config.read(config_path)    return config@app.command()def run():    """运行命令"""    config = load_config()    # 使用配置

import loggingdef setup_logging(verbose: bool):    level = logging.DEBUG if verbose else logging.INFO    logging.basicConfig(        level=level,        format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'    )@app.command()def process(verbose: bool = False):    """处理数据"""    setup_logging(verbose)    logger = logging.getLogger(__name__)    logger.info("开始处理...")    logger.debug("调试信息")