iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >Python配置文件yaml的用法详解
  • 935
分享到

Python配置文件yaml的用法详解

2024-04-02 19:04:59 935人浏览 八月长安

Python 官方文档:入门教程 => 点击学习

摘要

目录一、PyYaml二、yaml语法1、基本规则2、yaml转字典3、yaml转列表4、复合结构5、基本类型6、引用7、强制转换8、分段三、构造器(constructors)、表示器

YAML是一种直观的能够被电脑识别的的数据序列化格式,容易被人类阅读,并且容易和脚本语言交互。YAML类似于XML,但是语法比XML简单得多,对于转化成数组或可以hash的数据时是很简单有效的。

一、PyYaml

1、load() :返回一个对象

我们先创建一个yml文件,config.yml:

name: Tom Smith
age: 37
spouse:
    name: Jane Smith
    age: 25
children:
 - name: Jimmy Smith
   age: 15
 - name1: Jenny Smith
   age1: 12

读取yml文件:

import yaml
f = open(r'E:\AutomaticTest\Test_Framework\config\config.yml')
y = yaml.load(f)
print (y)

结果:

{'name': 'Tom Smith', 'age': 37, 'spouse': {'name': 'Jane Smith', 'age': 25}, 'children': [{'name': 'Jimmy Smith', 'age': 15}, {'name1': 'Jenny Smith', 'age1': 12}]}

2、load_all()生成一个迭代器

如果string或文件包含几块yaml文档,你可以使用yaml.load_all来解析全部的文档。

import yaml
f = '''
---
name: James
age: 20
---
name: Lily
age: 19
'''
y = yaml.load_all(f)
for data in y:
    print(data)

执行结果:

{'name': 'James', 'age': 20}
{'name': 'Lily', 'age': 19}

3、yaml.dump 将一个python对象生成为yaml文档

import yaml
aproject = {'name': 'Silenthand Olleander',
            'race': 'Human',
            'traits': ['ONE_HAND', 'ONE_EYE']
            }

print(yaml.dump(aproject,))

执行结果:

name: Silenthand Olleander
race: Human
traits: [ONE_HAND, ONE_EYE]

yaml.dump接收的第二个参数一定要是一个打开的文本文件或二进制文件,yaml.dump会把生成的yaml文档写到文件里

import yaml

aproject = {'name': 'Silenthand Olleander',
            'race': 'Human',
            'traits': ['ONE_HAND', 'ONE_EYE']
            }
f = open(r'E:\AutomaticTest\Test_Framework\config\config.yml','w')
print(yaml.dump(aproject,f))

4、yaml.dump_all()将多个段输出到一个文件中

import yaml

obj1 = {"name": "James", "age": 20}
obj2 = ["Lily", 19]

with open(r'E:\AutomaticTest\Test_Framework\config\config.yml', 'w') as f:
    yaml.dump_all([obj1, obj2], f)

输出到文件:

{age: 20, name: James}
--- [Lily, 19]

二、yaml语法

1、基本规则

1. 大小写敏感

2. 使用缩进表示层级关系

3. 缩进时不允许使用Tab,只允许使用空格

4. 缩进的空格数目不重要,只要相同层级的元素左对齐即可

5. # 表示注释,从它开始到行尾都被忽略

2、yaml转字典

yaml中支持映射或字典的表示,如下:

# 下面格式读到Python里会是个dict
name: 灰蓝
age: 0
job: Tester

输出:

{'name': '灰蓝', 'age': 0, 'job': 'Tester'}

3、yaml转列表

yaml中支持列表或数组的表示,如下:

# 下面格式读到Python里会是个list
- 灰蓝
- 0
- Tester

输出:

['灰蓝', 0, 'Tester']

4、复合结构

字典和列表可以复合起来使用,如下:

# 下面格式读到Python里是个list里包含dict
- name: 灰蓝
  age: 0
  job: Tester
- name: James
  age: 30

输出:

[{'name': '灰蓝', 'age': 0, 'job': 'Tester'}, {'name': 'James', 'age': 30}]

5、基本类型

yaml中有以下基本类型:

  • 字符串
  • 整型
  • 浮点型
  • 布尔型
  • null
  • 时间
  • 日期

我们写个例子来看下:

# 这个例子输出一个字典,其中value包括所有基本类型
str: "Hello World!"
int: 110
float: 3.141
boolean: true  # or false
None: null  # 也可以用 ~ 号来表示 null
time: 2016-09-22t11:43:30.20+08:00  # ISO8601,写法百度
date: 2016-09-22  # 同样ISO8601

输出:

{'str': 'Hello World!', 'int': 110, 'float': 3.141, 'boolean': True, 'None': None, 'time': datetime.datetime(2016, 9, 22, 3, 43, 30, 200000), 'date': datetime.date(2016, 9, 22)}

如果字符串没有空格或特殊字符,不需要加引号,但如果其中有空格或特殊字符,则需要加引号了

str: 灰蓝
str1: "Hello World"
str2: "Hello\nWorld"

输出:

{'str': '灰蓝', 'str1': 'Hello World', 'str2': 'Hello\nWorld'}

这里要注意单引号和双引号的区别,单引号中的特殊字符转到Python会被转义,也就是到最后是原样输出了,双引号不会被Python转义,到最后是输出了特殊字符;如:

str1: 'Hello\nWorld'
str2: "Hello\nWorld"

输出:

{'str1': 'Hello\\nWorld', 'str2': 'Hello\nWorld'}

可以看到,单引号中的’\n’最后是输出了,双引号中的’\n’最后是转义成了回车

6、引用

& 和 * 用于引用

name: &name 灰蓝
tester: *name

这个相当于一下脚本:

name: 灰蓝
tester: 灰蓝

输出:

{'name': '灰蓝', 'tester': '灰蓝'}

7、强制转换

yaml是可以进行强制转换的,用 !! 实现,如下:

str: !!str 3.14
int: !!int "123"

输出:

{'int': 123, 'str': '3.14'}

明显能够看出123被强转成了int类型,而float型的3.14则被强转成了str型。

8、分段

在同一个yaml文件中,可以用 — 来分段,这样可以将多个文档写在一个文件中

---
name: James
age: 20
---
name: Lily
age: 19

三、构造器(constructors)、表示器(representers)、解析器(resolvers )

1、yaml.YAMLObject

yaml.YAMLObject用元类来注册一个构造器(也就是代码里的 init() 方法),让你把yaml节点转为Python对象实例,用表示器(也就是代码里的 repr() 函数)来让你把Python对象转为yaml节点,看代码:

import yaml
class Person(yaml.YAMLObject):
    yaml_tag = '!person'

    def __init__(self, name, age):
        self.name = name
        self.age = age

    def __repr__(self):
        return '%s(name=%s, age=%d)' % (self.__class__.__name__, self.name, self.age)

james = Person('James', 20)

print (yaml.dump(james))  # Python对象实例转为yaml

lily = yaml.load('!person {name: Lily, age: 19}')

print (lily)  # yaml转为Python对象实例

输出:

!person {age: 20, name: James}

Person(name=Lily, age=19)

2、yaml.add_constructor 和 yaml.add_representer

你可能在使用过程中并不想通过上面这种元类的方式,而是想定义正常的类,那么,可以用这两种方法

import yaml


class Person(object):
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def __repr__(self):
        return 'Person(%s, %s)' % (self.name, self.age)

james = Person('James', 20)
print (yaml.dump(james))  # 没加表示器之前


def person_repr(dumper, data):
    return dumper.represent_mapping(u'!person', {"name": data.name, "age": data.age})  # mapping表示器,用于dict

yaml.add_representer(Person, person_repr)  # 用add_representer方法为对象添加表示器
print (yaml.dump(james))  # 加了表示器之后


def person_cons(loader, node):
    value = loader.construct_mapping(node)  # mapping构造器,用于dict
    name = value['name']
    age = value['age']
    return Person(name, age)

yaml.add_constructor(u'!person', person_cons)  # 用add_constructor方法为指定yaml标签添加构造器
lily = yaml.load('!person {name: Lily, age: 19}')
print (lily)

输出:

!!python/object:__main__.Person {age: 20, name: James}

!person {age: 20, name: James}

Person(Lily, 19)

第一行是没加表示器之前,多丑!中间那行是加了表示器之后,变成了规范的格式,下面添加了构造器,能够把 !person 标签转化为Person对象。

四、示例

yaml是一种很清晰、简洁的格式,而且跟Python非常合拍,非常容易操作,我们在搭建自动化测试框架的时候,可以采用yaml作为配置文件,或者用例文件,下面给出一个用例的示例

# Test using included Django test app
# First install python-djanGo
# Then launch the app in another terminal by doing
#   cd testapp
#   python manage.py testserver test_data.JSON
# Once launched, tests can be executed via:
#   python resttest.py Http://localhost:8000 miniapp-test.yaml
---
- config:
    - testset: "Tests using test app"

- test: # create entity
    - name: "Basic get"
    - url: "/api/person/"
- test: # create entity
    - name: "Get single person"
    - url: "/api/person/1/"
- test: # create entity
    - name: "Get single person"
    - url: "/api/person/1/"
    - method: 'DELETE'
- test: # create entity by PUT
    - name: "Create/update person"
    - url: "/api/person/1/"
    - method: "PUT"
    - body: '{"first_name": "Gaius","id": 1,"last_name": "Baltar","login": "gbaltar"}'
    - headers: {'Content-Type': 'application/json'}
- test: # create entity by POST
    - name: "Create person"
    - url: "/api/person/"
    - method: "POST"
    - body: '{"first_name": "Willim","last_name": "Adama","login": "theadmiral"}'
    - headers: {Content-Type: application/json}

到此这篇关于Python配置文件yaml的用法详解的文章就介绍到这了,更多相关Python yaml用法内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

--结束END--

本文标题: Python配置文件yaml的用法详解

本文链接: https://www.lsjlt.com/news/144493.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • Python配置文件yaml的用法详解
    目录一、PyYaml二、yaml语法1、基本规则2、yaml转字典3、yaml转列表4、复合结构5、基本类型6、引用7、强制转换8、分段三、构造器(constructors)、表示器...
    99+
    2022-11-13
  • SpringBoot详细讲解yaml配置文件的用法
    目录1.基本语法2.数据类型3.代码测试4.开启补全提示1.基本语法 key: value;kv之间有空格大小写敏感使用缩进表示层级关系缩进不允许使用tab,只允许空格缩进的空格数不...
    99+
    2022-11-13
  • Python实现解析yaml配置文件的示例详解
    目录楔子字典数组标量引用生成 yaml 文件楔子 前面我们介绍了 ini 格式的配置文件,本次来看看 yaml,它的表达能力相比 ini 更加的强大。yaml 文件以 .yml 结尾...
    99+
    2022-11-11
  • SpringBoot中YAML配置文件实例详解
    目录一、YAML 简介1、什么是 YAML ?2、优点3、扩展名4、语法规则5、格式二、三种配置文件1、properties 类型2、yml 类型3、yaml 类型4、优先级三、YA...
    99+
    2023-05-15
    spring boot yaml yaml配置文件 springboot yaml配置文件
  • SpringBoot超详细讲解yaml配置文件
    目录1.文件类型A.properties配置文件类型B.yaml基本语法数据类型2.配置提示1.文件类型 A.properties配置文件类型 同以前properties用法一样 B...
    99+
    2022-11-13
  • python读取yaml配置文件
    1.yaml [ˈjæməl]: Yet Another Markup Language :另一种标记语言。yaml 是专门用来写配置文件的语言,非常简洁和强大,之前用ini也能写配置文件,看了yaml后,发现这个更直观,更方便,有点类似...
    99+
    2023-01-31
    配置文件 python yaml
  • Python如何配置文件yaml
    今天小编给大家分享一下Python如何配置文件yaml的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。YAML是一种直观的能够...
    99+
    2023-06-29
  • yolov5模型配置yaml文件详细讲解
    目录以models/yolov5s.yaml为例我们一个一个来解释:补充:模型 yaml 文件中第四参数解释总结 yolov5的代码模型构建是通过.yaml文件实现的,初次...
    99+
    2022-11-11
  • python如何修改yaml配置文件
    使用python修改yaml配置文件的方法:1.新建python项目;2.使用pip方式安装yaml;3.使用os.path.realpath(__file__)方法获取配置文件路径;4.使用os.path.join()方法修改配置文件;具...
    99+
    2022-10-19
  • python yaml用法详解
    YAML是一种直观的能够被电脑识别的的数据序列化格式,容易被人类阅读,并且容易和脚本语言交互。YAML类似于XML,但是语法比XML简单得多,对于转化成数组或可以hash的数据时是很简单有效的。 一、PyYaml 1、load...
    99+
    2023-01-31
    详解 python yaml
  • Python学习之yaml文件的读取详解
    目录yaml 文件的应用场景与格式介绍yaml 文件的应用场景yaml 文件的格式第三方包 - pyyaml读取 yaml 文件的方法yaml文件读取演示案例yaml 文件的应用场景...
    99+
    2022-11-13
  • SpringBoot解析怎么指定Yaml配置文件
    这篇“SpringBoot解析怎么指定Yaml配置文件”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“SpringBoot解析...
    99+
    2023-07-05
  • Python常用配置文件ini、json、yaml读写总结
    本文参考文章,出于学习目的,写本文。 开发项目时,为了维护一些经常需要变更的数据,比如数据库的连接信息、请求的url、测试数据等,需要将这些数据写入配置文件,将数据和代码分离,只需要...
    99+
    2022-11-12
  • Python接口自动化浅析yaml配置文件原理及用法
    目录一、yaml介绍及使用01 yaml简介02 yaml语法规则03 yaml数据结构对象数组纯量二、yaml配置文件的使用01 yaml配置文件准备02 yaml配置文件格式校验...
    99+
    2022-11-12
  • SpringBoot中怎么使用yaml配置文件
    本篇内容介绍了“SpringBoot中怎么使用yaml配置文件”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!1.基本语法key: value...
    99+
    2023-07-02
  • Python配置文件管理之ini和yaml文件读取的实现
    1. 引言 当我们设计软件时,我们通常会花费大量精力来编写高质量的代码。但这往往还不够,一个好的软件还应该考虑其整个系统,如测试、部署、网络等。其中最重要的一个方面是配置管理。 良好...
    99+
    2023-02-28
    Python ini文件读取 Python ini和yaml文件读取
  • python 中yaml文件用法大全
    yaml简单介绍 YAML是一种标记语言,它使用空白符号缩进和大量依赖外观的特色,特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲。 大小写敏感 使用缩进表示层级关系 缩...
    99+
    2022-06-02
    python 中yaml文件用法 python yaml文件
  • 解决SpringBoot使用yaml作为配置文件遇到的坑
    目录SpringBoot yaml作为配置文件遇到的坑背景感觉修改一下比较好,类似这样:SpringBoot-yaml配置注入yaml基础语法字面量:普通的值 [ 数字,布尔值,字符...
    99+
    2022-11-12
  • python操作yaml的方法详解
    目录一、参考链接二、python类型转换为yaml三、yaml转换为python类型总结一、参考链接 https://pyyaml.org/wiki/PyYAMLDocumentat...
    99+
    2022-11-12
  • SpringBoot解析指定Yaml配置文件的实现过程
    目录前言1、自定义配置文件2、配置对象类3、YamlPropertiesSourceFactory 下面还有投票,帮忙投个票 前言 最近在看某个开源项目代码并准备参与其中,代码过了一...
    99+
    2023-03-22
    SpringBoot解析Yaml配置文件 SpringBoot Yaml配置文件
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作