Pular para o conteúdo principal

Renderer.render_case

Página gerada do fonte

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

Renderiza um caso dourado/negativo/aviso com todos os seus arquivos.

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

Assinatura e expansão​

def render_case(self, case: dict) -> None:

Parâmetros formais: self, case: dict.

Como funciona​

Renderiza um caso dourado/negativo/aviso com todos os seus arquivos.

Implementação​

def render_case(self, case: dict) -> None:
"""Renderiza um caso dourado/negativo/aviso com todos os seus arquivos."""
out = [f"# {case['name']}\n\n", f"Suíte `{case['suite']}` · tipo **{case['mode']}** · ",
f"M0: **{'sim' if case['m0'] else 'não'}** · M1: **{'sim' if case['m1'] else 'não'}**.\n\n"]
if not case["runner_registered"]:
out.append(":::warning[Suíte não localizada no runner]\nO caso foi descoberto em disco, mas o nome da suíte não aparece em tests/run.sh.\n:::\n\n")
out.append("## Como é verificado\n\n")
if case["mode"] == "negativo":
out.append("A compilação/tradução deve falhar e o diagnóstico deve conter o texto esperado. "
"Um programa que compila sem erro não satisfaz este caso.\n\n")
elif case["mode"] == "aviso":
out.append("O transpilador deve emitir o código W-xx correspondente; aviso não é o mesmo que erro fatal.\n\n")
else:
out.append("Compila e executa pelos caminhos indicados, compara stdout normalizado, status e stderr declarado. "
"Arquivos alternativos, quando presentes, representam resultados de plataforma explicitamente aceitos.\n\n")
if case["objetos"]:
out.append("O marcador `objetos` seleciona compilação separada (`-c`) e ligação posterior.\n\n")
out.append("## Arquivos do caso\n\n")
for name, path in case["files"].items():
source = self.inv.sources.get(path)
text = source.text if source else (self.inv.root / path).read_text(encoding="utf-8")
out.append(f"<details>\n<summary>{name} · {self.gh_link(path, label='fonte')}</summary>\n\n")
out.append(fence(text, code_language(path)) + "\n</details>\n\n")
out.append("## Símbolos documentados usados neste caso\n\n")
links = []
for name in case["symbols"]:
candidates = self.inv.by_name.get(name, [])
if len(candidates) == 1:
links.append(self.link(candidates[0]))
out.append(", ".join(sorted(set(links))) or "Nenhum símbolo do inventário localizado." )
out.append("\n\n:::note[Rastreabilidade]\nA lista vem de identificadores no código de teste, não de comentários ou strings. "
"Ela não mede cobertura de ramos nem garante que toda chamada foi executada.\n:::\n")
out.append(self.case_faq(case))
self.page(f"testes/casos/{case['suite']}/{case['name']}", case["name"], "".join(out), description=f"Caso {case['name']} da suíte {case['suite']}")

Nomes internos referenciados: code_language, fence.

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

Renderiza um caso dourado/negativo/aviso com todos os seus arquivos.

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

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

def render_case(self, case: dict) -> None:

Como chamar Renderer.render_case 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_case(self, case: dict) -> None:

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

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

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