autoclick 0.6.0

自动单击

autoclick使用类型注释创建基于单击的cli。

最简单的autoclick使用要求用@autoclick.command注释主方法

# test.pyimportautoclick@autoclick.command("greet")defmain(greeting:str,name:str):print(f"{greeting}{name}")if__name__=="__main__":main()

$ python test.py --help
Usage: test.py [OPTIONS][GREETING][NAME]

Options:
  --help  Show this message and exit.

对于其他自定义项，关键字参数可以传递给命令decorator:

importautoclick@autoclick.command(short_names={"greeting":"G","name":"n"},show_defaults=True)defmain(greeting:str="hello",name:str="human"):print(f"{greeting}{name}")

$ python test.py --help
Usage: test.py [OPTIONS]

Options:
  -G, --greeting TEXT  [default: hello]
  -n, --name TEXT      [default: human]
  --help               Show this message and exit.

类型转换

在click中，类型转换可以在回调中完成，也可以使用可调用类型（例如paramtype的子类）作为类型。在autoclick中，根据可调用类型的类型注释自动执行类型转换。但是，对于更复杂的类型转换，还有三种附加方法：

1. 自动转换功能。转换函数由@conversion修饰。默认情况下，转换修饰符从返回注释推断要转换为的类型。否则，可以将目标类型指定为decorator的参数。decorator将函数注册为指定类型的转换器。当遇到该类型作为命令函数的参数注释时，converter函数用于将字符串参数转换为该类型。

importautoclickclassBork:def__init__(self,n:int):self.n=ndef__str__(self):print(",".join(["bork"]*self.n))@autoclick.conversion()defbork(n:int)->Bork:returnBork(n)@autoclick.command("bork")defmain(b:Bork):print(b)

在需要专门处理公共类型的情况下，可以使用typing.newtype：

importautoclickimporttypingDoubleInt=typing.NewType("DoubleInt",int)@autoclick.conversion(DoubleInt)defdouble_int(i:str):returnint(i)*2@autoclick.command("double")defmain(i1:int,i2:DoubleInt):print(i1,i2)

1. 转换函数也可以在decorator命令中显式指定：

importautoclick@autoclick.command(types={"a":double_int})defmain(a:int):print(a)

请注意，单击中的任何类型。类型包也可以这样使用。

1. 对于复合类型，可以使用autoclick.composite_type和autoclick.composite_factory函数。复合类型的一个示例是一个类，该类的构造函数需要多个参数。对于复合类型，将执行相同的基于注释的cli创建，并将参数注入cli以代替复合参数。

importautoclick@autoclick.composite_type()classFoo:def__init__(self,bar:str,baz:int):self.bar=barself.baz=baz@autoclick.command()defmain(foo:Foo):print(foo.bar,foo.baz)

在这种情况下，main的选项是--foo bar和--foo baz。处理完cli后，这些选项的值将用于构造foo实例，然后将其传递给对main的调用。命令函数中的参数名在复合类型的参数名之前，因此复合类型可以在命令函数签名中使用多个类型。

函数返回一个复杂类型。例如，下面的代码等同于上面的代码：

importautoclickclassFoo:def__init__(self,bar:str,baz:int):...@autoclick.composite_factory(Foo)deffoo_factory(bar:str,baz:int):returnFoo(bar,baz)

条件和验证

条件和验证是相似的-它们都是采用**kwargs参数的装饰符。关键字是参数名，值是参数值。当函数接受多个参数时，它们应该指定顺序；顺序取决于python 3.5+字典隐式排序的行为。

条件函数用于根据其他参数的值修改一个或多个参数的值。条件函数可以返回dict，其中键是应该更新的参数名，值是新的参数值。

验证函数用于检查一个或多个参数值是否符合某些限制。将忽略验证函数的返回值。

条件函数和验证函数都可以抛出validationerror。

这些函数可以通过两种方式与参数关联。首先，使用命令decorator的条件和验证参数。这些是dict，参数名或参数名元组是键，函数是值。第二，当参数用@autoclick.validation修饰并且参数类型与validation decora的类型参数匹配时，验证函数可以与参数关联。托尔。多参数验证只能通过第一个方法关联。由于条件应该是多值的，因此没有@autoclick.conditional注释，即必须始终显式指定它们。

类型匹配

您还可以使用typing.newtype函数创建的不同类型进行类型匹配验证。例如，如果要定义的参数必须为正，甚至是：

# test.pyimportautoclick@autoclick.command("greet")defmain(greeting:str,name:str):print(f"{greeting}{name}")if__name__=="__main__":main()

# test.pyimportautoclick@autoclick.command("greet")defmain(greeting:str,name:str):print(f"{greeting}{name}")if__name__=="__main__":main()

# test.pyimportautoclick@autoclick.command("greet")defmain(greeting:str,name:str):print(f"{greeting}{name}")if__name__=="__main__":main()

# test.pyimportautoclick@autoclick.command("greet")defmain(greeting:str,name:str):print(f"{greeting}{name}")if__name__=="__main__":main()

# test.pyimportautoclick@autoclick.command("greet")defmain(greeting:str,name:str):print(f"{greeting}{name}")if__name__=="__main__":main()

# test.pyimportautoclick@autoclick.command("greet")defmain(greeting:str,name:str):print(f"{greeting}{name}")if__name__=="__main__":main()

# test.pyimportautoclick@autoclick.command("greet")defmain(greeting:str,name:str):print(f"{greeting}{name}")if__name__=="__main__":main()

# test.pyimportautoclick@autoclick.command("greet")defmain(greeting:str,name:str):print(f"{greeting}{name}")if__name__=="__main__":main()

# test.pyimportautoclick@autoclick.command("greet")defmain(greeting:str,name:str):print(f"{greeting}{name}")if__name__=="__main__":main()