extract_python
Gerada por tools/gerar_documentacao.py. Definição: tools/documentacao/analise.py:412.
Extrai funções/métodos Python com ast, docstrings e chamadas.
Tipo: função Python · Visibilidade: pública · Arquivo: tools/documentacao/analise.py.
Assinatura e expansão
def extract_python(inv: Inventory, source: Source) -> None:
Parâmetros formais: inv: Inventory, source: Source.
Como funciona
Extrai funções/métodos Python com ast, docstrings e chamadas.
Implementação completa · 53 linhas
def extract_python(inv: Inventory, source: Source) -> None:
"""Extrai funções/métodos Python com ast, docstrings e chamadas."""
try:
tree = ast.parse(source.text, filename=source.path)
except SyntaxError as exc:
inv.warnings.append(f"Python inválido em {source.path}: {exc}")
return
lines = source.lines
offsets = [0]
for line in lines:
offsets.append(offsets[-1] + len(line) + 1)
def header_of(child: ast.AST) -> str:
"""Recorta a assinatura até o início do primeiro comando do corpo.
Evita cortar em `:` de anotação ou de valor padrão, que não termina a
assinatura em Python.
"""
body = getattr(child, "body", None) or []
first = body[0] if body else child
start = offsets[child.lineno - 1] + child.col_offset
end = offsets[first.lineno - 1] + first.col_offset
text = source.text[start:end].strip() if end > start else ""
return text or (source.text[start:offsets[child.lineno]].strip().splitlines()[0] + ":")
def visit(node: ast.AST, prefix: str = "") -> None:
"""Visita recursivamente definições Python preservando qualificação de classe/função."""
for child in ast.iter_child_nodes(node):
if isinstance(child, (ast.FunctionDef, ast.AsyncFunctionDef)):
name = prefix + child.name
end = child.end_lineno or child.lineno
body = "\n".join(lines[child.lineno - 1:end])
args = [ast.get_source_segment(source.text, a) or a.arg for a in child.args.posonlyargs + child.args.args]
if child.args.vararg:
args.append("*" + child.args.vararg.arg)
args += [ast.get_source_segment(source.text, a) or a.arg for a in child.args.kwonlyargs]
if child.args.kwarg:
args.append("**" + child.args.kwarg.arg)
signature = header_of(child)
calls = sorted({n.func.id for n in ast.walk(child)
if isinstance(n, ast.Call) and isinstance(n.func, ast.Name)} |
{n.func.attr for n in ast.walk(child)
if isinstance(n, ast.Call) and isinstance(n.func, ast.Attribute)})
add_symbol(inv, Symbol(name, "função Python", "python", source.path,
child.lineno, end, signature, body, Path(source.path).stem,
ast.get_docstring(child) or "", [], calls, args,
visibility="interna" if child.name.startswith("_") else "pública"))
visit(child, name + ".")
elif isinstance(child, ast.ClassDef):
visit(child, prefix + child.name + ".")
else:
visit(child, prefix)
visit(tree)
Nomes internos referenciados: add_symbol, walk.
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.
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.
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 extract_python. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.
Em uma frase, o que extract_python faz?
Extrai funções/métodos Python com ast, docstrings e chamadas.
Qual é a assinatura e o tipo de retorno de extract_python?
Assinatura extraída de tools/documentacao/analise.py; visibilidade pública.
def extract_python(inv: Inventory, source: Source) -> None:
Como chamar extract_python 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 extract_python(inv: Inventory, source: Source) -> None:
Por que não há teste direto para extract_python?
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.
extract_python depende de compilador, padrão C ou sistema operacional?
extract_python é 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.