pyastbuilder

constructor de pyastas

Creación de un analizador de árbol de sintaxis abstracta para su propio lenguaje específico de dominio

pyastbuilder es un marco de Python para crear analizadores que construye un árbol de objetos que refleja el árbol de sintaxis abstracta (AST) del lenguaje, por el que se puede navegar, buscar y modificar pitónicamente. En el paquete se incluye un ejemplo demostrativo: un analizador para el lenguaje SPARQL del W3C, es decir, sparqlparser.py , que implementa Sparql v1.1. Sin embargo, se puede facilitar cualquier otro lenguaje especificado por BNF.

Existen muchos analizadores específicos o genéricos, sin embargo, la razón para desarrollar pyastbuilder es que a menudo el análisis se considera un proceso dinámico y de transmisión en vivo en el que existen varios ganchos a los que uno puede adjuntar su propio código, en lugar de la generación de una sintaxis abstracta y estática. árbol del "documento" electrónico, con una API para su acceso para su procesamiento posanalizado.

El trabajo pesado sobre el análisis real se deja en manos de pyparsing, que está incluido y se utiliza ampliamente.

Documentación

Principio de documentación

Seguimos nuestros siguientes

PRINCIPIO DE DISEÑO: Sea predictivo. Definir criterios claros para la ubicación de la documentación. ¿Qué parte de la documentación se incluye en los archivos README, qué partes se pueden encontrar en las páginas wiki y qué información se incluye en el código como comentarios? Defina y documente sus criterios de documentación, preferiblemente en la documentación principal que encontrará su usuario o desarrollador, que probablemente sea el archivo README.md del proyecto.

Criterios de documentación

Por ello seguimos los siguientes criterios en cuanto a documentación:

1. Todos los aspectos relacionados con el uso del software, así como su instalación , incluida una prueba de cordura para establecer la instalación correcta, han sido documentados en este WIKI, específicamente aquí.
2. Todos los aspectos relacionados con el desarrollo de su analizador particular para su propio lenguaje definido por EBNF se documentarán en la wiki como un manual separado ( TODO ).
3. Toda la descripción de los archivos de código fuente relacionados con pyastparser se documentará como archivos README.md en cada carpeta del árbol fuente.
4. La documentación de diseño sobre pyastbuilder , así como toda la documentación detallada y específica del código , está disponible en todo el código fuente como sintaxis de marcado reStructuredText (reST). Dado que este tipo de documentación sigue la convención de Python pydoc, se pueden generar sus páginas HTML correspondientes. La documentación estará disponible después de crear el HTML apuntando un navegador al archivo Doc/build/html/index.html ( TODO ).

Fuentes de documentación

Archivos README.md

Estos contendrán aquella parte de la documentación que involucra el diseño genérico sobre el código fuente que está disponible en la parte particular del árbol. Esta documentación está dirigida a los desarrolladores del proyecto con el fin de proporcionarles un conocimiento profundo de:

• el enfoque de diseño,
• la lógica interna del proceso principal,
• el marco estructural del proyecto, y
• cómo se relacionan con la estructura de árbol de origen con sus diferentes categorías de clases que se agrupan en directorios distintos.

páginas wiki

Puede encontrar una descripción completa de la documentación wiki en la página de inicio de wiki. Se pueden esperar las siguientes entradas:

1. Manual del usuario , donde se pueden encontrar descripciones, procedimientos y patrones con respecto al uso de sparqlparser como biblioteca en su propio código Python, así como cualquier otro xxxparser listo para usar que pueda proporcionarse en el futuro de este proyecto. Dado que cualquier otro xxxparser se basará en este mismo proyecto, podemos asumir con seguridad que encontraremos muchas referencias a casos de uso muy similares o incluso idénticos del sparqlparser .
2. Manual de desarrollo del analizador , que documentará los pasos genéricos a seguir para crear su propio analizador de lenguaje especificado por EBNF. Siempre que haya creado su propio xxxparser , compártalo con este proyecto y proporcione su propio capítulo en nuestro Manual del usuario sobre el uso de este analizador. Sin embargo: no duplique la documentación , utilice el manual sparqlparser como manual de referencia.

Contribuyendo

Lea CONTRIBUTING.md para obtener detalles sobre nuestro código de conducta y el proceso para enviarnos solicitudes de extracción.

Versionado

Usamos SemVer para el control de versiones. Para conocer las versiones disponibles, consulte las etiquetas en este repositorio.

Autores

• Jeroen Bruijning - Padre de la idea, autor principal - analizador
• Barry Nouwt (TNO) - Reestructuración de conformidad con el Código de conducta, mantenimiento
• Paul Brandt (TNO) - Usuario del proyecto - mediador

Véase también la lista de contribuyentes que participan(d) en este proyecto.

Licencia

Este proyecto tiene la licencia MIT; consulte el archivo LICENSE.md para obtener más detalles.

Expresiones de gratitud

• Un saludo a Paul McGuire, el autor de pyparsing. Hemos dejado el trabajo de análisis exhaustivo a este paquete y construimos nuestro paquete sobre eso.
• La compatibilidad con URI e IRI (su procesamiento de prefijos y expansión de base) y la conformidad con RFC 3987 no habrían alcanzado este nivel de calidad sin el excelente trabajo de Daniel Gerber, autor de rfc3987: Parsing and validation of URIs (RFC 3896) y IRI (RFC 3987).