Pyparsing 开源项目教程

Pyparsing 开源项目教程

pyparsingPython library for creating PEG parsers项目地址:https://gitcode.com/gh_mirrors/py/pyparsing

1. 项目目录结构及介绍

Pyparsing 项目的主要目录结构如下：

.
├── CHANGES.txt           // 更新日志
├── COPYING                // 许可证文件
├── examples               // 示例代码目录
│   ├── ...
│   └── ...                 // 各种示例脚本
├── parseTree.py           // 解析树相关模块
├── README.rst             // 主要项目说明
├── setup.cfg              // 构建配置文件
├── setup.py               // 安装脚本
└── src                     // 源代码目录
    ├── pyparsing.py       // 主要模块文件
    ├── pyparsing_common.py // 常用解析元素
    └── ...                 // 其他辅助模块

src 目录包含了 pyparsing 的核心代码，examples 目录则提供了各种示例，帮助用户理解如何使用库来定义和执行解析语法。

2. 项目的启动文件介绍

在 Pyparsing 中没有一个传统的"启动文件"，因为这是一个库而不是一个独立的应用程序。用户通过导入库中的模块（如 pyparsing 或 pyparsing_common）并调用其提供的类和方法来构建自己的解析器。例如，导入库并创建一个简单的解析表达式的方式如下：

from pyparsing import Word, alphas

name = Word(alphas)
expr = name + "is" + name
expr.parse_string("Alice is Bob")

这里，Word 和 alphas 是从 pyparsing 导入的，expr 是构造的解析规则。

3. 项目的配置文件介绍

Pyparsing 使用 setup.cfg 文件作为构建配置，它包含了安装时的相关设置，如 Python 版本要求、打包信息等。例如，setup.cfg 可能包含以下内容：

[metadata]
name = pyparsing
version = attr: pyparsing.__version__
author = Paul McGuire
author_email = <email address>
description = A Python parsing module
long_description = file: README.rst
url = https://github.com/pyparsing/pyparsing
license = MIT
 classifiers =
     Development Status :: 5 - Production/Stable
     Intended Audience :: Developers
     License :: OSI Approved :: MIT License
     Programming Language :: Python
     Topic :: Text Processing :: Markup
    Topic :: Scientific/Engineering :: Artificial Intelligence
     Topic :: Software Development :: Libraries :: Python Modules
    Typing :: Typed

[options]
packages = find:
python_requires = >=3.6.8
install_requires =
    typing>=3.5.3; python_version<"3.8"

[options.packages.find]
where = src

此配置文件指示了项目名称、作者信息、许可证类型、所需的 Python 版本以及依赖项等信息。当使用 pip install . 或 python setup.py install 进行安装时，这些配置将被用于构建和安装过程。

pyparsingPython library for creating PEG parsers项目地址:https://gitcode.com/gh_mirrors/py/pyparsing