Как я могу контролировать, какую скалярную форму PyYAML использует для моих данных?

Question

У меня есть объект с атрибутом короткой строки и атрибутом длинной многострочной строки. Я хочу записать короткую строку в виде скаляра YAML в кавычках, а многострочную строку в виде литерального скаляра:

my_obj.short = "Hello"
my_obj.long = "Line1\nLine2\nLine3"

Я бы хотел, чтобы YAML выглядело так:

short: "Hello"
long: |
  Line1
  Line2
  Line3

Как я могу поручить PyYAML сделать это? Если я позвоню yaml.dump(my_obj), то получится вывод, похожий на диктовку:

{long: 'line1

    line2

    line3

    ', short: Hello}

(Не уверен, почему long такой двойной ...)

Могу ли я диктовать PyYAML, как обращаться с моими атрибутами? Я бы хотел повлиять как на порядок, так и на стиль.

Answer 1

На основании Какие-нибудь библиотеки yaml в Python, которые поддерживают вывод длинных строк в виде блоковых литералов или свернутых блоков?

import yaml
from collections import OrderedDict

class quoted(str):
    pass

def quoted_presenter(dumper, data):
    return dumper.represent_scalar('tag:yaml.org,2002:str', data, style='"')
yaml.add_representer(quoted, quoted_presenter)

class literal(str):
    pass

def literal_presenter(dumper, data):
    return dumper.represent_scalar('tag:yaml.org,2002:str', data, style='|')
yaml.add_representer(literal, literal_presenter)

def ordered_dict_presenter(dumper, data):
    return dumper.represent_dict(data.items())
yaml.add_representer(OrderedDict, ordered_dict_presenter)

d = OrderedDict(short=quoted("Hello"), long=literal("Line1\nLine2\nLine3\n"))

print(yaml.dump(d))

Вывод

short: "Hello"
long: |
  Line1
  Line2
  Line3

Answer 2

Влюбившись в подход @ lbt , я получил этот код:

import yaml

def str_presenter(dumper, data):
  if len(data.splitlines()) > 1:  # check for multiline string
    return dumper.represent_scalar('tag:yaml.org,2002:str', data, style='|')
  return dumper.represent_scalar('tag:yaml.org,2002:str', data)

yaml.add_representer(str, str_presenter)

Он превращает каждую многострочную строку в буквальный.чтобы избежать исправления части обезьяны.Полный кредит @lbt и @ JFSebastian.

Answer 3

Я хотел, чтобы любой ввод с \n был литералом блока.Используя код в yaml/representer.py в качестве базы, я получил:

# -*- coding: utf-8 -*-
import yaml

def should_use_block(value):
    for c in u"\u000a\u000d\u001c\u001d\u001e\u0085\u2028\u2029":
        if c in value:
            return True
    return False

def my_represent_scalar(self, tag, value, style=None):
    if style is None:
        if should_use_block(value):
             style='|'
        else:
            style = self.default_style

    node = yaml.representer.ScalarNode(tag, value, style=style)
    if self.alias_key is not None:
        self.represented_objects[self.alias_key] = node
    return node


a={'short': "Hello", 'multiline': """Line1
Line2
Line3
""", 'multiline-unicode': u"""Lêne1
Lêne2
Lêne3
"""}

print(yaml.dump(a))
print(yaml.dump(a, allow_unicode=True))
yaml.representer.BaseRepresenter.represent_scalar = my_represent_scalar
print(yaml.dump(a))
print(yaml.dump(a, allow_unicode=True))

Выход

{multiline: 'Line1

    Line2

    Line3

    ', multiline-unicode: "L\xEAne1\nL\xEAne2\nL\xEAne3\n", short: Hello}

{multiline: 'Line1

    Line2

    Line3

    ', multiline-unicode: 'Lêne1

    Lêne2

    Lêne3

    ', short: Hello}

After override

multiline: |
  Line1
  Line2
  Line3
multiline-unicode: "L\xEAne1\nL\xEAne2\nL\xEAne3\n"
short: Hello

multiline: |
  Line1
  Line2
  Line3
multiline-unicode: |
  Lêne1
  Lêne2
  Lêne3
short: Hello

Answer 4

Вы можете использовать ruamel.yaml и его RoundTripLoader / Dumper (отказ от ответственности: я являюсь автором этого пакета) помимо того, что вы хотите, он поддерживает спецификацию YAML 1.2 (с 2009 года) имеет несколько других улучшений:

import sys
from ruamel.yaml import YAML

yaml_str = """\
short: "Hello"  # does keep the quotes, but need to tell the loader
long: |
  Line1
  Line2
  Line3
folded: >
  some like
  explicit folding
  of scalars
  for readability
"""

yaml = YAML()
yaml.preserve_quotes = True
data = yaml.load(yaml_str)
yaml.dump(data, sys.stdout)

дает:

short: "Hello"  # does keep the quotes, but need to tell the loader
long: |
  Line1
  Line2
  Line3
folded: >
  some like
  explicit folding
  of scalars
  for readability

(включая комментарий, начиная с того же столбца, что и раньше)

Вы также можете создать этот вывод, начиная с нуля, но затем вы нужно предоставить дополнительную информацию, например, Явные позиции о том, где сложить.