一区二区三区三上|欧美在线视频五区|国产午夜无码在线观看视频|亚洲国产裸体网站|无码成年人影视|亚洲AV亚洲AV|成人开心激情五月|欧美性爱内射视频|超碰人人干人人上|一区二区无码三区亚洲人区久久精品

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

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

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

Python 中常見(jiàn)的配置文件寫(xiě)法有哪些

馬哥Linux運(yùn)維 ? 來(lái)源:Python中文社區(qū) ? 作者:Python中文社區(qū) ? 2021-10-20 16:11 ? 次閱讀
加入交流群
微信小助手二維碼

掃碼添加小助手

加入工程師交流群

為什么要寫(xiě)配置文件

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

ini

ini即 Initialize 初始化之意,早期是在 Windows 上配置文件的存儲(chǔ)格式。ini文件的寫(xiě)法通俗易懂,往往比較簡(jiǎn)單,通常由節(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)庫(kù),我們直接就可以用來(lái)對(duì)ini文件進(jìn)行解析。如我們將上述內(nèi)容保存在一個(gè)名為db.ini的文件中,然后使用read()方法來(lái)進(jìn)行解析和讀取,最后通過(guò)items()方法來(lái)獲取指定節(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文件中沒(méi)有加引號(hào)而是直接將字面量寫(xiě)在上面的原因。獲取到鍵值對(duì)后,我其實(shí)直接就將其轉(zhuǎn)換成字典,然后通過(guò)解包的方式進(jìn)行穿參,保持代碼簡(jiǎ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格式可以說(shuō)是我們常見(jiàn)的一種文件形式了,也是目前在互聯(lián)網(wǎng)較為流行的一種數(shù)據(jù)交換格式。除此之外,json有時(shí)也是配置文件的一種。比如npmJavaScript 包管理工具類(lèi)似 Python 的pip)、以及微軟出品的目前被廣泛使用的 VSCode 編輯器,都使用json編寫(xiě)配置參數(shù)。configparser一樣,Python 也內(nèi)置了json標(biāo)準(zhǔn)庫(kù),可以通過(guò)load()loads()方法來(lái)導(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庫(kù)讀取 json 文件相對(duì)簡(jiǎn)單容易,而且很容易解析成 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)就是語(yǔ)法標(biāo)準(zhǔn)嚴(yán)格限制,為人所詬病之一的就是無(wú)法在當(dāng)中寫(xiě)注釋,除非采取json類(lèi)型的其他超集作為替代方案(VSCode 中能寫(xiě)注釋的json參數(shù)配置文件便是代替方案的一種);同時(shí)存在嵌套過(guò)深的問(wèn)題,容易導(dǎo)致出錯(cuò),不宜用來(lái)寫(xiě)過(guò)長(zhǎng)或復(fù)雜的參數(shù)配置信息。

toml

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

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

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

緊接著我們就可以通過(guò)toml庫(kù)中的load()方法來(lái)進(jìn)行讀?。?/span>

>>>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)化成了字典類(lèi)型,當(dāng)然這也就是json版的寫(xiě)法(將單引號(hào)替換成雙引號(hào)即可),方便我們后續(xù)調(diào)用或者傳參。

yaml

yaml格式(或yml格式)是目前較為流行的一種配置文件,它早在 2001 由一個(gè)名為 Clark Evans 的人提出;同時(shí)它也是目前被廣泛使用的配置文件類(lèi)型,典型的就是 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)容可以說(shuō)是冗長(zhǎng)和復(fù)雜,足足有80頁(yè)之多(斗尊強(qiáng)者,恐怖如斯……)。

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

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

json庫(kù)和toml庫(kù)一樣,通過(guò)load()方法來(lái)進(jìn)行加載。

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

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

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

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

如我們現(xiàn)在將之前的一些配置信息寫(xiě)入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

然后我們通過(guò)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庫(kù)的解析結(jié)果基本一致。

結(jié)尾

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

    關(guān)注

    0

    文章

    188

    瀏覽量

    33752
  • python
    +關(guān)注

    關(guān)注

    56

    文章

    4827

    瀏覽量

    86761
  • Docker
    +關(guān)注

    關(guān)注

    0

    文章

    515

    瀏覽量

    12969

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

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

收藏 人收藏
加入交流群
微信小助手二維碼

掃碼添加小助手

加入工程師交流群

    評(píng)論

    相關(guān)推薦
    熱點(diǎn)推薦

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

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

    CYW920820M2EVB-01開(kāi)發(fā)套件可以與藍(lán)牙的免提配置文件一起使用嗎?

    英飛凌 CYW920820M2EVB-01 開(kāi)發(fā)套件,我想將它與藍(lán)牙的免提配置文件一起使用。 是否可以。 該套件是否支持該配置文件? 我無(wú)法在任何地方找到該套件支持的配置文件。 如
    發(fā)表于 06-30 06:15

    如何才能知道英飛凌Bluetooth?產(chǎn)品支持哪種Bluetooth?配置文件和版本?

    如何才能知道英飛凌Bluetooth?產(chǎn)品支持哪種Bluetooth?配置文件和版本? A2DP、AVRCP、HSP、HFP 等 是否一個(gè)網(wǎng)頁(yè)或文檔解釋每個(gè)設(shè)備支持哪些配置文件和版本? 目前我想了解以下設(shè)備特別支持的
    發(fā)表于 06-27 06:04

    配置文件的差異介紹

    配置文件的差異 FA模型應(yīng)用在config.json文件中描述應(yīng)用的基本信息,一個(gè)應(yīng)用工程中可以創(chuàng)建多個(gè)Module,每個(gè)Module中都有一份config.json文件。config.json由
    發(fā)表于 06-05 06:50

    Profibus DP主站轉(zhuǎn)Modbus TCP網(wǎng)關(guān)配置文件制作

    Profibus DP主站轉(zhuǎn)Modbus TCP網(wǎng)關(guān)配置文件制作
    的頭像 發(fā)表于 04-02 13:06 ?281次閱讀
    Profibus DP主站轉(zhuǎn)Modbus TCP網(wǎng)關(guān)<b class='flag-5'>配置文件</b>制作

    Web Bluetooth SPP(串行端口配置文件)示例

    電纜替代(Cable Replacement)通常指的是通過(guò)無(wú)線(xiàn)技術(shù),如低功耗藍(lán)牙(Bluetooth LE)替代傳統(tǒng)的有線(xiàn)連接,例如串行端口配置文件(Serial Port Profile,簡(jiǎn)稱(chēng)SPP)。
    的頭像 發(fā)表于 02-28 09:40 ?641次閱讀

    DLPC3478怎么去做ini配置文件和firmware呢 ?

    你好我們現(xiàn)在是用其他廠(chǎng)商的芯片做的開(kāi)發(fā)板加上dlpc3478 2005dmd3010,我們不是官網(wǎng)那個(gè)evm,我們要自己開(kāi)發(fā)我們?cè)趺慈プ鰅ni配置文件 和firmware呢 ?之后我們是用特殊
    發(fā)表于 02-24 06:35

    如何導(dǎo)出交換機(jī)的配置文件

    在網(wǎng)絡(luò)管理中,導(dǎo)出交換機(jī)的配置文件是一項(xiàng)關(guān)鍵任務(wù),它有助于備份、審計(jì)、遷移或恢復(fù)網(wǎng)絡(luò)配置。本文將詳細(xì)介紹如何導(dǎo)出交換機(jī)配置文件,涵蓋多種方法,適用于不同場(chǎng)景和需求。文章內(nèi)容將圍繞幾種常見(jiàn)
    的頭像 發(fā)表于 02-02 17:20 ?3592次閱讀

    SSM開(kāi)發(fā)中的常見(jiàn)問(wèn)題及解決方案

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

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

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

    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 ?873次閱讀
    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 ?3次下載
    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)常有人問(wèn)我InModbus2的配置文件如何編輯來(lái)達(dá)到想要的結(jié)果,所以發(fā)布一些關(guān)于InModbus2的配置文件注意事項(xiàng),后期我還會(huì)發(fā)布一些示例來(lái)供大家參考讓大家都掌握一些簡(jiǎn)單
    發(fā)表于 07-26 07:21

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

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