开源云真机平台-Sonic平台-python自定义脚本-config.yaml方式实现全局配置参数的读写操作

开源云真机平台-Sonic平台-python自定义脚本-config.yaml方式实现全局配置参数的读写操作

【主要功能】

config.yaml方式实现全局配置参数的读写操作

使用python实现以下功能：
1、使用将接口获取的变量值，写入到当前目录下的config文件中，如delayTime=10；
2、读取当前目录下的config文件中，特定变量的值，如delayTime=10；
3、若config文件或者节点不存在，则自动进行创建；

【详细代码】
 

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import yaml,os


def write_config_yaml(key=None, value=None,config_file='config.yaml'):
    """
    将接口获取的变量值写入到config文件中
    :param config_file: config文件路径，默认为'config.yaml'
    :param key: 需要写入的变量名
    :param value: 需要写入的变量值
    :return: 如果文件不存在则创建，如果节点不存在则新增，如果节点存在则覆盖
    """
    if not os.path.exists(config_file):
        print(f'文件{config_file}不存在，将创建新的文件')
        with open(config_file, 'w', encoding='utf-8') as f:
            yaml.dump({}, f)
    with open(config_file, 'r', encoding='utf-8') as f:
        config = yaml.safe_load(f)
    if config is None:
        config = {}
    config[key] = value
    with open(config_file, 'w', encoding='utf-8') as f:
        yaml.dump(config, f)

# 封装函数：一次写入多个值至配置文件,适用于大量数据写入，提高性能
def write_configs_yaml(key_values=None,config_file='config.yaml'):
    """
    将接口获取的多个变量值写入到config文件中
    一次性写入多个节点的值时，只需要将多个节点的键值对存储在一个字典中，然后传入到 write_configs_yaml 函数中即可
    如：
    key_values = {'key1': value1, 'key2': value2}
    write_configs_yaml(key_values=key_values,config_file='config.yaml')
    :param config_file: config文件路径，默认为'config.yaml'
    :param key_values: 需要写入的变量名和值的字典，例如{'key1': value1, 'key2': value2}
    :return: 如果文件不存在则创建，如果节点不存在则新增，如果节点存在则覆盖
    """
    if not os.path.exists(config_file):
        print(f'文件{config_file}不存在，将创建新的文件')
        with open(config_file, 'w', encoding='utf-8') as f:
            yaml.dump({}, f)
    with open(config_file, 'r', encoding='utf-8') as f:
        config = yaml.safe_load(f)
    if config is None:
        config = {}
    for key, value in key_values.items():
        config[key] = value
    with open(config_file, 'w', encoding='utf-8') as f:
        yaml.dump(config, f)

def read_config_yaml(key=None,config_file='config.yaml'):
    """
        读取config文件中的特定变量值
        :param config_file: config文件路径，默认为'config.yaml'
        :param key: 需要读取的变量名
        :return: 返回读取到的变量值，如果文件或节点不存在则返回None
        """
    if not os.path.exists(config_file):
        print(f'文件{config_file}不存在')
        return None
    with open(config_file, 'r', encoding='utf-8') as f:
        config = yaml.safe_load(f)
    if key not in config:
        print(f'节点{key}不存在')
        return None
    return config[key]

# 打印config文件的内容
def type_config(config_file='config.yaml'):
    # 若配置文件存在，则读取所有变量值
    if os.path.exists(config_file):
        result = open(config_file, "r", encoding='utf-8').read()
        print(f"result={result}")
        return result

    # 若配置文件不存在，则返回空值
    else:
        return None

if __name__ == '__main__':
    # 以上代码实现了读取和写入config.yaml文件的功能，
    # 其中 read_config_yaml 函数用于读取特定变量的值，
    # write_config_yaml 函数用于将接口获取的变量值写入到config文件中。
    # 如果config文件不存在，会自动创建新的文件；
    # 如果节点不存在，会新增节点；
    # 如果节点存在，会覆盖原有的节点值。

    # 测试单个写入操作
    write_config_yaml('delayTime', 10)
    type_config()

    # 测试批量写入操作
    key_values = {'key1': "value1", 'key2': "value2"}
    write_configs_yaml(key_values=key_values,config_file='config.yaml')
    type_config()

    # 测试读取操作
    value = read_config_yaml('delayTime')
    print(value)

【运行效果】

result=delayTime: 10
key1: value1
key2: value2

result=delayTime: 10
key1: value1
key2: value2

10