Как конвертировать YAML в JSON [Python, PowerShell, Go]

Учебники
Go PowerShell Python

Многие современные инструменты, особенно в области управления конфигурацией и кода инфраструктуры (IaC), используют файлы JSON или YAML для хранения конфигурационных данных. Если вам нужно преобразовать данные из формата YAML в JSON, то эта статья для вас.

В этой статье вы узнаете несколько способов преобразования данных из YAML в формат JSON, включая написание скриптов на Python, PowerShell и Go.

Связано:PowerShell против Python: Битва века

Предварительные требования

Если вы хотите следовать примерам в этом учебнике, убедитесь, что у вас есть

  • A code editor. This article will use Visual Studio Code version 1.55.1. Feel free to use any code editor you want.

Связано:Что нужно знать о Visual Studio Code: Учебник

  • Чтобы начать преобразование YAML в JSON, вам нужен образец YAML-содержимого. Скопируйте содержимое ниже в новый файл с именем operating-systems.yml. Сохраните файл YAML в вашем рабочем каталоге. 
operating-systems.yml
Windows 10: 100
Windows Server 2019: 50
Windows Server 2022: 1
MacOS: 3
CentOS: 75
Photon: 12

Использование Python для преобразования YAML в JSON

Python – отличный язык для автоматизации. Но знаете ли вы, что можно расширить возможности Python и использовать его для преобразования документов из YAML в JSON? И вам нужно выполнить всего несколько шагов, чтобы начать преобразование YAML в JSON в кратчайшие сроки.

Пример в этом разделе требует, чтобы у вас были установлены Python 3.9 и PIP (последняя версия на момент написания – 21.0.1).

Добавление поддержки YAML в Python

Python не имеет встроенной поддержки YAML. Это означает, что Python не может читать или интерпретировать YAML-документы по умолчанию. Чтобы добавить поддержку YAML в Python, сначала вам нужно установить модуль PyYAML.

Чтобы установить модуль PyYAML, вам нужно выполнить команду pip, который является инструментом установки пакетов для Python. Для этого выполните следующие шаги.

Сначала откройте предпочитаемый интерпретатор команд, такой как командная строка или PowerShell. Команда pip должна работать в любом из них. В этом примере используется PowerShell.

Затем выполните следующую команду в PowerShell. Эта команда устанавливает модуль PyYAML.

pip install pyyaml

Как видно на скриншоте ниже, pip установил последнюю версию PyYAML (5.4.1 на момент написания).

Installing the PyYAML module

Написание скрипта преобразования

Теперь, когда вы установили необходимый модуль (PyYAML), вы готовы написать свой скрипт преобразования. Чтобы создать скрипт Python для преобразования YAML в JSON, выполните следующие шаги.

1. Откройте свой редактор кода и создайте новый файл с именем convert-os.py в вашем рабочем каталоге. Этот файл будет вашим скриптом.

2. Скопируйте код ниже и вставьте его в ваш пустой файл convert-os.py. Этот скрипт будет читать содержимое YAML-файла operating-systems.yml, преобразовывать его в формат JSON и записывать JSON-вывод в файл python_operating-systems.json. 

## convert-os.py
## Импорт модулей для обработки JSON и YAML
import yaml
import json

## Создание переменной для хранения импортируемых данных
os_list = {}

## Чтение YAML-файла
with open("c:\temp\operating-systems.yml") as infile:
     # Преобразование YAML в переменную, определенную выше os_list = yaml.load(infile, Loader=yaml.FullLoader)     # Вывести список в консоль print(os_list)
 Open a file to write the JSON output. The 'w' makes the file writable
 with open("c:\temp\python_operating-systems.json", 'w') as outfile:
     # Преобразование в JSON, установка "indent" делает файл более читаемым json.dump(os_list, outfile, indent=4) print("Файл JSON записан.")

3. Сохраните скрипт convert-os.py.

Запуск скрипта преобразования

После создания скрипта преобразования пришло время провести тестирование. Для выполнения скрипта Python преобразования YAML в JSON выполните следующие действия:

1. Откройте окно терминала. В этой статье используется PowerShell, но командная строка (CMD) также подойдет.

2. Скопируйте команду ниже, вставьте ее в PowerShell и нажмите Enter. Эта команда запускает исполняемую программу Python, чтобы вызвать скрипт convert-os.py, который вы создали в предыдущем разделе. 

python c:\temp\convert-os.py

После выполнения команды вы должны увидеть аналогичный вывод, как на изображении ниже. Как видите, команда отобразила вывод JSON на экране и сохраняет тот же вывод в файл c:\temp\python_operating-systems.json.

Running the YAML to JSON conversion script using Python

3. Наконец, откройте файл JSON под названием python_operating-systems.json, который должен был создать скрипт Python convert-os.py. В этом примере, чтобы открыть файл в блокноте, выполните следующую команду в PowerShell. 

notepad C:\temp\python_operating-systems.json
Viewing the python_operating-systems.json file in notepad

Использование PowerShell для преобразования YAML в JSON

PowerShell способен изменять текстовые файлы и преобразовывать объекты в несколько форматов, включая JSON. Поскольку PowerShell расширяем, вы можете использовать PowerShell для преобразования YAML в формат JSON с правильным модулем.

Добавление поддержки YAML в PowerShell

PowerShell имеет встроенную поддержку для обработки содержимого JSON, но не для YAML. К счастью, существует модуль, который расширяет PowerShell для поддержки файлов YAML. Этот модуль называется PowerShell-yaml, и последняя версия на момент написания это 0.4.2. Следуйте этим шагам, чтобы установить модуль.

1. На вашем компьютере откройте сеанс PowerShell.

2. Скопируйте указанную команду, вставьте ее в PowerShell и нажмите Enter. Эта команда использует cmdlet Install-Module для установки модуля PowerShell-yaml. 

Install-Module PowerShell-yaml

3. После установки модуля в PowerShell станут доступны две новые cmdlet в рамках модуля PowerShell-yaml. Эти новые cmdlet:

ConvertFrom-Yaml – cmdlet для преобразования данных YAML в хэш-таблицу.

ConvertTo-Yaml – cmdlet для преобразования объектов хэш-таблицы в данные YAML.

Для подтверждения наличия обеих cmdlet в PowerShell выполните указанную ниже команду в PowerShell. 

Get-Command -Module PowerShell-yaml

Как видно ниже, cmdlet Get-Command перечислил cmdlet из модуля PowerShell-yaml.

Getting the PowerShell-yaml cmdlets

Создание сценария конвертации

Для создания сценария конвертации YAML в JSON в PowerShell следуйте этим инструкциям.

1. Откройте ваш редактор кода и создайте новый файл с именем convert-os.ps1 в вашем рабочем каталоге.

2. Скопируйте код ниже и вставьте его в пустой файл convert-os.ps1. Фрагмент кода ниже считывает файл операционных систем operating-systems.yml и преобразует его в формат JSON. После этого JSON сохраняется в файле PowerShell_operating-systems.json. 

#convert-os.ps1
 #Считываем файл YAML с помощью Get-Content и преобразуем данные в хэш-таблицу с помощью ConvertFrom-Yaml. Переменная $os_list хранит объект хэш-таблицы.
 $os_list = (Get-Content -Path "C:\temp\operating-systems.yml" | ConvertFrom-Yaml)
 #Преобразуем объект хэш-таблицы в переменной $os_list в формат JSON с помощью ConvertTo-Json. После этого сохраняем JSON в файле C:\temp\PowerShell_operating-systems.json с помощью Set-Content.
 Set-Content -Path "C:\temp\PowerShell_operating-systems.json" -Value ($os_list | ConvertTo-Json)

Связано:Get-Content: Чтение текстовых файлов как профессионал в PowerShell

Связано:Set-Content: Способ PowerShell для записи в файл

3. Сохраните файл convert-os.ps1.

Запуск скрипта преобразования

Теперь, когда вы создали свой скрипт преобразования, следующим шагом будет его запуск для преобразования YAML в JSON. Чтобы выполнить скрипт преобразования PowerShell, выполните следующие шаги.

  1. Откройте окно PowerShell, если еще не открыли.

2. Скопируйте команду ниже, вставьте ее в PowerShell и нажмите Enter. Эта команда вызывает скрипт convert-os.ps1, который вы создали в предыдущем разделе. 

c:\temp\convert-os.ps1

3. После запуска скрипта откройте файл вывода JSON C:\temp\PowerShell_operating-systems.json, созданный скриптом convert-os.ps1 на предыдущем этапе. Для этого выполните следующую команду в PowerShell, чтобы открыть PowerShell_operating-systems.json в блокноте. 

notepad C:\temp\PowerShell_operating-systems.json
Viewing the content of the PowerShell_operating-systems.json file

Использование Go для преобразования YAML в JSON

Python и PowerShell – оба высокоуровневые языки. Быть высокоуровневыми облегчает написание сценариев, но также отнимает немного контроля. С другой стороны, Go – это низкоуровневый язык, что делает импорт данных YAML более сложным.

Пример в этом разделе будет использовать Go. Последняя версия на момент написания – go1.16.3. Если у вас еще нет Go, обратитесь к странице загрузки и установки, чтобы установить его на свой компьютер.

Добавление поддержки YAML в Go

Как и в PowerShell и Python, поддержка JSON является частью основных библиотек Go, но не YAML. Чтобы добавить поддержку YAML в Go, сначала вам нужно установить пакет YAML.v3 с использованием команды go get . Для установки пакета YAML.v3:

Сначала на вашем компьютере откройте командную оболочку, которую вы хотите использовать, например, командную строку или PowerShell. В этом примере используется PowerShell.

Далее скопируйте следующую команду и выполните её в PowerShell. Эта команда загрузит и установит пакет с именем gopkg.in/yaml.v3.

go get gopkg.in/yaml.v3
Installing the yaml.v3 package in Go

Написание Сценария Преобразования

Чтобы создать сценарий преобразования YAML в JSON на Go, следуйте этим инструкциям.

1. Откройте ваш редактор кода и создайте новый файл с именем convert-os.go в вашем рабочем каталоге.

2. Скопируйте код ниже и вставьте в созданный файл convert-os.go. Код импортирует необходимые пакеты, определяет некоторые структуры памяти, импортирует файл YAML и преобразует его в JSON перед записью в файл JSON с именем c:\temp\go_operating-systems.json.

// Это говорит, какую функцию загружать.
 package main
 // Импортировать пакеты:
 import (
  // Модуль JSON
     "encoding/json"
  // Для записи вывода на экран
     "fmt"
  // Для чтения и записи файлов
     "io/ioutil"
 // Модуль YAML
     "gopkg.in/yaml.v3"
 )
 // Определите две "структуры" - это структуры данных в памяти, и соответствуют
 // Формат файлов YAML и JSON.
 type operatingSystems struct {
     Windows10         int yaml:"Windows 10"
     WindowsServer2019 int yaml:"Windows Server 2019"
     WindowsServer2022 int yaml:"Windows Server 2022"
     MacOS             int yaml:"MacOS"
     CentOS            int yaml:"CentOS"
     Photon            int yaml:"Photon"
 }
 type operatingSystemsjson struct {
     Windows10         int json:"Windows 10"
     WindowsServer2019 int json:"Windows Server 2019"
     WindowsServer2022 int json:"Windows Server 2022"
     MacOS             int json:"MacOS"
     CentOS            int json:"CentOS"
     Photon            int json:"Photon"
 }
 func main() {
   // Дайте пользователю знать, что процесс начат
     fmt.Println("Parsing YAML file")
 // Определите путь к входному файлу
 var fileName string = "c:\temp\operating-systems.yml"
 // Загрузите YAML из файла. В Go требуется обработка ошибок для этого шага.
 yamlFile, err := ioutil.ReadFile(fileName)
     if err != nil {
         fmt.Printf("Error reading YAML file: %s\n", err)
         return
     }
 // Извлеките YAML в вашу структуру
     var oses operatingSystems
     yaml.Unmarshal(yamlFile, &oses)
 // Создайте структуру JSON, используя данные из структуры YAML
 var osesjson = operatingSystemsjson{
         Windows10:         oses.Windows10,
         WindowsServer2019: oses.WindowsServer2019,
         WindowsServer2022: oses.WindowsServer2022,
         MacOS:             oses.MacOS,
         CentOS:            oses.CentOS,
         Photon:            oses.Photon,
     }
 // Создайте строку для вывода в формате JSON.
 jsonOutput, err := json.Marshal(osesjson)
 // Выведите результат на экран. Обратите внимание, что %+v означает, что 
   // имя переменной выводится с данными. Вот почему
   // в выводе нет пробелов в именах ключей.
     fmt.Printf("Result: %+v\n", osesjson)
 //запись файла JSON
 err = ioutil.WriteFile("c:\temp\Go_operating-systems.json", jsonOutput, 0644)
 }

3. Сохраните файл convert-os.go.

Запуск сценария преобразования

Запуск сценариев на Go осуществляется с помощью команды go run , за которой следует имя файла сценария. Чтобы запустить сценарий преобразования YAML в JSON на Go, выполните следующие действия.

1. На своем компьютере откройте командную оболочку, которую хотите использовать. В Windows команда go будет работать как в командной строке, так и в PowerShell. В этом примере используется PowerShell для запуска go.

2. После того как вы находитесь в PowerShell, скопируйте указанную ниже команду и выполните ее в PowerShell. Эта команда вызовет команду go run для запуска сценария c:\temp\convert-os.go. 

go run c:\temp\convert-os.go
Running Convert-os Go script.

3. После выполнения сценария откройте выходной файл C:\temp\Go_operating-systems.json, который создал сценарий convert-os.go на предыдущем шаге. В этом примере файл Go_operating-systems.json открывается в блокноте.

Viewing the Go_operating-systems.json in notepad

Заключение

В этой статье вы узнали, как преобразовать данные и файлы YAML в JSON с помощью сценариев на Python, PowerShell и Go. Теперь, когда вы узнали различные способы преобразования YAML в JSON, каким способом вы думаете, что будете пользоваться чаще?

Source:
https://adamtheautomator.com/yaml-to-json/