AYUDA EN LÍNEA
 WINDEVWEBDEV Y WINDEV MOBILE

Ayuda / WLanguage / Sintaxis WLanguage / 
  • Importar archivos YAML
  • Asignación y lectura
  • Gestión de referencias
  • Propiedades específicas de las variables de tipo YAML
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReportes y ConsultasCódigo de Usuario (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Código Navegador
WINDEV Mobile
AndroidWidget Android iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Otros
Procedimientos almacenados
YAML (Tipo de variable)
 
El tipo YAML simplifica la manipulación de datos en formato YAML.
YAML es un formato de serialización de datos que puede ser leído por humanos, y que conserva un alto nivel de precisión. Es similar a JSON, pero ofrece algunas características adicionales (de hecho, se puede incluir JSON en YAML).
Estas características lo hacen muy útil para:
  • intercambiar datos entre sistemas informáticos,
  • archivos de configuración.
Las siguientes características son específicas de YAML:
  • comentarios (especialmente útiles para los archivos de configuración),
  • etiquetas, información sobre el tipo de datos (útil en las acciones de ida y vuelta (Round trip) para la serialización/deserialización),
  • alias dentro del documento para evitar repeticiones.
Ejemplo
V is YAML
Sintaxis

Declarar y asignar una variable de tipo YAML Ocultar los detalles

<Variable name> is YAML = <Value>

OR
 <Variable name> is YAML
 <Variable name> = <Value>
<Variable name>:
Nombre de la variable a declarar.
<Value>:
Valor que se asignará a la variable. Los siguientes valores se pueden asignar a una variable YAML:
  • NULL,
  • un booleano (True o False),
  • un numérico,
  • una fecha (convertida automáticamente en cadena RFC),
  • una cadena Ansi o Unicode con datos,
  • una cadena Ansi con datos en formato JSON.
Observaciones

Importar archivos YAML

Las variables YAML se pueden declarar especificando un documento de ejemplo (un archivo de texto). La estructura del documento será leída por WINDEV, WEBDEV y WINDEV Mobile. Así, el autocompletado estará disponible para los nombres de los nodos en el editor de código.
Para declarar una variable YAML con un documento de ejemplo:
  1. Agregue el documento de texto al proyecto con uno de los siguientes métodos:
    • en la pestaña "Proyecto", en el grupo "Proyecto", despliegue " Lista de elementos" y haga clic en "Lista de elementos del proyecto". La lista de elementos del proyecto aparece en pantalla. Haga clic en "Agregar" y seleccione el documento de texto.
    • arrastre y suelte el archivo en la carpeta "Descripciones externas" del panel "Explorador de proyectos".
    • en el panel "Explorador de proyectos", seleccione la carpeta "Descripciones externas", y luego la opción "Importar un XML o un JSON a este proyecto" del menú contextual.
  2. El documento JSON aparece en la carpeta "Descripciones externas" del panel "Explorador de proyectos". Se puede ver su estructura.
  3. Declare la variable de la siguiente manera:
    <Variable name> is YAML, description =  <Document name>

    o
    <Variable name> is YAML <description =  "Document name">

    <Nombre de documento> puede corresponder al nombre del documento de ejemplo (con o sin extensión).
    Observación: Esta declaración se puede obtener automáticamente "arrastrando y soltando" el nombre del documento de texto directamente desde el panel "Explorador de proyectos".
  4. Ahora puede acceder directamente a los nodos de la variable por sus nombres. El mecanismo de autocompletado del editor de código propone estos nombres automáticamente.
Observación: También es posible obtener verificación y asistencia para la compilación en una subparte del archivo YAML utilizando la siguiente sintaxis:
v2 is YAML, description="JSONFile.Member.SubMember"

v2 is YAML, <description="JSONFile.Member.SubMember">

Asignación y lectura

Asignación de una variable YAML
La sintaxis "j = ..." trata de analizar el valor como una cadena YAML. Esta sintaxis es "casi" equivalente a "j.YAMLFormat = ..." excepto si la cadena YAML no es válida: en ese caso, se copia directamente como valor del elemento YAML, sin ser interpretada.
La sintaxis "... = j.Member" asigna el valor del miembro. Esta sintaxis es equivalente a "j.Member.Value =... ".
Lectura de una variable YAML
La sintaxis "... = j" devuelve la cadena YAML que corresponde al contenido de la variable. Esta sintaxis es equivalente a "... =j.YAMLFormat ".
La sintaxis "... = j.Member" devuelve el valor del miembro. Esta sintaxis es equivalente a "... =j.Member.Value".
Gestión de comentarios
Cada línea de comentario se analiza:
  • si contiene el carácter '#'; este carácter y todos los caracteres que se encuentran antes de él se ignorarán. El resto será considerando como un comentario (aparecerá en la cadena YAML precedido por el carácter '#').
  • si está vacía, una línea vacía se agregará a la cadena YAML.
Observación: YAML importado y generado
La mayoría de los comentarios y el formato general del documento YAML se importan y utilizan en la siguiente exportación para generar un documento YAML similar al original.
La sangría original no se conserva, se regenera.

Gestión de referencias

Para hacer referencia a un miembro de una variable YAML desde otro miembro del objeto, use el operador '<-'.
Config is YAML
Config.Default.HTTPConfig.Port = 80
Config.Default.HTTPConfig.Protocol = HTTP
Config.Server.Internal.Configuration <- Config.Default.HTTPConfig
Config.Server.InternalBackup.Configuration <- Config.Default.HTTPConfig
Config.Server.External.Configuration.Port = 443
Config.Server.External.Configuration.Protocol = HTTPS

Propiedades específicas de las variables de tipo YAML

Las siguientes propiedades pueden utilizarse para manipular variables de tipo YAML:
Nombre de la propiedadTipo utilizadoEfecto
AliasCharacter stringNombre de alias a utilizar si se hace referencia al elemento varias veces en el mismo documento.
Esta propiedad es de solo lectura.
CommentAfterCharacter stringComentario que se encuentra después del elemento YAML en la cadena YAML generada.
CommentBeforeCharacter stringComentario que se encuentra antes del elemento YAML en la cadena YAML generada.
CommentInternalCharacter stringComentario interno del elemento YAML en la cadena YAML generada.
ExistBooleanEn modo de lectura:
  • True si existe el elemento,
  • False en caso contrario.
En modo de escritura:
  • True para validar el elemento,
  • False para eliminar el elemento.
YAMLFormatCharacter stringCadena YAML que corresponde al valor del elemento. Si esta cadena no está en formato YAML, se muestra una advertencia.
MemberArray de variables YAMLMiembros de la variable YAML.
NameCharacter stringNombre del miembro. Corresponde a una cadena vacía ("") si no hay ningún miembro.
CountIntegerNúmero de elementos:
  • 1 para elementos simples y objetos,
  • Número de elementos para arrays.
Esta propiedad es de solo lectura.
TypeIntegerTipo de elemento. Esta propiedad es de solo lectura.
ValueTodos los tiposValor del elemento.
Versión mínima requerida
  • Versión 25
Esta página también está disponible para…
Comentarios
Haga clic en [Agregar] para publicar un comentario

Última modificación: 23/06/2023

Señalar un error o enviar una sugerencia | Ayuda local