Renderer.case_faq
Gerada por tools/gerar_documentacao.py. Definição: tools/documentacao/render.py:1093.
FAQ de um caso dourado: execução, arquivos e resultado esperado.
Tipo: função Python · Visibilidade: pública · Arquivo: tools/documentacao/render.py.
Assinatura e expansão
def case_faq(self, case: dict) -> str:
Parâmetros formais: self, case: dict.
Como funciona
FAQ de um caso dourado: execução, arquivos e resultado esperado.
Implementação
def case_faq(self, case: dict) -> str:
"""FAQ de um caso dourado: execução, arquivos e resultado esperado."""
expected = next(((name, path) for name, path in sorted(case["files"].items())
if "esperado" in name), None)
expected_text = ""
expected_label = ""
if expected:
expected_label, path = expected
expected_text = (self.inv.root / path).read_text(encoding="utf-8").rstrip()
program = next((path for name, path in sorted(case["files"].items())
if path.endswith(".c")), None)
items = [
{"q": f"Este caso passa ou deve falhar?",
"a": [("O caso é **negativo**: a compilação/tradução precisa falhar com o diagnóstico "
"declarado; um programa que compila não satisfaz o caso.") if case["mode"] == "negativo"
else ("O caso é de **aviso**: o transpilador precisa emitir o código W-xx; aviso não "
"é erro fatal.") if case["mode"] == "aviso"
else ("O caso é de **execução**: compila, roda e o resultado precisa bater com o "
"arquivo dourado.")]},
{"q": "Quais caminhos de compilação são exigidos?",
"a": [f"M0 (macros): **{'sim' if case['m0'] else 'não'}**. "
f"M1 (transpilador): **{'sim' if case['m1'] else 'não'}**. " +
("Marcadores adicionais: " + ", ".join(f"`{m}`" for m in case["markers"]) + "."
if case["markers"] else "")]},
]
if expected_text:
items.append({"q": f"Qual é o resultado dourado (`{expected_label}`)?",
"a": ["Conteúdo literal versionado com o caso:"],
"code": expected_text, "lang": "text"})
if program:
items.append({"q": "Onde está o programa do caso?",
"a": [f"Fonte: `{program}`. O arquivo completo está na seção de arquivos acima."],
"code": f"cc -std=c11 -I include {program} build/libbasicgol.a -lm -o caso\n./caso",
"lang": "bash"})
items.append({"q": "O caso é executado por `make test`?",
"a": [("Sim: o nome da suíte aparece em `tests/run.sh`." if case["runner_registered"]
else "Não: a suíte foi descoberta em disco, mas o nome não aparece em "
"`tests/run.sh`. Sem esse registro o caso é documentado, não executado.")]})
return self.faq(
f"Perguntas frequentes sobre o caso `{case['name']}` da suíte `{case['suite']}`, "
"suas condições e seu resultado esperado.", items)
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.case_faq. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.
Em uma frase, o que Renderer.case_faq faz?
FAQ de um caso dourado: execução, arquivos e resultado esperado.
Qual é a assinatura e o tipo de retorno de Renderer.case_faq?
Assinatura extraída de tools/documentacao/render.py; visibilidade pública.
def case_faq(self, case: dict) -> str:
Como chamar Renderer.case_faq 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 case_faq(self, case: dict) -> str:
Por que não há teste direto para Renderer.case_faq?
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.case_faq depende de compilador, padrão C ou sistema operacional?
Renderer.case_faq é 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.