如何使用Python Click库通过正则表达式校验命令行参数

现有代码里要给name参数加正则校验，有两种最常用的实现路径，按需选择即可：

自定义可复用的正则校验类型 #

这是Click框架推荐的可复用校验实现方式，适合多个命令、多个参数要共用同一套正则规则的场景，封装好之后可以直接复用在任何参数的type属性上。
首先写一个继承click.ParamType的自定义类，把正则规则、错误提示封装进去：

import re
import click

class RegexParam(click.ParamType):
    def __init__(self, pattern: str, error_msg: str):
        self.regex = re.compile(pattern)
        self.error_msg = error_msg
        self.name = f"regex:{pattern}"

    def convert(self, value: str, param, ctx):
        # 用fullmatch做全字符串匹配，别用match，不然会漏判尾部的非法字符
        if not self.regex.fullmatch(value):
            self.fail(self.error_msg, param, ctx)
        return value

# 按业务规则实例化校验器，比如要求name是3-16位字母、数字、下划线组合
name_rule = RegexParam(
    pattern=r"^[a-zA-Z0-9_]{3,16}$",
    error_msg="name格式错误：必须是3-16位字母、数字、下划线组合"
)

之后直接把这个校验器实例传给@click.option的type参数就行，原来的create函数一行都不用改：

@click.command()
@click.option(
    "-n", "--name",
    required=True,
    type=name_rule,
    help="..."
)
def create(name: str):
    # 走到这里的name肯定是符合正则规则的，直接使用即可
    click.echo(f"创建项目 {name} 成功")

轻量回调校验 #

如果这个正则规则只给当前name参数用，不需要复用，那写个回调函数绑在option上就行，改动量最小。
直接在现有代码上加上回调逻辑就可以运行：

import re
import click

# 自定义业务正则规则
NAME_PATTERN = re.compile(r"^[a-zA-Z0-9_]{3,16}$")

def check_name(ctx, param, value):
    # required=True的参数空值会被框架提前拦截，这里不需要额外判空
    if not NAME_PATTERN.fullmatch(value):
        # 抛Click内置的参数错误，报错格式和框架自带的完全一致
        raise click.BadParameter("name格式错误：必须是3-16位字母、数字、下划线组合")
    return value

@click.command()
@click.option(
    "-n", "--name",
    required=True,
    type=str,
    callback=check_name,
    help="..."
)
def create(name: str):
    click.echo(f"创建项目 {name} 成功")

踩坑提醒 #

• 别用re.match做判断，re.match只会从字符串开头匹配，比如传"abc123!!!"这种值，只要开头符合规则就会被通过，必须用re.fullmatch做全串匹配
• 校验失败的时候别自己print错误信息，也别抛Python原生的ValueError，要用Click自带的click.BadParameter或者自定义类型的self.fail()方法，这样输出的报错提示会和框架的提示风格统一，不会显得突兀
• 只要参数标了required=True，就不用在校验逻辑里判断值是不是空，框架会先把没传参数的错误处理完，再触发校验逻辑，传进校验函数的value一定是非空的

内容的提问来源于stack exchange，提问作者ca9163d9