typed-argument-parser 1.2

类型化参数分析器（tap）

tap是python的argparse库的类型化现代化。

点击提供以下好处：

• 静态类型检查
• 代码完成
• 源代码导航（例如转到定义和实现）

目录

• 安装
• tap is python native
• 点击功能
  • 参数
  • 帮助字符串
  • 添加参数的灵活性
  • 类型
  • 利用过程参数进行参数处理
  • 处理已知参数
  • 子类化
  • 打印
  • 再现性
    • 再现性信息
    • 保存参数

安装

tap需要python 3.6+

要安装tap，请运行以下命令：

git clone https://github.com/kswanson-asapp/typed-argument-parser.git
cd typed-argument-parser
pip install -e .

tap是python原生的

要了解这一点，让我们看一个示例：

"""main.py"""fromtapimportTapclassSimpleArgumentParser(Tap):name:str# Your namelanguage:str='Python'# Programming languagepackage:str='Tap'# Package namestars:int# Number of starsmax_stars:int=5# Maximum starsargs=SimpleArgumentParser().parse_args()print(f'My name is {args.name} and I give the {args.language} package 'f'{args.package}{args.stars}/{args.max_stars} stars!')

使用TAP的方式与使用标准argparse的方式相同。

>>> python main.py --name Jesse --stars 5
My name is Jesse and I give the Python package Tap 5/5 stars!

等效的argparse代码是：

"""main.py"""fromargparseimportArgumentParserparser=ArgumentParser()parser.add_argument('--name',type=str,required=True,help='Your name')parser.add_argument('--language',type=str,help='Programming language')parser.add_argument('--package',type=str,default='Tap',help='Package name')parser.add_argument('--stars',type=int,required=True,help='Number of stars')parser.add_argument('--max_stars',type=int,default=5,help='Maximum stars')args=parser.parse_args()print(f'My name is {args.name} and I give the {args.language} package 'f'{args.package}{args.stars}/{args.max_stars} stars!')

python本机的优点包括能够：

• 覆盖方便的内置方法（例如process\u args确保参数之间的一致性）
• 添加自定义方法
• 从您自己的模板类继承

轻触功能

现在，我们将重点介绍一些我们最喜欢的功能，并举例说明它们在实践中的工作原理。

参数

参数被指定为在tap的子类中定义的类变量。定义为name:type的变量是必需的参数，而定义为name:type=value的变量不是必需的，并且默认为提供的值。

classMyTap(Tap):required_arg:strdefault_arg:str='default value'

帮助字符串

在运行python main.py-h时，单行注释会自动解析为提供的帮助字符串。参数的类型和默认值也在帮助字符串中提供。

"""main.py"""fromtapimportTapclassMyTap(Tap):x:float# What am I?pi:float=3.14# I'm pi!args=MyTap().parse_args()

运行python main.py-h将导致以下结果：

>>> python main.py -h
usage: demo.py --x X [--pi PI] [-h]

optional arguments:
  --x X       (float, required) What am I?
  --pi PI     (float, default=3.14) I'm pi!
  -h, --help  show this help message and exit

灵活地添加参数

python的argparse通过add_argument方法提供了许多高级参数解析功能。由于tap是argparse的包装，tap提供了所有相同的功能。

要使用此功能，首先像往常一样将参数定义为类变量，然后重写tap的add_arguments并使用self.添加参数就像使用argparse的添加参数

fromtapimportTapclassMyTap(Tap):positional_argument:strlist_of_three_things:List[str]argument_with_really_long_name:intdefadd_arguments(self):self.add_argument('positional_argument')self.add_argument('--list_of_three_things',nargs=3)self.add_argument('-arg','--argument_with_really_long_name')

类型

轻触可自动处理以下所有类型：

str,int,float,boolOptional[str],Optional[int],Optional[float]List[str],List[int],List[float]Set[str],Set[int],Set[float]

这些参数的解析如下：

str、int和float：每种类型都自动解析为各自的类型，就像argparse一样。

bool：如果参数arg指定为arg:bool或arg:bool=false，则将--arg标志添加到命令行将设置arg为true。如果arg被指定为arg:bool=true，则添加--arg将arg设置为false

可选：这些参数的解析方式与str、int和float完全相同

list：如果参数arg是list，只需指定用空格分隔的值，就像使用常规argparse一样。例如，--arg 123解析为arg=[1，2，3]

集合：与列表相同，但解析为集合而不是列表。

更复杂的类型必须用add_参数中的type关键字参数指定，如下例所示。

git clone https://github.com/kswanson-asapp/typed-argument-parser.git
cd typed-argument-parser
pip install -e .

git clone https://github.com/kswanson-asapp/typed-argument-parser.git
cd typed-argument-parser
pip install -e .

git clone https://github.com/kswanson-asapp/typed-argument-parser.git
cd typed-argument-parser
pip install -e .

git clone https://github.com/kswanson-asapp/typed-argument-parser.git
cd typed-argument-parser
pip install -e .

git clone https://github.com/kswanson-asapp/typed-argument-parser.git
cd typed-argument-parser
pip install -e .

git clone https://github.com/kswanson-asapp/typed-argument-parser.git
cd typed-argument-parser
pip install -e .