lbxtoolkit 2.2.0__py3-none-any.whl → 2.2.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
lbxtoolkit/__init__.py CHANGED
@@ -1,64 +1,97 @@
1
1
  """
2
- # **Biblioteca de ferramentas LBX S/A**
2
+ # **Caixa de ferramentas de automações de processo (RPA)**
3
3
 
4
- Esta biblioteca possui um ferramentas utilitárias de uso recorrente para aplicações de RPA em python.
4
+ Biblioteca com ferramentas utilitárias e de uso recorrente em aplicações de RPA para automações de processos.
5
+
6
+ Todas as classes e métodos deste módulo possuem **docstrings**.
7
+ Portanto, para ter acesso às informações de uso, use `nome_classe.__doc__`.
8
+ Exemplo:
9
+
10
+ ```python
11
+ from lbxtoolkit import Servicer
12
+ help = Servicer.__doc__
13
+ print(help)
14
+ ```
5
15
 
6
16
  ## **Classe e funções**
7
17
 
8
- Usa o Microsoft Entra ID (antiga Azure AD) para evitar execução não autorizada
9
- auth_EntraID:
10
- disclaimer : Mensagem sobre a necessidade de autenticação
11
- valida_grupo : Autentica o usuário e aborta se checa não pertencer ao grupo de segurança
18
+ **auth_EntraID**
19
+ Usa o Microsoft Entra ID (antiga Azure AD) para evitar execução não autorizada de scripts
20
+ - `disclaimer` : Mensagem sobre a necessidade de autenticação
21
+ - `valida_grupo` : Autentica o usuário e aborta se checa não pertencer ao grupo de segurança
12
22
 
13
-
23
+
14
24
  **postgreSQL**
15
25
  Interage com o banco de dados PostgreSQL
16
- - _.db_: Inicia sessão com o banco
17
- - _.csv_df_: Lê arquivo CSV e gera Dataframe (pandas) a partir dele
18
- - _.db_insert_df_: Insere informações de Dataframe em tabela do banco com estrutura equivalente
19
- - _.db_select_: Retorna um cursor a partir de uma query
20
- - _.db_update_: Executa update em tabelas
26
+ - `db` Inicia sessão com o banco
27
+ - `csv_df` Lê arquivo CSV e gera Dataframe (pandas) a partir dele
28
+ - `db_insert_df` Insere informações de Dataframe em tabela do banco com estrutura equivalente
29
+ - `db_select` Retorna um cursor a partir de uma query
30
+ - `db_update` Executa update em tabelas
21
31
 
22
32
 
23
33
  **api_rest**
24
34
  Interage com APIs RESTfull, especialmente providas para a plataforma Sienge
25
- - _.auth_base_: Autentica (HTTPBasicAuth) sessão na API
26
- - _.auth_bearer_: Autentica sessão na API pelos métodos: OAuth, JWT, Bearer
27
- - _.endpoint_json_: Realizad chama ao endpoint. Payload em formato `json` opcional.
28
- - _.trata_erro_sienge_: Retorna a mensagem de erro do Sienge caso código de retorno seja diferente de 200.
29
- - _.close_: Encerra a sessão autenticada
35
+ - `auth_base` Autentica (HTTPBasicAuth) sessão na API
36
+ - `auth_bearer` Autentica sessão na API pelos métodos: OAuth, JWT, Bearer
37
+ - `endpoint_json` Realizad chama ao endpoint. Payload em formato `json` opcional.
38
+ - `trata_erro_sienge` Retorna a mensagem de erro do Sienge caso código de retorno seja diferente de 200.
39
+ - `close` Encerra a sessão autenticada
30
40
 
31
41
  **lbx_logger**
32
42
  Manipula e formata as mensagens de saída do script para direcioná-las para tela (stdout) e/ou arquivo de log
33
- - _.add_: Adiciona a mensagem a um _buffer_ sem exibir, acumulando até a próxima chamada em algum dos níveis abaixo.
34
- - _.print_: Contorna o manipulador de log e imprime diretamente na tela (stdout), sem formatar a mensagem nem registrar no arquivo
35
- - _.debug, .info, .aviso, .erro, .critico_: Classifica as mensagens por nível de severidade/relevância e rediciona a saída (arquivo, tela, tela+arquivo) conforme a configuração do nível
36
- - _.stop_logging_: Interrompe a manipulação das saídas pelo logger e restaura as saídas padrão (stdout/stderr) para a tela
37
- - _.filtra_: Filtra os eventos do arquivo de log registrados em um intervalo de tempo específico
43
+ - `add` Adiciona a mensagem a um _buffer_ sem exibir, acumulando até a próxima chamada em algum dos níveis abaixo.
44
+ - `print` Contorna o manipulador de log e imprime diretamente na tela (stdout), sem formatar a mensagem nem registrar no arquivo
45
+ - `debug, .info, .aviso, .erro, .critico` Classifica as mensagens por nível de severidade/relevância e rediciona a saída (arquivo, tela, tela+arquivo) conforme a configuração do nível
46
+ - `stop_logging` Interrompe a manipulação das saídas pelo logger e restaura as saídas padrão (stdout/stderr) para a tela
47
+ - `filtra` Filtra os eventos do arquivo de log registrados em um intervalo de tempo específico
48
+
49
+ **SafeLogger**
50
+ Intercepta as ordens de saída comandadas pelos métodos de lbx_logger e interrompe um daemon em execução antes de saír
51
+
52
+ **ConfigManager**
53
+ Permite a inicialização/instanciamento e o consumo de objetos entre classes e métodos independentes, inclusive métodos estáticos (sem instanciamento da classe), garantindo que todas as partes do código usem a mesma instância e, portanto, compartilhem a mesma configuração.
54
+ - `initialize` Inicialização com Argumentos Dinâmicos: O método initialize usa **kwargs para aceitar qualquer número de pares chave-valor, armazenando-os no dicionário da instância.
55
+ - `get` O método get aceita uma chave como argumento e retorna o valor correspondente do dicionário _config.
56
+ - `set` O método set permite adicionar ou atualizar dinamicamente valores no dicionário _config.
57
+ - `reset` O método reset limpa todas as configurações armazenadas, permitindo uma nova inicialização do ConfigManager com novos valores
58
+
59
+ **ServicoWindows**
60
+ Gerencia a instalação e execução de um daemon como um serviço do windows. Também assum o controle dos argumentos recebidos via linha de comando.
61
+ - `SvcInstall` Cria um serviço do windows com base neste script
62
+ - `SvcRemove` Remove o serviço do windows configurado à partir de `SvcInstall`
63
+ - `SvcStop` Para/Interrompe a execução do serviço do windows criado por este script (método herdado da classe pai _win32serviceutil.ServiceFramework_)
64
+ - `SvcDoRun` Inicializa a execução do serviço do windows criado por este script (método herdado da classe pai _win32serviceutil.ServiceFramework_)
65
+
66
+ **Servicer**
67
+ Classe base com a esrtutura padrão para a criação dameons/serviços do windows.
68
+ - `run`, `stop` Usados para iniciar (`run`) e parar (`stop`) a execução do daemon/serviço.
69
+ - `main` deve ser chamada para controlar a sua chamada inicial do script, tratando os argumentos da linha de comando
70
+ - `on_run` é o método que efetivamente executa o propósito do script quando o método pai `run` é executado
71
+ - `args_parser` é o método que define o comportamento do script quando o método `main` é executado (**`argpaser`**)
38
72
 
39
73
  **misc**
40
74
  Classe de miscelâneas/diversos
41
- - _.seleciona_arquivo_: Abre um picker do sistema operacionar para selecionar um *arquivo* e retorna seu path
42
- - _.seleciona_dir_: Abre um picker do sistema operacionar para selecionar um *diretório* e retorna seu path
43
- - _.normaliza_: Limpa caracteres especiais e espaços de strings e retorna tudo em minúsculo
44
- - _.get_cmd_window_: Captura a referencia da janela atual (cmd.exe) para retornar o foco à ela depois de chamar os pickers
45
- - _.maximize_console_: Maxima a janela do console (cmd.exe)
75
+ - `seleciona_arquivo` Abre um picker do sistema operacionar para selecionar um *arquivo* e retorna seu path
76
+ - `seleciona_dir` Abre um picker do sistema operacionar para selecionar um *diretório* e retorna seu path
77
+ - `normaliza` Limpa caracteres especiais e espaços de strings e retorna tudo em minúsculo
78
+ - `get_cmd_window` Captura a referencia da janela atual (cmd.exe) para retornar o foco à ela depois de chamar os pickers
79
+ - `maximize_console` Maxima a janela do console (cmd.exe)
46
80
 
47
81
  ## Instalação e uso:
48
82
 
49
83
  ### Instalação
50
-
51
- ```
84
+ ```bash
52
85
  pip install lbx_toolkit
53
86
  ```
54
87
 
55
88
  ### Uso
56
- ```
57
- from lbx_toolkit import auth_EntraID, PostgreSQL, api_rest, lbx_logger
89
+ ```python
90
+ from lbx_toolkit import auth_EntraID, PostgreSQL, api_rest, lbx_logger, SafeLogger, ServicoWindows, ConfigManager, Servicer
58
91
  ```
59
92
  """
60
93
  import locale
61
- from .lbx_logger import lbx_logger
94
+ from .lbx_logger import lbx_logger, SafeLogger
62
95
  from .config_manager import ConfigManager
63
96
  from .service_windows import ServicoWindows
64
97
  from .service import Servicer
@@ -70,12 +103,13 @@ from .misc import misc
70
103
  locale.setlocale(locale.LC_ALL, 'pt_BR.UTF-8')
71
104
 
72
105
  __all__ = [
73
- "lbx_logger",
74
- "ConfigManager",
75
- "ServicoWindows",
76
- "Servicer",
77
- "auth_EntraID",
78
- "postgreSQL",
79
- "api_rest",
80
- "misc"
106
+ "lbx_logger",
107
+ "SafeLogger",
108
+ "ConfigManager",
109
+ "ServicoWindows",
110
+ "Servicer",
111
+ "auth_EntraID",
112
+ "postgreSQL",
113
+ "api_rest",
114
+ "misc"
81
115
  ]
lbxtoolkit/api_rest.py CHANGED
@@ -7,79 +7,81 @@ from requests.auth import HTTPBasicAuth
7
7
 
8
8
  class api_rest: # Classe para interação com APIs Rest (especialmente Sienge)
9
9
  """
10
- #### Classe **api_rest**
10
+ #### Classe **api_rest**
11
11
 
12
- Destina-se a interatir com APIs RESTfull, em especial as publicadas pela SoftPlan para a [Plataforma Sienge](https://api.sienge.com.br/docs/).
12
+ Destina-se a interatir com APIs RESTfull, em especial as publicadas pela SoftPlan para a [Plataforma Sienge](https://api.sienge.com.br/docs/).
13
13
 
14
- A classe deve ser instanciada conforme sintaxe abaixo:
14
+ A classe deve ser instanciada conforme sintaxe abaixo:
15
15
 
16
- `api_rest(url, credenciais, cadencia, timeout=6, logger=None, headers={"Content-Type": "application/json"}, verify=True)`
16
+ ```python
17
+ api_rest(url, credenciais, cadencia, timeout=6, logger=None, headers={"Content-Type": "application/json"}, verify=True)
18
+ ```
17
19
 
18
- São nessários 2 parâmetros posicionais obrigatórios, e 5 parametros nominais facultativos (valor padrão, se omisso, indicado na sintaxe acima):
19
- - `url`: o endereço da URL de autenticação da API
20
- - `crednciais`: Dicionário com credenciais de autenticação.
21
- - `cadencia` Número máximo de chamadas *por segudo* à API
22
- - `timeout` Tempo máximo (segundos) para aguardar retorno à chamada. Padrão 6s, se omisso.
23
- - `logger` O objeto _log handler_ para lidar com as informações de saída. Se não informado, todas as saídas serão direcionadas para a stdout.
24
- - `headers` Cabeçalhos _http_ para a requisição à API.
25
- - `verify` Verifica a validade do certificado SSL do servidor de destino da requisição.
20
+ São nessários 2 parâmetros posicionais obrigatórios, e 5 parametros nominais facultativos (valor padrão, se omisso, indicado na sintaxe acima):
21
+ - `url`: o endereço da URL de autenticação da API
22
+ - `crednciais`: Dicionário com credenciais de autenticação.
23
+ - `cadencia` Número máximo de chamadas *por segudo* à API
24
+ - `timeout` Tempo máximo (segundos) para aguardar retorno à chamada. Padrão 6s, se omisso.
25
+ - `logger` O objeto _log handler_ para lidar com as informações de saída. Se não informado, todas as saídas serão direcionadas para a stdout.
26
+ - `headers` Cabeçalhos _http_ para a requisição à API.
27
+ - `verify` Verifica a validade do certificado SSL do servidor de destino da requisição.
26
28
 
27
- Quanto às credenciais de autenticação, assim como a classe de interação com o PostgreSQL, elas precisam ser fornecidas na forma de um *dicionário*.
28
- Para o método `api_rest.aut_basic()`, o formato deve ser:
29
- ```
30
- credenciais = {
31
- 'user': 'USUARIO_API',
32
- 'password': 'TOKEN_USUARIO'
33
- }
34
- ```
35
- Caso a autenticação seja pelo método `api_rest.aut_bearer()`, o dicionário deve corresponder ao formato previsto pelo endpoint e seu conteúdo será enviado como um JSON ao endereço indicado no parametro `url`
29
+ Quanto às credenciais de autenticação, assim como a classe de interação com o PostgreSQL, elas precisam ser fornecidas na forma de um *dicionário*.
30
+ Para o método `api_rest.aut_basic()`, o formato deve ser:
31
+ ```python
32
+ credenciais = {
33
+ 'user': 'USUARIO_API',
34
+ 'password': 'TOKEN_USUARIO'
35
+ }
36
+ ```
37
+ Caso a autenticação seja pelo método `api_rest.aut_bearer()`, o dicionário deve corresponder ao formato previsto pelo endpoint e seu conteúdo será enviado como um JSON ao endereço indicado no parametro `url`
36
38
 
37
39
 
38
- A classe possui 3 métodos:
39
- - `api_rest.auth_basic()`: instanciamento da sessão autenticando pelo método HTTPBasicAuth
40
- - `api_rest.auth_bearer()`: instanciamento da sessão autenticando pelos métodos OAuth, JWT, Bearer
41
- - `api_rest.endpoint_json([endereço], [método], payload=None)`: para a chamada ao endpoint
42
- - `close()` para encerra a instância/sessão
40
+ A classe possui 3 métodos:
41
+ - `api_rest.auth_basic()`: instanciamento da sessão autenticando pelo método HTTPBasicAuth
42
+ - `api_rest.auth_bearer()`: instanciamento da sessão autenticando pelos métodos OAuth, JWT, Bearer
43
+ - `api_rest.endpoint_json([endereço], [método], payload=None)`: para a chamada ao endpoint
44
+ - `close()` para encerra a instância/sessão
43
45
 
44
- O consumo é feito pelo método `api_rest.endpoint_json` que suporta apenas APIs cujo payload (opcional) seja aceito no formato JSON.
46
+ O consumo é feito pelo método `api_rest.endpoint_json` que suporta apenas APIs cujo payload (opcional) seja aceito no formato JSON.
45
47
 
46
- Esse método espera 2 parametros posicionais obrigatórios: o endereço do endpoint e o verbo (get, post, patch ou put), tendo parametro opcional o objeto de 'payload' (json).
47
- Note que o endereço do endpoint deve ser informado completo. A URL informada no instanciamento da classe corresponde apenas ao endereço de autenticação.
48
+ Esse método espera 2 parametros posicionais obrigatórios: o endereço do endpoint e o verbo (get, post, patch ou put), tendo parametro opcional o objeto de 'payload' (json).
49
+ Note que o endereço do endpoint deve ser informado completo. A URL informada no instanciamento da classe corresponde apenas ao endereço de autenticação.
48
50
 
49
- O tempo, em segundos, transcorrido entre a chamada a atual e a chamada anterior ao endpoint pode ser consultado pelo argumento `.Intervalo` no objeto recebido do retorno à chamada ao método `.endpoint_json`.
51
+ O tempo, em segundos, transcorrido entre a chamada a atual e a chamada anterior ao endpoint pode ser consultado pelo argumento `.Intervalo` no objeto recebido do retorno à chamada ao método `.endpoint_json`.
50
52
 
51
- Da mesma forma, o tempo de espera imposto para respeitar a cadência do webservcie também pode ser consultado pelo argumento `.Espera`.
53
+ Da mesma forma, o tempo de espera imposto para respeitar a cadência do webservcie também pode ser consultado pelo argumento `.Espera`.
52
54
 
53
- Exemplo de uso:
55
+ Exemplo de uso:
54
56
 
55
- ```
56
- from lbx_toolkit import api_rest
57
+ ```python
58
+ from lbx_toolkit import api_rest
57
59
 
58
- UrlBase=r'https://api.sienge.com.br/lbx/public/api/v1'
59
- Credenciais = {
60
- 'user': 'USUARIO_API',
61
- 'password': 'TOKEN_USUARIO'
62
- }
63
- ApiSienge = api_rest(UrlBase,Credenciais,2.5) # limite de 2 requisições/segundo para cadência de chamada ao endpoint
64
- Auth = ApiSienge.auth_basic()
60
+ UrlBase=r'https://api.sienge.com.br/lbx/public/api/v1'
61
+ Credenciais = {
62
+ 'user': 'USUARIO_API',
63
+ 'password': 'TOKEN_USUARIO'
64
+ }
65
+ ApiSienge = api_rest(UrlBase,Credenciais,2.5) # limite de 2 requisições/segundo para cadência de chamada ao endpoint
66
+ Auth = ApiSienge.auth_basic()
65
67
 
66
- Nutitulo=input('Numero do título:')
67
- Nuparcela=input('Numero da parcela:')
68
- Vencimento=input('Vencimento [AAAA-MM-DD]:')
69
- Payload = {
70
- "dueDate": f"{Vencimento}"
71
- }
72
- EndPoint = f'{UrlBase}/bills/{Nutitulo}/installments/{Nuparcela}'
68
+ Nutitulo=input('Numero do título:')
69
+ Nuparcela=input('Numero da parcela:')
70
+ Vencimento=input('Vencimento [AAAA-MM-DD]:')
71
+ Payload = {
72
+ "dueDate": f"{Vencimento}"
73
+ }
74
+ EndPoint = f'{UrlBase}/bills/{Nutitulo}/installments/{Nuparcela}'
73
75
 
74
- #chama o endpoint e recebe o retorno no objeto AlteraVcto
75
- AlteraVcto = ApiSienge.endpoint_json(EndPoint, 'patch', Payload)
76
- ```
76
+ #chama o endpoint e recebe o retorno no objeto AlteraVcto
77
+ AlteraVcto = ApiSienge.endpoint_json(EndPoint, 'patch', Payload)
78
+ ```
77
79
 
78
- No exemplo acima não é esperado que o endpoint retorne nenhum dado (`patch`).
80
+ No exemplo acima não é esperado que o endpoint retorne nenhum dado (`patch`).
79
81
 
80
- Quando se usa o verbo `get` e se espera o retorno de algum dado, use o método `.json` do pacote `request` para acessar o objeto recebido.
82
+ Quando se usa o verbo `get` e se espera o retorno de algum dado, use o método `.json` do pacote `request` para acessar o objeto recebido.
81
83
 
82
- Para uso em APIs com autenticação JWT (JSON Web Token), OAuth, Bearer Token Authentication, a construção é a mesma indicada acima, bastando-se usar `.auth_bearer()` ao invés de _.auth_basic()_, e ajustar o dicionário `credenciais` informado no instanciamento da classe, que deve ser estruturado conforme o padrão fornecido peo mantendor da API e será enviado como payload ao endpoint (`json=credenciais`).
84
+ Para uso em APIs com autenticação JWT (JSON Web Token), OAuth, Bearer Token Authentication, a construção é a mesma indicada acima, bastando-se usar `.auth_bearer()` ao invés de _.auth_basic()_, e ajustar o dicionário `credenciais` informado no instanciamento da classe, que deve ser estruturado conforme o padrão fornecido peo mantendor da API e será enviado como payload ao endpoint (`json=credenciais`).
83
85
 
84
86
  """
85
87
  def __init__(self, url, credenciais, cadencia=3, timeout=6, logger=None, headers={"Content-Type": "application/json"}, verify=True):
@@ -14,43 +14,42 @@ from webdriver_manager.chrome import ChromeDriverManager
14
14
 
15
15
  class auth_EntraID: # Classe de autenticação de usuários no Microsoft Entra ID (antiga Azure AD)
16
16
  """
17
- #### Classe **auth_EntraID**
17
+ #### Classe **auth_EntraID**
18
18
 
19
- Este recurso tem o propósito de controlar as permissões de execução do script usando as credencias do ambiente AD em nuvem da Microsoft (Azure AD >> Microsoft Entra ID), abortando se a autentição falhar ou o usuário não pertencer ao grupo.
19
+ Este recurso tem o propósito de controlar as permissões de execução do script usando as credencias do ambiente AD em nuvem da Microsoft (Azure AD Microsoft Entra ID), abortando se a autentição falhar ou o usuário não pertencer ao grupo.
20
20
 
21
- Essa classe possui apenas dois métodos:
21
+ Essa classe possui apenas dois métodos:
22
22
 
23
23
  - `auth_EntraID.disclaimer()`: apenas exibe uma tela de informações/instruções ao usuário.
24
-
25
24
  - `auth_EntraID.valida_grupo([client_id], [client_secret], [tenant_id], timeout=60, log_file='auth_EntraID.log')`: efetua a autenticação do usuário e verifica se ele pertence ao grupo informado, abortando a execução caso não pertença ao grupo ou a autenticação não seja validada no tempo estabelecido. Os argumentos `timeout` e `log_file` são opcionais e, se omitidos, os valores aqui atribuídos serão adotados como padrão.
26
25
 
27
- É necessário obter parametros da plataforma de identidade da Microsoft (AD Azure, agora Microsoft Entra ID), no [*Centro de administração do Microsoft Entra*](https://entra.microsoft.com).
28
- Sugerimos não armazenar estas ou outras informações sensíveis no script. Considere usar o pacote `dotenv` para isso.
26
+ É necessário obter parametros da plataforma de identidade da Microsoft (AD Azure, agora Microsoft Entra ID), no [*Centro de administração do Microsoft Entra*](https://entra.microsoft.com).
27
+ Sugerimos não armazenar estas ou outras informações sensíveis no script. Considere usar o pacote `dotenv` para isso.
29
28
 
30
- Os argumentos obrigatórios (posicionais) são:
29
+ Os argumentos obrigatórios (posicionais) são:
31
30
 
32
- 1) `tenant_id` corresponde ao campo *ID do Locatário*, que pode ser obtido na página [visão geral de identidade do domínio](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/TenantOverview.ReactView)
31
+ 1. `tenant_id` corresponde ao campo *ID do Locatário*, que pode ser obtido na página [visão geral de identidade do domínio](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/TenantOverview.ReactView)
33
32
 
34
- 2) `client_id` corresponde ao *ID do aplicativo (cliente)*, obtido na secção [_Identidade > Aplicativos > Registros de Aplicativo_](https://entra.microsoft.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade/quickStartType~/null/sourceType/Microsoft_AAD_IAM). Considere não reaproveitar aplicativos e criar um específico para essa finalidade.
33
+ 2. `client_id` corresponde ao *ID do aplicativo (cliente)*, obtido na secção [_Identidade Aplicativos Registros de Aplicativo_](https://entra.microsoft.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade/quickStartType~/null/sourceType/Microsoft_AAD_IAM). Considere não reaproveitar aplicativos e criar um específico para essa finalidade.
35
34
 
36
- 3) `secret_id` corresponde ao *Valor* do _ID secreto_ (não ao próprio ID Secreto) do aplicativo. Este token não é passivel de consulta após gerado e para obtê-lo, é necessário criar um novo segredo para o aplicativo na subsecção _"Certificados e Segredos"_, após clicar no nome do aplicativo exibo na indicada no item (2). O token (_Valor do segredo_) deve ser copiado e anotado no ato da criação, pois *não é possível consultá-lo posteriormente*.
35
+ 3. `secret_id` corresponde ao *Valor* do _ID secreto_ (não ao próprio ID Secreto) do aplicativo. Este token não é passivel de consulta após gerado e para obtê-lo, é necessário criar um novo segredo para o aplicativo na subsecção _"Certificados e Segredos"_, após clicar no nome do aplicativo exibo na indicada no item (2). O token (_Valor do segredo_) deve ser copiado e anotado no ato da criação, pois *não é possível consultá-lo posteriormente*.
37
36
 
38
37
 
39
- ```
40
- from lbx_toolkit import auth_EntraID
38
+ ```python
39
+ from lbx_toolkit import auth_EntraID
41
40
 
42
- client_id = 'SEU_CLIENT_ID'
43
- client_secret = 'SEU_CLIENT_SECRET'
44
- tenant_id = 'SEU_TENANT_ID'
41
+ client_id = 'SEU_CLIENT_ID'
42
+ client_secret = 'SEU_CLIENT_SECRET'
43
+ tenant_id = 'SEU_TENANT_ID'
45
44
 
46
- # inicializa instância
47
- auth = auth_EntraID(client_id, client_secret, tenant_id, timeout=60, log_file='auth_EntraID.log')
45
+ # inicializa instância
46
+ auth = auth_EntraID(client_id, client_secret, tenant_id, timeout=60, log_file='auth_EntraID.log')
48
47
 
49
- # exibe a mensagem padrão de aviso
50
- auth.disclaimer()
48
+ # exibe a mensagem padrão de aviso
49
+ auth.disclaimer()
51
50
 
52
- auth.valida_grupo('Nome do Grupo de Distribuição')
53
- # se usuário não pertencer a grupo informado, a execução do script é abortada.
51
+ auth.valida_grupo('Nome do Grupo de Distribuição')
52
+ # se usuário não pertencer a grupo informado, a execução do script é abortada.
54
53
  ```
55
54
  """
56
55
  def __init__(self, client_id, client_secret, tenant_id, grupo, timeout=60, log_file='auth_EntraID.log'):
@@ -1,11 +1,13 @@
1
1
  class ConfigManager: # Inicializa e recupera variáveis em ambiente de intercâmbio entre classes
2
2
  """
3
- Como Funciona
4
- Singleton Pattern: ConfigManager é um singleton que garante que todas as partes do código usem a mesma instância e, portanto, compartilhem a mesma configuração.
5
- Inicialização com Argumentos Dinâmicos: O método initialize usa **kwargs para aceitar qualquer número de pares chave-valor, armazenando-os no dicionário _config da instância.
6
- Método Genérico get: O método get aceita uma chave como argumento e retorna o valor correspondente do dicionário _config.
7
- Método set: O método set permite adicionar ou atualizar dinamicamente valores no dicionário _config.
8
- Método reset: O método reset limpa todas as configurações armazenadas, permitindo uma nova inicialização do ConfigManager com novos valores
3
+ #### Classe **auth_EntraID**
4
+
5
+ É um singleton que garante que todas as partes do código usem a mesma instância e, portanto, compartilhem a mesma configuração.
6
+
7
+ - `initialize(chave1=valor1, ..., chaveN=valorN)` : O método initialize usa **kwargs para aceitar qualquer número de pares chave-valor, armazenando-os no dicionário _config da instância.
8
+ - `get('chave')`: O método get aceita uma chave como argumento e retorna o valor correspondente do dicionário _config.
9
+ - `set('chave', valor)`: O método set permite adicionar ou atualizar dinamicamente valores no dicionário _config.
10
+ - `reset`: O método reset limpa todas as configurações armazenadas, permitindo uma nova inicialização do ConfigManager com novos valores
9
11
  """
10
12
  _instance = None
11
13
  def __new__(cls):