别再用`import settings`导入django settings了

起因

  • 记得之前刚开始写django项目时,用import settings导入settings,被老大叼了。当时也没怎么想,只是照做了。直到最近参与一个同事写的django项目中,发现了好的地方都是使用这种方式导入settings。这个其中的影响,不能说难受,只能说贼难受。。。为了成功说服他改掉这种写法,那我得先搞懂来不是,所以有了这篇文章。

对比

from django.conf import settings与import settings的区别。前者是从django模版导入settings,是django官方推荐的导入settings的方式,后者是从项目模块中导入settings。

  • "import settings"导入将在 sys.path 中找到的第一个名为 settings.py 的python模块。它只允许访问你定义的设置文件,所以,如果你试图访问一个没有在你的设置文件中指定,django又具备的默认设置( django.conf.global_settings ),你会得到一个错误。
  • django.conf.settings 不是一个文件,而是一个懒加载对象。当你使用 from django.conf import settings时,Django还会做其他检查。

影响

非预期的变量值

场景一

  • 本地开发时,经常需要使用manage.py在终端启动各种命令。指定非settings文件运行(如:settings_local.py),加载的仍然是settings.py中的配置。

    ini 复制代码
    python manage.py runserver --settings=proj.settings_local
    python manage.py migrate --settings=proj.settings_local
    python manage.py collectstatic --settings=proj.settings_local
  • 怎么影响到的

    • settings_local.py中全力引用settings.py的变量,然后对一些变量进行覆盖
lua 复制代码
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'proj.settings_local')

场景二

  • 使用环境变量DJANGO_SETTINGS_MODULE指定settings时

源码分析

  • Django启动的时候,会使用setup方法,源码如下。因此每次启动时会执行" from django.conf import settings"代码,settings中配置加载到内存中。
python 复制代码
# django/__init__.py
def setup(set_prefix=True):
    """
Configure the settings (this happens as a side effect of accessing the
first setting), configure logging and populate the app registry.
Set the thread-local urlresolvers script prefix if `set_prefix` is True.
"""
from django.apps import apps
    from django.conf import settings
    from django.urls import set_script_prefix
    from django.utils.log import configure_logging

    configure_logging(settings.LOGGING_CONFIG, settings.LOGGING)
    if set_prefix:
        set_script_prefix(
            '/' if settings.FORCE_SCRIPT_NAME is None else settings.FORCE_SCRIPT_NAME
        )
    apps.populate(settings.INSTALLED_APPS)
  • 使用wsgi启动时,也是间接调用django的setup方法。
python 复制代码
# django/core/wsgi.py 文件
def get_wsgi_application():
    """
The public interface to Django's WSGI support. Return a WSGI callable.

Avoids making django.core.handlers.WSGIHandler a public API, in case the
internal WSGI implementation changes or moves in the future.
"""
django.setup(set_prefix=False)
    return WSGIHandler()
  • 使用在manage.py在终端启动时,调用的是ManagementUtility对象的execute方法,其中有调用setup()方法
python 复制代码
# django/core/management/__init__.py
def execute_from_command_line(argv=None):
    """Run a ManagementUtility."""
    utility = ManagementUtility(argv)
    utility.execute()

循环引用

  • 如果在settings中引用其他模块时,又以项目文件方式导入settings,可能会导致循环引用。

懒加载

Django的懒加载(lazy loading)机制指的是在需要时才加载某些设置,而不是在应用程序启动时就立即加载所有设置。这种机制有几个重要的意义:

  1. 性能优化: Django的settings.py可能包含大量的配置项,但并不是所有配置项都会在应用程序启动时立即使用。通过懒加载,只有在需要时才加载相应的配置项,可以节省内存和启动时间,提高应用程序的性能。
  2. 如果不设置成懒加载,在顶层导入模块的能力与手动配置设置对象的能力不兼容

因此,如果直接在项目中导入settings文件,则不会具备这样的优点。

总结

这篇文章起源于对Django项目中导入settings方式的疑惑。对比了from django.conf import settingsimport settings的区别,后者从项目模块中导入settings,可能导致非预期的变量值。源码分析表明,Django启动时会使用内置模块加载settings配置,若项目中直接导入settings则无法享受到懒加载带来的性能优势。同时可能导致循环引用问题,非预期的变量值,甚至是报错。

引用

相关推荐
齐 飞1 天前
SpringBoot实现国际化(多语言)配置
java·spring boot·后端
David爱编程1 天前
锁升级机制全解析:偏向锁、轻量级锁、重量级锁的秘密
java·后端
技术小泽1 天前
深度解析Netty架构工作原理
java·后端·性能优化·架构·系统架构
摸鱼仙人~1 天前
Spring Boot 拦截器(Interceptor)与过滤器(Filter)有什么区别?
java·spring boot·后端
华农第一蒟蒻1 天前
Elasticsearch赋能3D打印机任务统计分析
java·大数据·spring boot·后端·elasticsearch·adb·maven
bobz9651 天前
mtu 协商与配置
后端
AAA修煤气灶刘哥1 天前
后端哭晕:超时订单取消踩过的坑,延迟消息这么玩才对!
后端·spring cloud·rabbitmq
金銀銅鐵1 天前
[Java] 验证 HashMap 的扩容时机
java·后端
食亨技术团队1 天前
聚合配送系统对非阻塞并发的实践
后端
零念1 天前
ragflow-疑难杂症-OSError: [Errno 24] Too many open files
后端