Renderer.render_internals
Gerada por tools/gerar_documentacao.py. Definição: tools/documentacao/render.py:1295.
Agrupa funções internas por linguagem e arquivo.
Tipo: função Python · Visibilidade: pública · Arquivo: tools/documentacao/render.py.
Assinatura e expansão
def render_internals(self) -> None:
Parâmetros formais: self.
Como funciona
Agrupa funções internas por linguagem e arquivo.
Implementação
def render_internals(self) -> None:
"""Agrupa funções internas por linguagem e arquivo."""
self.category("internos", "Código interno e ferramentas", 40)
groups = defaultdict(list)
for symbol in self.inv.symbols.values():
if symbol.kind == "função C" and symbol.path.startswith(("include/", "src/")):
continue
if symbol.kind == "macro":
continue
groups[(symbol.language, Path(symbol.path).with_suffix("").as_posix())].append(symbol)
body = ["# Inventário interno\n\n",
"Funções do transpilador, harness C, runners Bash e scripts Python — incluindo o próprio gerador. "
"Cada página traz assinatura, corpo, chamadores e referências de teste disponíveis.\n\n"]
for (language, path), symbols in sorted(groups.items()):
area = {"python": "Python", "shell": "Shell", "c": "C"}.get(language, language)
folder = f"internos/{area.lower()}/{path.replace('/', '-')}"
self.category(folder, f"{area} · {path}", 10)
rows = [f"# {area} · {path}\n\n", f"Fonte: {self.gh_link(path)}.\n\n",
"| Função | Linhas | Resumo | Referências diretas |\n|---|---|---|---:|\n"]
for symbol in sorted(symbols, key=lambda s: s.line):
summary = protect(plain(self.contract(symbol).get("resumo") or symbol.comment or "Contrato no corpo")[:160]).replace("|", "\\|")
rows.append(f"| {self.link(symbol)} | {symbol.line}–{symbol.end} | {summary} | {len(self.direct_refs(symbol))} |\n")
rows.append(self.internal_faq(path, language, symbols))
self.page(folder + "/index", f"{area} · {path}", "".join(rows), label="Funções", position=0)
body.append(f"- [{area} · {path}](/{folder}/) — {len(symbols)} função(ões)\n")
body.append(self.faq(
"Perguntas frequentes sobre o inventário interno: transpilador, harness, runners e scripts.",
[
{"q": "O que entra no inventário interno?",
"a": ["Funções de `tools/basicgolc.c`, do harness `tests/`, dos runners Bash e dos "
"scripts Python — incluindo `tools/gerar_documentacao.py` e `tools/cobertura.py`. "
"Macros e funções públicas ficam na [referência](/referencia/)."]},
{"q": "Uma função interna é API pública?",
"a": ["Não. Nomes internos podem mudar sem promessa de compatibilidade. A superfície "
"pública é o que `include/basicgol.h` e os cabeçalhos de módulo declaram."]},
{"q": "Como o transpilador é testado?",
"a": ["Pela CLI: casos dourados, matriz de portabilidade e fuzz de mutação, além dos "
"modos de aviso W-01…W-07."],
"code": "make test\nmake fuzz\npython3 tests/fuzz_basicgolc.py --iteracoes 500",
"lang": "bash"},
{"q": "O inventário interno substitui a leitura do código?",
"a": ["Não. Ele mostra assinatura, corpo, chamadores e referências, mas não prova "
"cobertura de ramos. Use os permalinks e os testes citados para auditar."]},
]))
self.page("internos/index", "Inventário interno", "".join(body), label="Visão geral", position=0)
Nomes internos referenciados: plain, protect.
Como este símbolo aparece nos testes
Nenhuma referência direta a este nome foi encontrada nos arquivos de teste. Isso pode ser esperado para guardas de inclusão, configuração ou código exercitado indiretamente; não é uma afirmação de cobertura zero.
Compiladores, padrão C e sistema operacional
Nenhum ramo condicional externo foi detectado para este símbolo. A implementação é compartilhada no fonte; isso não certifica compiladores ou sistemas não executados.
- Script Python: usa a biblioteca padrão e pathlib/subprocess quando aplicável; caminhos não devem depender do separador de um único OS.
A matriz histórica distingue executado, compilado, avaliado e não testado. Consulte a matriz, os compiladores e os logs atuais dos workflows antes de chamar um alvo de suportado.
Perguntas frequentes
Perguntas reunidas a partir da definição, do contrato editorial e dos testes de Renderer.render_internals. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.
Em uma frase, o que Renderer.render_internals faz?
Agrupa funções internas por linguagem e arquivo.
Qual é a assinatura e o tipo de retorno de Renderer.render_internals?
Assinatura extraída de tools/documentacao/render.py; visibilidade pública.
def render_internals(self) -> None:
Como chamar Renderer.render_internals corretamente?
Nenhum exemplo editorial nem chamada direta em teste foi localizada. A forma de uso é a assinatura acima; os chamadores aparecem na seção de evidência indireta quando existem.
def render_internals(self) -> None:
Por que não há teste direto para Renderer.render_internals?
A busca estática não encontrou o identificador nos arquivos de teste. Isso é esperado para guardas de inclusão, configuração de build e nomes alcançados apenas por chamadores internos. O JSON de cobertura registra a lacuna em vez de convertê-la em aprovação.
Renderer.render_internals depende de compilador, padrão C ou sistema operacional?
Renderer.render_internals é uma função Python: requer Python 3.10+ e biblioteca padrão, sem compilador C.
O que acontece em caso de falha ou uso inválido?
Não há ressalva editorial específica para este nome. O comportamento em falha é o do corpo/expansão mostrado acima; não invente validação que o fonte não faz.