XML-zu-YAML-Konverter

YAML 1.2 wurde als Obermenge von JSON entworfen, es gibt hier also keinen eigenen Baum. Das XML wird in dieselbe Struktur umgewandelt, die die Seite XML nach JSON erzeugt, und ein anderer Serialisierer schreibt sie aus. Jede Abbildungsentscheidung jener Seite gilt unverändert: Attribute werden Schlüssel mit Präfix, Text, der ein Element mit Attributen oder Kindern teilt, landet unter einem Textschlüssel, ein zweimal auftretendes Element wird eine Sequenz, und Kommentare fallen weg.

Eines wird schlimmer. In JSON sieht ein Verbraucher wenigstens Klammern; in YAML ist der Unterschied zwischen einem Eintrag und zwei ein eingerückter Skalar gegenüber einer Liste von Strichen, und das bemerkt niemand in einem Diff. Nehmen Sie das Feld „immer ein Array“ für alles, was begrifflich eine Liste ist, damit ein Dokument mit einem Eintrag und eines mit fünfzig dieselbe Gestalt erzeugen.

<order id="00042">
  <total currency="GBP">19.90</total>
  <line sku="0071">Widget</line>
  <line sku="0072">Gasket</line>
  <country>NO</country>
</order>

order:
  attr_id: '00042'
  total:
    attr_currency: GBP
    text: '19.90'
  line:
    - attr_sku: '0071'
      text: Widget
    - attr_sku: '0072'
      text: Gasket
  country: 'NO'

YAML 1.1 definiert seinen Boolean-Typ durch Aufzählung, und die Aufzählung ist breiter, als irgendwer erwartet. Die veröffentlichte Typseite listet wörtlich: y, Y, yes, Yes, YES, n, N, no, No, NO, true, True, TRUE, false, False, FALSE, on, On, ON, off, Off, OFF. Jedes davon lädt ohne Anführungszeichen als Boolean.

Die Folge hat einen Namen. Ein Datenbestand mit ISO-Ländercodes bekommt NO für Norwegen, und der Parser reicht der Anwendung false. Dieselbe Liste verschlingt eine Ja/Nein-Spalte aus einer Tabelle und jeden Schalter, der on oder off heißt und Text sein sollte. YAML 1.2 hat das Kernschema auf nur true und false verengt, aber PyYAML, Rubys Psych, Ansible und ein großer Teil des Kubernetes-Werkzeugs lösen weiterhin die 1.1-Menge auf, gehen Sie also davon aus, dass sie ganz lebendig ist.

Der Emitter setzt jeden Skalar, der genau auf diese Liste passt, in einfache Anführungszeichen, die einbuchstabigen Formen eingeschlossen, dazu null, Null, NULL und die Tilde. Achten Sie auf die Groß- und Kleinschreibung: yES und nO stehen nicht in der 1.1-Liste und werden nicht gequotet, denn kein konformer Parser liest sie ebenfalls als Boolean.

Die Boolean-Menge ist der berühmte Fall, nicht der häufige. Die meisten Werte, die brechen, sind Zahlen, die nie Zahlen waren, denn YAML leitet einen Typ aus der Schreibung eines einfachen Skalars ab, genau wie JSON das nicht tut. Ein Skalar wird in einfache Anführungszeichen gesetzt, wenn er auf die Boolean- oder Null-Menge passt, wenn er auf eine JSON-Zahlengrammatik passt (das deckt 42, 19.90 und 1.10 ab), wenn er eine führende Null mit weiteren Ziffern hat, wenn er leer ist, wenn er mit einem YAML-Indikatorzeichen wie einem Bindestrich oder einer Raute beginnt, oder wenn an einem Ende Leerraum steht.

Mehrzeiliger Text wird nicht gequotet. Er wird ein literaler Blockskalar, eingeleitet von einem senkrechten Strich mit Strip-Indikator. Literal wird absichtlich dem gefalteten vorgezogen: Ein gefalteter Block fließt einzelne Zeilenumbrüche zu Leerzeichen um und zerstört damit eingebetteten Code und Adressen. Der Strip-Indikator entfernt den abschließenden Zeilenumbruch, den ein Block sonst hinzufügen würde.

Manche Werte verlassen den Emitter dennoch ohne Anführungszeichen und können nachgelagert den Typ wechseln. Sie werden aufgeführt statt beschönigt, denn kein Emitter, der einfache Skalare benutzt, hat die Typermittlung von YAML gelöst:

• Sexagesimale Zahlen. YAML 1.1 liest 22:22 als Ganzzahl zur Basis 60, eine Dauer wird in PyYAML also 1342. Ein 1.2-Parser wie js-yaml liefert die Zeichenkette, das hängt also davon ab, welche Seite die Datei liest.
• Hexadezimale Schreibungen. 0x1F lädt sowohl in YAML 1.1 als auch im 1.2-Kernschema als 31, ein hexadezimaler Farbcode braucht also Anführungszeichen.
• Datumsangaben. 2024-01-05 passt auf den Timestamp-Typ von YAML, js-yaml und PyYAML reichen Ihnen also beide ein Datumsobjekt statt einer Zeichenkette.
• Blockskalare, deren erste Zeile weiter eingerückt ist als die folgenden, was passiert, wenn ein CDATA-Abschnitt führende Leerzeichen bewahrt. YAMLs Lösung ist ein ausdrücklicher Einrückungsindikator nach dem senkrechten Strich, den dieser Emitter nicht schreibt.

Das ist die eine Vorbereitung, die sich lohnt. Die Voreinstellungen wurden für JSON gewählt, wo sie sicher sind, und YAML hat für Schlüssel eine strengere Grammatik als für Werte.

Das Standard-Attributpräfix ist @_ und der Standard-Textschlüssel ist #text. In YAML ist @ ein reservierter Indikator, mit dem ein einfacher Skalar nicht beginnen darf, ein Schlüssel @_id macht das Dokument also unparsbar: js-yaml meldet „bad indentation of a mapping entry“ und PyYAML meldet ein Zeichen, das kein Token beginnen kann. Eine führende # ist schlimmer, weil sie nicht scheitert. Eine Zeile mit #text: 19.90 ist ein Kommentar, die Datei lädt also, und der Wert ist einfach nicht da.

Beide Felder sitzen in der Steuerzeile über dem Editor. Setzen Sie das Präfix auf etwas Schlichtes wie attr_ und den Textschlüssel auf text, und jeder Schlüssel in der Ausgabe ist ein gewöhnlicher YAML-Name. Schlüssel, die aus anderen Gründen Anführungszeichen brauchen, etwa soap:Body, werden automatisch gequotet, denn ein Doppelpunkt ist in einem nackten Schlüssel nicht zulässig.

Zwei Schritte: das XML sicher parsen, dann mit einem Dumper serialisieren, dem Sie gesagt haben, richtig zu quoten. Die XML-Hälfte braucht die üblichen Entity-Flags, denn die Voreinstellungen in Java und .NET lösen ein DOCTYPE auf. Die YAML-Hälfte braucht Aufmerksamkeit, weil Dumper sich darin unterscheiden, wie entschlossen sie quoten.