PyYAML dump format

Utilisation ruamel.yaml à la place.

De La Bibliothèque De La Lutte! Un Conte de Deux Bibliothèques

PyYAML est effectivement mort et a été pendant plusieurs années. Pour compliquer les choses, le projet officiel de la maison à http://pyyaml.org semble avoir été prise récemment. Ce site a accueilli la PyYAML outil de suivi, de documentation et de téléchargements. De cette écriture, tous sont partis. Ce n'est rien de moins calamiteuse. Bienvenue à juste un autre jour dans l'open source.

ruamel.yaml est activement maintenu. Contrairement à PyYAML, ruamel.yaml prend en charge:

• YAML <= 1.2. PyYAML prend uniquement en charge le format YAML <= 1.1. C'est vital, comme YAML 1.2 intentionnellement les sauts de compatibilité descendante avec YAML 1.1 dans plusieurs cas limites. Ce serait habituellement une mauvaise chose. Dans ce cas, cela rend YAML 1.2 un sur-ensemble strict de JSON. Depuis YAML 1.1 est pas un sur-ensemble strict de JSON, c'est une bonne chose.
• Aller-retour conservation. Lors de l'appel de yaml.dump() faire un dump d'un dictionnaire chargé par un appel précédent à yaml.load():
  • PyYAML naïvement ignore tous entrée mise en forme – y compris des commentaires, commande, devis, et les espaces. Rejetés comme tellement numérique refuser dans le plus proche disponible seau bits.
  • ruamel.yaml habilement respecte tous entrée mise en forme. Tout. L'ensemble de la stylistique enchilada. L'ensemble de la littéraire shebang. Tous.

De la bibliothèque de la Migration: Le Sentier de Code Larmes

Depuis ruamel.yaml est un PyYAML fourche et donc conforme à la PyYAML de l'API, de la commutation de PyYAML à ruamel.yaml dans des applications existantes est généralement aussi simple que de remplacer toutes les occurrences de ce:

# This imports PyYAML. Stop doing this.
import yaml

...avec ceci:

# This imports "ruamel.yaml". Always do this.
from ruamel import yaml

Que c'est.

Aucun autre changement ne devrait être nécessaire. Le yaml.load() et yaml.dump() fonctions devraient continuer à se comporter comme prévu, avec l'avantage de support de YAML 1.2 et activement recevoir des corrections de bugs.

Aller-retour de la Préservation et de Ce qu'Il Peut Faire pour Vous

Pour assurer la compatibilité avec PyYaml, le yaml.load() et yaml.dump() fonctions ne pas effectuez des allers-retours à la conservation par défaut. Pour ce faire, transmettre explicitement:

• L'option Loader=ruamel.yaml.RoundTripLoader mot-clé paramètre yaml.load().
• L'option Dumper=ruamel.yaml.RoundTripDumper mot-clé paramètre yaml.dump().

Un exemple gentiment "emprunté" de ruamel.yaml de la documentation:

import ruamel.yaml

inp = """\
# example
name:
  # Yet another Great Duke of Hell. He's not so bad, really.
  family: TheMighty
  given: Ashtaroth
"""

code = ruamel.yaml.load(inp, Loader=ruamel.yaml.RoundTripLoader)
code['name']['given'] = 'Astarte'  # Oh no you didn't.

print(ruamel.yaml.dump(code, Dumper=ruamel.yaml.RoundTripDumper), end='')

C'est fait. Commentaires, commande, devis, et le les espaces seront désormais conservés intacts.

tl;dr

Toujours utiliser ruamel.yaml. N'utilisez jamais de PyYAML. ruamel.yaml vie. PyYAML est fétide d'un cadavre en décomposition dans le moisissent charnier terrain de PyPi.

Vive ruamel.yaml.

Dans mon cas, je veux " si la valeur contient un { ou un }, sinon rien. Par exemple:

 en:
   key1: value is 1
   key2: 'value is {1}'

Pour effectuer cette, fonction de copie represent_str() à partir d'un fichier representer.py dans le module PyYaml et utiliser un autre style si la chaîne contient { ou un }:

def represent_str(self, data):
    tag = None
    style = None
    # Add these two lines:
    if '{' in data or '}' in data:
        style = '"'
    try:
        data = unicode(data, 'ascii')
        tag = u'tag:yaml.org,2002:str'
    except UnicodeDecodeError:
        try:
            data = unicode(data, 'utf-8')
            tag = u'tag:yaml.org,2002:str'
        except UnicodeDecodeError:
            data = data.encode('base64')
            tag = u'tag:yaml.org,2002:binary'
            style = '|'
    return self.represent_scalar(tag, data, style=style)

Pour l'utiliser dans votre code:

import yaml

def represent_str(self, data):
  ...

yaml.add_representer(str, represent_str)

Dans ce cas, pas de diffences entre les clés et les valeurs, et c'est assez pour moi. Si vous voulez un style différent pour les clés et les valeurs, d'effectuer la même chose avec la fonction represent_mapping