pyastbuilder

пястстроитель

Создание синтаксического анализатора абстрактного синтаксического дерева для вашего собственного предметно-ориентированного языка.

pyastbuilder — это среда Python для создания анализаторов, которые создают дерево объектов , отражающее абстрактное синтаксическое дерево языка (AST), по которому можно осуществлять навигацию, поиск и изменение с помощью Python. В пакет включен один наглядный пример: синтаксический анализатор языка W3C SPARQL, то есть sparqlparser.py , который реализует Sparql v1.1. Однако можно использовать любой другой язык, указанный в BNF.

Существует множество специальных или универсальных парсеров, однако причина разработки pyastbuilder заключается в том, что часто синтаксический анализ рассматривается как потоковый динамический процесс, в котором существует несколько перехватчиков, к которым можно прикрепить свой собственный код, в отличие от генерации статического абстрактного синтаксиса. дерево электронного «документа» с API для доступа к нему для последующей обработки.

Тяжелая работа по фактическому синтаксическому анализу возлагается на pyparsing, который включен и широко используется.

Документация

Принцип документирования

Мы следим за нашими подписчиками

ПРИНЦИП ДИЗАЙНА: Будьте предусмотрительным. Определите четкие критерии расположения документации. Какая часть документации помещена в файлы README, какие части можно найти на страницах вики, а какую информацию вы помещаете в код в виде комментариев? Определите и задокументируйте критерии документации, желательно в основной части документации, которую будет использовать ваш пользователь или разработчик, которой, вероятно, является файл README.md проекта.

Критерии документации

Поэтому мы следуем следующим критериям в отношении документации:

1. Все аспекты, касающиеся использования программного обеспечения, а также его установки , включая проверку правильности установки, документированы в этой WIKI, а именно здесь.
2. Все аспекты, касающиеся разработки вашего конкретного парсера для вашего собственного языка, определенного EBNF, будут задокументированы в вики в виде отдельного руководства ( TODO ).
3. Все описания файлов исходного кода , связанных с pyastparser , будут задокументированы как файлы README.md в каждой папке дерева исходного кода.
4. Проектная документация по pyastbuilder , а также вся подробная документация по конкретному коду доступна в исходном коде в виде синтаксиса разметки reStructuredText (reST). Поскольку этот тип документации соответствует соглашению Python pydoc, можно создавать соответствующие HTML-страницы. Документация будет доступна после создания HTML, указав в браузере файл Doc/build/html/index.html ( TODO ).

Источники документации

Файлы README.md

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

• дизайнерский подход,
• внутренняя логика основного процесса,
• структурную основу проекта и
• как они связаны со структурой дерева исходного кода с различными категориями классов, сгруппированными в отдельные каталоги.

Вики-страницы

Полный обзор документации вики можно найти на домашней странице вики. Можно ожидать следующие записи:

1. Руководство пользователя , в котором можно найти описания, инструкции и шаблоны использования sparqlparser в качестве библиотеки в вашем собственном коде Python, а также любого другого готового xxxparser , который может быть предоставлен в будущем. проект. Поскольку любой другой xxxparser будет основан на этом же проекте, мы можем с уверенностью предположить, что в sparqlparser можно найти множество ссылок на очень похожие или даже идентичные варианты использования.
2. Руководство по разработке парсера , в котором описаны общие шаги, которые необходимо предпринять для создания собственного синтаксического анализатора языка, определенного EBNF. Всякий раз, когда вы создаете свой собственный xxxparser , поделитесь им с этим проектом и создайте отдельную главу в нашем руководстве пользователя, посвященную использованию этого парсера. Однако: не дублируйте документацию , а вместо этого используйте руководство sparqlparser в качестве справочного руководства.

Содействие

Пожалуйста, прочтите CONTRIBUTING.md для получения подробной информации о нашем кодексе поведения и процессе отправки нам запросов на включение.

Управление версиями

Мы используем SemVer для управления версиями. Доступные версии см. в тегах этого репозитория.

Авторы

• Йерун Брюйнинг — Отец идеи, главный автор — парсер
• Барри Ноут (TNO) – Реструктуризация в соответствии с Кодексом поведения, техническое обслуживание
• Пол Брандт (TNO) – Пользователь проекта – медиатор

См. также список участников, которые принимают участие(d) в этом проекте.

Лицензия

Этот проект лицензируется по лицензии MIT — подробности см. в файле LICENSE.md.

Благодарности

• Подсказка Полу Макгуайру, автору pyparsing. Мы оставили исчерпывающую работу по синтаксическому анализу этому пакету и построили наш пакет поверх него.
• Поддержка URI и IRI (их обработка префиксов и расширение базы) и соответствие RFC 3987 не достигли бы такого уровня качества без превосходной работы Дэниела Гербера, автора rfc3987: Анализ и проверка URI (RFC 3896) и IRI (RFC 3987).