Skip to content

Latest commit

 

History

History
142 lines (81 loc) · 3.8 KB

Changelog.md

File metadata and controls

142 lines (81 loc) · 3.8 KB

0.2.1

bug修复

  • 修复多层节点情况下无法返回返回值

改进

  • 在有返回值时由__call__中返回的值会包含节点信息

0.2.0

新增特性

  1. 提供一个默认的返回config的main而不是提示没有注册main
  2. 允许main返回任意值,这个值会在调用__call__时返回
  3. 增加方法with_schema用于在实例化后注册一个schema,支持json字符串,dict和pydantic的类三种形式,注意,pydantic的类不支持嵌套,不支持Union,不支持Optional,但可以将with_schema作为装饰器使用,且节点将会使用被装饰的类名小写作为节点名,类docstring作为description

移除特性

  1. 移除对python 3.10 以下版本的支持
  2. 移除setup.py和setup.cfg

0.1.5

交互优化

  1. 现在展示子命令时展示的时子命令docstring的第一行而不再展示全部.

0.1.4

bug修复

  1. 修复了boolean型参数必须使用命令行设置无效的问题

0.1.3

bug修复

  • 修复了boolean型参数必须使用命令行设置为True否则一定被false覆盖的问题
  • 修复了boolean型参数的const定义需要取值类型为string的bug

0.1.2

新增特性

  • EntryPoint类可以直接在实例化时通过参数定义其description, epilog, usage, name等属性.这样我们就可以直接实例化EntryPoint构造节点而不用继承了.这一特性适合用在构造非叶子节点时.
  • 与其对应的,.regist_sub方法现在可以添加参数用于在实例化节点时放入参数

0.1.1

bug修复

  • 解决自定义解析的配置文件不受``控制的问题
  • 解决打印出奇怪字符的问题

0.1.0

新特性

  • schema字段现在支持title$comment字段了
  • schema中定义的title字段可以用于定义命令行的缩写

0.0.9

新特性

  • 可以使用@regist_config_file_parser(config_file_name)来注册如何解析特定命名的配置文件

0.0.8

新特性

  • 可以通过设置load_all_config_file = True来按设定顺序读取全部预设的配置文件位置

0.0.7

新特性

  • 可以通过设置字段config_file_only_get_need来控制从配置文档中读取数据时是全量读取还是根据schema的定义读取.默认为True
  • 默认新增一个命令行flag--config/-c来指定一个路径用于读取配置文件,其行为和默认位置配置文件一致.

0.0.6

修复bug

  • 修复了每一级子命令都会打印epilog的bug

新特性

  • array类型的参数现在也可以被作为命令行中的noflag字段了.它的输入行为使用nargs="+"的形式

0.0.5

修复bug

  • 修复了array类型无法设置enum的问题

0.0.4

修复bug

  • verify_schema被设置为False时不会抛出警告
  • 对环境变量的解析不会再有None
  • 环境变量不会再解析默认值

新特性

  • 中间节点的的--help命令会在底部展示子命令的简介.简介内容为子命令的docstring

0.0.3

修复bug

  • array类型的协议定义无法解析item的问题

0.0.2

新增功能

  • array类型可以设置默认值

0.0.1

新增功能

  • 实现了如下基本功能
    • default_config_file_paths字段可以读取yaml格式的配置文件

0.0.0

新增功能

  • 实现了如下基本功能
    • 根据子类的名字构造命令
    • 入口节点可以通过方法regist_subregist_subcmd注册子节点
    • 根据子类的docstring,epilog字段description字段自动构造,命令行说明.
    • 根据子类的schema字段env_prefix字段自动构造环境变量的读取规则.
    • 根据子类的default_config_file_paths字段自动按顺序读取json格式配置文件中的参数.
    • 根据schema字段校验配置
    • 根据schema字段构造命令行参数
    • 使用装饰器as_main注册获取到配置后执行的函数