typer-cli:如何与typer一起使用自定义数据类型
typer-cli:如何与typer一起使用自定义数据类型
提问于 2021-08-12 10:51:30
单击with click.ParamType，用于定义自定义参数类型，但它不适用于typer (下面的示例代码段)
我想使用，我自己的日期时间格式，例如:今天%H:%M，%M：%H(自动使用日期作为今天)。Typer已经允许设置，自定义日期时间格式，但它没有涵盖我的用例。
这是来自单击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.ParamType，typer不需要将其转换为单击类型。
实现我自己的日期时间格式的最佳方法是什么？
- 创建一个继承自
datetime的新类，并重写strptime以适应我的usecase会不会更好呢？ - 这是否可以由打字机本身来实现？因为这很容易通过点击
谢谢
回答 1
Stack Overflow用户
发布于 2021-09-06 18:25:41
不过，我不太熟悉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: ^希望这能帮到你。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/68756029
复制相关文章
相似问题
腾讯云开发者
