Proton Lib (Python)

Cliente Python da plataforma Proton. A automação usa esta biblioteca para reportar ao Proton o progresso, o status, os logs, os parâmetros e os recursos de cada execução.

Distribuição: protoncloud-sdk. Import: proton.

from proton.proton_automation import start_component, end_component, update_run_status
from proton.run_status import RunStatus

Instalação

pip install protoncloud-sdk

ou, com uv:

uv add protoncloud-sdk

Configuração

Host e token são resolvidos nesta ordem — a mesma convenção das bibliotecas Java do Proton:

1. Variável de ambiente — PROTON_HOST, PROTON_TOKEN
2. proton.ini no diretório de execução

Quando a automação roda pelo Proton Runner, ele injeta PROTON_HOST e PROTON_TOKEN no processo, apontando para o servidor de onde a execução nasceu. É isso que permite o mesmo projeto rodar em qualquer ambiente sem editar arquivo — e sem guardar token no repositório.

O arquivo continua válido e é a única fonte quando se roda a automação fora do runner:

[server]
hostname = https://app.protoncloud.com.br/api
token = <token>

[reports]
video_record = false
video_upload = true

O token pode vir com ou sem o prefixo Bearer ; a biblioteca normaliza e nunca o duplica.

Não versione o proton.ini com o token preenchido: prefira deixá-lo fora do controle de versão e deixar o runner fornecer as credenciais.

Fixando o ambiente do projeto

Para um teste apontado a outro servidor, ou um projeto que precise ignorar o que o runner injeta:

[server]
config_precedence = file

Sem isso, quando o valor injetado difere do arquivo, a biblioteca imprime uma linha dizendo qual venceu. O valor do token nunca é impresso, porque a saída da automação sobe como log da execução no Proton.

Contexto da execução

Fora de uma execução do Proton, is_proton_execution() é False e as chamadas viram no-op — o mesmo teste roda localmente sem falar com o servidor.

Migrando de uma cópia local da pasta proton/

Projetos que carregam esta biblioteca como uma pasta proton/ copiada migram em dois passos:

1. adicione protoncloud-sdk às dependências;
2. apague a pasta proton/ do projeto.

O segundo passo não é opcional: a pasta local tem precedência sobre o pacote instalado, e enquanto ela existir o projeto continua executando a cópia antiga.