yaml 配置笔记

时间：2025-04-05 08:22:48

yaml 配置笔记

    • 安装
    • yaml 基础
      • 基础语法
      • 数据类型
      • YAML 对象
      • YAML 数组
      • 复合结构
      • 纯量
      • 引用
    • yaml 使用
      • 编写 yaml
      • 加载 yaml
      • 结果


安装

pip install pyyaml

yaml 基础

基础语法

  • 大小写敏感
  • 使用缩进表示层级关系
  • 缩进不允许使用tab，只允许空格
  • 缩进的空格数不重要，只要相同层级的元素左对齐即可
  • '#'表示注释

数据类型

YAML 支持以下几种数据类型

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

YAML 对象

  • 对象键值对使用冒号结构表, 冒号后面要加一个空格。

    key: value

  • 层级关系

    key:{key1: value1, key2: value2, ...}

  • 缩进关系

    key: 
    child-key: value
    child-key2: value2

  • 较为复杂的对象格式

    使用问号加一个空格代表一个复杂的 key，配合一个冒号加一个空格代表一个 value：

    ?  
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2

    意思即对象的属性是一个数组 [complexkey1,complexkey2]，对应的值也是一个数组 [complexvalue1,complexvalue2]


YAML 数组

  • 以 - 开头的行表示构成一个数组

    - A
- B
- C

  • YAML 支持多维数组，可以使用行内表示

    key: [value1, value2, ...]

  • 子成员也是数组

    -
 - A
 - B
 - C

  • 复杂个例

    companies 属性是一个数组，每一个数组元素又是由 id、name、price 三个属性构成。

    companies:
    -
        id: 1
        name: company1
        price: 200W
    -
        id: 2
        name: company2
        price: 500W

  • 流式方式

    companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]

复合结构

languages:
  - Ruby
  - Perl
  - Python 
websites:
  YAML:  
  Ruby: ruby- 
  Python:  
  Perl:

json

{ 
  languages: [ 'Ruby', 'Perl', 'Python'],
  websites: {
    YAML: '',
    Ruby: '',
    Python: '',
    Perl: '' 
  } 
}

纯量

纯量是最基本的，不可再分的值，包括：

  • 字符串
  • 布尔值
  • 整数
  • 浮点数
  • Null
  • 时间
  • 日期
boolean: 
    - TRUE  #true,True都可以
    - FALSE  #false，False都可以
float:
    - 3.14
    - 6.8523015e+5  #可以使用科学计数法
int:
    - 123
    - 0b1010_0111_0100_1010_1110    #二进制表示
null:
    nodeName: 'node'
    parent: ~  #使用~表示null
string:
    - 哈哈
    - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行，每一行会被转化成一个空格
date:
    - 2018-02-17    #日期必须使用ISO 8601格式，即yyyy-MM-dd
datetime: 
    -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

引用

& 锚点和 * 别名，可以用来引用:

defaults: &defaults
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  <<: *defaults

test:
  database: myapp_test
  <<: *defaults

相当于:

defaults:
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  adapter:  postgres
  host:     localhost

test:
  database: myapp_test
  adapter:  postgres
  host:     localhost

& 用来建立锚点（defaults），<< 表示合并到当前数据，* 用来引用锚点。

下面是另一个例子:

- &showell Steve 
- Clark 
- Brian 
- Oren 
- *showell

转为 JavaScript 代码如下:

[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]



yaml 使用

编写 yaml

friend: &myFriend
  name: 李晓华
  sex: 男
  age: 16

student:
  name: 张三 # 姓名
  sex: 男  # 性别
  age: 16   # 年龄
  height: 180   # 身高
  college:  # 学校
    -     # 代表数组  - 缩进方式
      id: 1
      title: 清华大学
      position: 北京
    -
     {id: 2,title: 清华大学,position: 北京}   # 代表数组  - 流式方式
  isMarry: true   # boolean 值
  avgScore: 3.59   # 平均绩点
  inDate: 2021-09-01 # 入校时间
  outDate: 2024-07-01T12:02:03+08:00  # 离校时间 时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区
  friend: *myFriend		# 引用

加载 yaml

import yaml

f = open('./','r',encoding='utf-8')
result = ()
print(type(result),result)

# 转换成字典
directory = (result,Loader=)        # 后面的参数是为了去除报错
print(type(directory),directory)

# 通过字典读取信息
print("姓名:%s" % directory['student']['name'])
print("性别:%s" % directory['student']['sex'])
print("年龄:%s" % directory['student']['age'])
print("身高:%s" % directory['student']['height'])
print("学校:%s" % directory['student']['college'][0])
print("婚否:%s" % directory['student']['isMarry'])
print("平均绩点:%s" % directory['student']['avgScore'])
print("入校时间:%s" % directory['student']['inDate'])
print("离校时间:%s" % directory['student']['outDate'])
print("我朋友的名字:%s" % directory['student']['friend'])

结果

<class 'str'> friend: &myFriend
  name: 李晓华
  sex: 男
  age: 16

student:
  name: 张三 # 姓名
  sex: 男  # 性别
  age: 16   # 年龄
  height: 180   # 身高
  college:  # 学校
    -     # 代表数组  - 缩进方式
      id: 1
      title: 清华大学
      position: 北京
    -
     {id: 2,title: 清华大学,position: 北京}   # 代表数组  - 流式方式
  isMarry: true   # boolean 值
  avgScore: 3.59   # 平均绩点
  inDate: 2021-09-01 # 入校时间
  outDate: 2024-07-01T12:02:03+08:00  # 离校时间 时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区
  friend: *myFriend




<class 'dict'> {'friend': {'name': '李晓华', 'sex': '男', 'age': 16}, 'student': {'name': '张三', 'sex': '男', 'age': 16, 'height': 180, 'college': [{'id': 1, 'title': '清华大学', 'position': '北京'}, {'id': 2, 'title': '清华大学', 'position': '北京'}], 'isMarry': True, 'avgScore': 3.59, 'inDate': (2021, 9, 1), 'outDate': (2024, 7, 1, 12, 2, 3, tzinfo=((seconds=28800))), 'friend': {'name': '李晓华', 'sex': '男', 'age': 16}}}
姓名:张三
性别:男
年龄:16
身高:180
学校:{'id': 1, 'title': '清华大学', 'position': '北京'}
婚否:True
平均绩点:3.59
入校时间:2021-09-01
离校时间:2024-07-01 12:02:03+08:00
我朋友的名字:{'name': '李晓华', 'sex': '男', 'age': 16}

OVER~

相关文章