从 Python 3.11 开始,标准库引入了一个名为 tomllib 的模块,但请注意,这仅是用于解析 TOML 文件的功能,并且最初只包含了读取(解析)TOML 数据的能力,而不包括生成 TOML 数据的功能,使用时需要 import tomllib,with open('config.toml', 'br') as f:   注意需要二进制读取

        如果你需要不仅限于解析还包括生成 TOML 文件的能力,或者你正在使用的 Python 版本低于 3.11,那么你仍然需要依赖第三方库如 toml。该库提供了全面的支持,包括解析和生成 TOML 文件,使用时需要 import toml,with open('config.toml', 'r') as f: 进行读取

1. 为什么要使用配置文件,而不是直接使用 python 文件进行配置

        主要是出于安全考虑,如果使用 python 直接配置,在 import 的时候是会执行代码的,会有安全风险。配置文件是文本文件,与代码剥离,修改文件不会产生风险。

        灵活性,可维护性,如果给别人的是二进制文件,又是用 python 文件进行配置,别人就没法修改配置了,与代码剥离,更加灵活。

        使用配置文件,不会与环境,编程语言进行绑定,更加灵活,可移植,复用,方便使用和维护,不同的编程语言可以共享一份配置文件了。

主要功能

  • 解析toml.load() 方法可以从文件加载并解析 TOML 数据到 Python 字典   
  •                   toml.loads() 方法可以从字符串加载并解析 TOML 数据到 Python 字典。

  • 生成toml.dump() 可以将 Python 字典转换为 TOML 格式,写入到文件。
  •        toml.dumps() 可以将 Python 字典转换为 TOML 格式的字符串。

    解析完后得到的是python的字典,可以用字典的方法进行修改,更新,然后输出到新的文件

    例:

    import toml
    from pprint import pp
    
    # 读取原始的 TOML 文件
    with open("config.toml", "r") as f:
        config = toml.load(f)
    
    # 打印原始内容
    pp("Original Configuration:")
    pp(toml.dumps(config))
    pp(config)
    
    # 更新一些值
    config['name'] = 'newname'
    config['title'] = "Updated TOML Example"
    
    # 将更新后的配置写入新的 TOML 文件
    with open("new_config.toml", "w") as f:
        toml.dump(config, f)
    
    # comment use "#", config.toml
    
    name = 'hahaname'
    age = 23
    sex = "femule\""
    hobbies = ['reading', 'writeing']
    birtime = 2021-01-01T00:00:00Z
    

    new_config.toml

    name = "newname"
    age = 23
    sex = "femule\""
    hobbies = [ "reading", "writeing",]
    birtime = 2021-01-01T00:00:00Z
    title = "Updated TOML Example"
    

    作者:2301_78094384

    物联沃分享整理
    物联沃-IOTWORD物联网 » 在 python 中使用 toml

    发表回复