Renderer.slug
Gerada por tools/gerar_documentacao.py. Definição: tools/documentacao/render.py:130.
Gera rota estável por tipo/módulo, reunindo apelidos de macro.
Tipo: função Python · Visibilidade: pública · Arquivo: tools/documentacao/render.py.
Assinatura e expansão
def slug(self, symbol: Symbol) -> str:
Parâmetros formais: self, symbol: Symbol.
Como funciona
Gera rota estável por tipo/módulo, reunindo apelidos de macro.
Implementação
def slug(self, symbol: Symbol) -> str:
"""Gera rota estável por tipo/módulo, reunindo apelidos de macro."""
name = re.sub(r"[^a-zA-Z0-9_-]+", "-", symbol.name).strip("-").lower().lstrip("_") or "simbolo"
if symbol.kind == "macro":
short = next((a for a in symbol.aliases if not a.startswith("BG_")), symbol.name.removeprefix("BG_"))
return f"referencia/linguagem/{self.macro_category(symbol)}/{short.lower().lstrip('_') or 'simbolo'}"
if symbol.kind == "função C":
if symbol.path.startswith(("include/", "src/")):
return f"referencia/funcoes/{symbol.module}/{name}"
if symbol.path.startswith("tools/"):
return f"internos/transpilador/{name}"
return f"internos/c/{Path(symbol.path).with_suffix('').as_posix().replace('/', '-')}/{name}"
area = {"python": "python", "shell": "shell"}.get(symbol.language, "c")
stem = Path(symbol.path).with_suffix("").as_posix().replace("/", "-")
return f"internos/{area}/{stem}/{name.replace('.', '-')}"
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.slug. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.
Em uma frase, o que Renderer.slug faz?
Gera rota estável por tipo/módulo, reunindo apelidos de macro.
Qual é a assinatura e o tipo de retorno de Renderer.slug?
Assinatura extraída de tools/documentacao/render.py; visibilidade pública.
def slug(self, symbol: Symbol) -> str:
Como chamar Renderer.slug 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 slug(self, symbol: Symbol) -> str:
Por que não há teste direto para Renderer.slug?
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.slug depende de compilador, padrão C ou sistema operacional?
Renderer.slug é 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.