為什么要寫配置文件

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

從這里可以看出?toml?有點類似于前面所講的?ini?文件。但是它比?ini?擴展了更多的內容。

在樣例圖片中我們可以看到，除了基本的字符串以外，例如時間戳、布爾值、數(shù)組等都進一步支持，而且樣式和 Python 的原生寫法十分類似。

當然這里不會過多介紹?toml?格式的一些規(guī)范說明，有人已經對官方的規(guī)范文檔進行了翻譯，有興趣的朋友可以直接查閱。

這么契合 Python 方式的配置文件類型已經有開發(fā)者造出了相應的「輪子」，目前在 Github 上 Stars 數(shù)最多的是則?uiri/toml?的版本，不過該版本僅通過了 v0.5 版本?toml?規(guī)范，但在使用上還是蠻簡潔的，我們可以通過?pip?命令進行安裝

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?庫中的?load()?方法來進行讀?。?/span>

>>>?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'}}

yaml

所以感興趣的朋友可以再自行了解相關用法。

YAML 官方早已經提供了相應的 Python 庫進行支持，即?PyYAML；當然也同樣需要我們事先進行安裝：

pip?install?pyyaml

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

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

這和 Python 內置的?string?標準庫中?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()?方法進行解析：

>>>?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'}}

可以看到最后結果和前面的?toml?庫的解析結果基本一致。

結尾