Pular para o conteúdo principal

protect

Página gerada do fonte

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

Escapa sintaxe MDX acidental em prosa, sem tocar em código Markdown.

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

Assinatura e expansão​

def protect(text: str) -> str:

Parâmetros formais: text: str.

Como funciona​

Escapa sintaxe MDX acidental em prosa, sem tocar em código Markdown.

Implementação​

def protect(text: str) -> str:
"""Escapa sintaxe MDX acidental em prosa, sem tocar em código Markdown."""
parts = re.split(r"(`+[^`]*`+)", text, flags=re.S)
for i, part in enumerate(parts):
if part.startswith("`"):
continue
part = part.replace("{", "{").replace("}", "}")
part = re.sub(r"<(https?://[^>]+|mailto:[^>]+)>", lambda m: f"[{m.group(1)}]({m.group(1)})", part)
part = part.replace("<", "&lt;")
parts[i] = part
return "".join(parts)

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_escrita_mdx_nao_quebra_codigo, test_gerador.py. Linhas: 9, 80. Tipo de evidência: código; via protect.

Linhas 7–11 · 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

Ver no GitHub

Linhas 78–82 · abrir contexto
"""Chaves e ângulos em prosa são escapados; código inline permanece."""
text = "use <basicgol.h> e {x}, mas `SE x { y; }` fica intacto"
escaped = protect(text)
self.assertIn("&lt;basicgol.h>", escaped)
self.assertIn("&#123;x&#125;", escaped)

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.

Nenhum arquivo de teste foi localizado para os chamadores diretos.

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

Em uma frase, o que protect faz?​

Escapa sintaxe MDX acidental em prosa, sem tocar em código Markdown.

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

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

def protect(text: str) -> str:

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

Uso extraído de tests/documentacao/test_gerador.py:7, 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

Onde protect é 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.

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

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