📘 Param Manager – Guia Completo de Uso
🟦 Uso Básico
Crie um arquivo main.py:
from param_manager import ParamManager
# Obter a instância do gerenciador
param_manager = ParamManager()
# Recuperar todos os parâmetros de um app
params = param_manager.get_all_params('nome_do_app')
# Recuperar um parâmetro específico
param = param_manager.get_param('nome_do_app', 'nome_parametro')
# Limpar o cache para um app específico
param_manager.clear_cache('nome_do_app')
# Obter informações sobre o cache atual
cache_info = param_manager.get_cache_info()
print(cache_info)
⚙️ Configuração Avançada
from param_manager import ParamManager
param_manager = ParamManager.get_instance(
api_url="http://minha-api.exemplo.com",
cache_duration=1800,
timeout=10,
username="admin",
password="SenhaSegura123",
api_error_cooldown=60,
verify_ssl=True,
)
api_error_cooldown é quanto tempo, em segundos, a biblioteca espera depois de
uma falha da API antes de tentar de novo; sem ele, vale o próprio
cache_duration. verify_ssl liga a verificação de certificado TLS nas
leituras. Todas as opções, com as variáveis de ambiente correspondentes, estão
em Configuração.
🔐 Autenticação Automática com Username e Password
O Param Manager aceita autenticação com username e password.
✔ Diretamente
param_manager = ParamManager.get_instance(
api_url="http://minha-api.exemplo.com",
username="admin",
password="senha123"
)
✔ Via .env
Crie o arquivo:
PARAMS_USERNAME=admin
PARAMS_PASSWORD=MinhaSenhaUltraSegura
Para configurar uma instância específica, prefixe com o nome dela — o valor prefixado tem precedência sobre o global:
FINANCEIRO_PARAMS_USERNAME=admin
FINANCEIRO_PARAMS_PASSWORD=MinhaSenhaUltraSegura
E inicialize:
param_manager = ParamManager.get_instance(
api_url="http://minha-api.exemplo.com"
)
🟩 Criar ou Atualizar Parâmetros (upsert_params)
param_manager.upsert_params(
"financeiro",
"limite_diario",
value=5000,
param_type="int",
description="Limite diário permitido",
user_editable=True,
min_value=0,
max_value=10000,
referenced_params=["limite_global"]
)
🟥 Deletar Parâmetros
param_manager.delete_param("financeiro", "limite_diario")
🟧 Atualizar Apenas um Campo
Use o próprio upsert_params: informe só o que muda. Os campos opcionais que
você não passar (description, user_editable, limites, referenced_params)
não são enviados ao servidor.
O que acontece com eles depende de como o servidor está configurado:
- Com
USER_EDITABLE_ENFORCEMENT=explicit, os metadados já gravados são preservados, e só muda o que foi enviado. - No modo padrão,
legacy, o servidor preenche os campos ausentes com os valores padrão —user_editablevolta aFalse, por exemplo.
Se o valor de um metadado importa, passe-o explicitamente. A configuração do
servidor está descrita em
USER_EDITABLE_ENFORCEMENT,
no site do produto.
param_manager.upsert_params(
"financeiro",
"limite_diario",
value=7500,
param_type="int",
)
🟦 Listar Aplicações
param_manager.list_apps()
# {'apps': [...]}
🧠 Fallback Quando API Está Indisponível
- Tenta acessar a API
- Se falhar, usa dados locais (TinyDB)
- Continua funcionando normalmente
📂 Armazenamento Local
O Param Manager salva o fallback num arquivo por instância:
<base>/param_manager/<instancia>/params_<instancia>.json
Para a instância padrão, isso é
param_manager/default/params_default.json. A <base> vem de
local_db_path, da variável LOCAL_DB_PATH ou do diretório do .env,
nessa ordem.
Se você trabalha sem servidor, veja também o modo local, que usa um segundo arquivo — separado deste — para os parâmetros que você ainda não sincronizou.
📌 Resumo dos Recursos
- Autenticação com usuário e senha ✔
- Renovação automática de token ✔
- Cache com TTL ✔
- Fallback automático ✔
- Upsert completo ✔
- Update granular ✔
- Deleção ✔
- TinyDB ✔