Módulo `satcfe.alertas`¶

class satcfe.alertas.AlertaCFePendentes(resposta)¶

Checa a existência de documentos CF-e-SAT pendentes no equipamento SAT, aguardando serem enviados à SEFAZ. Este alerta estará ativo se houver ao menos um documento CF-e-SAT pendente de transmissão no equipamento SAT.

checar()¶

Efetivamente checa se o alerta deve ou não ser ativado em função dos dados da resposta e de outras condições. As classes de alertas devem sobrescrever este método.

Tipo de retorno:
Retorna:	Retorna `True` se o resultado da checagem indicar que este alerta está ativo (o mesmo que `ativo`).
	bool

mensagem()¶

Retorna uma mensagem amigável ao usuário, descrevendo da melhor forma possível a condição do alerta. As classes de alertas devem sobrescrever este método.

Tipo de retorno:
	unicode

pendentes¶

Retorna o número de cupons pendentes de transmissão para a SEFAZ.

Tipo de retorno:
	int

class satcfe.alertas.AlertaDivergenciaHorarios(resposta)¶

Checa o horário do equipamento SAT em relação ao horário atual, emitindo um alerta caso exista uma divergência entre os horáros superior a 3600 segundos (1 hora). Para alterar o limite de tolerância que ativará este alerta, modifique o atributo tolerancia_em_segundos.

Nota

O limite de tolerância para este alerta, de uma hora, é uma herança do Requisito XVII do PAF-ECF, Sincronismo entre data e hora do registro com data e hora do Cupom Fiscal, embora SAT-CF-e não tenha qualquer relação com o PAF-ECF.

checar()¶

Efetivamente checa se o alerta deve ou não ser ativado em função dos dados da resposta e de outras condições. As classes de alertas devem sobrescrever este método.

Tipo de retorno:
Retorna:	Retorna `True` se o resultado da checagem indicar que este alerta está ativo (o mesmo que `ativo`).
	bool

divergencia¶

Divergência em segundos entre o horário local (do computador) e o horário do equipamento SAT, segundo a resposta de consulta ao status operacional. Precisão de microsegundos é desprezada.

Uma divergência negativa indica que o horário local (do computador) está atrasado em relação ao relógio do equipamento SAT. Para saber se a divergência de horarários ultrapassou o limite de tolerância, consulte o atributo ativo.

Tipo de retorno:
	int

mensagem()¶

Retorna uma mensagem amigável ao usuário, descrevendo da melhor forma possível a condição do alerta. As classes de alertas devem sobrescrever este método.

Tipo de retorno:
	unicode

tolerancia_em_segundos = 3600¶: Limite de tolerância, em segundos, para ativar o alerta.

class satcfe.alertas.AlertaOperacao(resposta)¶

Classe base para os alertas de operação.

ativo¶: Indica se o alerta está ou não ativo.

checar()¶

Efetivamente checa se o alerta deve ou não ser ativado em função dos dados da resposta e de outras condições. As classes de alertas devem sobrescrever este método.

Tipo de retorno:
Retorna:	Retorna `True` se o resultado da checagem indicar que este alerta está ativo (o mesmo que `ativo`).
	bool

mensagem()¶

Retorna uma mensagem amigável ao usuário, descrevendo da melhor forma possível a condição do alerta. As classes de alertas devem sobrescrever este método.

Tipo de retorno:
	unicode

class satcfe.alertas.AlertaVencimentoCertificado(resposta)¶

Checa a data de vencimento do certificado instalado, ativando o alerta caso o vencimento esteja próximo. Para alterar o limite de proximidade do vencimento que ativa este alerta, modifique o atributo vencimento_em_dias, cujo padrão é de 60 dias.

checar()¶

Efetivamente checa se o alerta deve ou não ser ativado em função dos dados da resposta e de outras condições. As classes de alertas devem sobrescrever este método.

Tipo de retorno:
Retorna:	Retorna `True` se o resultado da checagem indicar que este alerta está ativo (o mesmo que `ativo`).
	bool

dias_para_vencimento¶

O número de dias que restam até o vencimento do certificado instalado. Se o certificado já estiver vencido, retornará zero.

Tipo de retorno:
	int

mensagem()¶

Retorna uma mensagem amigável ao usuário, descrevendo da melhor forma possível a condição do alerta. As classes de alertas devem sobrescrever este método.

Tipo de retorno:
	unicode

vencido¶

Indica se o certificado instalado no equipamento está vencido.

Tipo de retorno:
	bool

vencimento_em_dias = 60¶: Determina o número de dias até o vencimento do certificado que irá ativar o alarte.

satcfe.alertas.checar(cliente_sat)¶

Checa em sequência os alertas registrados (veja registrar()) contra os dados da consulta ao status operacional do equipamento SAT. Este método irá então resultar em uma lista dos alertas ativos.

Tipo de retorno:
Parâmetros:	cliente_sat – Uma instância de `satcfe.clientelocal.ClienteSATLocal` ou `satcfe.clientesathub.ClienteSATHub` onde será invocado o método para consulta ao status operacional do equipamento SAT.
	list

satcfe.alertas.registrar(classe_alerta)¶: Registra uma classe de alerta (subclasse de AlertaOperacao). Para mais detalhes, veja checar().

Módulo satcfe.alertas¶

Módulo `satcfe.alertas`¶