0
  • 聊天消息
  • 系統(tǒng)消息
  • 評(píng)論與回復(fù)
登錄后你可以
  • 下載海量資料
  • 學(xué)習(xí)在線課程
  • 觀看技術(shù)視頻
  • 寫文章/發(fā)帖/加入社區(qū)
會(huì)員中心
創(chuàng)作中心

完善資料讓更多小伙伴認(rèn)識(shí)你,還能領(lǐng)取20積分哦,立即完善>

3天內(nèi)不再提示

Python 中常見的配置文件寫法有哪些

馬哥Linux運(yùn)維 ? 來源:Python中文社區(qū) ? 作者:Python中文社區(qū) ? 2021-10-20 16:11 ? 次閱讀

為什么要寫配置文件

在開發(fā)過程中,我們常常會(huì)用到一些固定參數(shù)或者是常量。對(duì)于這些較為固定且常用到的部分,往往會(huì)將其寫到一個(gè)固定文件中,避免在不同的模塊代碼中重復(fù)出現(xiàn)從而保持核心代碼整潔。這個(gè)固定文件我們可以直接寫成一個(gè).py文件,例如settings.pyconfig.py,這樣的好處就是能夠在同一工程下直接通過import來導(dǎo)入當(dāng)中的部分;但如果我們需要在其他Python 的平臺(tái)進(jìn)行配置文件共享時(shí),寫成單個(gè).py就不是一個(gè)很好的選擇。這時(shí)我們就應(yīng)該選擇通用的配置文件類型來作為存儲(chǔ)這些固定的部分。目前常用且流行的配置文件格式類型主要有ini、json、toml、yamlxml等,這些類型的配置文件我們都可以通過標(biāo)準(zhǔn)庫或第三方庫來進(jìn)行解析。

ini

ini即 Initialize 初始化之意,早期是在 Windows 上配置文件的存儲(chǔ)格式。ini文件的寫法通俗易懂,往往比較簡單,通常由節(jié)(Section)、鍵(key)和值(value)組成,就像以下形式:
[localdb]
host     = 127.0.0.1
user     = root
password = 123456
port     = 3306
database = mysql
Python 本身內(nèi)置的configparser標(biāo)準(zhǔn)庫,我們直接就可以用來對(duì)ini文件進(jìn)行解析。如我們將上述內(nèi)容保存在一個(gè)名為db.ini的文件中,然后使用read()方法來進(jìn)行解析和讀取,最后通過items()方法來獲取指定節(jié)點(diǎn)下的所有鍵值對(duì)。
>>>fromconfigparserimportConfigParser
>>>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')]
需要注意的是,configparser默認(rèn)將值以字符串的形式呈現(xiàn),所以這也就是為什么我們?cè)?/span>db.ini文件中沒有加引號(hào)而是直接將字面量寫在上面的原因。獲取到鍵值對(duì)后,我其實(shí)直接就將其轉(zhuǎn)換成字典,然后通過解包的方式進(jìn)行穿參,保持代碼簡潔:
#!pipinstallpymysql
importpymysql
fromconfigparserimportConfigParser

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

con=pymysql.connect(**db_cfg)

json

json格式可以說是我們常見的一種文件形式了,也是目前在互聯(lián)網(wǎng)較為流行的一種數(shù)據(jù)交換格式。除此之外,json有時(shí)也是配置文件的一種。比如npmJavaScript 包管理工具類似 Python 的pip)、以及微軟出品的目前被廣泛使用的 VSCode 編輯器,都使用json編寫配置參數(shù)。configparser一樣,Python 也內(nèi)置了json標(biāo)準(zhǔn)庫,可以通過load()loads()方法來導(dǎo)入文件式和字符串的json內(nèi)容。
{
"localdb":{
"host":"127.0.0.1",
"user":"root",
"password":"123456",
"port":3306,
"database":"mysql"
}
}

我們將上述內(nèi)容保存為db.json后進(jìn)行讀取和解析,json庫讀取 json 文件相對(duì)簡單容易,而且很容易解析成 Python 的字典對(duì)象。
>>>importjson
>>>frompprintimportpprint
>>>
>>>withopen('/Users/Bobot/db.json')asj:
...cfg=json.load(j)['localdb']
...
>>>pprint(cfg)
{'database':'mysql',
'host':'127.0.0.1',
'password':'123456',
'port':3306,
'user':'root'}
使用json文件配置的缺點(diǎn)就是語法標(biāo)準(zhǔn)嚴(yán)格限制,為人所詬病之一的就是無法在當(dāng)中寫注釋,除非采取json類型的其他超集作為替代方案(VSCode 中能寫注釋的json參數(shù)配置文件便是代替方案的一種);同時(shí)存在嵌套過深的問題,容易導(dǎo)致出錯(cuò),不宜用來寫過長或復(fù)雜的參數(shù)配置信息

toml

toml格式(或tml格式)是 Github 聯(lián)合創(chuàng)始人 Tom Preston-Werner 所提出的一種配置文件格式。根據(jù)維基百科的資料toml最開始提出時(shí)是在 2013年7月份,距今已有七年時(shí)間;它在某些方面也與后面要談到的yaml文件有些類似,但如果當(dāng)你知道 yaml 的規(guī)范有幾十頁(沒有錯(cuò),真的就是幾十頁……)的時(shí)候,可能你真的就不太愿意去寫那么復(fù)雜的配置文件,toml格式則倒是個(gè)不錯(cuò)的選擇。toml格式大致如下:

f05cbf0e-315c-11ec-82a8-dac502259ad0.png

01-toml樣式從這里可以看出toml有點(diǎn)類似于前面所講的ini文件。但是它比ini擴(kuò)展了更多的內(nèi)容。在樣例圖片中我們可以看到,除了基本的字符串以外,例如時(shí)間戳、布爾值、數(shù)組等都進(jìn)一步支持,而且樣式和 Python 的原生寫法十分類似。當(dāng)然這里不會(huì)過多介紹toml格式的一些規(guī)范說明,有人已經(jīng)對(duì)官方的規(guī)范文檔進(jìn)行了翻譯,有興趣的朋友可以直接查閱。這么契合 Python 方式的配置文件類型已經(jīng)有開發(fā)者造出了相應(yīng)的「輪子」,目前在 Github 上 Stars 數(shù)最多的是則是uiri/toml的版本,不過該版本僅通過了 v0.5 版本toml規(guī)范,但在使用上還是蠻簡潔的,我們可以通過pip命令進(jìn)行安裝
pipinstalltoml
該庫的解析方式很簡單,也有點(diǎn)類似于json庫的解析用法,即通過load()loads()來進(jìn)行解析;同理轉(zhuǎn)換并導(dǎo)出也是同樣類似的用法。比如我們現(xiàn)在將以下內(nèi)容寫入到config.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()方法來進(jìn)行讀取:

>>>importtoml
>>>importos
>>>frompprintimportpprint
>>>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

yaml格式(或yml格式)是目前較為流行的一種配置文件,它早在 2001 由一個(gè)名為 Clark Evans 的人提出;同時(shí)它也是目前被廣泛使用的配置文件類型,典型的就是 Docker 容器里的docker-compose.yml配置文件,如果經(jīng)常使用 Docker 進(jìn)行部署的人對(duì)此不會(huì)陌生。yaml文件的設(shè)計(jì)從 Python、XML 等地方獲取靈感,所以在使用時(shí)能很清楚地看到這些部分的影子。在上一節(jié)toml內(nèi)容里我曾提到,yaml的規(guī)范內(nèi)容可以說是冗長和復(fù)雜,足足有80頁之多(斗尊強(qiáng)者,恐怖如斯……)。

f0bc32e0-315c-11ec-82a8-dac502259ad0.png

02-yaml規(guī)范頁數(shù)所以感興趣的朋友可以再自行了解相關(guān)用法。YAML 官方早已經(jīng)提供了相應(yīng)的 Python 庫進(jìn)行支持,即PyYAML;當(dāng)然也同樣需要我們事先進(jìn)行安裝:
pipinstallpyyaml

json庫和toml庫一樣,通過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)庫中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)行解析:

>>>importos
>>>frompprintimportpprint
>>>
>>>withopen(os.path.expanduser("~/config.yaml"),"r")asconfig:
...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庫的解析結(jié)果基本一致。

結(jié)尾

本文列舉了一些主流且常見的配置文件類型及其 Python 的讀取方法,可能有的讀者會(huì)發(fā)現(xiàn)當(dāng)中沒有xml格式類型的內(nèi)容。對(duì)于xml配置文件可能與 Java 系語言打交道的朋友遇見得會(huì)多一些,但xml文件的可讀性實(shí)在是讓人望而生畏;對(duì)xml文件不了解的朋友可以使用 Chrome 瀏覽器隨便進(jìn)入一個(gè)網(wǎng)站然后按下 F12 進(jìn)入開發(fā)者后查看那密密麻麻的 html 元素便是.xml的縮影。除了這些主流的配置文件類型之外,像一些.cfg、.properties等都可以作為配置文件,甚至和開頭提到的那樣,你單獨(dú)用一個(gè).py文件來書寫各類配置信息作為配置文件進(jìn)行導(dǎo)入都是沒問題,只是在跨語言共享時(shí)可能會(huì)有些障礙。因此本文就不過多介紹,感興趣的朋友可以進(jìn)一步自行了解。在本文里列舉的配置文件類型其復(fù)雜性由上到下依次增加:ini < json ≈ toml < yaml,它們之間各有優(yōu)劣,可以根據(jù)自己實(shí)際的需求和團(tuán)隊(duì)協(xié)作要求來具體選擇。
編輯:jq
聲明:本文內(nèi)容及配圖由入駐作者撰寫或者入駐合作網(wǎng)站授權(quán)轉(zhuǎn)載。文章觀點(diǎn)僅代表作者本人,不代表電子發(fā)燒友網(wǎng)立場。文章及其配圖僅供工程師學(xué)習(xí)之用,如有內(nèi)容侵權(quán)或者其他違規(guī)問題,請(qǐng)聯(lián)系本站處理。 舉報(bào)投訴
  • XML
    XML
    +關(guān)注

    關(guān)注

    0

    文章

    188

    瀏覽量

    33102
  • python
    +關(guān)注

    關(guān)注

    56

    文章

    4797

    瀏覽量

    84786
  • Docker
    +關(guān)注

    關(guān)注

    0

    文章

    474

    瀏覽量

    11867

原文標(biāo)題:Python 中常見的配置文件寫法

文章出處:【微信號(hào):magedu-Linux,微信公眾號(hào):馬哥Linux運(yùn)維】歡迎添加關(guān)注!文章轉(zhuǎn)載請(qǐng)注明出處。

收藏 人收藏

    評(píng)論

    相關(guān)推薦

    SSM開發(fā)中的常見問題及解決方案

    在SSM(Spring + Spring MVC + MyBatis)框架的開發(fā)過程中,開發(fā)者可能會(huì)遇到一些常見問題。以下是對(duì)這些問題的詳細(xì)分析以及相應(yīng)的解決方案: 一、配置文件問題 問題描述
    的頭像 發(fā)表于 12-17 09:16 ?390次閱讀

    linux網(wǎng)卡配置文件

    網(wǎng)卡配置文件 ? ? 網(wǎng)卡目錄[root@localhost opt]# ls /etc/sysconfig/network-scripts/網(wǎng)卡文件名字,和我們ifconfig看到的一樣
    的頭像 發(fā)表于 12-10 10:09 ?238次閱讀

    springboot的項(xiàng)目如何既要用jar包啟動(dòng),同時(shí)還可以為不同的機(jī)房設(shè)置不同的配置文件

    作者:京東科技 李意文 1、首先先把配置文件從jar中抽離 示例代碼: ? org.apache.maven.plugins maven-jar-plugin 3.2.0
    的頭像 發(fā)表于 10-19 16:48 ?530次閱讀
    springboot的項(xiàng)目如何既要用jar包啟動(dòng),同時(shí)還可以為不同的機(jī)房設(shè)置不同的<b class='flag-5'>配置文件</b>

    HID over GATT配置文件(HOGP)低功耗藍(lán)牙

    電子發(fā)燒友網(wǎng)站提供《HID over GATT配置文件(HOGP)低功耗藍(lán)牙.pdf》資料免費(fèi)下載
    發(fā)表于 09-26 11:01 ?1次下載
    HID over GATT<b class='flag-5'>配置文件</b>(HOGP)低功耗藍(lán)牙

    確定LDO的任務(wù)配置文件兼容性

    電子發(fā)燒友網(wǎng)站提供《確定LDO的任務(wù)配置文件兼容性.pdf》資料免費(fèi)下載
    發(fā)表于 09-24 10:44 ?0次下載
    確定LDO的任務(wù)<b class='flag-5'>配置文件</b>兼容性

    InModbus2配置文件的注意事項(xiàng)

    大家好,由于最近經(jīng)常有人問我InModbus2的配置文件如何編輯來達(dá)到想要的結(jié)果,所以發(fā)布一些關(guān)于InModbus2的配置文件注意事項(xiàng),后期我還會(huì)發(fā)布一些示例來供大家參考讓大家都掌握一些簡單
    發(fā)表于 07-26 07:21

    python寫驗(yàn)證環(huán)境cocotb

    本文介紹了cocotb的安裝、python tb文件寫法、用xrun仿真cocotb的腳本等,我們來看看體驗(yàn)如何。
    的頭像 發(fā)表于 07-24 09:38 ?560次閱讀
    用<b class='flag-5'>python</b>寫驗(yàn)證環(huán)境cocotb

    鴻蒙開發(fā)Ability Kit程序框架服務(wù):FA模型應(yīng)用配置文件

    應(yīng)用配置文件中包含應(yīng)用配置信息、應(yīng)用組件信息、權(quán)限信息、開發(fā)者自定義信息等,這些信息在編譯構(gòu)建、分發(fā)和運(yùn)行解決分別提供給編譯工具、應(yīng)用市場和操作系統(tǒng)使用。
    的頭像 發(fā)表于 06-24 14:49 ?370次閱讀
    鴻蒙開發(fā)Ability Kit程序框架服務(wù):FA模型應(yīng)用<b class='flag-5'>配置文件</b>

    鴻蒙開發(fā):【Stage模型應(yīng)用配置文件

    應(yīng)用配置文件中包含應(yīng)用配置信息、應(yīng)用組件信息、權(quán)限信息、開發(fā)者自定義信息等,這些信息在編譯構(gòu)建、分發(fā)和運(yùn)行解決分別提供給編譯工具、應(yīng)用市場和操作系統(tǒng)使用。
    的頭像 發(fā)表于 06-15 09:15 ?1701次閱讀
    鴻蒙開發(fā):【Stage模型應(yīng)用<b class='flag-5'>配置文件</b>】

    激活BT/BLE雙模式配置文件時(shí),可以使用相同的Mac地址(公共地址)嗎?

    激活 BT/BLE 雙模式配置文件時(shí),我可以使用相同的 Mac 地址(公共地址)嗎? 風(fēng)險(xiǎn)嗎?
    發(fā)表于 05-31 08:08

    CYW4373是否支持SPP和GATT配置文件?

    CYW4373 是否支持 SPP 和 GATT 配置文件
    發(fā)表于 05-31 06:13

    是否可能使用CYSPP配置文件連接到外圍設(shè)備?

    我們的現(xiàn)有系統(tǒng)使用中央和外圍設(shè)備,使用基于 Microchip RN4020 的中央和外圍設(shè)備。 由于供應(yīng)限制的原因,我們希望將英飛凌 CYBT-483056 SoC 用于 BLE central。 我們想知道是否可能使用CYSPP配置文件連接到外圍設(shè)備? 或任何其他請(qǐng)
    發(fā)表于 03-01 06:54

    支持CiA402驅(qū)動(dòng)器配置文件的示例程序用于通過EtherCAT?通信進(jìn)行電機(jī)控制

    電子發(fā)燒友網(wǎng)站提供《支持CiA402驅(qū)動(dòng)器配置文件的示例程序用于通過EtherCAT?通信進(jìn)行電機(jī)控制.pdf》資料免費(fèi)下載
    發(fā)表于 02-21 14:21 ?2次下載
    支持CiA402驅(qū)動(dòng)器<b class='flag-5'>配置文件</b>的示例程序用于通過EtherCAT?通信進(jìn)行電機(jī)控制

    Linux系統(tǒng)中的配置文件

    系統(tǒng)文件,用于配置主機(jī)名與 IP 地址的映射關(guān)系。當(dāng)系統(tǒng)需要解析主機(jī)名時(shí),會(huì)首先查找 /etc/hosts 文件,如果在該文件中找到了相應(yīng)的映射關(guān)系,則直接使用對(duì)應(yīng)的 IP 地址進(jìn)行通
    發(fā)表于 02-19 17:36 ?1299次閱讀

    筆記本電腦中常見的電子元器件哪些?

    筆記本電腦中常見的電子元器件哪些? 筆記本電腦中常見的電子元器件包括以下幾類: 1. 中央處理器(CPU):CPU是筆記本電腦的核心部件,負(fù)責(zé)執(zhí)行計(jì)算機(jī)的指令。常見的CPU品牌
    的頭像 發(fā)表于 02-02 10:19 ?2970次閱讀