pyastbuilder

construtor de piast

Construindo um analisador de árvore de sintaxe abstrata para sua própria linguagem específica de domínio

pyastbuilder é uma estrutura python para construir analisadores que constrói uma árvore de objetos que reflete a árvore de sintaxe abstrata (AST) da linguagem, que pode ser navegada, pesquisada e modificada pythonicamente. Incluído no pacote está um exemplo demonstrativo: um analisador para a linguagem W3C SPARQL, ou seja, sparqlparser.py , que implementa Sparql v1.1. No entanto, qualquer outra linguagem especificada pela BNF pode ser facilitada.

Existem muitos analisadores específicos ou genéricos, no entanto, a razão para desenvolver pyastbuilder é que muitas vezes a análise é considerada um processo dinâmico e de streaming no qual existem vários ganchos aos quais se pode anexar o próprio código, em oposição à geração de uma sintaxe estática e abstrata árvore do “documento” eletrônico, com API para seu acesso para processamento pós-analisado.

O trabalho pesado sobre a análise real é deixado para o pyparsing, que está incluído e é amplamente utilizado.

Documentação

Princípio da documentação

Seguimos nossos seguidores

PRINCÍPIO DO DESIGN: Seja Preditivo. Defina critérios claros para a localização da documentação. Que parte da documentação é colocada nos arquivos README, que partes podem ser encontradas nas páginas wiki e que informações você coloca no código como comentários? Defina e documente seus critérios de documentação, de preferência na documentação principal que seu usuário ou desenvolvedor irá acessar, que provavelmente é o arquivo README.md do projeto.

Critérios de documentação

Portanto, seguimos os seguintes critérios em relação à documentação:

1. Todos os aspectos relativos ao uso do software, bem como sua instalação , incluindo um teste de sanidade para estabelecer a instalação correta, foram documentados neste WIKI, especificamente aqui.
2. Todos os aspectos relativos ao desenvolvimento de Seu Analisador Particular para sua própria linguagem definida por EBNF serão documentados no wiki como um manual separado ( TODO ).
3. Todas as descrições dos arquivos de código-fonte envolvidos com pyastparser serão documentadas como arquivos README.md em cada pasta da árvore de origem.
4. A documentação de design sobre pyastbuilder , bem como toda a documentação detalhada específica do código , está disponível em todo o código-fonte como sintaxe de marcação reStructuredText (reST). Como este tipo de documentação segue a convenção do python pydoc, suas páginas HTML correspondentes podem ser geradas. A documentação estará disponível após a construção do HTML apontando um navegador para o arquivo Doc/build/html/index.html ( TODO ).

Fontes de documentação

Arquivos README.md

Eles conterão aquela parte da documentação que envolve o design genérico do código-fonte que está disponível na parte específica da árvore. Esta documentação destina-se aos desenvolvedores do projeto com o objetivo de proporcionar-lhes um conhecimento profundo de:

• a abordagem do design,
• a lógica interna do processo principal,
• o quadro estrutural do projeto, e
• como eles se relacionam com a estrutura da árvore de origem com suas diferentes categorias de classes agrupadas em diretórios distintos.

Páginas Wiki

Uma visão geral completa da documentação do wiki pode ser encontrada na página inicial do wiki. Pode-se esperar as seguintes entradas:

1. Manual do usuário , onde descrições, instruções e padrões podem ser encontrados com relação ao uso do sparqlparser como biblioteca em seu próprio código python, bem como qualquer outro xxxparser pronto para uso que possa ser fornecido no futuro deste projeto. Como qualquer outro xxxparser será baseado neste mesmo projeto, podemos assumir com segurança que encontraremos muitas referências a casos de uso muito semelhantes ou mesmo idênticos no sparqlparser .
2. Manual de Desenvolvimento do Parser , que documentará as etapas genéricas a serem executadas para criar seu próprio analisador de linguagem especificado pelo EBNF. Sempre que você tiver criado seu próprio xxxparser , compartilhe-o com este projeto e forneça seu próprio capítulo em nosso Manual do Usuário sobre o uso deste analisador. No entanto: Não duplique a documentação , mas use o manual sparqlparser como manual de referência.

Contribuindo

Leia CONTRIBUTING.md para obter detalhes sobre nosso código de conduta e o processo de envio de pull requests para nós.

Versionamento

Usamos SemVer para versionamento. Para as versões disponíveis, consulte as tags neste repositório.

Autores

• Jeroen Bruijning - Pai da ideia, autor principal - analisador
• Barry Nouwt (TNO) – Reestruturação em atendimento ao Código de Conduta, manutenção
• Paul Brandt (TNO) – Usuário do projeto – mediador

Veja também a lista de colaboradores que participam(d) deste projeto.

Licença

Este projeto está licenciado sob a licença MIT - consulte o arquivo LICENSE.md para obter detalhes

Agradecimentos

• Gorjeta para Paul McGuire, autor de pyparsing. Deixamos o trabalho exaustivo de análise para este pacote e construímos nosso pacote em cima disso.
• O suporte para URIs e IRIs (seu processamento de prefixo e expansão de base) e a conformidade com RFC 3987 não teriam chegado a esse nível de qualidade sem o excelente trabalho de Daniel Gerber, autor de rfc3987: Análise e validação de URIs (RFC 3896) e IRIs (RFC 3987).