Pular para o conteúdo principal

Renderer.write

Página gerada do fonte

Gerada por tools/gerar_documentacao.py. Definição: tools/documentacao/render.py:1566.

Renderiza todas as páginas, guias e JSONs e escreve a árvore gerenciada.

Tipo: função Python · Visibilidade: pública · Arquivo: tools/documentacao/render.py.

Assinatura e expansão​

def write(self, output: Path) -> dict:

Parâmetros formais: self, output: Path.

Como funciona​

Renderiza todas as páginas, guias e JSONs e escreve a árvore gerenciada.

Implementação completa · 53 linhas
def write(self, output: Path) -> dict:
"""Renderiza todas as páginas, guias e JSONs e escreve a árvore gerenciada."""
for symbol in sorted(self.inv.symbols.values(), key=lambda s: s.key):
if symbol.kind == "macro" and self.macro_target(symbol):
continue
self.render_symbol(symbol)
self.render_indexes()
self.render_tests()
self.render_internals()
self.render_examples()
self.render_project()
self.render_build()
# Guias editoriais são fontes pequenas e versionadas; entram no mesmo build.
manuals = self.inv.root / "website" / "manuais"
if manuals.exists():
for path in sorted(manuals.rglob("*")):
if path.is_file() and path.suffix in {".md", ".mdx"}:
relative = path.relative_to(manuals).as_posix()
target = "guias/" + str(Path(relative).with_suffix("")) if not relative.startswith("inicio") else relative
target = str(Path(target).with_suffix(""))
self.pages[target + ".mdx"] = path.read_text(encoding="utf-8")
for name, label, pos in [("guias", "Guias", 10), ("referencia", "Referência", 20),
("testes", "Testes", 30), ("internos", "Internos", 40),
("exemplos", "Exemplos", 50), ("projeto", "Projeto", 60)]:
self.category(name, label, pos)
inventory = {
"schema": 1, "commit": self.commit,
"counts": dict(Counter(s.kind for s in self.inv.symbols.values())),
"symbols": [{"name": s.name, "aliases": s.aliases, "kind": s.kind, "language": s.language,
"path": s.path, "line": s.line, "end": s.end, "signature": s.signature,
"module": s.module, "visibility": s.visibility, "conditions": s.conditions,
"calls": s.calls, "url": "/" + self.slug(s), "source": self.gh(s.path, s.line)}
for s in sorted(self.inv.symbols.values(), key=lambda s: s.key)],
"references": [r.__dict__ for r in self.inv.references],
"cases": self.inv.cases, "modes": self.inv.modes, "warnings": self.inv.warnings,
}
no_refs = [s.key for s in sorted(self.inv.symbols.values(), key=lambda s: s.key)
if not self.direct_refs(s) and not (s.kind == "macro" and self.macro_target(s))]
coverage = {"schema": 1, "sem_referencia_direta": no_refs,
"sem_resumo_editorial": sorted(set(self.audit["sem_resumo_editorial"])),
"parser_warnings": self.inv.warnings,
"nota": "Referência direta não é cobertura de execução; ausência não implica defeito."}
self.pages["../static/api/inventario.json"] = json.dumps(inventory, ensure_ascii=False, indent=2, sort_keys=True) + "\n"
self.pages["../static/api/cobertura.json"] = json.dumps(coverage, ensure_ascii=False, indent=2, sort_keys=True) + "\n"
output.mkdir(parents=True, exist_ok=True)
(output / ".documentacao-gerada").write_text("Não edite: saída de tools/gerar_documentacao.py\n", encoding="utf-8")
for relative, content in sorted(self.pages.items()):
path = (output / relative).resolve()
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text(content, encoding="utf-8")
return {"pages": len(self.pages), "symbols": len(self.inv.symbols), "cases": len(self.inv.cases),
"references": len(self.inv.references), "warnings": self.inv.warnings,
"sem_referencia_direta": len(no_refs), "sem_resumo_editorial": len(coverage["sem_resumo_editorial"])}

Como este símbolo aparece nos testes​

Sem uso direto localizado

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.
Não confunda implementação com certificação

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.write. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.

Em uma frase, o que Renderer.write faz?​

Renderiza todas as páginas, guias e JSONs e escreve a árvore gerenciada.

Qual é a assinatura e o tipo de retorno de Renderer.write?​

Assinatura extraída de tools/documentacao/render.py; visibilidade pública.

def write(self, output: Path) -> dict:

Como chamar Renderer.write 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 write(self, output: Path) -> dict:

Por que não há teste direto para Renderer.write?​

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.write depende de compilador, padrão C ou sistema operacional?​

Renderer.write é 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.