來源丨網(wǎng)絡(luò)

為什么要寫配置文件

ini

[localdb]
host     = 127.0.0.1
user     = root
password = 123456
port     = 3306
database = mysql

>>>?from?configparser?import?ConfigParser
>>>?cfg?=?ConfigParser()
>>>?cfg.read("/Users/Bobot/db.ini")
['/Users/Bobot/db.ini']
>>>?cfg.items("localdb")
[('host',?'127.0.0.1'),?('user',?'root'),?('password',?'123456'),?('port',?'3306'),?('database',?'mysql')]

#!pip?install?pymysql
import?pymysql
from?configparser?import?ConfigParser

cfg?=?ConfigParser()
cfg.read("/Users/Bobot/db.ini")
db_cfg?=?dict(cfg.items("localdb"))

con?=?pymysql.connect(**db_cfg)

json

{
????"localdb":{
????????"host":?"127.0.0.1",
????????"user":?"root",
????????"password":?"123456",
????????"port":?3306,
????????"database":?"mysql"
????}
}

>>>?import?json
>>>?from?pprint?import?pprint
>>>?
>>>?with?open('/Users/Bobot/db.json')?as?j:
...?????cfg?=?json.load(j)['localdb']
...?
>>>?pprint(cfg)
{'database':?'mysql',
?'host':?'127.0.0.1',
?'password':?'123456',
?'port':?3306,
?'user':?'root'}

toml

pip?install?toml

[mysql]
host     = "127.0.0.1"
user     = "root"
port     = 3306
database = "test"

  [mysql.parameters]
  pool_size = 5
  charset   = "utf8"

  [mysql.fields]
  pandas_cols = [ "id", "name", "age", "date"]

緊接著我們就可以通過?toml?庫(kù)中的?load()?方法來進(jìn)行讀取：

>>>?import?toml
>>>?import?os
>>>?from?pprint?import?pprint
>>>?cfg?=?toml.load(os.path.expanduser("~/Desktop/config.toml"))
>>>?pprint(cfg)
{'mysql':?{'database':?'test',
???????????'fields':?{'pandas_cols':?['id',?'name',?'age',?'date']},
???????????'host':?'127.0.0.1',
???????????'parameters':?{'charset':?'utf8',?'pool_size':?5},
???????????'port':?3306,
???????????'user':?'root'}}

可以看到?toml?文件被間接地轉(zhuǎn)化成了字典類型，當(dāng)然這也就是?json?版的寫法（將單引號(hào)替換成雙引號(hào)即可），方便我們后續(xù)調(diào)用或者傳參。

yaml

pip?install?pyyaml

同?json?庫(kù)和?toml?庫(kù)一樣，通過?load()?方法來進(jìn)行加載。

需要注意的是，使用?load()?方法會(huì)存在一定的安全隱患，從思科 Talos 的這份報(bào)告中我們可以看到，如果加載了未知或不信任的?yaml?文件，那么有可能會(huì)存在被攻擊的風(fēng)險(xiǎn)和網(wǎng)絡(luò)安全隱患，因?yàn)樗軌蛑苯诱{(diào)用相應(yīng)的 Python 函數(shù)來執(zhí)行為攻擊者所需要的命令，比如說在?yaml?文件中寫入這么一段：

#?使用Linux和macOS的朋友不要輕易嘗試
!!python/object/apply:os.system?["rm?-rf?/"]

因此最好是使用?safe_load()?來代替?load()?方法。

這和 Python 內(nèi)置的?string?標(biāo)準(zhǔn)庫(kù)中?Template?類的?substitute()?模板方法一樣存在著同樣的安全隱患，所以使用?safe_substitute()?來替代是一樣的道理。

如我們現(xiàn)在將之前的一些配置信息寫入?config.yaml?文件中：

mysql:
??host:?"127.0.0.1"
??port:?3306
??user:?"root"
??password:?"123456"
??database:?"test"

??parameter:
????pool_size:?5
????charset:?"utf8"

??fields:
????pandas_cols:?
??????-?id
??????-?name
??????-?age
??????-?date

然后我們通過?safe_load()?方法進(jìn)行解析：

>>>?import?os
>>>?from?pprint?import?pprint
>>>?
>>>?with?open(os.path.expanduser("~/config.yaml"),?"r")?as?config:
...?????cfg?=?yaml.safe_load(config)
...?
>>>?pprint(cfg)
{'mysql':?{'database':?'test',
???????????'fields':?{'pandas_cols':?['id',?'name',?'age',?'date']},
???????????'host':?'127.0.0.1',
???????????'parameter':?{'charset':?'utf8',?'pool_size':?5},
???????????'password':?'123456',
???????????'port':?3306,
???????????'user':?'root'}}

可以看到最后結(jié)果和前面的?toml?庫(kù)的解析結(jié)果基本一致。

結(jié)尾