Introdução aos arquivos YAML

Se você não esteve em Nárnia ou o caminhão isekai não te fez uma “visita”, você já deve ter esbarrado em arquivos YAML por aí. Seja em configurações de aplicativos, scripts de automação ou até mesmo em projetos de ciência de dados, o YAML está em toda parte. Mas o que exatamente é esse tal de YAML e por que ele é tão onipresente? Bem, é exatamente o que vamos explorar neste artigo.

Origens do YAML

O YAML, que significa “YAML Ain’t Markup Language” (YAML não é uma linguagem de marcação), é um formato de serialização de dados humanamente legível. Ele foi idealizado por Clark Evans e Ingy döt Net em 2001, durante um momento de reflexão sobre os formatos de configuração existentes na época e teve sua primeira especificação publicada em 2004. A ideia era criar algo que fosse mais legível para humanos e fácil de escrever, ao mesmo tempo em que fosse fácil de processar por máquinas.

YAML é frequentemente usado para representar estruturas de dados complexas de forma simples e intuitiva, tornando-se uma escolha popular para configurações de software, arquivos de manifesto e muito mais.

Objetivos

1. O YAML deve ser facilmente legível pelos seres humanos.
2. Os dados YAML devem ser portáteis entre linguagens de programação.
3. O YAML deve corresponder às estruturas de dados nativas de linguagens dinâmicas.
4. O YAML deve ter um modelo consistente para oferecer suporte a ferramentas genéricas.
5. O YAML deve oferecer suporte ao processamento de uma passagem.
6. O YAML deve ser expressivo e extensível.
7. O YAML deve ser fácil de implementar e usar.

O que é um Arquivo YAML?

Um arquivo YAML é um documento de texto que usa uma sintaxe simples e legível para representar dados. Ele é frequentemente usado para configurações de aplicativos, manifestos de serviço, definições de API, e muitos outros propósitos em que a estrutura de dados precisa ser definida de forma clara e concisa.

O YAML organiza os dados em pares de chave e valor, listas e estruturas aninhadas. Isso permite uma representação flexível e expressiva de diferentes tipos de dados.

Exemplo:

# Este é um exemplo de arquivo YAML
nome: João Silva
idade: 30
cidade: São Paulo

Neste exemplo:

• nome, idade e cidade são chaves.
• João Silva, 30 e São Paulo são os valores correspondentes a essas chaves.
• Os espaços são importantes na sintaxe YAML, pois indicam a estrutura hierárquica dos dados.

Como Criar um Arquivo YAML

Criar um arquivo YAML é simples. Tudo o que você precisa é de um editor de texto básico. Siga estas etapas para criar um arquivo YAML:

1. Abra um editor de texto, como o Bloco de Notas no Windows ou o TextEdit no macOS.
2. Digite os dados no formato YAML.
3. Salve o arquivo com a extensão .yaml ou .yml.

Por exemplo, você poderia criar um arquivo chamado config.yaml com o seguinte conteúdo:

# Configurações do aplicativo
nome: "Meu Aplicativo"
versao: 1.0
modo_depuracao: false

Tipos de Dados Suportados

O YAML suporta diversos tipos de dados, incluindo:

• Strings: representados sem aspas ou com aspas simples ou duplas.
• Números: inteiros ou decimais.
• Booleanos: true ou false.
• Listas: itens sequenciais, representados por um hífen seguido pelo valor.
• Dicionários: pares de chave e valor.
• Null: representado por null ou ~.

Aqui está um exemplo que mostra diferentes tipos de dados em YAML:

nome: "Maria"
idade: 25
ativo: true
interesses:
  - YAML
  - Desenvolvimento Web
  - Jogos
endereco:
  rua: Rua das Flores
  numero: 123
  cidade: Belo Horizonte
  complemento: null

Operações com YAML

Comentários: Você pode adicionar comentários ao seu arquivo YAML para documentação ou explicação. Comentários são precedidos pelo caractere # e podem ser adicionados em qualquer lugar no arquivo.

# Este é um comentário
chave: valor  # Comentário ao lado de uma linha
outra_chave: outro_valor  # Mais um comentário

Referências e âncoras: Você pode usar referências e âncoras para reutilizar partes do seu arquivo YAML em diferentes lugares.

pessoa1: &pessoa
  nome: João
  idade: 30

pessoa2: *pessoa

Adicionar tipos aos valores: Você pode explicitar a “tipagem” do valores atribuídos as chaves:

nome: !!str "Maria"
idade: !!int 25
ativo: !!bool true
peso: !!float 53.5

Textos com múltiplas linhas: Adicionar textos com múltiplas linhas

app: "Systoque"
objetivo: |
  Gerenciar os estoque da loja.
  Notificar sobre itens próximos a escassez

Conclusão

O YAML é uma linguagem de serialização de dados legível por humanos amplamente usada para representar estruturas de dados de forma simples e intuitiva. Neste artigo, discutimos o que é um arquivo YAML, sua sintaxe básica e como criar um. Com seu formato fácil de entender e ampla gama de tipos de dados suportados, o YAML é uma escolha popular para uma variedade de aplicações, desde configurações de software até definições de API. Experimente criar seus próprios arquivos YAML e aproveite a clareza e legibilidade que eles oferecem.

Referências

yaml.org