关于yaml转义的几种尝试

yaml的优点、用法啥的就不在这讲了，主要是将yaml语法中的对字符串几种转义列举出来，本文使用的是python3的pyyaml做测试

1.字符串默认不使用引号表示。

str: 字符串value

用python3读取展示

{'str': '字符串value'}

2.如果字符串首尾想要保留空格，就需要放在引号中

str: ' 字符串value '

用python3读取展示

{'str': ' 字符串value '}

3.如果字符串中包含特殊字符，如：“[]:-”，也需要放在引号中

str: '- key: [v]字符串value'

用python3读取展示

{'str': '- key: [v]字符串value'}

4.单引号和双引号的区别，单引号会对特殊字符转义，双引号不会对特殊字符转义

str1: '这是\n字符串'
str2: "这是\n字符串"

用python3读取展示

{'str1': '这是\\n字符串', 'str2': '这是\n字符串'}

也就是单引号中的特殊字符最终会被当成普通字符打印出来，而双引号中的特殊字符会用特殊字符的效果（\n在双引号中打印出来会换行）

{'str1': '这是\\n字符串', 'str2': '这是\n字符串'}
str1 --> 这是\n字符串
str2 --> 这是
字符串

5.单引号之中如果还有单引号，必须连续使用两个单引号转义

str1: '这是''字符串内包含一个单引号字符串'
str2: '这是''被字符串内的单引号引起来的内容''字符串'

用python3读取展示

{'str1': "这是'字符串内包含一个单引号字符串", 'str2': "这是'被字符串内的单引号引起来的内容'字符串"}

6.如果字符串内包含单引号又包含双引号的情况下，单引号用两个单引号转义，双引号直接写就行

str: '这是''一个单引号"一个双引号字符串'

用python3读取展示

{'str': '这是\'一个单引号"一个双引号字符串'}

7.字符串可以写成多行，从第二行开始，必须有一个单空格缩进。换行符会被转为空格

str1: 
  这是
  一个
  多行
  字符串

用python3读取展示

{'str1': '这是 一个 多行 字符串'}

8.多行字符串可以使用|保留换行符，也可以使用>折叠换行

str1: |
  这是
  一个
  多行
  字符串

str2: >
  这是
  一个
  多行
  字符串

用python3读取展示

{'str1': '这是\n一个\n多行\n字符串\n', 'str2': '这是 一个 多行 字符串\n'}

9.+表示保留文字块末尾的换行，-表示删除字符串末尾的换行

str1: |+
  这是
  一个
  多行
  字符串


str2: |+
  这是
  一个
  多行
  字符串


str3: >-
  这是
  一个
  多行
  字符串


str4: >-
  这是
  一个
  多行
  字符串

用python3读取展示

{'str1': '这是\n一个\n多行\n字符串\n\n\n', 'str2': '这是\n一个\n多行\n字符串\n\n\n', 'str3': '这是 一个 多行 字符串', 'str4': '这是 一个 多行 字符串'}

10.如果字符串的情况真的很复杂，不知道怎么转义才是正确的，那就使用python3来写如yaml文件吧
python3代码如下

import yaml

yamlFile = 'conf.yml'
complex_string = '''这是很复杂的字符串，有很多特殊字符
！@#￥%……&*（）——+/”：’/。、】【<>.,;: ''"||[]\n
换行
\ttab键
可以随便写
'''
data = {
    'complex_str': complex_string
}
f = open(yamlFile, 'w', encoding='utf-8')
yaml.dump(data, f, allow_unicode=True)

生成的yml文件内容

complex_str: "这是很复杂的字符串，有很多特殊字符\n！@#￥%……&*（）——+/”：’/。、】【<>.,;: ''\"||[]\n\n换行\n\t\
  tab键\n可以随便写\n"

用python3读取展示

{'complex_str': '这是很复杂的字符串，有很多特殊字符\n！@#￥%……&*（）——+/”：’/。、】【<>.,;: \'\'"||[]\n\n换行\n\ttab键\n可以随便写\n'}