如何运用 YAML 配置文件?
最编程
2024-02-14 11:57:17
...
一、yaml文件介绍
yaml是一个专门用来写配置文件的语言。
1. yaml文件规则
- 区分大小写;
- 使用缩进表示层级关系;
- 使用
空格键
缩进,而非Tab键
缩进 - 缩进的空格数目不固定,只需要相同层级的元素左侧对齐;
- 文件中的字符串不需要使用引号标注,但若字符串包含有特殊字符则需用引号标注;
- 注释标识为#
2. yaml文件数据结构
- 对象:键值对的集合(简称 "映射或字典") 键值对用冒号 “:” 结构表示,冒号与值之间需用空格分隔
- 数组:一组按序排列的值(简称 "序列或列表") 数组前加有 “-” 符号,符号与值之间需用空格分隔
- 纯量(scalars):单个的、不可再分的值(如:字符串、bool值、整数、浮点数、时间、日期、null等) None值可用null可 ~ 表示
二、python中读取yaml配置文件
1. 前提条件
python中读取yaml文件前需要安装pyyaml和导入yaml模块:
- 使用yaml需要安装的模块为pyyaml(
pip3 install pyyaml
); - 导入的模块为yaml(
import yaml
)
2. 读取yaml文件数据
python通过open方式读取文件数据,再通过load函数将数据转化为列表或字典;
import yaml
import os
def get_yaml_data(yaml_file):
# 打开yaml文件
print("***获取yaml文件数据***")
file = open(yaml_file, 'r', encoding="utf-8")
file_data = file.read()
file.close()
print(file_data)
print("类型:", type(file_data))
# 将字符串转化为字典或列表
print("***转化yaml数据为字典或列表***")
data = yaml.load(file_data)
print(data)
print("类型:", type(data))
return data
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "config.yaml")
get_yaml_data(yaml_path)
"""
***获取yaml文件数据***
# yaml键值对:即python中字典
usr: my
psw: 123455
类型:<class 'str'>
***转化yaml数据为字典或列表***
{'usr': 'my', 'psw': 123455}
类型:<class 'dict'>
"""
3. yaml文件数据为键值对
(1)yaml文件中内容为键值对:
# yaml键值对:即python中字典
usr: my
psw: 123455
s: " abc\n"
python解析yaml文件后获取的数据:
{'usr': 'my', 'psw': 123455, 's': ' abc\n'}
(2)yaml文件中内容为“键值对'嵌套"键值对"
# yaml键值对嵌套:即python中字典嵌套字典
usr1:
name: a
psw: 123
usr2:
name: b
psw: 456
python解析yaml文件后获取的数据:
{'usr1': {'name': 'a', 'psw': 123}, 'usr2': {'name': 'b', 'psw': 456}}
(3)yaml文件中“键值对”中嵌套“数组”
# yaml键值对中嵌套数组
usr3:
- a
- b
- c
usr4:
- b
python解析yaml文件后获取的数据:
{'usr3': ['a', 'b', 'c'], 'usr4': ['b']}
4. yaml文件数据为数组
(1)yaml文件中内容为数组
# yaml数组
- a
- b
- 5
python解析yaml文件后获取的数据:
['a', 'b', 5]
(2)yaml文件“数组”中嵌套“键值对”
# yaml"数组"中嵌套"键值对"
- usr1: aaa
- psw1: 111
usr2: bbb
psw2: 222
python解析yaml文件后获取的数据:
[{'usr1': 'aaa'}, {'psw1': 111, 'usr2': 'bbb', 'psw2': 222}]
5. yaml文件中基本数据类型:
# 纯量
s_val: name # 字符串:{'s_val': 'name'}
spec_s_val: "name\n" # 特殊字符串:{'spec_s_val': 'name\n'
num_val: 31.14 # 数字:{'num_val': 31.14}
bol_val: true # 布尔值:{'bol_val': True}
nul_val: null # null值:{'nul_val': None}
nul_val1: ~ # null值:{'nul_val1': None}
time_val: 2018-03-01t11:33:22.55-06:00 # 时间值:{'time_val': datetime.datetime(2018, 3, 1, 17, 33, 22, 550000)}
date_val: 2019-01-10 # 日期值:{'date_val': datetime.date(2019, 1, 10)}
6. yaml文件中引用
yaml文件中内容
animal3: &animal3 fish
test: *animal3
python读取的数据
{'animal3': 'fish', 'test': 'fish'}
三、python中读取多个yaml文档
1. 多个文档在一个yaml文件,使用 --- 分隔方式来分段
如:yaml文件中数据
# 分段yaml文件中多个文档
---
animal1: dog
age: 2
---
animal2: cat
age: 3
2. python脚本读取一个yaml文件中多个文档方法
python获取yaml数据时需使用load_all函数来解析全部的文档,再从中读取对象中的数据
# yaml文件中含有多个文档时,分别获取文档中数据
def get_yaml_load_all(yaml_file):
# 打开yaml文件
file = open(yaml_file, 'r', encoding="utf-8")
file_data = file.read()
file.close()
all_data = yaml.load_all(file_data)
for data in all_data:
print(data)
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "config.yaml")
get_yaml_load_all(yaml_path)
"""结果
{'animal1': 'dog', 'age': 2}
{'animal2': 'cat', 'age': 3}
"""
四、python对象生成yaml文档
1. 直接导入yaml(即import yaml)生成的yaml文档
通过yaml.dump()方法不会将列表或字典数据进行转化yaml标准模式,只会将数据生成到yaml文档中
# 将python对象生成yaml文档
import yaml
def generate_yaml_doc(yaml_file):
py_object = {'school': 'zhang',
'students': ['a', 'b']}
file = open(yaml_file, 'w', encoding='utf-8')
yaml.dump(py_object, file)
file.close()
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "generate.yaml")
generate_yaml_doc(yaml_path)
"""结果
school: zhang
students: [a, b]
"""
2. 使用ruamel模块中的yaml方法生成标准的yaml文档
(1)使用ruamel模块中yaml前提条件
- 使用yaml需要安装的模块:ruamel.yaml(pip3 install ruamel.yaml);
- 导入的模块:from ruamel import yaml
(2)ruamel模块生成yaml文档
def generate_yaml_doc_ruamel(yaml_file):
from ruamel import yaml
py_object = {'school': 'zhang',
'students': ['a', 'b']}
file = open(yaml_file, 'w', encoding='utf-8')
yaml.dump(py_object, file, Dumper=yaml.RoundTripDumper)
file.close()
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "generate.yaml")
generate_yaml_doc_ruamel(yaml_path)
"""结果
school: zhang
students:
- a
- b
"""
(3)ruamel模块读取yaml文档
# 通过from ruamel import yaml读取yaml文件
def get_yaml_data_ruamel(yaml_file):
from ruamel import yaml
file = open(yaml_file, 'r', encoding='utf-8')
data = yaml.load(file.read(), Loader=yaml.Loader)
file.close()
print(data)
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "dict_config.yaml")
get_yaml_data_ruamel(yaml_path)
上一篇: YAML 文件格式指南
下一篇: 简单易懂的YAML语法指南
推荐阅读
-
如何在 Linux 下根据域名和普通证书转换自行签发 OpenSSL 证书。 修改 openssl.cnf 配置文件,创建根证书,自行签发泛域证书,将 crt 转换为 pem 格式,生成 p12 格式的
-
JET*选集学习笔记:如何运用实践论进行学习实验
-
Kubernetes 如何下挂 w11 目录(基于 Docker Desktop) -2. 完整 yaml
-
Gitlab CI 配置文件 .gitlab-ci.yaml 解释(上)
-
如何实现 *** FATAL CONFIG FILE ERROR (Redis 6.2.6) *** 详细读取配置文件
-
Java 类加载器的作用 - 简介:类加载器是 Java™ 中一个非常重要的概念。类加载器负责将 Java 类的字节码加载到 Java 虚拟机中。本文首先详细介绍了 Java 类加载器的基本概念,包括代理模型、加载类的具体过程和线程上下文类加载器等。然后介绍了如何开发自己的类加载器,最后介绍了类加载器在 Web 容器和 OSGi™ 中的应用。 类加载器是 Java 语言的一项创新,也是 Java 语言广受欢迎的重要原因之一。它允许将 Java 类动态加载到 Java 虚拟机中并执行。类加载器从 JDK 1.0 开始出现,最初是为了满足 Java Applets 的需求而开发的,Java Applets 需要从远程位置下载 Java 类文件并在浏览器中执行。现在,类加载器已广泛应用于网络容器和 OSGi。一般来说,Java 应用程序的开发人员不需要直接与类加载器交互;Java 虚拟机的默认行为足以应对大多数情况。但是,如果遇到需要与类加载器交互的情况,而您又不太了解类加载器的机制,就很容易花费大量时间调试异常,如 ClassNotFoundException 和 NoClassDefFoundError。本文将详细介绍 Java 的类加载器,帮助读者深入理解 Java 语言中的这一重要概念。下面先介绍一些基本概念。 类加载器的基本概念 顾名思义,类加载器用于将 Java 类加载到 Java 虚拟机中。一般来说,Java 虚拟机以如下方式使用 Java 类:Java 源程序(.java 文件)经 Java 编译器编译后转换为 Java 字节代码(.class 文件)。类加载器负责读取 Java 字节代码并将其转换为 java.lang 实例。每个实例都用来表示一个 Java 类。通过该实例的 newInstance 方法创建该类的对象。实际情况可能更加复杂,例如,Java 字节代码可能是由工具动态生成或通过网络下载的。 基本上,所有类加载器都是 java.lang.ClassLoader 类的实例。下面将详细介绍这个 Java 类。 java.lang.ClassLoader 类简介 java.lang.ClassLoader 类的基本职责是根据给定类的名称为其查找或生成相应的字节码,然后根据这些字节码定义一个 Java 类,即 java.lang.Class 类的实例。除此之外,ClassLoader 还负责加载 Java 应用程序所需的资源,如图像文件和配置文件。不过,本文只讨论它加载类的功能。为了履行加载类的职责,ClassLoader 提供了许多方法,其中比较重要的方法如表 1 所示。下文将详细介绍这些方法。 表 1.与加载类相关的 ClassLoader 方法
-
在 jar 中输入 SpringBoot 项目后,如何加载外部配置文件?
-
Springboot 项目通过 Config ResourceBundle 类为静态方法和 config.properties 读取 yaml 配置文件信息。
-
如何在Unity中轻松运用OnTriggerEnter功能
-
如何设置和定制GVim/Vim的配置文件