Pular para o conteúdo principal

main

Página gerada do fonte

Gerada por tools/gerar_documentacao.py. Definição: tools/gerar_documentacao.py:85.

CLI: gerar, verificar determinismo e opcionalmente falhar em avisos do parser.

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

Assinatura e expansão​

def main(argv: list[str] | None = None) -> int:

Parâmetros formais: argv: list[str] | None.

Como funciona​

CLI: gerar, verificar determinismo e opcionalmente falhar em avisos do parser.

Implementação​

def main(argv: list[str] | None = None) -> int:
"""CLI: gerar, verificar determinismo e opcionalmente falhar em avisos do parser."""
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("--root", type=Path, default=ROOT)
parser.add_argument("--output", type=Path, help="Saída docs; padrão website/docs")
parser.add_argument("--check", action="store_true", help="Não escreve; compara com a saída existente")
parser.add_argument("--strict", action="store_true", help="Falha se o parser reportar sintaxe não reconhecida")
parser.add_argument("--repo-url", default=os.environ.get("DOCS_REPOSITORY_URL", "https://github.com/havaianasdestruido/BASICGOL"))
parser.add_argument("--commit", default=None)
args = parser.parse_args(argv)
root = args.root.resolve()
output = (args.output or root / "website" / "docs").resolve()
static_api = output.parent / "static" / "api"
commit = args.commit or current_commit(root)
try:
if args.check:
with tempfile.TemporaryDirectory(prefix="basicgol-docs-") as tmp:
summary = build(root, Path(tmp) / "docs", args.repo_url, commit)
problems = check_outputs(Path(tmp), output, static_api)
if problems:
print("Documentação desatualizada ou diferente:", file=sys.stderr)
print("\n".join(problems[:40]), file=sys.stderr)
return 1
else:
clean_managed_output(output, static_api)
summary = build(root, output, args.repo_url, commit)
print(json.dumps(summary, ensure_ascii=False, indent=2))
return 1 if args.strict and summary["warnings"] else 0
except (RuntimeError, ValueError, OSError) as exc:
print(f"gerar_documentacao: {exc}", file=sys.stderr)
return 2

Interface BASICGOL relacionada​

BG_INICIO

Nomes internos referenciados: build, check_outputs, clean_managed_output, current_commit.

Como este símbolo aparece nos testes​

9 ocorrência(s) em 9 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/auditar_exemplos.py​

Contexto: auditar_exemplos.py. Linhas: 151. Tipo de evidência: código; via main.

Linhas 149–151 · abrir contexto

if __name__ == '__main__':
sys.exit(main())

Ver no GitHub

tests/documentacao/check_llms_build.py​

Contexto: check_llms_build.py. Linhas: 35. Tipo de evidência: código; via main.

Linhas 33–35 · abrir contexto

if __name__ == '__main__':
main()

Ver no GitHub

tests/documentacao/test_gerador.py​

Contexto: test_gerador.py. Linhas: 160. Tipo de evidência: código; via main.

Linhas 158–160 · abrir contexto

if __name__ == "__main__":
unittest.main()

Ver no GitHub

tests/fuzz_basicgolc.py​

Contexto: fuzz_basicgolc.py. Linhas: 184. Tipo de evidência: código; via main.

Linhas 182–184 · abrir contexto

if __name__ == "__main__":
sys.exit(main())

Ver no GitHub

tests/portabilidade/cpp_inclusao.cpp​

Contexto: cpp_inclusao.cpp. Linhas: 19. Tipo de evidência: código; via main.

Linhas 17–21 · abrir contexto
#include <cstring>

int main()
{
char destino[8] = {0};

Ver no GitHub

tests/run.sh · heredoc na linha 174​

Contexto: C incorporado no runner (linha 174). Linhas: 191. Tipo de evidência: código; via main.

Linhas 189–191 · abrir contexto
#error "nome curto NATURAL_CURTO nao deveria existir"
#endif
int main(void) { return 0; }

Ver no GitHub

tests/run.sh · heredoc na linha 202​

Contexto: C incorporado no runner (linha 202). Linhas: 209. Tipo de evidência: código; via main.

Linhas 207–209 · abrir contexto
#error "SOMA_SEGURA nao deveria existir sem BG_USAR_EXTENSOES"
#endif
int main(void) { return 0; }

Ver no GitHub

tests/test_biblioteca.c​

Contexto: test_biblioteca.c. Linhas: 551. Tipo de evidência: código; via main.

Linhas 549–553 · abrir contexto
}

int main(int argc, char **argv)
{
if (argc == 2 && strcmp(argv[1], "--stdin") == 0) {

Ver no GitHub

tests/test_filesystem.c​

Contexto: test_filesystem.c. Linhas: 16. Tipo de evidência: código; via main.

Linhas 14–18 · abrir contexto
}

int main(void) {
// temp file
char tmp[256];

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.

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

Em uma frase, o que main faz?​

CLI: gerar, verificar determinismo e opcionalmente falhar em avisos do parser.

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

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

def main(argv: list[str] | None = None) -> int:

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

Uso extraído de tests/auditar_exemplos.py:149, com as linhas vizinhas preservadas:


if __name__ == '__main__':
sys.exit(main())

Onde main é exercitado nos testes?​

Há 9 ocorrência(s) em 9 arquivo(s): tests/auditar_exemplos.py, tests/documentacao/check_llms_build.py, tests/documentacao/test_gerador.py, tests/fuzz_basicgolc.py, tests/portabilidade/cpp_inclusao.cpp …. 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.

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

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