typer-cli：如何在 typer 中使用自定义数据类型

Question

Click 有 click.ParamType，用于定义自定义参数类型，但它不适用于打字机（下面的示例片段）

我想使用我自己的日期时间格式，例如：今天％H：％M，％M：％H（自动使用日期作为今天）。 Typer 已经允许设置，自定义日期时间格式，但它不涵盖我的用例。

这是来自 click docs 的示例，我尝试与 typer 一起使用。

class BasedIntParamType(click.ParamType):
    name = "integer"

    def convert(self, value, param, ctx):
        if isinstance(value, int):
            return value

        try:
            if value[:2].lower() == "0x":
                return int(value[2:], 16)
            elif value[:1] == "0":
                return int(value, 8)
            return int(value, 10)
        except ValueError:
            self.fail(f"{value!r} is not a valid integer", param, ctx)

BASED_INT = BasedIntParamType()

def main(based_int: BASED_INT):
    print(based_int)
    
if __name__=="__main__":
    typer.run(main)

它给出了这个错误：

Traceback (most recent call last):
  File "/home/yashrathi/test.py", line 26, in <module>
    typer.run(main)
  File "/home/yashrathi/.local/lib/python3.9/site-packages/typer/main.py", line 859, in run
    app()
  File "/home/yashrathi/.local/lib/python3.9/site-packages/typer/main.py", line 214, in __call__
    return get_command(self)(*args, **kwargs)
  File "/home/yashrathi/.local/lib/python3.9/site-packages/typer/main.py", line 239, in get_command
    click_command = get_command_from_info(typer_instance.registered_commands[0])
  File "/home/yashrathi/.local/lib/python3.9/site-packages/typer/main.py", line 423, in get_command_from_info
    ) = get_params_convertors_ctx_param_name_from_function(command_info.callback)
  File "/home/yashrathi/.local/lib/python3.9/site-packages/typer/main.py", line 404, in get_params_convertors_ctx_param_name_from_function
    click_param, convertor = get_click_param(param)
  File "/home/yashrathi/.local/lib/python3.9/site-packages/typer/main.py", line 656, in get_click_param
    parameter_type = get_click_type(
  File "/home/yashrathi/.local/lib/python3.9/site-packages/typer/main.py", line 587, in get_click_type
    raise RuntimeError(f"Type not yet supported: {annotation}")  # pragma no cover
RuntimeError: Type not yet supported: <__main__.BasedIntParamType object at 0x7f7295822fd0>

typer.main.get_click_type

，似乎与自定义点击类型不兼容。但click知道如何处理

click.ParamType

，打字机不需要将其转换为click类型。

实现我自己的日期时间格式的最佳方法是什么？

• 创建一个继承自

  datetime

  并覆盖

  strptime

  的新类以适合我的用例会好吗？
• 这个可以用typer自己实现吗？因为只需点击即可轻松完成此操作

谢谢你

Answer 1

我不熟悉

typer

，但是，您可以通过以下方式使用

click

来实现它。

实现日期时间格式的一种方法是从

click.ParamType

扩展并自己完成所有硬解析。

或者，如果您只想对

click.DateTime

的工作方式进行一些小调整，您也可以直接从

click.DateTime

扩展。
这样您就可以让

click.DateTime

完成大部分繁重的工作。

为了稍微简化您的情况，假设我们希望用户能够指定：

$ cli --newdate today    # which converts today to a click.DateTime
2021-12-30               # Note: below I also show how to return "today" 

此外，我们希望保留

click.DateTime

的旧行为，这样这也有效：

$ cli --newdate 2042-12-29
2042-12-29

然后我们可以按如下方式实现：

import datetime
from typing import Optional, Sequence, Any
import click

class EnhancedDate(click.DateTime):
    name = "enhanceddate"

    def __init__(self, formats: Optional[Sequence[str]] = None):
        super().__init__(formats)
        self.formats += ["today"]  # add your formats here

    def convert(self, value: Any, param: Optional["Parameter"], ctx: Optional["Context"]) -> Any:
        # And in the convert, we'll handle our own formats first
        if value is None or value == "today":
            return datetime.date.today()
            # Alternatively, if you return "today" here 
            # you also get the "today" string in your commands
            # when you use type=EnhancedDate()
              
        # we'll let click handle all the other stuff
        return super().convert(value, param, ctx)

@click.command()
@click.option("--newdate", type=EnhancedDate())
def cli(newdate):
    click.echo(newdate)


cli()

这种方法的好处是您可以获得开箱即用的点击文档：

python3 cli.py --help
Usage: cli.py [OPTIONS]

Options:
  --newdate [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S|today]
  --help                          Show this message and exit.
# Notice how `today` is added automatically over here:       ^

希望这对您有帮助。

Answer 2

class DateTyper:

    @classmethod
    def parse_value(cls, value: str):
        if not re.search(r'\d{2}\/\d{2}\/\d{4}', value, re.I):
            raise ValueError()
        return datetime.strptime(value, '%d/%m/%Y')

@app.command()
def foo(
    days: DateTyper = typer.Option(parser=DateTyper.parse_value)
):
    print(days)

运行时

src git:(main) ✗ dotenv run python -m main foo --days 01/01/1111 
1111-01-01 00:00:00

如果输入无效选项

src git:(main) ✗ dotenv run python -m main foo --days 01/01/111 
Usage: main.py foo [OPTIONS]
Try 'main.py foo --help' for help.
╭─ Error ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ Invalid value for '--days': 01/01/111 

(precodahora-env) ➜  src git:(main) ✗ dotenv run python -m main foo --days foo      
Usage: main.py foo [OPTIONS]
Try 'main.py foo --help' for help.
╭─ Error ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ Invalid value for '--days': foo