当前位置:   article > 正文

Python接口自动化浅析yaml配置文件原理及用法_python 文件流 写yaml

python 文件流 写yaml

在自动化过程中,需要使用配置文件储存数据,比如数据库信息、账号信息、域名等。

其中,yaml文件是一种配置文件类型,相比较ini,conf配置文件来说,更加的简洁,操作也更加简单,同时可以存放不同类型的数据。

以下主要介绍yaml语法、yaml存储数据,封装类读写yaml配置文件。

一、yaml介绍及使用

01 yaml简介

YAML 语言( /ˈjæməl/ )的设计目标,就是方便人类读写。

它实质上是一种通用的数据串行化格式。

YAML 是一种非常灵活的格式,几乎是 JSON 的超集。

除了支持注释、换行符分隔、多行字符串、裸字符串和更灵活的类型系统之外,YAML 也支持引用文件,以避免重复代码。

02 yaml语法规则

基本语法规则:

  • 大小写敏感;
  • 使用缩进表示层级关系;
  • 缩进时不允许使用Tab键,只允许使用空格;
  • 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可;
  • # 表示注释,从这个字符一直到行尾,都会被解析器忽略;

03 yaml数据结构

  • 对象:键值对的集合,又称为映射(mapping)、哈希(hashes) 、字典(dictionary);
  • 数组:一组按次序排列的值,又称为序列(sequence) 、列表(list);
  • 纯量(scalars):单个的、不可再分的值;

对象

Map(属性和值)(键值对)的形式:

key:(空格)value :表示一对键值对,空格不可省略。

1

2

3

person:

    name: vivi

    age: 18

一行写法:

1

person:{name: vivi,age: 18}

相当于JSON格式:

1

{"name":"vivi","age":18}

数组

一组连词线开头的行,构成一个数组。数组前加有 “-” 符号,符号与值之间需用空格分隔。

1

2

3

4

color:

   - red

   - blue

   - green

一行写法:

1

color: [red,blue,green]

相当于JSON:

1

["red","blue","green"]

纯量

单个的、不可再分的值。(如:字符串、bool值、整数、浮点数、时间、日期、null等)

1

2

3

4

5

n1: 8

n2: 8.8

n3: true

n4: false

n5: 'vivi'

二、yaml配置文件的使用

01 yaml配置文件准备

在项目下新建一个目录config,在目录下新建一个文件config.yaml。

在config.yaml配置文件中写入数据库配置。

1

2

3

4

5

6

7

mysql:

  host: "127.0.0.1"

  port: 3306

  user: "vivi"

  password: "123456"

  db: "ITester"

  charset: "utf8"

02 yaml配置文件格式校验

刚了解yaml的同学,可能对yaml格式掌握不熟练,出现格式错误,这里推荐一个在线网站,用于校验我们写的yaml文件格式是否正确。

在线地址:

http://www.bejson.com/validators/yaml/

三、yaml配置文件读写

python中读取yaml文件前需要安装pyyaml和导入yaml模块。

01 安装pyYaml

在python中读取yaml文件,需要用到第三方模块PyYaml。

安装命令:

pip install pyYaml

02 yaml模块源码解析

从yaml模块中提取出load、dump函数。

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

def load(stream, Loader=None):

    """

    Parse the first YAML document in a stream

    and produce the corresponding Python object.

    """

    if Loader is None:

        load_warning('load')

        Loader = FullLoader

    loader = Loader(stream)

    try:

        return loader.get_single_data()

    finally:

        loader.dispose()

         

def dump(data, stream=None, Dumper=Dumper, **kwds):

    """

    Serialize a Python object into a YAML stream.

    If stream is None, return the produced string instead.

    """

    return dump_all([data], stream, Dumper=Dumper, **kwds)

load:

将yaml流转化为python字典;

dump:

将python对象转化为yaml流;

03 读写yaml配置文件

将读写yaml配置文件的类进行封装。

在common目录下新建一个文件,config_handler.py用于读写yaml。

config_handler.py

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

import yaml

  

class YamlHandler:

    def __init__(self,file):

        self.file = file

  

    def read_yaml(self,encoding='utf-8'):

        """读取yaml数据"""

        with open(self.file, encoding=encoding) as f:

            return yaml.load(f.read(), Loader=yaml.FullLoader)

             

    def write_yaml(self, data, encoding='utf-8'):

        """向yaml文件写入数据"""

        with open(self.file, encoding=encoding, mode='w') as f:

            return yaml.dump(data, stream=f, allow_unicode=True)

  

if __name__ == '__main__':

    data = {

        "user":{

            "username": "vivi",

            "password": "123456"

        }

    }

    # 读取config.yaml配置文件数据

    read_data = YamlHandler('../config/config.yaml').read_yaml()

    # 将data数据写入config1.yaml配置文件

    write_data = YamlHandler('../config/config1.yaml').write_yaml(data)

    print(read_data)

运行结果为:

1

2

3

4

5

6

7

8

9

10

{'mysql':

    {

           'host': '127.0.0.1',

           'port':3306,

           'user': 'vivi',

        password': '123456',

             'db': 'ITester',

        'charset': 'utf8'

   }

}

写入到config1.yaml的数据。

config1.yaml

1

2

3

user:

  password: '123456'

  username: vivi

  1. ​现在我也找了很多测试的朋友,做了一个分享技术的交流群,共享了很多我们收集的技术文档和视频教程。
  2. 如果你不想再体验自学时找不到资源,没人解答问题,坚持几天便放弃的感受
  3. qq群号:485187702【暗号:csdn11
  4. 可以加入我们一起交流。而且还有很多在自动化,性能,安全,测试开发等等方面有一定建树的技术大牛
  5. 分享他们的经验,还会分享很多直播讲座和技术沙龙
  6. 可以免费学习!划重点!开源的!!!
  7. 视频+文档+PDF+面试题可以关注公众号:【软件测试小dao】

最后感谢每一个认真阅读我文章的人,看着粉丝一路的上涨和关注,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走! 希望能帮助到你!【100%无套路免费领取】

声明:本文内容由网友自发贡献,转载请注明出处:【wpsshop博客】
推荐阅读
相关标签
  

闽ICP备14008679号