extract_shell
Gerada por tools/gerar_documentacao.py. Definição: tools/documentacao/analise.py:467.
Extrai funções Bash por nome, corpo balanceado e comentário anterior.
Tipo: função Python · Visibilidade: pública · Arquivo: tools/documentacao/analise.py.
Assinatura e expansão
def extract_shell(inv: Inventory, source: Source) -> None:
Parâmetros formais: inv: Inventory, source: Source.
Como funciona
Extrai funções Bash por nome, corpo balanceado e comentário anterior.
Implementação
def extract_shell(inv: Inventory, source: Source) -> None:
"""Extrai funções Bash por nome, corpo balanceado e comentário anterior."""
masked = mask_code(source.text, "shell")
starts = list(re.finditer(r"^([A-Za-z_][A-Za-z_0-9]*)\s*\(\)\s*\{", masked, re.MULTILINE))
for match in starts:
start = match.end() - 1
depth = 0
end = len(masked)
for index in range(start, len(masked)):
if masked[index] == "{":
depth += 1
elif masked[index] == "}":
depth -= 1
if depth == 0:
end = index + 1
break
line = source.text.count("\n", 0, match.start()) + 1
body = source.text[match.start():end]
comment = ""
prior = line - 2
comments = []
while prior >= 0 and source.lines[prior].lstrip().startswith("#"):
comments.append(source.lines[prior])
prior -= 1
comment = clean_comment("\n".join(reversed(comments)))
add_symbol(inv, Symbol(match.group(1), "função Shell", "shell", source.path,
line, source.text.count("\n", 0, end) + 1,
match.group(1) + "()", body, Path(source.path).stem,
comment, [], sorted(set(IDENT.findall(mask_code(body, "shell"))))))
Nomes internos referenciados: add_symbol, clean_comment, mask_code.
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_shell. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.
Em uma frase, o que extract_shell faz?
Extrai funções Bash por nome, corpo balanceado e comentário anterior.
Qual é a assinatura e o tipo de retorno de extract_shell?
Assinatura extraída de tools/documentacao/analise.py; visibilidade pública.
def extract_shell(inv: Inventory, source: Source) -> None:
Como chamar extract_shell 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_shell(inv: Inventory, source: Source) -> None:
Por que não há teste direto para extract_shell?
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_shell depende de compilador, padrão C ou sistema operacional?
extract_shell é 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.