如何将字符串拆分为多行并在 YAML 中保留空格？

Question

请注意，问题类似于this one，但仍然不同，因此这些答案无法解决我的问题：

• 用于插入控制字符，例如\x08，看来我得用双引号"。
• 所有空格都需要按照给定的方式保留。对于换行符，我明确使用\n。

我有一些字符串数据需要存储在 YAML 中，例如：

• " This is my quite long string data "
• "This is my quite long string data"
• "This_is_my_quite_long_string_data"
• "Sting data\nwhich\x08contains control characters"

并在 YAML 中需要它，如下所示：

Key: "  This  is  my" +
     "  quite  long " +
     " string  data  "

只要我停留在单行就没有问题，但是我不知道如何将字符串内容放到多行。

YAML 块标量样式（>、|）在这里没有帮助，因为它们不允许转义，它们甚至会进行一些空格剥离、换行符/空格替换，这对我的情况是无用的。

看起来唯一的方法似乎是使用双引号"和反斜杠\，像这样：

Key: "\
  This is \
  my quite \
  long string data\
  "

在YAML online parser 中尝试此操作会得到预期的"This is my quite long string data"。

但不幸的是，如果“子行”之一具有前导空格，则它会失败，如下所示：

Key: "\
  This is \
  my quite\
   long st\
  ring data\
  "

这导致"This is my quitelong string data"，删除了此示例中quite 和long 之间的空格。我想到解决这个问题的唯一方法是将每个子行的第一个前导空格替换为\x20，如下所示：

Key: "\
  This is \
  my quite\
  \x20long st\
  ring data\
  "

由于我选择 YAML 来获得最佳的人类可读格式，我发现 \x20 有点丑陋的解决方案。也许有人知道更好的方法？

为了保持人类可读性，我也不想为此使用!!binary。

Answer 1

代替\x20，您可以简单地转义该行的第一个非缩进空格：

Key: "\
  This is \
  my quite\
  \ long st\
  ring data\
  "

这适用于多个空格，您只需要转义第一个。

Answer 2

您的观察是正确的，控制字符只能用双引号标量表示。

但是，如果子行（在 YAML 中：续行）具有前导空格，则解析器不会失败。是您对 YAML 标准的解释不正确。该标准明确规定，对于多行double quoted scalars：

所有前导和尾随空格字符都从内容中排除。

所以你可以在long 之前添加任意数量的空格，这不会有什么不同。

Python 的双引号标量的表示器（在 ruamel.yaml 和 PyYAML 中）总是将换行符表示为 \n。我不知道其他语言中的 YAML 表示器，您对此有更多控制权（例如，在双引号标量中使用双换行符来表示 \n）。因此，您可能必须编写自己的代表。

在编写表示器时，您可以尝试使换行更智能，因为它可以最大限度地减少转义空格的数量（通过将它们放在同一行的单词之间）。 但尤其是在双倍空格与单词的比率高的字符串上，再加上操作的宽度很小，如果没有转义空格，将很难（如果不是不可能的话）。

这样的代表应首先检查 IMO 是否需要双引号（即除了换行符之外还有控制字符）。如果不是，并且有换行符，您可能最好将字符串表示为块样式文字标量（不排除行首或行尾的空格）。