Pular para o conteúdo principal

check_outputs

Página gerada do fonte

Gerada por tools/gerar_documentacao.py. Definição: tools/gerar_documentacao.py:50.

Compara a saída recém-gerada com os artefatos locais, sem modificá-los.

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

Assinatura e expansão​

def check_outputs(expected: Path, docs: Path, static_api: Path) -> list[str]:

Parâmetros formais: expected: Path, docs: Path, static_api: Path.

Como funciona​

Compara a saída recém-gerada com os artefatos locais, sem modificá-los.

Implementação​

def check_outputs(expected: Path, docs: Path, static_api: Path) -> list[str]:
"""Compara a saída recém-gerada com os artefatos locais, sem modificá-los."""
problems = []
for want, actual in ((expected / "docs", docs), (expected / "static" / "api", static_api)):
a, b = tree_digest(want), tree_digest(actual)
for path in sorted(set(a) | set(b)):
if path not in a:
problems.append(f"obsoleto: {actual / path}")
elif path not in b:
problems.append(f"ausente: {actual / path}")
elif a[path] != b[path]:
problems.append(f"diferente: {actual / path}")
return problems

Nomes internos referenciados: tree_digest.

Como este símbolo aparece nos testes​

3 ocorrência(s) em 1 arquivo(s) de teste. Os links apontam para linhas exatas; os trechos mostram o contexto local. Uma menção não prova que todos os ramos foi executado.

tests/documentacao/test_gerador.py​

Contexto: GeradorTest.test_saida_deterministica_e_check, test_gerador.py. Linhas: 10, 95, 97. Tipo de evidência: código; via check_outputs.

Linhas 8–12 · abrir contexto
from tools.documentacao.analise import collect
from tools.documentacao.render import Renderer, protect
from tools.gerar_documentacao import check_outputs, clean_managed_output, tree_digest

ROOT = Path(__file__).resolve().parents[2]

Ver no GitHub

Linhas 93–99 · abrir contexto
renderer.write(base / folder / "docs")
self.assertEqual(tree_digest(base / "a"), tree_digest(base / "b"))
self.assertEqual(check_outputs(base / "a", base / "b" / "docs", base / "b" / "static" / "api"), [])
(base / "b" / "docs" / "stale.mdx").write_text("stale", encoding="utf-8")
self.assertTrue(any("obsoleto" in p for p in check_outputs(base / "a", base / "b" / "docs", base / "b" / "static" / "api")))

def test_toda_pagina_tem_faq_com_codigo(self) -> None:

Ver no GitHub

Evidência indireta​

Estes símbolos chamam/encaminham para este nome. As referências deles ajudam a rastrear o caminho, mas não substituem um teste específico deste símbolo.

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

Em uma frase, o que check_outputs faz?​

Compara a saída recém-gerada com os artefatos locais, sem modificá-los.

Qual é a assinatura e o tipo de retorno de check_outputs?​

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

def check_outputs(expected: Path, docs: Path, static_api: Path) -> list[str]:

Como check_outputs aparece em código real deste repositório?​

Uso extraído de tests/documentacao/test_gerador.py:8, com as linhas vizinhas preservadas:

from tools.documentacao.analise import collect
from tools.documentacao.render import Renderer, protect
from tools.gerar_documentacao import check_outputs, clean_managed_output, tree_digest

ROOT = Path(__file__).resolve().parents[2]

Onde check_outputs é exercitado nos testes?​

Há 3 ocorrência(s) em 1 arquivo(s): tests/documentacao/test_gerador.py. Os links da seção de evidência apontam para a linha exata; uma menção não prova que todos os ramos foram executados.

check_outputs depende de compilador, padrão C ou sistema operacional?​

check_outputs é 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.