Python · tools/documentacao/analise
Fonte: tools/documentacao/analise.
| Função | Linhas | Resumo | Referências diretas |
|---|---|---|---|
Source.__post_init__ | 38–41 | Codifica a fonte em bytes UTF-8 para offsets corretos do Tree-sitter. | 0 |
Source.lines | 44–46 | Expõe a fonte como linhas para snippets e links. | 0 |
Source.digest | 49–51 | Calcula hash SHA-256 determinístico do conteúdo da fonte. | 0 |
Symbol.key | 74–78 | Identifica símbolo por tipo/nome ou por arquivo para evitar colisões internas. | 0 |
Symbol.slug | 81–89 | Gera rota estável por tipo/módulo, reunindo apelidos de macro. | 0 |
Inventory.finish | 116–132 | Reconstrói índices por nome, resolve apelidos canônicos e ordena saídas. | 0 |
walk | 135–139 | Percorre uma árvore Tree-sitter em profundidade, incluindo o nó raiz. | 0 |
segment | 142–144 | Extrai texto de um nó usando offsets de bytes UTF-8 do Tree-sitter. | 0 |
ancestors | 147–152 | Percorre os pais de um nó até a raiz da árvore. | 0 |
previous_comment | 155–162 | Reúne comentários imediatamente anteriores a uma definição. | 0 |
clean_comment | 165–178 | Remove delimitadores e marcadores de comentário sem alterar o conteúdo. | 0 |
conditions | 181–213 | Extrai condições de pré-processador ancestrais, incluindo negação de else. | 3 |
declarator_name | 216–233 | Encontra o identificador em declaradores C aninhados/ponteiro. | 0 |
called_names | 236–244 | Lista chamadas diretas por identificador dentro de um nó C. | 0 |
module_for | 247–254 | Deriva o módulo de documentação a partir do caminho do fonte. | 0 |
mask_code | 257–309 | Substitui comentários e literais por espaços, preservando linhas/colunas. Não interpreta o pré-processador. Strings não são tratadas como chamadas; nomes de mod | 0 |
identifier_spans | 312–325 | Lista identificadores e linhas, incluindo corpos de macros C. | 0 |
add_symbol | 328–345 | Insere um símbolo ou mescla protótipo/definição sem duplicar a página. | 0 |
extract_c | 348–409 | Extrai funções, protótipos e macros de uma árvore C sem pré-processar alvos. | 0 |
extract_python | 412–464 | Extrai funções/métodos Python com ast, docstrings e chamadas. | 0 |
extract_python.header_of | 424–435 | Recorta a assinatura até o início do primeiro comando do corpo. Evita cortar em : de anotação ou de valor padrão, que não termina a assinatura em Python. | 0 |
extract_python.visit | 437–463 | Visita recursivamente definições Python preservando qualificação de classe/função. | 0 |
extract_shell | 467–495 | Extrai funções Bash por nome, corpo balanceado e comentário anterior. | 0 |
extract_heredocs | 498–522 | Indexa heredocs de runners como fontes virtuais com linhas originais. | 0 |
string_value | 525–528 | Remove aspas de um literal string simples extraído da AST C. | 0 |
extract_modes | 531–557 | Liga strcmp(caso, 'modo') e strcmp(argv[1], '--modo') ao ramo C real. | 0 |
container_for | 560–570 | Resolve o contexto mais específico de uma referência de teste. | 0 |
discover_cases | 573–603 | Descobre suítes/casos em disco, arquivos esperados, marcadores e registro no runner. | 0 |
discover_make | 606–614 | Extrai targets, dependências e linhas do Makefile. | 0 |
collect | 617–716 | Coleta fontes, símbolos, referências, casos, modos e exemplos do repositório. | 3 |
Perguntas frequentes
Perguntas frequentes sobre tools/documentacao/analise e as 30 função(ões) indexada(s) nele.
Que funções este arquivo expõe?
As funções abaixo foram extraídas do próprio arquivo. Elas são internas ao projeto: não fazem parte da API pública de basicgol.h.
def __post_init__(self) -> None:
# Tree-sitter usa bytes UTF-8, não índices de caracteres Unicode.
def lines(self) -> list[str]:
def digest(self) -> str:
def key(self) -> str:
def slug(self) -> str:
def finish(self) -> None:
Como executar este arquivo?
Depende do tipo de arquivo. A receita abaixo é a do projeto; flags e argumentos específicos estão na assinatura de cada função.
python3 tools/documentacao/analise
As funções internas têm teste próprio?
2 das 30 funções possuem referência direta nos testes. As demais podem ser alcançadas apenas por chamadores; o JSON de cobertura registra a lacuna.
Qual é o contrato de Source.__post_init__?
Codifica a fonte em bytes UTF-8 para offsets corretos do Tree-sitter.
def __post_init__(self) -> None:
# Tree-sitter usa bytes UTF-8, não índices de caracteres Unicode.
"""Codifica a fonte em bytes UTF-8 para offsets corretos do Tree-sitter."""
self.data = self.text.encode("utf-8")