【Django】使配置文件更易理解、更易找到

首先,在开发和实施Django时,有时不可避地会有很多应用程序。在这种项目结构下,寻找配置文件可能有点麻烦,只需要记住目录名称,因为它们是按字母顺序排列的,所以只要搜索就能找到。但是,因为我本身就不喜欢”寻找工作”,所以即使是这样,我也觉得有点麻烦…
因此,通过将此设置目录保持在”绝对顶部”的状态,可以省去搜索的麻烦。这是一个非常简单的解决方案,所以大家也请一定要尝试使用。

将设置目录的名称设置为”_config”,可以使该目录显示在最上方。

.
├── _config # プロジェクトの一番上に設定ディレクトリ
├── app1
├── app2
└── app3

实施步骤

对于那些打算将本文中的内容真正应用到他们自己的Django项目中的人,我们也提供了实现步骤。

前提 – Condition/assumption

假设Python3和Django已经安装好了。版本可以任意选择,但我是在以下环境中进行实现的。

Python版本为3.8.5,Django版本为3.2.8。

如果从一开始开发Django项目的话

$ mkdir <projectName>
$ cd <projectName>
$ django-admin startproject _config .

如果要将其应用于正在开发中的Django项目中

如果已经有一个开发中的Django项目,那么需要将原始的配置目录名(假设为“settingDirName”)改为“_config”。

.
└── <settingDirName> → _config
- os.environ.setdefault('DJANGO_SETTINGS_MODULE', '<settingDirName>.settings')
+ os.environ.setdefault('DJANGO_SETTINGS_MODULE', '_config.settings')
- ROOT_URLCONF = '<settingDirName>.urls'
+ ROOT_URLCONF = '_config.urls'
- WSGI_APPLICATION = '<settingDirName>.wsgi.application'
+ WSGI_APPLICATION = '_config.wsgi.application'

如果你使用WSGI·ASGI来配置,那么就需要进行设置更改,但如果不是的话,应该不需要进行任何更改。

- os.environ.setdefault('DJANGO_SETTINGS_MODULE', '<settingDirName>.settings')
+ os.environ.setdefault('DJANGO_SETTINGS_MODULE', '_config.settings')
- os.environ.setdefault('DJANGO_SETTINGS_MODULE', '<settingDirName>.settings')
+ os.environ.setdefault('DJANGO_SETTINGS_MODULE', '_config.settings')

这篇文章的想法是由我实验室的后辈教给我的,但我觉得能用一些简单的方法来完成的感觉非常好。正如我在开头所说的,在进行Django项目开发时,有时会变得杂乱无章,所以我希望能借鉴其他人的文章中提到的最佳实践方法。

※期待您的意見、疑問或其他問題!

我写了一篇应用这篇文章内容提出Django项目结构建议的文章。请务必一并查看!

将【Django】项目结构分为「设置」「用户管理」「应用程序」三个部分。

使用Django时的最佳做法,是通过Qiita的文章来清晰地描述设置值的更改以及其他差异的方法。

广告
将在 10 秒后关闭
bannerAds