Pular para o conteúdo principal

Python · tools/documentacao/analise

Fonte: tools/documentacao/analise.

FunçãoLinhasResumoReferências diretas
Source.__post_init__38–41Codifica a fonte em bytes UTF-8 para offsets corretos do Tree-sitter.0
Source.lines44–46Expõe a fonte como linhas para snippets e links.0
Source.digest49–51Calcula hash SHA-256 determinístico do conteúdo da fonte.0
Symbol.key74–78Identifica símbolo por tipo/nome ou por arquivo para evitar colisões internas.0
Symbol.slug81–89Gera rota estável por tipo/módulo, reunindo apelidos de macro.0
Inventory.finish116–132Reconstrói índices por nome, resolve apelidos canônicos e ordena saídas.0
walk135–139Percorre uma árvore Tree-sitter em profundidade, incluindo o nó raiz.0
segment142–144Extrai texto de um nó usando offsets de bytes UTF-8 do Tree-sitter.0
ancestors147–152Percorre os pais de um nó até a raiz da árvore.0
previous_comment155–162Reúne comentários imediatamente anteriores a uma definição.0
clean_comment165–178Remove delimitadores e marcadores de comentário sem alterar o conteúdo.0
conditions181–213Extrai condições de pré-processador ancestrais, incluindo negação de else.3
declarator_name216–233Encontra o identificador em declaradores C aninhados/ponteiro.0
called_names236–244Lista chamadas diretas por identificador dentro de um nó C.0
module_for247–254Deriva o módulo de documentação a partir do caminho do fonte.0
mask_code257–309Substitui 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 mod0
identifier_spans312–325Lista identificadores e linhas, incluindo corpos de macros C.0
add_symbol328–345Insere um símbolo ou mescla protótipo/definição sem duplicar a página.0
extract_c348–409Extrai funções, protótipos e macros de uma árvore C sem pré-processar alvos.0
extract_python412–464Extrai funções/métodos Python com ast, docstrings e chamadas.0
extract_python.header_of424–435Recorta 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.visit437–463Visita recursivamente definições Python preservando qualificação de classe/função.0
extract_shell467–495Extrai funções Bash por nome, corpo balanceado e comentário anterior.0
extract_heredocs498–522Indexa heredocs de runners como fontes virtuais com linhas originais.0
string_value525–528Remove aspas de um literal string simples extraído da AST C.0
extract_modes531–557Liga strcmp(caso, 'modo') e strcmp(argv[1], '--modo') ao ramo C real.0
container_for560–570Resolve o contexto mais específico de uma referência de teste.0
discover_cases573–603Descobre suítes/casos em disco, arquivos esperados, marcadores e registro no runner.0
discover_make606–614Extrai targets, dependências e linhas do Makefile.0
collect617–716Coleta 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")