oscript-yaml

KO | EN

gitlite — search

#react #ai #typescript #golang #machine-learning #deep-learning #nodejs #macos #java #awesome #vue #pytorch #ios #openai

(★ 16)

Реализация yaml-парсера средствами oscript

oscript-yaml 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# oscript-yaml 🚀

Полнофункциональная библиотека для работы с YAML в экосистеме OneScript/1C. Реализует парсинг и сериализацию YAML с поддержкой основных возможностей стандарта YAML 1.2 включая вложенные структуры, якоря, многострочные литералы и Flow Style синтаксис.

[![GitHub release](https://img.shields.io/github/v/release/Segate-ekb/oscript-yaml)](https://github.com/Segate-ekb/oscript-yaml/releases)
[![Tests](https://img.shields.io/badge/tests-418%20passed-green)](https://github.com/Segate-ekb/oscript-yaml)
[![OneScript](https://img.shields.io/badge/OneScript-2.0.0--rc.7+-blue)](https://oscript.io/)

## 📋 Оглавление

- [Установка](#установка)
- [Быстрый старт](#быстрый-старт)
- [API](#api)
- [Поддерживаемые возможности](#поддерживаемые-возможности)
- [Статус реализации](#статус-реализации)
- [Тестирование](#тестирование)
- [Нагрузочные тесты](#нагрузочные-тесты)

## 🚀 Установка

```bash
opm install oscript-yaml
```

Или клонируйте репозиторий:
```bash
git clone https://github.com/Segate-ekb/oscript-yaml.git
```

## ⚡ Быстрый старт

```bsl
#Использовать oscript-yaml

Парсер = Новый ПарсерYaml();

// Простой пример парсинга
СтрокаYAML = "
| name: John Doe
| age: 30
| active: true
|";

Результат = Парсер.ПрочитатьYaml(СтрокаYAML);
Сообщить(Результат.Получить("name")); // John Doe

// Сериализация в YAML
Данные = Новый Структура;
Данные.Вставить("имя", "Иван Иванов");
Данные.Вставить("возраст", 25);
Данные.Вставить("активен", Истина);

СтрокаYAML = Парсер.ЗаписатьYaml(Данные);
Сообщить(СтрокаYAML);
```

## 📚 API

### Класс ПарсерYaml

#### ПрочитатьYaml(СтрокаYaml)

Парсит YAML-строку и возвращает соответствующую структуру данных.

**Параметры:**
- `СтрокаYaml` (Строка) - YAML-строка для парсинга

**Возвращаемое значение:**
- Массив - массив документов yaml

**Пример:**
```bsl
Парсер = Новый ПарсерYaml();
Результат = Парсер.ПрочитатьYaml("key: value");
```

#### ПрочитатьИзФайла(ПутьКФайлу)

Читает YAML-файл в кодировке UTF-8 и возвращает соответствующую структуру данных.

**Параметры:**
- `ПутьКФайлу` (Строка) - путь к YAML-файлу

**Возвращаемое значение:**
- Произвольный - распарсенная структура данных или массив документов

**Пример:**
```bsl
Парсер = Новый ПарсерYaml();
Результат = Парсер.ПрочитатьИзФайла("config.yaml");
```

#### ЗаписатьYaml(Значение)

Сериализует данные в YAML-формат.

**Параметры:**
- `Значение` (Произвольный) - данные для сериализации

**Возвращаемое значение:**
- Строка - YAML-представление данных

**Пример:**
```bsl
Парсер = Новый ПарсерYaml();
Данные = Новый Структура("ключ", "значение");
СтрокаYAML = Парсер.ЗаписатьYaml(Данные);
// Результат: "---\nключ: значение"
```

#### ЗаписатьВФайл(ПутьКФайлу, Значение)

Сериализует данные в YAML-формат и записывает результат в файл в кодировке UTF-8.

**Параметры:**
- `ПутьКФайлу` (Строка) - путь к YAML-файлу
- `Значение` (Произвольный) - данные для сериализации

**Пример:**
```bsl
Парсер = Новый ПарсерYaml();
Данные = Новый Структура("ключ", "значение");
Парсер.ЗаписатьВФайл("config.yaml", Данные);
```

## ✅ Поддерживаемые возможности

### Базовые типы данных

- ✅ Строки (с кавычками и без)
- ✅ Числа (целые и вещественные)
- ✅ Булевы значения (`true`, `false`)
- ✅ Null значения (`null`, `~`)
- ✅ Комментарии (`#`)
- ✅ Множественные документы (`---` и `...`)

### Структуры данных

- ✅ Соответствия (объекты)
- ✅ Массивы (списки)
- ✅ Вложенные структуры любой глубины
- ✅ Смешанные типы в массивах

### Flow Style (инлайн синтаксис)

- ✅ Массивы в квадратных скобках `[1, 2, 3]`
- ✅ Объекты в фигурных скобках `{key: value}`
- ✅ Вложенные Flow структуры
- ✅ Пустые коллекции `[]`, `{}`
- ✅ Смешанный Flow и Block стили

### Многострочные литералы

- ✅ Literal style (`|`) - сохраняет переводы строк
- ✅ Folded style (`>`) - объединяет строки
- ✅ strip_literal: (`|-`) - убирает последний перенос строки
- ✅ keep_literal: (`|+`)   - сохраняет финальные переводы строк

### Пустые коллекции

- ✅ Пустые массивы в Flow style `[]`
- ✅ Пустые объекты в Flow style `{}`
- ✅ Неявные пустые значения (Block style)
- ✅ Null значения (`null`, `~`)

### Якоря и ссылки

- ✅ Определение якорей `&anchor`
- ✅ Ссылки на якоря `*anchor`
- ✅ Слияние объектов `<<: *anchor`
- ✅ Простые ссылки на скалярные значения

### Обработка ошибок

- ✅ Проверка синтаксиса Flow Style
- ✅ Валидация парных скобок и кавычек
- ✅ Информативные сообщения об ошибках

## 🚧 Статус реализации

### ✅ Полностью реализовано

1. **Базовый парсинг YAML** - ключ-значение пары, скалярные типы
2. **Массивы Block Style** - списки с дефисами
3. **Вложенные структуры** - многоуровневые объекты любой глубины
4. **Многострочные литералы** - `|` и `>` стили, chomping и indentation indicators
5. **Flow Style** - инлайн массивы `[1, 2, 3]` и объекты `{key: value}`
6. **Пустые коллекции** - `[]`, `{}`, неявные пустые значения
7. **Комментарии** - строки с `#`
8. **Якоря и ссылки** - `&anchor`, `*anchor`, `<<: *anchor`
9. **Смешанные типы** - комбинации различных структур
10. **Сложные структуры** - глубокая вложенность и композиции
11. **YAML сериализация** - полная поддержка записи в YAML формат
12. **Базовое экранирование строк** - `\n`, `\t`, `\r`, `\"`, `\\`, `\/`, `\b`, `\f`
13. **Unicode поддержка** - `\uXXXX` и `\xXX` последовательности
14. **Обработка ошибок** - валидация синтаксиса и информативные сообщения
15. **Пробелы, табуляция и explicit keys** - сценарии из YAML Test Suite
16. **YAML директивы** - `%YAML`, tag handles и связанные проверки
17. **Файловые операции** - чтение YAML из файла и запись YAML в файл

### 🔄 В разработке / Планируется

1. **Расширение удобства API**
   - Настройки форматирования сериализатора
   - Дополнительные вспомогательные методы для документов YAML

### 📋 Планы развития

- **Улучшение парсинга очень больших файлов** - контроль памяти и времени на больших YAML
- **Сложные ключи** - расширение пользовательских сценариев поверх explicit keys

#### Долгосрочные планы
- **Производительность** - точечная оптимизация при появлении измеримого узкого места
- **Потоковый парсинг** - обработка файлов по частям
- **Плагины типов** - кастомные обработчики данных

## 🧪 Тестирование

Проект включает обширный набор тестов на основе официального YAML Test Suite:

- **Всего тестов:** 418 обнаружено
- **Пройдено:** 418 тестов (100%)
- **Пропущено:** 0 тестов
- **Покрытие:** основные возможности YAML 1.2

### Запуск тестов

```bash
# Все тесты
oneunit e

# Конкретная категория
oneunit e --tagsInclude flow    # Flow Style тесты
oneunit e --tagsInclude anchor  # Якоря и ссылки
oneunit e --tagsInclude literal # Многострочные литералы
oneunit e --tagsInclude error   # Обработка ошибок
```

## Нагрузочные тесты

Для проверки работы на больших YAML в `utils` есть отдельные сценарии. Они генерируют документ из 5000 элементов с вложенными массивами и соответствиями, затем проверяют десериализацию или сериализацию.

```bash
# Десериализация большого YAML (~665 КБ)
oscript -measure utils/load-deserialize.os

# Сериализация большого объекта в YAML (~665 КБ)
oscript -measure utils/load-serialize.os
```

Контрольный прогон на текущем окружении:

```text
utils/load-deserialize.os: 5000 элементов, 664976 байт, 00:00:17.4475616
utils/load-serialize.os:   5000 элементов, 664976 байт, 00:00:03.1080556
```

Оба сценария завершаются успешно. По результатам проверки срочная оптимизация не требуется: сериализация работает быстро для текущего объема, десериализация ожидаемо дороже и остается кандидатом только для будущей точечной оптимизации при росте требований к большим файлам.

## 📄 Лицензия

MIT License - см. файл LICENSE для подробностей.

## 👨‍💻 Автор

**Egor Ivanov** - [e.ivanov@1cdevelopers.ru](mailto:e.ivanov@1cdevelopers.ru)

## 🔗 Полезные ссылки

- [YAML спецификация 1.2](https://yaml.org/spec/1.2.2/)
- [OneScript документация](https://oscript.io/)
- [Официальный YAML Test Suite](https://github.com/yaml/yaml-test-suite)
- [Тестовый Фреймворк](https://github.com/sfaqer/OneUnit)

---

oscript-yaml

oscript-yaml 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

oscript-yaml

oscript-yaml 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README