Python讀取組態檔的實戰操作

2023-04-02 06:01:46

一、 yaml

1、準備

支援的資料型別：

字典、列表、字串、布林值、整數、浮點數、Null、時間等

基本語法規則：

大小寫敏感
使用縮排表示層級關係
相同層級的元素左側對齊
鍵值對用冒號 “:” 結構表示，冒號與值之間需用空格分隔
陣列前加有 “-” 符號，符號與值之間需用空格分隔
None值可用null 和 ~ 表示
多組資料之間使用3橫槓—分割
#表示註釋，但不能在一段程式碼的行末尾加 #註釋，否則會報錯

python沒有自帶的處理yaml檔案的庫，需要下載第三方庫PyYAML 或 ruamel.yaml ，這裡我們安裝PyYAML ，同時寫入測試資料

pip install pyyaml
cat << EOF > test.yaml
os: Android
osVersion: 10
account:
  username: xiaoqq
  password: 123456
deviceName: null
appPackage: ~
bool1: True
EOF

2、運算元據

2.1 讀取資料

import yaml

with open('test.yaml', 'r', encoding='utf-8') as f:
    result = yaml.load(f.read(), Loader=yaml.FullLoader)
print(result)  # 其返回一個字典資料

2.2 寫入資料

# -*- coding:utf-8 -*-
import yaml

data = {
    "name": "李華",
    "friends": [
        "first",
        "second"
    ],
    "age": 17
}
with open('./new.yml', 'w', encoding='utf-8') as f:
   yaml.dump(data=data, stream=f, allow_unicode=True)

二、 ini

1、準備

組態檔作為一種可讀性很好的格式，非常適用於儲存程式中的設定資料。在每個組態檔中，設定資料會被分組。每個分組在其中指定對應的各個變數值。

這裡我們使用configparser庫來讀取conf檔案

環境準備：

pip install configparser  # 安裝第三方庫
cat << EOF > test.ini  # 建立組態檔
[config]
platformName=Android
appPackage=com.romwe
appActivity=com.romwe.SplashActivity

[cmd]
viewPhone=adb devices
startServer=adb start-server
stopServer=adb kill-server

[log]
log_error=true
EOF

2、運算元據

2.1 讀取資料

# -*- coding:utf-8 -*-
from configparser import ConfigParser

cp = ConfigParser()
cp.read("test.conf")
print(cp.items("cmd"))  # 獲取cmd節點下的所有鍵值對
print(cp.sections())  # 獲取所有的節點
print(cp.get("config", "platformName"))  # 獲取platformName的值

2.2. 寫資料

# -*- coding:utf-8 -*-
from configparser import ConfigParser

cp = ConfigParser()
cp.read("test.conf")
cp.set("config", "platformName", "apple")  # 修改資料
cp.add_section("test")  # 新增節點，還可以新增選項
cp.remove_section("cmd")  # 移除節點
cp.write(open("test.conf", "w", encoding="utf-8"))

三、 xml

1、準備

XML 易於擴充套件，主要用來傳送和儲存資料，聚焦的是資料的內容。

Python 有三種 XML 解析方式：SAX（simple API for XML）、DOM（Document Object Model）、ElementTree。

DOM 方式：DOM 中文譯為檔案物件模型，是 W3C 組織推薦的標準程式設計介面，它將 XML 資料在記憶體中解析成一個樹，通過對樹的操作來操作 XML。
SAX 方式：SAX 是一個用於處理 XML 事件驅動的模型，它逐行掃描檔案，一邊掃描一邊解析，對於大型檔案的解析擁有巨大優勢，儘管不是 W3C 標準，但它卻得到了廣泛認可。
ElementTree 方式：ElementTree 相對於 DOM 來說擁有更好的效能，與 SAX 效能差不多，API 使用也很方便。

這裡就使用 ElementTree 的方式對XML進行解析：

首先建立一個XML檔案test.xml：

<?xml version="1.0" encoding="utf-8" ?>
<list>
    <student id="stu1" name="stu">
        <id>1001</id>
        <name>張三</name>
        <age>22</age>
    </student>
    <student id="stu2" name="stu">
        <id>1002</id>
        <name>李四</name>
        <age>23</age>
    </student>

</list>

xml是python內建的庫

2、運算元據

2.1 讀取資料

由於我對xml資料的操作不太熟悉，這裡只展示對xml資料的寫入

#!/usr/bin/python3
# -*- coding: UTF-8 -*-
import xml.etree.ElementTree as ET

tree = ET.parse("test.xml")
# 根節點
root = tree.getroot()
# 標籤名
print('root_tag:', root.tag)
for stu in root:
    # 屬性值
    print("stu_name:", stu.attrib["name"])
    # 標籤中內容
    print("id:", stu[0].text)
    print("name:", stu[1].text)
    print("age:", stu[2].text)

2.2 寫入資料

# -*- coding:utf-8 -*-

import xml.etree.ElementTree as ET

# 增加換行符
def __indent(elem, level=0):
    i = "n" + level * "t"
    if len(elem):
        if not elem.text or not elem.text.strip():
            elem.text = i + "t"
        if not elem.tail or not elem.tail.strip():
            elem.tail = i
        for elem in elem:
            __indent(elem, level + 1)
        if not elem.tail or not elem.tail.strip():
            elem.tail = i
    else:
        if level and (not elem.tail or not elem.tail.strip()):
            elem.tail = i

root = ET.Element('Root')  # 建立節點
tree = ET.ElementTree(root)  # 建立檔案

for i in range(5):
    element = ET.Element('Name')
    element.set('age', str(i))
    element.text = 'default'
    root.append(element)

__indent(root)  # 增加換行符
tree.write('default.xml', encoding='utf-8', xml_declaration=True)

# # 檔案內容
# <?xml version='1.0' encoding='utf-8'?>
# <Root>
#     <Name age="0">default</Name>
#     <Name age="1">default</Name>
#     <Name age="2">default</Name>
#     <Name age="3">default</Name>
#     <Name age="4">default</Name>
# </Root>

四、 env

1、準備

.env檔案，是存放環境變數的檔案

檔案說明：

.env：全域性預設組態檔，無論什麼環境都會載入合併。
.env.development：開發環境的組態檔
.env.production：生產環境的組態檔

首先，我們先來暫時建立一個test.env

ADMIN_HOST = https://uat-rm-gwaaa.cn
ADMIN_LOGIN_ROUTE = /api/rm/auth/admin/login
ADMIN_LOGIN_DATA = {"phone":"13922221111","paord":"6d614954ed51"}

專案中的環境變數寫到.env檔案裡，以k，v的方式讀取作為環境變數

環境設定：

pip install python-dotenv  # 安裝dotenv

2、讀取檔案

最簡單和最常見的用法是在應用程式啟動時呼叫load_dotenv，從當前目錄或其父目錄中的.env檔案或指定的路徑載入環境變數，然後呼叫os.getenv提供的與環境相關的方法

from dotenv import load_dotenv, find_dotenv
from pathlib import Path
from glob import glob
from os import getenv

for i in glob(str(Path(__file__).parent / "*.env")):  # 獲取到所有的環境變數的值
    # load_dotenv(find_dotenv(i), verbose=True)  # 載入環境變數
    load_dotenv(dotenv_path=i, verbose=True)  # 這兩個方法用法一樣，具體用法可以到百度自行搜尋

print(getenv("admin_host"))

環境變數，顧名思義，其為不變的量，相當於一個常數，所以這裡就不提供修改環境變數的值，再載入到檔案中的方法了。

五、 json

1、準備

用json檔案作為組態檔來儲存一些可能要人工修改的引數，主要技巧在於將字典內容轉為變數。這裡，我們使用JSON模組來讀取json檔案。其為python的內建庫。

首先，我們先建立一個test.json

{
    "target_dir": "E:/data",
    "interval_mins": 5,
    "time_record": "201904011230"
}

2、運算元據

然後，建立指令碼來操作這個組態檔：

#!/usr/bin/python3
# -*- coding: UTF-8 -*-
__author__ = "A.L.Kun"
__file__ = "demo01.py"
__time__ = "2022/10/7 7:55"
import json


path = "test.json"
with open(path, "r", encoding="utf-8") as f:
    data = json.load(f)   # 載入我們的資料
    print(data)
    
    
with open(path, "w", encoding="utf-8") as f:
    data["temp"] = [1, 2, 3]  # 修改我們的設定，重新儲存到檔案中
    json.dump(data, f, indent=3, ensure_ascii=False)

更多json詳細的操作，可以看這篇部落格：https://blog.csdn.net/qq_62789540/article/details/122482706

六、 toml

1、準備

TOML 的目標是成為一個極簡的組態檔格式。TOML 被設計成可以無歧義地被對映為雜湊表，從而被多種語言解析。

我們使用toml庫來解析toml檔案

首先，我們進行環境準備：

pip install toml 
cat << EOF > test.toml
title = "TOML in file a"

[owner]
name = "Tom Preston-Werner"
organization = "GitHub"
bio = "GitHub Cofounder & CEOnLikes tater tots and beer."
dob = 1979-05-27T07:32:00Z
EOF

2、運算元據

2.1 讀取資料

# -*- coding:utf-8 -*-
import toml
path = "test.toml"

a = toml.load(path)
print(a)

2.2 寫入資料

# -*- coding:utf-8 -*-
import toml
path = "test.toml"

data = {
    "name": "李華",
    "friends": [
        "first",
        "second"
    ],
    "age": 17
}

toml.dump(data, open(path, "w", encoding="utf-8"))

七、 HOCON

1、準備

HOCON（Human-Optimized Config Object Notation）是一個易於使用的組態檔格式。它被用於 Sponge 以及利用 Sponge API 的獨立外掛以儲存重要的資料，比如設定或者玩家資料。HOCON 檔案通常以 .conf 作為字尾名。

組成部分

一個 key 是一個鍵值對字串中的前一個值
一個 value 可以是字串、數位、物件、陣列或者布林值並緊隨 key 的後面
一個 key-value separator 把鍵和值分離，可以是 : 或者 =
一個 comment 以 # 或者 // 開頭，通常用於提供反饋或說明

我們這裡直接使用Nginx的組態檔作為演示，test.conf：

deployment {
      proxy {
        // Name has to be replaced with the name of the project
        cluster.NAME {
          property1 = [a_list]
          property2.host = "hostname"
        }
      }
}

環境準備，這裡使用pyhocon 庫來讀取檔案：

pip install pyhocon

2、資料操作

2.1 讀取資料

# -*- coding:utf-8 -*-
from pyhocon import ConfigFactory, HOCONConverter
import json
with open("test.conf", "r", encoding="utf-8") as f:
    data = f.read()
    
config_data = ConfigFactory.parse_string(data)
config_data = json.loads(HOCONConverter.to_json(config_data))
print(config_data)

2.2 寫入資料

# -*- coding:utf-8 -*-
from pyhocon.tool import HOCONConverter
from pyhocon.config_tree import ConfigTree

s = {
    "name": "Luihua",
    "age": 23,
    "dic": {
        "1": "asd",
        "2": "a"
    }
}
data = ConfigTree(s)  # 注意要先轉換為ConfigTree物件才能成功

with open("test.conf", "w", encoding="utf-8") as f:
    f.write(HOCONConverter.to_hocon(data))

基本的組態檔的讀取方式都在這裡了，大家可以根據自己的需求學習！

總結

到此這篇關於Python讀取組態檔的文章就介紹到這了,更多相關Python讀取組態檔內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

Python讀取組態檔的實戰操作

目錄

一、 yaml

1、 準備

2、 運算元據

2.1 讀取資料

二、 ini

1、準備

2、 運算元據

2.1 讀取資料

2.2. 寫資料

三、 xml

1、 準備

2、 運算元據

2.1 讀取資料

2.2 寫入資料

四、 env

1、 準備

2、 讀取檔案

五、 json

1、 準備

2、 運算元據

六、 toml

1、 準備

2、 運算元據

2.1 讀取資料

2.2 寫入資料

七、 HOCON

1、 準備

2、 資料操作

2.1 讀取資料

總結

熱門文章

1、準備

2、運算元據

2、運算元據

1、準備

2、運算元據

1、準備

2、讀取檔案

1、準備

2、運算元據

1、準備

2、運算元據

1、準備

2、資料操作