首页 > 编程语言> > python模块-PyYAML

python模块-PyYAML

2022-09-13 00:31:57 作者：互联网

　　YAML是专门用来写配置文件的语言，远比JSON格式方便。

　　YAML语言的设计目标，就是方便人类读写。

　　YAML是一种比XML和JSON更轻的文件格式，也更简单更强大，它可以通过缩进来表示结构，是不是听起来就和Python很搭？

　　顾名思义，用语言编写的文件就可以称之为YAML文件。PyYaml是Python的一个专门针对YAML文件操作的模块，使用起来非常简单。

1.yaml文件格式简介

　　基本规则：

大小写敏感
使用缩进表示层级关系
缩进时不允许使用Tab键，只允许使用空格。
缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
使用#表示注释
字符串可以不用引号标注

　　yaml 支持的数据结构有三种：

对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
纯量（scalars）：单个的、不可再分的值。字符串、布尔值、整数、浮点数、Null、时间、日期

1.1 对象

user: admin
pwd: 123
job:
  - teacher
  - nurese

#输出
{'user': 'admin',
 'pwd': 123,
 'job': ['teacher', 'nurese']}

1.2 数组序列

- admin1: 123456
- admin2: 111111
- admin3: 222222

#输出：
[{'admin1': 123456},
{'admin2': 111111}, 
{'admin3': 222222}]

1.3 纯量

n1: 52.10
---------------------------------------------------------------
n2: true 
n3: false    #不区分大小写
---------------------------------------------------------------
#None用~表示
n4: ~


输出：{'n1': 52.1}
---------------------------------------------------------------
输出：{'n2': True, 'n3': False}
---------------------------------------------------------------
输出：{'n4': None}

1.4 混合使用

1.list嵌套dict

- user: admin1
  psw: '123456'
- user: admin2
  psw: '111111'
- user: admin3
  psw: '222222'

　　用python读取出来的结果：

[{'user': 'admin1', 'psw': '123456'},
{'user': 'admin2', 'psw': '111111'},
{'user': 'admin3', 'psw': '222222'}]

2.dict嵌套list

nub1:
    - admin1
    - '123456'
nb2:
    - admin2
    - '111111'
nb3:
    - admin3
    - '222222'

　　用python读取出来的结果：

{'nub1': ['admin1', '123456'],

'nb2': ['admin2', '111111'],

2.Yaml语法详解

2.1 基本规则

大小写敏感
使用缩进表示层级关系
缩进时不允许使用Tab键，只允许使用空格。
缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
使用#表示注释
字符串可以不用引号标注

2.2 yaml转字典

　　yaml中支持映射或字典的表示，如下：

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

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

2.3 yaml转列表

　　yaml中支持列表或数组的表示，如下：

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

输出：
['灰蓝', 0, 'Tester']

2.4 复合结构

　　字典和列表可以复合起来使用，如下：

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

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

2.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’最后是转义成了回车

2.6 引用

　　& 和 * 用于引用

name: &name 灰蓝
tester: *name

　　这个相当于一下脚本：

name: 灰蓝
tester: 灰蓝

　　输出：

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

2.7 强制转换

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

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

　　输出：

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

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

2.8 分段

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

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

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

3.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)

3.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对象。

4.PyYaml使用实例

4.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'./config.yaml')
#y = yaml.load(f)  #yaml5.1后废弃这种方法
#由于Yaml 5.1版本后弃用了 yaml.load(file) 这个用法。Yaml 5.1版本之后就修改了需要指定Loader，通过默认加载器（FullLoader）禁止执行任意函数，使得此load函数的安全得到加强。
#下面三种方法都可以
# y=yaml.load(f,Loader=yaml.FullLoader)
# y=yaml.safe_load(f)
y=yaml.load(f, Loader=yaml.CLoader)
print (y)

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

4.2 load_all()生成一个迭代器

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

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


#结果输出
{'name': 'James', 'age': 20}
{'name': 'Lily', 'age': 19}

4.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'./config2.yaml','w')
print(yaml.dump(aproject,f))

　　文件输出

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

import yaml

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

with open(r'./config3.yaml', 'w') as f:
    yaml.dump_all([obj1, obj2], f)

　　结果文件输出:

5.总结

　　看完这篇文章，可以看到，整个操作都是比较简单的，但是是不是发现没有增加，删除等操作呀？这个确实好像修改数据，好像只有把数据全部取出来,然后修改,然后在存回去

官方链接:http://pyyaml.org/wiki/PyYAMLDocumentation

标签：输出,PyYAML,name,python,age,灰蓝,yaml,模块,self
来源： https://www.cnblogs.com/lizexiong/p/16687805.html