Gelatin 技术文档

1. 安装指南

系统要求

• Python 3.6 或更高版本
• 依赖库：lxml、yaml

安装步骤

1. 使用 pip 安装 Gelatin：

   pip install Gelatin
   

2. 验证安装是否成功：

   gel --version
   

2. 项目使用说明

概述

Gelatin 是一个解析器生成器，用于将文本转换为结构化格式，如 XML、JSON 或 YAML。它结合了词法分析器、解析器和输出生成器，定义了一种简单的语言来实现文本到结构化格式的转换。

示例

假设你有一个文本文件 input.txt，内容如下：

User
----
Name: John, Lastname: Doe
Office: 1st Ave
Birth date: 1978-01-01

User
----
Name: Jane, Lastname: Foo
Office: 2nd Ave
Birth date: 1970-01-01

你可以使用以下 Gelatin 语法将其转换为 XML：

define nl /[\r\n]/
define ws /\s+/
define fieldname /[\w ]+/
define value /[^\r\n,]+/
define field_end /[\r\n,] */

grammar user:
    match 'Name:' ws value field_end:
        out.add_attribute('.', 'firstname', '$2')
    match 'Lastname:' ws value field_end:
        out.add_attribute('.', 'lastname',  '$2')
    match fieldname ':' ws value field_end:
        out.add('$0', '$3')
    match nl:
        do.return()

grammar input:
    match 'User' nl '----' nl:
        out.open('user')
        user()

输出结果

<xml>
  <user lastname="Doe" firstname="John">
    <office>1st Ave</office>
    <birth-date>1978-01-01</birth-date>
  </user>
  <user lastname="Foo" firstname="Jane">
    <office>2nd Ave</office>
    <birth-date>1970-01-01</birth-date>
  </user>
</xml>

3. 项目 API 使用文档

使用 CLI 工具

1. 将输入文件转换为 XML：

   gel -s mysyntax.gel input.txt
   

2. 将输入文件转换为 JSON 或 YAML：

   gel -s mysyntax.gel -f json input.txt
   gel -s mysyntax.gel -f yaml input.txt
   

使用 Python 模块

from Gelatin.util import compile, generate

# 解析 .gel 文件
syntax = compile('syntax.gel')

# 将输入文件转换为 XML、YAML 和 JSON
print(generate(syntax, 'input.txt'))
print(generate(syntax, 'input.txt', format='yaml'))
print(generate(syntax, 'input.txt', format='json'))

4. 项目安装方式

使用 pip 安装

pip install Gelatin

从源码安装

1. 克隆项目仓库：

   git clone https://github.com/knipknap/Gelatin.git
   

2. 进入项目目录并安装：

   cd Gelatin
   python setup.py install
   

通过以上步骤，你可以成功安装并使用 Gelatin 项目。