Pular para o conteúdo principal

Renderer.import_markdown

Página gerada do fonte

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

Importa documento original ajustando título, links e sintaxe MDX.

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

Assinatura e expansão​

def import_markdown(self, source_path: Path, target: str, title: str | None = None,
document_key: str | None = None) -> None:

Parâmetros formais: self, source_path: Path, target: str, title: str | None, document_key: str | None.

Como funciona​

Importa documento original ajustando título, links e sintaxe MDX.

Implementação​

def import_markdown(self, source_path: Path, target: str, title: str | None = None,
document_key: str | None = None) -> None:
"""Importa documento original ajustando título, links e sintaxe MDX."""
text = source_path.read_text(encoding="utf-8")
match = re.match(r"#\s+(.+)\n", text)
heading = match.group(1).strip() if match else source_path.stem
if match:
text = text[match.end():].lstrip()
text = self.rewrite_links(text, source_path.parent)
text = self.escape_mdx(text)
position = int(match.group(1)) if (match := re.match(r"(\d+)-", source_path.stem)) else None
text += self.document_extra(document_key or source_path.stem, text)
self.page(target, title or heading, text, description=heading, position=position)

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

Em uma frase, o que Renderer.import_markdown faz?​

Importa documento original ajustando título, links e sintaxe MDX.

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

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

def import_markdown(self, source_path: Path, target: str, title: str | None = None,
document_key: str | None = None) -> None:

Como chamar Renderer.import_markdown 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 import_markdown(self, source_path: Path, target: str, title: str | None = None,
document_key: str | None = None) -> None:

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

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

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