Configuração Python YAML com análise de variáveis ​​de ambiente

Carregue um arquivo de configuração YAML e resolva quaisquer variáveis ​​de ambiente

Se você trabalhou com projetos Python, provavelmente já se deparou com diversas maneiras de fornecer configuração. Não vou abordar todos os caminhos aqui, mas alguns deles são:

  • usando arquivos .ini
  • usando uma classe python
  • usando arquivos .env
  • usando arquivos JSON ou XML
  • usando um arquivo yaml

Minha preferência é trabalhar com configuração yaml porque geralmente acho muito prático e fácil de usar e gosto muito que os arquivos yaml também sejam usados, por exemplo, na configuração do docker-compose, então é algo com o qual a maioria está familiarizada.

Para análise de yaml, uso a biblioteca PyYAML Python.

Neste artigo falaremos sobre o caso do arquivo yaml e mais especificamente o que você pode fazer para evitar manter seus segredos, por exemplo, senhas, hosts, nomes de usuários etc, diretamente nele .

Digamos que temos um exemplo muito simples de configuração de arquivo yaml:

database:
 name: database_name
 user: me
 password: very_secret_and_complex
 host: localhost
 port: 5432
ws:
 user: username
 password: very_secret_and_complex_too
 host: localhost

Para que o PyYAML seja capaz de resolver variáveis ​​de ambiente, precisamos de três coisas principais:

  • Um padrão regex para a identificação da variável de ambiente, por exemplopattern = re.compile(‘.*?\${(\w+)}.*?’)
  • Uma tag que significará que há uma variável de ambiente (ou mais) a ser analisada, por exemplo !ENV.
  • E uma função que o carregador usará para resolver as variáveis ​​de ambiente

Exemplo de configuração YAML com variáveis ​​de ambiente:

database:
 name: database_name
 user: !ENV ${DB_USER}
 password: !ENV ${DB_PASS}
 host: !ENV ${DB_HOST}
 port: 5432
ws:
 user: !ENV ${WS_USER}
 password: !ENV ${WS_PASS}
 host: !ENV ‘https://${CURR_ENV}.ws.com.local'

ws:
 user: !ENV ${WS_USER}
 password: !ENV ${WS_PASS}
 host: !ENV 'https://${CURR_ENV}.ws.com.${MODE}'  # multiple env var

Primeiro defina as variáveis ​​de ambiente. Por exemplo, para DB_PASS:

export DB_PASS=very_secret_and_complex

read -s ‘Database password: ‘ db_pass
export DB_PASS=$db_pass
    
      

python use_env_variables_in_config_example.py -c /path/to/yaml

E no seu código, faça coisas com conf, por exemplo, acesse a senha do banco de dados assim:conf['database']['DB_PASS']

Eu espero que isso tenha sido útil. Quaisquer opiniões, dúvidas, correções e sugestões são muito bem-vindas :)

Links Úteis

Suggested posts

Como executar plugins ChatGPT gratuitamente usando Langchain

Como executar plugins ChatGPT gratuitamente usando Langchain

Você deve ter ouvido falar sobre todos os novos plug-ins poderosos do ChatGPT, como navegador, intérprete de código, etc. Mas há um problema, o acesso aos plug-ins é limitado a uma lista de espera e, portanto, muitos não têm acesso a ela.

Meus recursos de codificação mais usados

Meus recursos de codificação mais usados

Esta semana, recebi um e-mail de um membro da lista de e-mails diários. Eles queriam saber: quais recursos você visita diariamente, semanalmente e mensalmente? Ótima pergunta! Fico feliz em tentar compartilhar algumas ideias sobre meu fluxo de trabalho e os principais recursos que uso.

Related posts

Financiando a remoção de carbono no FY24

A divisão das solicitações de apropriações da Carbon180 em todos os caminhos

Financiando a remoção de carbono no FY24

Por Alyson Lee, consultor administrativo de assuntos governamentais O processo de apropriações anuais do governo federal é fundamental para nossos esforços para financiar a remoção de dióxido de carbono (CDR). Todos os anos, a Carbon180 envia solicitações a vários escritórios do Congresso para ajudar a orientar para onde os dólares do próximo ano irão fluir.

VIDA SEM LIMITES

Quando você cresce, tende a ouvir que o mundo é do jeito que é e sua vida é apenas viver sua vida dentro do mundo, nunca arriscando sua vida, apenas siga um caminho definido e morra no final, e tente não bater demais nas paredes. Mas essa é uma vida muito limitada.

Chega de senhas — como as senhas substituirão sua senha

Chega de senhas — como as senhas substituirão sua senha

Para evitar ambigüidade, os seguintes termos serão usados; Autenticador; O celular que está sendo utilizado para fazer o login no Site; O site ou aplicativo que o usuário está usando para fazer a solicitação de login do Serviço; O fornecedor que fornece o serviço fornecido, por exemplo

That Threat Archive: Vol 7 Black Basta

That Threat Archive: Vol 7 Black Basta

No mundo interconectado de hoje, a ameaça de ataques cibernéticos é mais prevalente do que nunca. Criminosos cibernéticos e agentes de estado-nação estão constantemente buscando explorar vulnerabilidades e roubar dados valiosos, representando um risco significativo para organizações de todos os tamanhos.