clean_managed_output
Gerada por tools/gerar_documentacao.py. Definição: tools/gerar_documentacao.py:65.
Remove apenas a árvore marcada como gerada e os dois JSON conhecidos.
Tipo: função Python · Visibilidade: pública · Arquivo: tools/gerar_documentacao.py.
Assinatura e expansão
def clean_managed_output(docs: Path, static_api: Path) -> None:
Parâmetros formais: docs: Path, static_api: Path.
Como funciona
Remove apenas a árvore marcada como gerada e os dois JSON conhecidos.
Implementação
def clean_managed_output(docs: Path, static_api: Path) -> None:
"""Remove apenas a árvore marcada como gerada e os dois JSON conhecidos."""
if docs.exists():
if not (docs / ".documentacao-gerada").exists():
raise RuntimeError(f"Recusando apagar diretório não gerenciado: {docs}")
shutil.rmtree(docs)
for name in ("inventario.json", "cobertura.json"):
path = static_api / name
if path.exists():
path.unlink()
Como este símbolo aparece nos testes
2 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_nao_apaga_saida_nao_gerenciada, test_gerador.py. Linhas: 10, 133. Tipo de evidência: código; via clean_managed_output.
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]
Linhas 131–135 · abrir contexto
(docs / "manual.md").write_text("não apagar", encoding="utf-8")
with self.assertRaises(RuntimeError):
clean_managed_output(docs, Path(tmp) / "api")
self.assertTrue((docs / "manual.md").exists())
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.
main→ tests/auditar_exemplos.py, tests/documentacao/check_llms_build.py, tests/documentacao/test_gerador.py, tests/fuzz_basicgolc.py, tests/portabilidade/cpp_inclusao.cpp …
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 clean_managed_output. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.
Em uma frase, o que clean_managed_output faz?
Remove apenas a árvore marcada como gerada e os dois JSON conhecidos.
Qual é a assinatura e o tipo de retorno de clean_managed_output?
Assinatura extraída de tools/gerar_documentacao.py; visibilidade pública.
def clean_managed_output(docs: Path, static_api: Path) -> None:
Como clean_managed_output 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 clean_managed_output é exercitado nos testes?
Há 2 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.
clean_managed_output depende de compilador, padrão C ou sistema operacional?
clean_managed_output é 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.