如何正确输出包含“#”的 YAML 文件的字符串？

Question

我正在使用 Django 3 和 Python 3.7。我正在尝试编写一个函数来输出格式正确的 YAML。我有这个...

def strip_invalid(s):
    res = ''
    for x in s:
        if Reader.NON_PRINTABLE.match(x):
            # res += '\\x{:x}'.format(ord(x))
            continue
        res += x
    return res
...
yaml_street = load(strip_invalid(street.strip().encode("utf-8", 'ignore').decode("utf-8")))

问题是，如果“street”是“55 E JACKSON BLVD # 150”，则上述输出

55 E JACKSON BLVD

请注意，包括“#”在内的所有内容均已删除。如何调整上述内容以包含所有内容，但可能为 YAML 输出正确转义？

Answer 1

您可能打算使用dump 而不是load。

dump(data, stream=None) 将给定的 Python 对象序列化到流中。如果 stream 为 None，则返回生成的流。

^{来源：https://pyyaml.org/wiki/PyYAMLDocumentation#reference}

from yaml import dump
print(dump({'foo': 'bar # with hash'}))

输出：

foo: 'bar # with hash'

所以你的整个代码最终会是：

from yaml import dump
street = '  55 E JACKSON BLVD # 150  '
yaml_street = dump(street.strip())
print(yaml_street)

输出：

'55 E JACKSON BLVD # 150'

---

但是，如果您坚持编写自己的函数，则会发生这种情况，因为哈希 # 实际上是 YAML 中的注释

foo: I am a string until the hash # and then I am a comment

为避免这种情况，您可以quote your string:

foo: 'I am a string until the second quote # even if there is a hash'

另请注意，在 YAML 中转义现有引用 ' 只是将其翻倍。

foo: 'Don't us me I am a broken YAML construct'

将被解决

foo: 'I''m able to fit quote in a YAML string by doubling it'

所以你可以去：

def strip_invalid(s):
    res = ''
    for x in s:
        if Reader.NON_PRINTABLE.match(x):
            # res += '\\x{:x}'.format(ord(x))
            continue
        res += x
    return "'{}'".format(res.replace("'","''"))

yaml_street = strip_invalid(street.strip().encode("utf-8", 'ignore').decode("utf-8"))