Pular para o conteúdo principal

Renderer.render_examples

Página gerada do fonte

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

Publica exemplos versionados e suas saídas douradas.

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

Assinatura e expansão​

def render_examples(self) -> None:

Parâmetros formais: self.

Como funciona​

Publica exemplos versionados e suas saídas douradas.

Implementação​

def render_examples(self) -> None:
"""Publica exemplos versionados e suas saídas douradas."""
self.category("exemplos", "Exemplos executáveis", 50)
body = ["# Exemplos executáveis\n\n", "Fontes de `docs/exemplos`, com saídas douradas quando versionadas. ",
"`make exemplos` compila os exemplos; o bloco `10_exemplos` de `tests/run.sh` confere os resultados.\n\n"]
for example in self.inv.examples:
source = self.inv.sources[example["path"]]
out = [f"# {example['name']}\n\n", f"Fonte: {self.gh_link(example['path'])}.\n\n", fence(source.text, "c"), "\n"]
for name, path in example["files"].items():
if path == example["path"]:
continue
text = (self.inv.root / path).read_text(encoding="utf-8")
out.append(f"## {name}\n\n" + fence(text, code_language(path)) + "\n")
links = [self.link(self.inv.by_name[n][0]) for n in example["symbols"] if len(self.inv.by_name.get(n, [])) == 1]
out.append("## Referência relacionada\n\n" + (", ".join(links) or "Nenhum símbolo inventariado.") + "\n")
out.append(self.example_faq(example, source.text))
self.page(f"exemplos/{example['name']}", example["name"], "".join(out))
body.append(f"- [{example['name']}](/exemplos/{example['name']})\n")
body.append(self.faq(
"Perguntas frequentes sobre os exemplos executáveis e como eles são conferidos.",
[
{"q": "De onde vêm os exemplos?",
"a": [f"De `docs/exemplos/`: **{len(self.inv.examples)} exemplos** com fontes C e, "
"quando aplicável, entradas e saídas douradas versionadas ao lado."]},
{"q": "Como compilar todos de uma vez?",
"a": ["O alvo `make exemplos` usa o mesmo conjunto de flags do restante do projeto."],
"code": "make exemplos", "lang": "bash"},
{"q": "Os exemplos são executados pela CI?",
"a": ["Os que possuem arquivos dourados são executados pelo bloco de exemplos de "
"`tests/run.sh`; comparações normalizam CR para o modo texto do Windows."]},
{"q": "Posso usar um exemplo como base para meu programa?",
"a": ["Sim: eles são programas BASICGOL completos, com `INICIO`/`FIM`. Copie o padrão "
"de declaração de variáveis e leitura, não o conteúdo específico."]},
]))
self.page("exemplos/index", "Exemplos executáveis", "".join(body), label="Visão geral", position=0)

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

Publica exemplos versionados e suas saídas douradas.

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

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

def render_examples(self) -> None:

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

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

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

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