YAML

Una guía rápida y la especificación completa están disponibles en el sitio oficial. ^{[ 22 ]} A continuación se presenta una sinopsis de los elementos básicos.

YAML acepta todo el conjunto de caracteres Unicode, excepto algunos caracteres de control , y puede codificarse en cualquiera de los siguientes sistemas de codificación : UTF-8 , UTF-16 o UTF-32 . (Aunque UTF-32 no es obligatorio, es necesario para que un analizador sea compatible con JSON ). ^{[ 23 ]}

• La sangría con espacios en blanco se utiliza para indicar estructura; sin embargo, no se permiten caracteres de tabulación como parte de dicha sangría. ^{[ 24 ]}
• Los comentarios comienzan con el signo de número ( #), pueden comenzar en cualquier parte de una línea y continuar hasta el final de la misma. Los comentarios deben estar separados de otros tokens por caracteres de espacio en blanco. ^{[ 25 ]} Si #los caracteres aparecen dentro de una cadena, entonces son #literales de signo de número ( ).
• Los miembros de la lista se indican mediante un guion inicial ( -) con un miembro por línea.
  • También se puede especificar una lista encerrando el texto entre corchetes ( [...]) con cada entrada separada por una coma .
• Una entrada de matriz asociativa se representa usando dos puntos espacio en el formato clave: valor, con una entrada por línea. YAML requiere que los dos puntos vayan seguidos de un espacio para que las cadenas de estilo URL, como , http://www.wikipedia.orgpuedan representarse sin necesidad de ir entre comillas.
  • Se puede usar un signo de interrogación delante de una clave, en el formato "?clave: valor", para permitir que la clave contenga guiones iniciales, corchetes, etc., sin comillas.
  • También se puede especificar una matriz asociativa mediante texto encerrado entre llaves ( {...}), con las claves separadas de los valores por dos puntos y las entradas separadas por comas (no se requieren espacios para mantener la compatibilidad con JSON).
• Las cadenas (un tipo de escalar en YAML) normalmente no van entre comillas, pero pueden ir entre comillas dobles ( "), o comillas simples ( ').
  • Dentro de las comillas dobles, los caracteres especiales pueden representarse con secuencias de escape al estilo C que comienzan con una barra invertida ( \). Según la documentación, el único escape octal admitido es \0.
  • Dentro de las comillas simples, la única secuencia de escape admitida es una comilla simple doble ( '') que denota la comilla simple misma, como en 'don''t'.
• Los escalares de bloque están delimitados con sangría con modificadores opcionales para preservar ( |) o plegar ( >) saltos de línea.
• Varios documentos dentro de una misma secuencia están separados por tres guiones ( ---).
  • Tres puntos ( ...) finalizan opcionalmente un documento dentro de un flujo.
• Los nodos repetidos se denotan inicialmente con un signo de ampersand ( &&) y posteriormente se referencian con un asterisco ( *).
• Los nodos pueden etiquetarse con un tipo o etiqueta usando un doble signo de exclamación ( !!) seguido de una cadena, que puede expandirse en una URI.
• Los documentos YAML en un flujo pueden ir precedidos de "directivas" compuestas por un signo de porcentaje ( %) seguido de un nombre y parámetros separados por espacios. En YAML 1.1 se definen dos directivas:
  • La directiva %YAML se utiliza para identificar la versión de YAML en un documento determinado.
  • La directiva %TAG se utiliza como atajo para prefijos URI. Estos atajos pueden utilizarse posteriormente en etiquetas de tipo de nodo.

El formato de bloque convencional utiliza un guion y un espacio para comenzar un nuevo elemento en la lista.

--- # Películas favoritas : Casablanca , Con la muerte en los talones , El hombre que no estaba allí

El formato en línea opcional está delimitado por coma + espacio y encerrado entre corchetes (similar a JSON ). ^{[ 26 ]}

--- # Lista de la compra [ leche , pastel de calabaza , huevos , zumo ]

Las claves se separan de los valores mediante dos puntos y un espacio. Los bloques con sangría, comunes en los archivos de datos YAML, utilizan sangría y saltos de línea para separar los pares clave/valor. Los bloques en línea, comunes en los flujos de datos YAML, utilizan coma y espacio para separar los pares clave/valor entre llaves.

--- # Bloque con sangría nombre : John Smith edad : 33 --- # Bloque en línea { nombre : John Smith , edad : 33 }

Las cadenas no requieren comillas. Hay dos maneras de escribir cadenas de varias líneas: una que conserva los saltos de línea (usando el |carácter) y otra que los elimina (usando el >carácter), ambas seguidas de un carácter de salto de línea.

Datos : | Había una vez un hombre alto de Ealing que subió a un autobús a Darjeeling. En la puerta decía : "Por favor, no se siente en el suelo". Así que él se sentó cuidadosamente en el techo.

Por defecto, se eliminan la sangría inicial (de la primera línea) y los espacios en blanco finales, aunque se puede especificar explícitamente otro comportamiento.

datos : > El texto ajustado se doblará en un solo párrafoLas líneas en blanco indican saltos de párrafo.

El texto plegado convierte los saltos de línea en espacios y elimina los espacios en blanco iniciales.

--- # Los Smith - { nombre : John Smith , edad : 33 } - nombre : Mary Smith edad : 27 - [ nombre , edad ]: [ Rae Smith , 4 ] # Se admiten secuencias como claves --- # Personas, por género hombres : [ John Smith , Bill Jones ] mujeres : - Mary Smith - Susan Williams

Los objetos y las listas son componentes importantes en YAML y pueden combinarse. El primer ejemplo es una lista de objetos clave-valor: todas las personas de la familia Smith. El segundo las lista por género; se trata de un objeto clave-valor que contiene dos listas.

Las características que distinguen a YAML de las capacidades de otros lenguajes de serialización de datos son las estructuras ^{[ 27 ]} y los datos y las claves compuestas.

Las estructuras YAML permiten almacenar varios documentos dentro de un solo archivo, usar referencias para nodos repetidos y usar nodos arbitrarios como claves. ^{[ 27 ]}

Para mayor claridad, concisión y para evitar errores de entrada de datos, YAML proporciona anclas de nodo (usando &) y referencias (usando *). Las referencias al ancla funcionan para todos los tipos de datos (vea la referencia de envío en el ejemplo a continuación).

A continuación se muestra un ejemplo de una cola en un secuenciador de instrumentos en la que se hace referencia a dos pasos sin describirlos completamente.

--- # Protocolos de secuenciación para cirugía ocular láser - paso : &id001 # define la etiqueta de anclaje &id001 instrumento : Lasik 2000 energía del pulso : 5.4 duración del pulso : 12 repetición : 1000 tamaño del punto : 1 mm- paso : &id002 instrumento : Lasik 2000 energía de pulso : 5.0 duración del pulso : 10 repetición : 500 tamaño del punto : 2 mm - Instrumento 1 : *id001 # se refiere al primer paso (con el ancla &id001) - Instrumento 2 : *id002 # se refiere al segundo paso

La tipificación explícita de datos rara vez se observa en la mayoría de los documentos YAML, ya que YAML detecta automáticamente los tipos simples. Los tipos de datos se pueden dividir en tres categorías: básicos, definidos y definidos por el usuario. Los básicos son aquellos que se espera que existan en cualquier analizador (por ejemplo, números de coma flotante, enteros, cadenas, listas, mapas, etc.). Muchos tipos de datos más avanzados, como los datos binarios, están definidos en la especificación YAML, pero no son compatibles con todas las implementaciones. Finalmente, YAML define una forma de extender localmente las definiciones de tipos de datos para dar cabida a clases, estructuras o primitivas definidas por el usuario (por ejemplo, números de coma flotante de precisión cuádruple).

YAML detecta automáticamente el tipo de dato de la entidad, pero a veces es necesario especificarlo explícitamente. La situación más común se da cuando una cadena de una sola palabra que parece un número, un valor booleano o una etiqueta requiere desambiguación, ya sea encerrándola entre comillas o utilizando una etiqueta de tipo de dato explícita.

--- a : 123 # un entero b : "123" # una cadena, desambiguada por comillas c : 123.0 # un flotante d : !!float 123 # también un flotante a través del tipo de datos explícito prefijado por (!!) e : !!str 123 # una cadena, desambiguada por el tipo explícito f : !!str Sí # una cadena a través del tipo explícito g : Sí # un booleano Verdadero (yaml1.1), cadena "Sí" (yaml1.2) h : Sí, no tenemos plátanos # una cadena, "Sí" y "No" desambiguadas por el contexto.

No todas las implementaciones de YAML incluyen todos los tipos de datos definidos en la especificación. Estos tipos integrados utilizan un prefijo de doble exclamación ( !!). Algunos tipos particularmente interesantes, que no se muestran aquí, son los conjuntos, los mapas ordenados, las marcas de tiempo y los datos hexadecimales. Aquí se muestra un ejemplo de datos binarios codificados en base64 .

--- imagen : !!binario | R0lGODdhDQAIAIAAAAAAANn Z2SwAAAAADQAIAAACF4SDGQ ar3xxbJ9p0qa7R0YxwzaFME 1IAADs=

Muchas implementaciones de YAML pueden admitir tipos de datos definidos por el usuario para la serialización de objetos. Los tipos de datos locales no son tipos de datos universales, sino que se definen en la aplicación mediante la biblioteca del analizador YAML. Los tipos de datos locales utilizan un único signo de exclamación ( !).

YAML admite claves compuestas, que constan de múltiples valores. Dichas claves son útiles para transformaciones de coordenadas, identificadores de múltiples campos, casos de prueba con condiciones compuestas, etc. ^{[ 28 ]}

--- # Transformación entre dos sistemas de coordenadas transform : { x : 1 , y : 2 }: { x : 3 , y : 4 } { x : 5 , y : 6 }: { x : 7 , y : 8 }

La jerarquía de la estructura de datos se mantiene mediante la indentación del contorno.

--- recibo : Factura de compra de Oz-Ware fecha : 2012-08-06 cliente : nombre : Dorothy apellido : Galeartículos : - part_no : A4786 descrip : Cubo de agua (lleno) precio : 1.47 cantidad : 4- part_no : E1628 descrip : Pantuflas de tacón alto "Ruby" size : 8 price : 133.7 quantity : 1Factura a : &id001 Calle : | 123 Tornado Alley Suite 16 Ciudad : East Centerville Estado : KSenviar a : *id001specialDelivery : > Sigue el camino de baldosas amarillas hasta la Ciudad Esmeralda. No le hagas caso al hombre detrás de la cortina. ...

Tenga en cuenta que las cadenas no requieren comillas. El número específico de espacios en la sangría no es importante siempre que los elementos paralelos tengan la misma justificación izquierda y los elementos anidados jerárquicamente tengan mayor sangría. Este documento de ejemplo define una matriz asociativa con 7 claves de nivel superior: una de las claves, "items", contiene una lista de 2 elementos, cada elemento de los cuales es a su vez una matriz asociativa con claves diferentes. Se muestran los datos relacionales y la eliminación de redundancia: el contenido de la matriz asociativa "ship-to" se copia del contenido de la matriz asociativa "bill-to" como lo indican las etiquetas de anclaje ( &) y referencia ( *). Se pueden agregar líneas en blanco opcionales para facilitar la lectura. Varios documentos pueden existir en un solo archivo/flujo y están separados por ---. Se puede usar un opcional ...al final de un archivo (útil para señalar un final en comunicaciones de flujo sin cerrar la tubería).

Debido a que YAML se basa principalmente en la indentación de esquema para la estructura, es especialmente resistente a la colisión de delimitadores . La insensibilidad de YAML a las comillas y llaves en valores escalares significa que se pueden incrustar documentos XML, JSON o incluso YAML dentro de un documento YAML simplemente indentándolo en un literal de bloque (usando |o >):

--- ejemplo : > El HTML se convierte en YAML sin modificar mensaje : |<blockquote style="font: italic 1em serif"> <p>"Tres siempre es mayor que dos, incluso para valores grandes de dos"</p> <p>--Autor desconocido</p> </blockquote> fecha : 2007-06-01

YAML se puede insertar en JSON entrecomillando y escapando todas las comillas internas. YAML se puede insertar en XML escapando los caracteres reservados ( <, >, &, ', ") y convirtiendo los espacios en blanco, o insertándolo en una sección CDATA .

A diferencia de JSON, que solo puede representar datos en un modelo jerárquico donde cada nodo hijo tiene un único padre, YAML también ofrece un esquema relacional simple que permite que se hagan referencias a datos idénticos repetidos desde dos o más puntos en el árbol en lugar de ingresarlos redundantemente en esos puntos. Esto es similar a la funcionalidad IDREF integrada en XML. ^{[ 29 ]} El analizador YAML luego expande estas referencias en las estructuras de datos completas que implican cuando se leen, por lo que cualquier programa que utilice el analizador no tiene que estar al tanto de un modelo de codificación relacional, a diferencia de los procesadores XML, que no expanden las referencias. Esta expansión puede mejorar la legibilidad al tiempo que reduce los errores de entrada de datos en archivos de configuración o protocolos de procesamiento donde muchos parámetros permanecen iguales en una serie secuencial de registros mientras que solo unos pocos varían. Un ejemplo es que los registros "enviar a" y "facturar a" en una factura son casi siempre los mismos datos.

YAML es un lenguaje puramente de representación de datos y, por lo tanto, no tiene comandos ejecutables. Si bien la validación y el análisis seguro son inherentemente posibles en cualquier lenguaje de datos, la implementación es un escollo tan conocido que la falta de un lenguaje de comandos asociado en YAML puede ser una ventaja relativa en términos de seguridad.

Sin embargo, YAML permite etiquetas específicas del lenguaje, de modo que un analizador que admita dichas etiquetas puede crear objetos locales arbitrarios. Cualquier analizador YAML que permita la ejecución de instanciaciones de objetos sofisticadas abre la posibilidad de un ataque de inyección. Los analizadores Perl que permiten la carga de objetos de clases arbitrarias crean los llamados valores "bendecidos". El uso de estos valores puede desencadenar un comportamiento inesperado, por ejemplo, si la clase utiliza operadores sobrecargados. Esto puede conducir a la ejecución de código Perl arbitrario. ^{[ 30 ]}

La situación es similar para los analizadores de Python o Ruby. Según la documentación de PyYAML: ^{[ 31 ]}

Tenga en cuenta que la capacidad de construir un objeto Python arbitrario puede ser peligrosa si recibe un documento YAML de una fuente no confiable, como Internet. La función yaml.safe_loadlimita esta capacidad a objetos Python simples, como números enteros o listas. [...]

PyYAML permite construir un objeto Python de cualquier tipo. Incluso se pueden construir instancias de clases Python utilizando la !!python/objectetiqueta.

La especificación YAML identifica un documento de instancia como una "Presentación" o "flujo de caracteres". ^{[ 32 ]} Las estructuras lógicas principales en un documento de instancia YAML son escalares, secuencias y asignaciones. ^{[ 33 ]} La especificación YAML también indica algunas restricciones básicas que se aplican a estas estructuras lógicas principales. Por ejemplo, según la especificación, las claves de asignación no tienen un orden. En todos los casos en que el orden de los nodos sea significativo, se debe usar una secuencia. ^{[ 34 ]}

Además, al definir la conformidad para los procesadores YAML, la especificación YAML define dos operaciones principales: volcado y carga . Todos los procesadores compatibles con YAML deben proporcionar al menos una de estas operaciones, y opcionalmente pueden proporcionar ambas. ^{[ 35 ]} Finalmente, la especificación YAML define un modelo de información o "grafo de representación", que debe crearse durante el procesamiento tanto para las operaciones de volcado como de carga , aunque esta representación no tiene por qué estar disponible para el usuario a través de una API. ^{[ 36 ]}

La sintaxis JSON es la base de YAML versión 1.2, que se promulgó con el propósito expreso de hacer que YAML "cumpla con JSON como un subconjunto oficial". ^{[ 4 ]} Aunque las versiones anteriores de YAML no eran estrictamente compatibles, ^{[ 37 ]} las discrepancias rara vez eran perceptibles, y la mayoría de los documentos JSON pueden ser analizados por algunos analizadores de YAML como Syck. ^{[ 38 ]} Esto se debe a que la estructura semántica de JSON es equivalente al "estilo en línea" opcional de escribir YAML. Si bien las jerarquías extendidas pueden escribirse en estilo en línea como JSON, este no es un estilo YAML recomendado excepto cuando ayuda a la claridad.

YAML cuenta con muchas características adicionales que no están presentes en JSON, incluyendo comentarios, tipos de datos extensibles, anclajes relacionales, cadenas sin comillas y tipos de mapeo que preservan el orden de las claves.

Debido a su concisión , la serialización y deserialización de JSON es mucho más rápida que la de YAML. ^{[ 39 ] [ 40 ]}

TOML se diseñó como una mejora del formato de archivo .ini . YAML utiliza un mínimo de caracteres indicadores en comparación con el estricto requisito de TOML de comillas y corchetes. El uso de una sangría significativa en YAML se ha contrastado con la notación de puntos de los nombres de claves y tablas de TOML para transmitir la misma estructura semántica. Existen diferentes opiniones sobre qué convención produce archivos de configuración más legibles. ^{[ 41 ] [ 42 ]}

YAML carece del concepto de atributos de etiqueta que se encuentran en XML. En cambio, YAML tiene declaraciones de tipo extensibles (incluidos tipos de clase para objetos).

YAML no posee descriptores de esquema de documento definidos por el lenguaje XML que permitan, por ejemplo, la autovalidación de un documento. Sin embargo, existen varios lenguajes de descriptores de esquema definidos externamente para YAML (como Doctrine , Kwalify y Rx) que cumplen esa función. Además, la semántica proporcionada por las declaraciones de tipo definidas por el lenguaje YAML en el propio documento YAML suele reducir la necesidad de un validador en situaciones sencillas y comunes. Adicionalmente, YAXML , que representa estructuras de datos YAML en XML, permite aplicar a YAML importadores de esquemas XML y mecanismos de salida como XSLT .

La comparación de formatos de serialización de datos proporciona una comparación más completa de YAML con otros formatos de serialización.