Skip to main content

基于dataclass的符合逻辑的配置取用方式。

Project description

Conf Root

PyPI - Version

基于dataclass的符合逻辑的配置文件取用方式。主要功能如下:

  1. 封装dataclass到配置文件。
  2. 将argparse的设置转换为配置文件。这允许在科研项目的代码中能快速地通过配置文件运行代码。

封装dataclass

from conf_root import configuration, YamlAgent
from dataclasses import dataclass


# @configuration
# 这个装饰器也支持上面这种简写方式
@configuration('config.yaml', agent=YamlAgent)
@dataclass
class AppConfig:
    database_host: str = 'localhost'
    database_port: int = 5432


# 检测是否存在配置文件(默认文件名: `config.yaml`) ,如果不存在则按照默认值新建文件。
# 如存在配置文件,则加载文件中的配置。
app_config = AppConfig()
# 对 app_config 内容改动后,可通过以下方式写入配置文件
app_config.save()
# 对 配置文件 内容改动后,可通过以下方式加载配置文件
app_config.load()

note: dataclass 中的字段需指定类型。

解析 Argparse

import argparse
from conf_root import configuration, ArgparseConfiguration

# 科研项目经常出现一大堆parser.argument
parser = argparse.ArgumentParser()
parser.add_argument("--dataSet", type=str, default="wiki", help="cora, citeseer, wiki, corafull, FedDBLP")
# ...
parser.add_argument("--dropout", type=float, default=0.5)
args = parser.parse_args()

# 使用以下代码解析Argparse并转换为支持conf_root的dataclass。
arg_config = ArgparseConfiguration.from_argparse(parser)
ArgsClass = configuration(arg_config.dataclass)

# 之后可以使用以下代码,创建并使用配置文件。
# 大部分科研项目的情况下,使用下面就可以了
args_dataclass = ArgsClass(**vars(args))
# 如果parser中包含不支持的参数,使用下面的方法过滤
args_dataclass2 = ArgsClass(**arg_config.filter_unsupported(args))

# 或者使用配置文件值优先的参数解析结果,可替换原本的args
args = arg_config.get_namespace(args_dataclass2, args)

note: 在默认产生的dataclass对象中,优先使用 命令行参数 > 配置文件值 > 默认值。可通过 load() 方式使用配置文件值覆盖命令行参数。

argparse 到 dataclass 目前仅支持常见的参数。这不意味着有不支持的命令行参数会导致报错,这些参数将会被忽略。具体限制如下:

  1. Argparse 的 action 必须为 'store(即默认值)', 'store_const', 'store_true', 'store_false' 之一。
  2. Argparse 的 nargs 不支持。
  3. Argparse 中 choices 和 required 的限制将会被忽略。

More Example

from conf_root import configuration, JsonAgent
from dataclasses import dataclass, field


@dataclass
class DataBaseUserConfig:
    database_user: str = 'admin'
    database_password: str = 'default_password'


@configuration(agent=JsonAgent)
# 可通过agent_class指定配置文件格式
# 此时默认配置文件名为 `config.json`
@dataclass
class AppConfig:
    database_host: str = 'localhost'
    database_port: int = 5432
    # 可嵌套dataclass定义
    user_config: DataBaseUserConfig = field(default_factory=DataBaseUserConfig)


app_config = AppConfig()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

conf_root-0.2.0.tar.gz (8.7 kB view hashes)

Uploaded Source

Built Distribution

conf_root-0.2.0-py3-none-any.whl (8.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page