Python中Toml配置文件的操作詳解

更新時(shí)間：2023年09月17日 10:47:30 作者：databook

TOML是一種用于配置文件的輕量級(jí)、易讀的數(shù)據(jù)序列化格式,這篇文章主要為大家詳細(xì)介紹了python如何對(duì)Toml配置文件進(jìn)行簡(jiǎn)單操作,感興趣的小伙伴可以了解下

1. 基本類型

配置項(xiàng)的值在TOML中也像在JSON中一樣，是可以有類型的。

它說(shuō)支持的基本類型主要有布爾值，數(shù)值（整數(shù)，浮點(diǎn)數(shù)），字符串和日期等幾種。

1.1. 布爾值

python中的TOML模塊可以加載toml格式的字符串，或者toml文件的文件流。

# -*- coding: utf-8 -*-
import tomllib
# 加載toml文件
with open("./sample.toml", "rb") as f:
    data = tomllib.load(f)
print("bool_var1 = ", data["bool_var1"])
print("bool_var2 = ", data["bool_var2"])
# 運(yùn)行結(jié)果
bool_var1 =  False
bool_var2 =  True

toml文件示例：sample.toml

bool_var1 = false
bool_var2 = true

1.2. 數(shù)值

數(shù)值類型分為整數(shù)和浮點(diǎn)數(shù)兩種。

整型除了10進(jìn)制，也可以用16進(jìn)制，8進(jìn)制和2進(jìn)制。

# 10進(jìn)制
int_var1 = 99
int_var2 = -17
int_var3 = 1_234_000
# 16進(jìn)制，大小寫都可以
hex_var1 = 0xDE
hex_var2 = 0xde
# 8進(jìn)制
oct_var = 0o666
# 2進(jìn)制
bin_var = 0b11010110

解析之后，會(huì)自動(dòng)轉(zhuǎn)換成10進(jìn)制。

with open("./sample.toml", "rb") as f:
    data = tomllib.load(f)
print("int_var1 = ", data["int_var1"])
print("int_var2 = ", data["int_var2"])
print("int_var3 = ", data["int_var3"])
print("hex_var1 = ", data["hex_var1"])
print("hex_var2 = ", data["hex_var2"])
print("oct_var = ", data["oct_var"])
print("bin_var = ", data["bin_var"])
# 運(yùn)行結(jié)果
int_var1 =  99
int_var2 =  -17
int_var3 =  1234000
hex_var1 =  222
hex_var2 =  222
oct_var =  438
bin_var =  214

浮點(diǎn)型的各種配置示例：

float_var1 = 3.1415
float_var2 = -0.01
float_var3 = 5e+22
float_var4 = -2E-2
float_var5 = 6.626e-34

解析示例：各種格式的float寫法都可以解析。

with open("./sample.toml", "rb") as f:
    data = tomllib.load(f)
print("float_var1 = ", data["float_var1"])
print("float_var2 = ", data["float_var2"])
print("float_var3 = ", data["float_var3"])
print("float_var4 = ", data["float_var4"])
print("float_var5 = ", data["float_var5"])
# 運(yùn)行結(jié)果
float_var1 =  3.1415
float_var2 =  -0.01
float_var3 =  5e+22
float_var4 =  -0.02
float_var5 =  6.626e-34

1.3. 字符串

對(duì)于字符串類型的配置項(xiàng)，支持單行和多行字符串。

配置文件示例：

str_single = "abcdefg"
str_multi = """ab
cd
ef
"""

解析示例：

with open("./sample.toml", "rb") as f:
    data = tomllib.load(f)
print("str_single = ", data["str_single"])
print("str_multi = ", data["str_multi"])
# 運(yùn)行結(jié)果
str_single =  abcdefg
str_multi =  ab
cd
ef

字符串的配置除了單行和多行以外，還有單引號(hào)和雙引號(hào)的區(qū)別。

單引號(hào)字符串：原樣顯示字符串內(nèi)容
雙引號(hào)字符串：解析字符串中的轉(zhuǎn)義符

str_var1 = "ab\tcd\nef"
str_var2 = 'ab\tcd\nef'

解析之后：

with open("./sample.toml", "rb") as f:
    data = tomllib.load(f)
print("str_var1 = ", data["str_var1"])
print("str_var2 = ", data["str_var2"])
# 運(yùn)行結(jié)果
str_var1 =  ab  cd
ef
str_var2 =  ab\tcd\nef

1.4. 日期

最后一個(gè)常用的基本類型是日期類型。

配置示例：

date_var1 = 2023-09-13T10:08:22
date_var2 = 2023-09-13
date_var3 = 10:08:22

解析示例：

with open("./sample.toml", "rb") as f:
    data = tomllib.load(f)
s = "date_var1 = {} (type: {})".format(data["date_var1"], 
                                       type(data["date_var1"]))
print(s)
s = "date_var2 = {} (type: {})".format(data["date_var2"], 
                                       type(data["date_var2"]))
print(s)
s = "date_var3 = {} (type: {})".format(data["date_var3"], 
                                       type(data["date_var3"]))
print(s)
# 運(yùn)行結(jié)果
date_var1 = 2023-09-13 10:08:22 (type: <class 'datetime.datetime'>)
date_var2 = 2023-09-13 (type: <class 'datetime.date'>)
date_var3 = 10:08:22 (type: <class 'datetime.time'>)

日期類型可以是完整的年月日時(shí)分秒，也可以只有年月日或時(shí)分秒。

2. 復(fù)合類型

復(fù)合類型主要是列表和字典。

2.1. 列表

列表中的元素可以是上面的介紹的任意基本類型。

配置示例：（列表中元素的數(shù)據(jù)類型可以不同，也可以是一個(gè)列表）

lst_var1 = [1, 3.14, "str", 2023-09-13T10:08:22]
lst_var2 = [[1, 2], ["abc", "def"]]

解析示例：

with open("./sample.toml", "rb") as f:
    data = tomllib.load(f)
print("lst_var1 = ", data["lst_var1"])
print("lst_var2 = ", data["lst_var2"])
# 運(yùn)行結(jié)果
lst_var1 =  [1, 
             3.14, 
             'str', 
             datetime.datetime(2023, 9, 13, 10, 8, 22)]
lst_var2 =  [[1, 2], ['abc', 'def']]

2.2. 字典

配置示例：（字典中值的數(shù)據(jù)類型可以不同，也可以是一個(gè)字典）

[dict_var1]
key1 = 1
key2 = 3.14
key3 = "str"
key4 = 2023-09-13T10:08:22
[dict_var1.sub_dict]
key = "val"

解析示例：

with open("./sample.toml", "rb") as f:
    data = tomllib.load(f)
print("dict_var1 = ", data["dict_var1"])
# 運(yùn)行結(jié)果
dict_var1 =  {
    'key1': 1, 
    'key2': 3.14,
    'key3': 'str',
    'key4': datetime.datetime(2023, 9, 13, 10, 8, 22),
    'sub_dict': {'key': 'val'}
}

3. 類型組合

如果是寫代碼的話，列表中嵌入字典或者字典中嵌入列表都非常簡(jiǎn)單，

但是，配置文件中定義這種復(fù)雜的結(jié)構(gòu)就沒那么容易了。

TOML提供了簡(jiǎn)單的語(yǔ)法來(lái)實(shí)現(xiàn)復(fù)雜類型之間的組合。

3.1. 列表中的字典

配置示例：

[[student]]
name = "aaa"
age = 15
score = 100
[[student]]
name = "bbb"
age = 14
score = 89
[[student]]
name = "ccc"
age = 17
score = 98

解析示例：

with open("./sample.toml", "rb") as f:
    data = tomllib.load(f)
print("students = ", data["student"])
# 運(yùn)行結(jié)果
students =  [
    {'name': 'aaa', 'age': 15, 'score': 100},
    {'name': 'bbb', 'age': 14, 'score': 89},
    {'name': 'ccc', 'age': 17, 'score': 98},
]

3.2. 字典中的列表

字典中嵌入列表比較簡(jiǎn)單：

[teacher]
name = "abc"
classes = ["一班", "二班", "三班"]

解析示例：

with open("./sample.toml", "rb") as f:
    data = tomllib.load(f)
print("teacher = ", data["teacher"])
# 運(yùn)行結(jié)果
teacher =  {
    'name': 'abc', 
    'classes': ['一班', '二班', '三班']
}