TatSu 开源项目教程

TatSu 开源项目教程

TatSu 竜 TatSu generates Python parsers from grammars in a variation of EBNF 项目地址: https://gitcode.com/gh_mirrors/ta/TatSu

1. 项目的目录结构及介绍

TatSu 是一个使用 Python 编写的工具，它可以将 EBNF（扩展巴科斯-诺尔范式）的语法输入转换成 Python 的 PEG（递归下降解析器）解析器。以下是 TatSu 项目的目录结构及其介绍：

TatSu/
├── .github/              # 存放与 GitHub 相关的配置文件
├── docs/                 # 项目文档
├── etc/                  # 其他辅助文件
├── examples/             # 示例代码和语法文件
├── grammar/              # 存放语法定义文件
├── media/                # 媒体文件，如图片等
├── tatsu/                # TatSu 的核心代码
├── test/                 # 测试代码
├── .gitignore            # Git 忽略文件列表
├── LICENSE.txt           # 项目许可证文件
├── MANIFEST.in           # 打包时包含的文件列表
├── Makefile              # Makefile 文件，用于构建项目
├── README.rst            # 项目说明文件
├── mypy.ini              # MyPy 类型检查配置文件
├── pyproject.toml        # Python 项目配置文件
├── readthedocs.yaml      # Read the Docs 配置文件
├── requirements-dev.txt  # 开发环境依赖
├── requirements-test.txt # 测试环境依赖
├── ruff.toml             # Ruff 代码风格检查配置文件
└── tox.ini               # Tox 测试配置文件

2. 项目的启动文件介绍

在 TatSu 项目中，并没有一个特定的“启动文件”。通常，用户会通过 Python 的命令行工具来使用 TatSu。以下是一个简单的示例，说明如何使用 TatSu 来解析一个字符串：

from tatsu import parse

GRAMMAR = '''
@@grammar::CALC
start = expression $ ;
expression = | expression '+' term | expression '-' term | term ;
term = | term '*' factor | term '/' factor | factor ;
factor = | '(' expression ')' | number ;
number = /\d+/ ;
'''

if __name__ == '__main__':
    from tatsu.util import asjson
    ast = parse(GRAMMAR, '3 + 5 * ( 10 - 20 )')
    print(asjson(ast))

这段代码定义了一个简单的算术表达式语法，并使用 TatSu 来解析字符串 '3 + 5 * ( 10 - 20 )'。

3. 项目的配置文件介绍

在 TatSu 项目中，配置文件主要用于定义项目的构建、测试、代码风格检查等流程。以下是几个重要的配置文件及其用途：

• .gitignore：指定 Git 忽略的文件和目录，以避免不必要的文件被提交到版本控制。
• mypy.ini：配置 MyPy 类型检查工具的选项，用于检查代码中的类型错误。
• pyproject.toml：定义了项目的元数据，包括项目名称、版本、依赖等。
• ruff.toml：配置 Ruff 代码风格检查工具的选项，用于检查代码风格问题。
• tox.ini：配置 Tox 测试工具，用于自动化测试流程。

以上是 TatSu 项目的基本介绍，希望对您的使用有所帮助。

TatSu 竜 TatSu generates Python parsers from grammars in a variation of EBNF 项目地址: https://gitcode.com/gh_mirrors/ta/TatSu