Pular para o conteúdo principal

Renderer.render_project

Página gerada do fonte

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

Importa especificação, decisões, relatórios, README e cobertura versionada.

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

Assinatura e expansão​

def render_project(self) -> None:

Parâmetros formais: self.

Como funciona​

Importa especificação, decisões, relatórios, README e cobertura versionada.

Implementação​

def render_project(self) -> None:
"""Importa especificação, decisões, relatórios, README e cobertura versionada."""
self.category("projeto", "Especificação e decisões", 60)
body = ["# Especificação, decisões e relatórios\n\n",
"Os documentos originais do repositório são importados a cada build, com links internos ajustados. "
"Eles preservam o histórico e as ressalvas; a referência gerada mostra o estado atual dos símbolos.\n\n"]
for path in sorted((self.inv.root / "docs").glob("*.md")):
target = "projeto/" + path.stem
self.import_markdown(path, target)
title = re.match(r"#\s+(.+)", path.read_text(encoding="utf-8"))
label = title.group(1) if title else path.stem
body.append(f"- [{label}](/{target})\n")
self.import_markdown(self.inv.root / "README.md", "projeto/visao-geral", title="Visão geral · README",
document_key="visao-geral")
body.append("- [Visão geral · README](/projeto/visao-geral)\n")
body.append(self.faq(
"Perguntas frequentes sobre os documentos normativos e históricos do projeto.",
[
{"q": "Qual é a diferença entre “Projeto” e “Referência”?",
"a": ["A referência é gerada do código atual: assinaturas, expansões, guards e usos em "
"testes. Os documentos do projeto preservam a especificação, as decisões e os "
"relatórios históricos, que podem descrever fases já concluídas."]},
{"q": "Um documento histórico vale como estado atual?",
"a": ["Não automaticamente. Quando especificação e código divergirem, a referência "
"gerada mostra o que o fonte faz hoje; o relatório mostra o que foi executado na "
"fase documentada."]},
{"q": "Estes documentos são editados pelo gerador?",
"a": ["Não. Eles são importados de `docs/` e do `README.md` a cada build, com links "
"internos ajustados. A fonte versionada continua sendo o arquivo original."]},
{"q": "Onde encontro os critérios de aceitação?",
"a": ["Nos documentos numerados: especificação, critérios, relatório de fase e matriz "
"de compatibilidade. Use a navegação lateral; a ordem acompanha o prefixo "
"numérico dos arquivos.",
"Os mesmos arquivos podem ser listados e reimportados pelo gerador:"],
"code": "ls docs/*.md\npython3 tools/gerar_documentacao.py --strict", "lang": "bash"},
]))
self.page("projeto/index", "Especificação e decisões", "".join(body), label="Documentos do projeto", position=0)
self.category("testes/documentos", "Documentos originais de testes", 80)
self.import_markdown(self.inv.root / "tests" / "COBERTURA.md", "testes/cobertura-versionada",
title="Cobertura versionada (relatório)", document_key="cobertura-versionada")
self.import_markdown(self.inv.root / "tests" / "README.md", "testes/leiame-original",
title="README original dos testes", document_key="leiame-original")

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.render_project. 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_project faz?​

Importa especificação, decisões, relatórios, README e cobertura versionada.

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

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

def render_project(self) -> None:

Como chamar Renderer.render_project 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_project(self) -> None:

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

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

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