Paramètres Django: déclenchez KeyError, augmentez ImproperlyConfigured ou utilisez les valeurs par défaut?

Question

Django s'attend à ce que vous utilisiez des variables d'environnement dans settings.py pour s'adapter à plusieurs environnements (par exemple local, heroku, AWS).

Je suppose que je devrais définir -par exemple- le nom d'utilisateur du DB dans une variable d'environnement DB_USERNAME. Comment dois-je le lire?

import os 
DB_USERNAME = os.environ['DB_USERNAME'] 
DB_USERNAME = os.environ.get('DB_USERNAME') 
DB_USERNAME = os.environ.get('DB_USERNAME', 'john') 

Dois-je capturer l'KeyError et élever moi-même ImproperlyConfigured? Je préfère faire arrêter l'application plutôt que de l'exécuter en utilisant des paramètres incorrects (par défaut, les gens oubliant de définir une variable, etc).

Dans le cas des valeurs par défaut, il peut même arriver que John existe à la fois loaclly et à distance, mais avec des autorisations différentes. Ça n'a pas l'air très robuste.

Answer 1

Je suggérerais une approche différente de ce que vous faites.

J'utilise le processus suivant:

1. Créer un fichier .env ou .ini avec vos variables d'environnement dans ce:

   DB_USERNAME=myDB 
   A_NUMBER=1 
   ALLOWED_HOSTS=localhost, 127.0.0.1, my_host 
   DEBUG=False 
   MY_DJANGO_KEY=no_peeking_this_is_secret 
   

2. Utilisez decouple.config -qui fera votre vie easier- à lire vous .env/.ini fichier:

   sur settings.py:

   from decouple import Csv, config 
   
   DEBUG = config('DEBUG', cast=bool, default=True) 
   A_NUMBER = config('A_NUMBER') # No cast needed! 
   ALLOWED_HOSTS = config('ALLOWED_HOSTS', cast=Csv(), default='') 
   ... 
   

Cela vous permettra d'avoir plusieurs .env ou .ini fichiers pour chacun de vos configurations possibles et vous ne serez pas à vous soucier de mélanger des autorisations etc.

Enfin, je tendre à utiliser les valeurs par défaut avec les plus faibles tolérances possibles (ex. regarde mes hôtes autorisés par défaut qui est une chaîne vide).
Mais s'il existe une variable très importante qui doit être réglé correctement, alors:

• La méthode config() soulèvera un UndefinedValueError si une variable est définie et aucun défaut sont définis.

• On peut donc créer un bloc try:... except: de prévoir que:

  try: 
      SUPER_IMPORTANT_VAR = config('SUPER_IMPORTANT_VAR') 
  except UndefinedValueError: 
      print('Hey!! You forgot to set SUPER_IMPORTANT_VAR!!')