django核心异常.ImproperlyConfigured: 设置SECRET_KEY环境变量

Question

在我使用environ将SECRET_KEY和DEBUG设置为环境变量之前，这个项目是正常工作的。但是在那之后，我遇到了以下错误：

输出结果如下：

(env) E:\ecommercedj>python manage.py runserver
Traceback (most recent call last):
  File "E:\ecommercedj\env\lib\site-packages\environ\environ.py", line 273, in get_value
    value = self.ENVIRON[var]
  File "c:\users\matruchhaya\appdata\local\programs\python\python38-32\lib\os.py", line 675, in __getitem__
    raise KeyError(key) from None
KeyError: 'SECRET_KEY'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "manage.py", line 21, in <module>
    main()
  File "manage.py", line 17, in main
    execute_from_command_line(sys.argv)
  File "E:\ecommercedj\env\lib\site-packages\django\core\management\__init__.py", line 401, in execute_from_command_line
    utility.execute()
  File "E:\ecommercedj\env\lib\site-packages\django\core\management\__init__.py", line 395, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "E:\ecommercedj\env\lib\site-packages\django\core\management\base.py", line 328, in run_from_argv
    self.execute(*args, **cmd_options)
  File "E:\ecommercedj\env\lib\site-packages\django\core\management\commands\runserver.py", line 60, in execute
    super().execute(*args, **options)
  File "E:\ecommercedj\env\lib\site-packages\django\core\management\base.py", line 369, in execute
    output = self.handle(*args, **options)
  File "E:\ecommercedj\env\lib\site-packages\django\core\management\commands\runserver.py", line 67, in handle
    if not settings.DEBUG and not settings.ALLOWED_HOSTS:
  File "E:\ecommercedj\env\lib\site-packages\django\conf\__init__.py", line 76, in __getattr__
    self._setup(name)
  File "E:\ecommercedj\env\lib\site-packages\django\conf\__init__.py", line 63, in _setup
    self._wrapped = Settings(settings_module)
  File "E:\ecommercedj\env\lib\site-packages\django\conf\__init__.py", line 142, in __init__
    mod = importlib.import_module(self.SETTINGS_MODULE)
  File "c:\users\matruchhaya\appdata\local\programs\python\python38-32\lib\importlib\__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
  File "<frozen importlib._bootstrap>", line 991, in _find_and_load
  File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 671, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 783, in exec_module
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "E:\ecommercedj\ecom\settings.py", line 11, in <module>
    SECRET_KEY = env('SECRET_KEY')
  File "E:\ecommercedj\env\lib\site-packages\environ\environ.py", line 123, in __call__
    return self.get_value(var, cast=cast, default=default, parse_default=parse_default)
  File "E:\ecommercedj\env\lib\site-packages\environ\environ.py", line 277, in get_value
    raise ImproperlyConfigured(error_msg)
django.core.exceptions.ImproperlyConfigured: Set the SECRET_KEY environment variable

(env) E:\ecommercedj>

设置.py

import os
import environ

env = environ.Env()

# read th .env file
environ.Env.read_env()

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

SECRET_KEY = env('SECRET_KEY')

DEBUG = env('DEBUG')

ALLOWED_HOSTS = ['*']
.....

.env文件

SECRET_KEY的值未使用引号

SECRET_KEY = my_secret_key_value
DEBUG = True

在添加environ之前，该项目运行良好。是否由于environ引起了错误？应该如何消除这个错误？

- Aman Sharma

---

将 SECRET_KEY = "my_secret_key_value" 放入 .env 文件中并加上引号。 - Kishan Parmar

你使用哪个库来处理环境变量？ - Danizavtz

我已经尝试将 "my_secret_key_value" 用引号括起来，但仍然不起作用。我正在使用 ENVIRON 处理环境变量。 - Aman Sharma

如果您正在使用 docker container，则必须进行额外的设置。 - stanimirsp

Answer 1

.env文件应该与settings.py文件在同一个目录下。

- nxoo

---

这个问题已经解决了，与文件位置无关。 - Kemp

将文件移至与settings.py在同一级别后，问题已被解决。 - Shedrack

Answer 2

解决了！！

在 .env 文件中删除赋值运算符和变量之间，以及值和赋值运算符之间的空格。

例如：

SECRET_KEY=my_secret_key_value
DEBUG=True

- Aman Sharma

Answer 3

首先，按照以下方式安装Django-environ

pip install django-environ

接下来，在您的settings.py中像这样导入environs：

import environs

import os
import environ
from pathlib import Path
from django.core.exceptions import ImproperlyConfigured

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent

# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
env = environ.Env()
environ.Env.read_env()


def get_env_variable(var_name):
try:
    return os.environ[var_name]
except KeyError:
    error_msg = "set the %s environment variable" % var_name
    raise ImproperlyConfigured(error_msg)


SECRET_KEY = get_env_variable('SECRET_KEY')

这是一个普通的Django设置文件，您所做的是从异常中导入os、environ、ImproperlyConfigured，编写函数get_env_variable并对SECRET_KEY调用它。

接下来，在与您的settings.py文件相同的目录中创建一个.env文件，并填写以下内容：

SECRET_KEY=django-insecure-b)8xiyg09+9)e4ko!o_*%5am=5(%=-%uvo5g*618619)8xcwfa

请将密钥字符串替换为您自己的。 您可以参考这篇文章

- SanRaph

Answer 4

1. First Create .env file in the same directory as the settings

2. Second, remove any space between variable and key-value (i.e KEY=my_key)

   import environ
   
   env = environ.Env()
   environ.Env.read_env(os.path.join(BASE_DIR, 'somepath/.env')) #<-- where ever your .env lies inside project directory
   SECRET_KEY = os.environ.get('somekeyInsidenvFile',env('somekeyInsidenvFile')) #
   

- Atif Shafi

Answer 5

实际上有一个简单的解决方案。

settings.py

import os
import environ

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

env = environ.Env()

# read th .env file
environ.Env.read_env(env_file=str(BASE_DIR) + '/.env')    

SECRET_KEY = env('SECRET_KEY')

DEBUG = env('DEBUG')

ALLOWED_HOSTS = ['*']
.....

.env 文件

SECRET_KEY=secret_key_value
DEBUG=True

最后，在.env文件中不要在等号前后使用空格。

- fatihatagunn

Answer 6

清除.env文件中的空格！！

在.env文件中，删除赋值运算符和变量之间以及值和赋值运算符之间的空格。例如：

DJANGO_SECRET_KEY="NDCNSDIWBDVIBDVUOWDVJ30F9342FE20F9JCME"
DEBUG="True"

- Michael Assanama

Answer 7

我也遇到了同样的错误。我的问题是由于 .env 文件的位置引起的。

我的文件结构如下：

BASEDIRECTORY
  Django-Project
    myapp1
    myapp2
    myInitializedProjectApp
      settings.py
      wsgi.py
      ...
  .env
  .gitignore
  Dockerfile
  ...

所以我的env应用程序与我的Django项目文件夹处于同一级别

在我的settings.py中，在声明BASE_DIR之后，我包括： env.read_env('../.env')

我想这基本上是将文件夹从BASE_DIR向上发送到需要读取的.env文件的位置。

- imbes

Answer 8

如果您的SECRET_KEY以$（美元符号）开头，则会遇到与OP相同的异常，这是django-environ包中已知的bug。

在这种情况下，只需生成新的SECRET_KEY：

from django.core.management.utils import get_random_secret_key
print(get_random_secret_key())

- Aron

Answer 9

对我来说，将SECRET_KEY=my_secret_key_value之间没有空格解决了这个问题！

- Elena

Answer 10

在某些情况下，您可能希望根据环境变量在设置中设置变量，如果没有设置环境变量，则使用一些默认值。

提供一个默认选项以避免配置不正确的异常。

SECRET_KEY = env('SECRET_KEY', default="asdfasdfasdfasdf")

DEBUG = env('DEBUG', default=False)

- Sagar Devkota