Django settings files contain all of your Django installation configuration. This file is usually in your project folder. For example, if we create a project named mysite, then the configuration file setting.py is in the mysite folder in the project.
Some commonly used settings configurations are listed below for reference.
1. Configure static files
#STATIC_URL = '/static/' is the static file alias STATIC_URL = '/static/' #Static file address splicing, the following 'static' file is the file name of the static file (JS, IMG, CSS) created by itself STATICFILES_DIRS = ( os.path.join(BASE_DIR, 'static'), #Static files under the main file os.path.join(BASE_DIR,"blog","statics"), #Static files under the project blog file )
2. mysql database configuration
########The original default sqlite
DATABASES in setting = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db .sqlite3'),
}
}
############Change to mysql as follows
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': ' test', #Your database name'USER
': 'root', #Your database user name'PASSWORD
': '19941028', #Your database password'HOST
': '', #Your database host, leave blank The default is localhost
'PORT': '3306', #your database port
}}
#Because mysql default engine is MySQLdb, in __init__.Add the following code to the py file
#In python3, it must be replaced with pymysql, and the following code can be added to the main configuration file (under the file with the same name as the project, not the app configuration file)
import pymysql
pymysql.install_as_MySQLdb()
#If the pymysql plate cannot be found, install it through pip install pymysql.
3. Set the print log to the screen
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'handlers': {
'console': {
'level': 'DEBUG',
'class': 'logging.StreamHandler',
},
},
'loggers': {
'django.db.backends': {
'handlers': ['console'],
'propagate': True,
'level': 'DEBUG',
},
}
}
4. Language
LANGUAGE_CODE = 'en-us'# Default LANGUAGE_CODE = 'zh-hans'# Change to Chinese, mainly for admin pages
5. Configure the template path
TEMPLATE_DIRS = ( os.path.join(BASE_DIR,'templates'), ) #Then add the templates folder under the project root directory
6. Register APP
INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles' , 'app1.apps.App1Config', # already exists by default, if not, just add the app name For example: 'blog' # new applications must be added here ]
7. SQL statement
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'handlers': {
'console': {
'level': 'DEBUG',
'class': 'logging.StreamHandler',
},
},
'loggers': {
'django.db.backends': {
'handlers': ['console'],
'propagate': True,
'level': 'DEBUG',
},
}
}
When your operation is related to the database, the statement we wrote will be translated into sql statement and printed on the server.
8. If the UserInfo (user table) in the database inherits django's built-in AbstractUser
1) The model needs to be imported
from django.contrib.auth.models import AbstractUser
2) Add in the Settings file
AUTH_USER_MODEL = "Application Name.UserInfo"
9. Middleware, middleware written by myself
For example, the two middlewares M1 and M2 in the md.py file under the md folder in the project
MIDDLEWARE = [ 'django.middleware.security.SecurityMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', 'md.md.M1', 'md.md.M2', ]
It should be noted that the middleware written by oneself, the configuration should be written later in the system
10. Related configuration of session storage
1) Database configuration (default)
Django supports Session by default, and stores Session data in the database by default, namely: django_session table. Configuration settings.py SESSION_ENGINE = 'django.contrib.sessions.backends.db' # Engine (default) SESSION_COOKIE_NAME = "sessionid" # The key when the session cookie is saved on the browser, namely: sessionid = random string (default) SESSION_COOKIE_PATH = "/" # The path where the session cookie is saved (default) SESSION_COOKIE_DOMAIN = None # The domain name where the session cookie is saved (default) SESSION_COOKIE_SECURE = False # Whether HTTPS transmits the cookie (default) SESSION_COOKIE_HTTPONLY = True # Whether the session cookie only supports http Transmission (default) SESSION_COOKIE_AGE = 1209600 # Session cookie expiration date (2 weeks) (default) SESSION_EXPIRE_AT_BROWSER_CLOSE = False # Whether to close the browser to make the Session expire (default) SESSION_SAVE_EVERY_REQUEST = False # Whether to save the Session for each request, only after the default modification save (default)
2) Cache configuration
Configuration settings.py SESSION_ENGINE = 'django.contrib.sessions.backends.cache' # Engine SESSION_CACHE_ALIAS = 'default' # The cache alias used (default memory cache, or memcache), where the alias depends on the cache setting SESSION_COOKIE_NAME = " sessionid" # The key when the session cookie is saved on the browser, namely: sessionid = random string SESSION_COOKIE_PATH = "/" # The path where the session cookie is saved SESSION_COOKIE_DOMAIN = None # The domain name where the session cookie is saved SESSION_COOKIE_SECURE = False # Whether it is Https Transmission cookie SESSION_COOKIE_HTTPONLY = True # Whether the Session cookie only supports http transmission SESSION_COOKIE_AGE = 1209600 # Session cookie expiration date (2 weeks) SESSION_EXPIRE_AT_BROWSER_CLOSE = False # Whether to close the browser to make the Session expire SESSION_SAVE_EVERY_REQUEST = False # Whether Each request saves the Session, Save after modification by default
3) Default configuration
Configuration settings.py SESSION_ENGINE = 'django.contrib.sessions.backends.file' # Engine SESSION_FILE_PATH = None # Cache file path, if None, use tempfile module to get a temporary address tempfile.gettempdir() SESSION_COOKIE_NAME = "sessionid" # The key when the session cookie is saved on the browser, namely: sessionid=random string SESSION_COOKIE_PATH = "/" # The path where the session cookie is saved SESSION_COOKIE_DOMAIN = None # The domain name where the session cookie is saved SESSION_COOKIE_SECURE = False # Whether HTTPS transmits the cookie SESSION_COOKIE_HTTPONLY = True # Whether the Session cookie only supports http transmission SESSION_COOKIE_AGE = 1209600 # Session cookie expiration date (2 weeks) SESSION_EXPIRE_AT_BROWSER_CLOSE = False # Whether to close the browser to make the Session expire SESSION_SAVE_EVERY_REQUEST = False # Whether to save the Session for each request, after the default modification save
Note:
1) You can also customize the configuration, but the customized configuration must be written to the configuration file and the configuration can be imported when used in the last code
from django.conf import settings settings. configuration name
2) All the above configurations need to be modified for specific problems, and the system default configuration is not explained.
3) The above configurations are just common configurations encountered in the previous django introductory tutorial. Subsequent configurations will be gradually added and updated in this tutorial.
11. Configuration file upload directory
#Set file upload path MEDIA_URL = '/media/' MEDIA_ROOT = os.path.join(BASE_DIR, 'media/')
If you want to access your uploaded files in the browser, you need to make the following settings in urls.py:
from django.views.static import serve
from django.conf import settings
urlpatterns = [
...
re_path('^media/(?P<path>.*)$', serve, {'document_root': settings.MEDIA_ROOT}),
]
Django settings optimal configuration example code
The specific code is as follows:
import os
import socket
SITE_ID = 1
# 项目的根目录
# 简化后面的操作
PROJECT_ROOT = os.path.dirname(os.path.dirname(__file__))
# 加载应用
# 把应用添加到INSTALLED_APPS中
from apps.kuser.mysetting import myapp as kuser_app
from apps.blog.mysetting import myapp as blog_app
MY_APPS = blog_app + kuser_app
# 加载静态文件
from apps.blog.mysetting import my_staticfiles as blog_staticfiles
from apps.kuser.mysetting import my_staticfiles as kuser_staticfiles
MY_STATIC_DIRS = blog_staticfiles + kuser_staticfiles
# 加载模板文件
from apps.blog.mysetting import my_templates as blog_templates
from apps.kuser.mysetting import my_templates as kuser_templates
MY_TEMPLATE_DIRS = blog_templates + kuser_templates
# 密钥配置
# 适用于开发环境和部署环境
# 可以从系统环境中，配置文件中，和硬编码的配置中得到密钥
try:
SECRET_KEY = os.environ['SECRET_KEY']
except:
try:
with open(os.path.join(PROJECT_ROOT, 'db/secret_key').replace('\\', '/')) as f:
SECRET_KEY = f.read().strip()
except:
SECRET_KEY = '*lk^6@0l0(iulgar$j)faff&^(^u+qk3j73d18@&+ur^xuTxY'
# 得到主机名
def hostname():
sys = os.name
if sys == 'nt':
hostname = os.getenv('computername')
return hostname
elif sys == 'posix':
host = os.popen('echo $HOSTNAME')
try:
hostname = host.read()
return hostname
finally:
host.close()
else:
raise RuntimeError('Unkwon hostname')
#调试和模板调试配置
#主机名相同则为开发环境，不同则为部署环境
#ALLOWED_HOSTS只在调试环境中才能为空
if socket.gethostname().lower() == hostname().lower():
DEBUG = TEMPLATE_DEBUG = True
ALLOWED_HOSTS = []
else:
ALLOWED_HOSTS = [
'baidu.com',
'0.0.0.0',
]
DEBUG = TEMPLATE_DEBUG = False
#数据库配置
MYDB = {
'mysql': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'books', #你的数据库名称
'USER': 'root', #你的数据库用户名
'PASSWORD': '', #你的数据库密码
'HOST': '', #你的数据库主机，留空默认为localhost
'PORT': '3306', #你的数据库端口
},
'sqlite': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(PROJECT_ROOT, 'db/db.sqlite3').replace('\\', '/'),
}
}
# 给静态文件url一个后缀，在templates里用到的。
# 映射到静态文件的url
# STATIC_URL的含义与MEDIA_URL类似
STATIC_URL = '/static/'
# 总的static目录
# 可以使用命令 manage.py collectstatic 自动收集static文件
# STATIC_ROOT = os.path.join(PROJECT_ROOT, 'static').replace('\\', '/')
#放各个app的static目录及公共的static目录
#STATICFILES_DIRS：和TEMPLATE_DIRS的含义差不多，就是除了各个app的static目录以外还需要管理的静态文件设置，
#比如项目的公共文件差不多。然后给静态文件变量赋值，告诉Django，静态文件在哪里
#另外，Django提供了一个findstatic命令来查找指定的静态文件所在的目录，例如：D:\TestDjango>python manage.py findstatic Chrome.jpg
# 默认情况下（如果没有修改STATICFILES_FINDERS的话），Django首先会在STATICFILES_DIRS配置的文件夹中寻找静态文件，然后再从每个app的static子目录下查找，
# 并且返回找到的第一个文件。所以我们可以将全局的静态文件放在STATICFILES_DIRS配置的目录中，将app独有的静态文件放在app的static子目录中。
# 存放的时候按类别存放在static目录的子目录下，如图片都放在images文件夹中，所有的CSS都放在css文件夹中，所有的js文件都放在js文件夹中。
STATICFILES_DIRS = (
("downloads", os.path.join(PROJECT_ROOT, 'static/downloads').replace('\\', '/')),
("uploads", os.path.join(PROJECT_ROOT, 'static/uploads').replace('\\', '/')),
)
# 将app中的静态文件添加到静态文件配置列表中
STATICFILES_DIRS += MY_STATIC_DIRS
# 最后关键的部分是STATICFILES_DIRS以下配置
# 简要说一下，static文件夹在项目里，有css js images 三个文件夹（看项目结构），他们的路径分别是：
# os.path.join(STATIC_ROOT,'css')，os.path.join(STATIC_ROOT,'js')，os.path.join(STATIC_ROOT,'images')；
# 我们分别给他们起三个别名css，js，images（你可以随意给，不过为了易记，我们原名称指定别名了）
TEMPLATE_DIRS = (
os.path.join(PROJECT_ROOT, 'templates').replace('\\', '/'),
)
# 配置应用的模板文件路径
TEMPLATE_DIRS += MY_TEMPLATE_DIRS
# 配置缓存
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
'LOCATION': 'unix:/tmp/memcached.sock',
'KEY_PREFIX': 'lcfcn',
'TIMEOUT': None
}
}
LOGIN_REDIRECT_URL = '/'
LOGIN_URL = '/auth/login/'
LOGOUT_URL = '/auth/logout/'
# 指用户上传的文件，比如在Model里面的FileFIeld，ImageField上传的文件。如果你定义
# MEDIA_ROOT=c:\temp\media，那么File=models.FileField(upload_to="abc/")，上传的文件就会被保存到c:\temp\media\abc。MEDIA_ROOT必须是本地路径的绝对路径。
MEDIA_ROOT = os.path.join(PROJECT_ROOT, 'static/uploads')
# MEDIA_URL是指从浏览器访问时的地址前缀。
MEDIA_URL = '/uploads/'
# 应用注册列表
INSTALLED_APPS = (
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'django.contrib.sites',
'django.contrib.sitemaps',
)
#为了不和系统应用混合，自己开发的应用放在这里
# 将自己写的app添加到应用列表中去
INSTALLED_APPS += MY_APPS
# django 中间件
# django处理一个Request的过程是首先通过django 中间件，然后再通过默认的URL方式进行的。
# 所以说我们要做的就是在django 中间件这个地方把所有Request拦截住，
# 用我们自己的方式完成处理以后直接返回Response,那么我们可以简化原来的设计思路，
# 把中间件不能处理的 Request统统不管，丢给Django去处理。
MIDDLEWARE_CLASSES = (
'django.middleware.cache.UpdateCacheMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
# 'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
'django.middleware.cache.FetchFromCacheMiddleware',
)
ROOT_URLCONF = 'lcforum.urls'
WSGI_APPLICATION = 'lcforum.wsgi.application'
#数据库配置
DATABASES = {
'default': MYDB.get('sqlite'),
}
# 语言
LANGUAGE_CODE = 'zh-cn'
# 时区
TIME_ZONE = 'Asia/Shanghai'
USE_TZ = True
# 在template中使用静态文件
# 采用这种方式需要有一些额外配置，打开settings.py，确认TEMPLATE_CONTEXT_PROCESSORS中包含有'django.core.context_processors.static'
# TEMPLATE_CONTEXT_PROCESSORS = (
# 'django.core.context_processors.debug',
# 'django.core.context_processors.i18n',
# 'django.core.context_processors.media',
# 'django.core.context_processors.static',
# 'django.contrib.auth.context_processors.auth',
# 'django.contrib.messages.context_processors.messages',
#
# 'django.core.context_processors.tz',
# 'django.contrib.messages.context_processors.messages',
# # 'blog.context_processors.custom_proc',自定义函数
# )
#from django.conf import settings
#gettext = lambda s: s
#getattr()
# 假设有个工程mysite，有两个app为blog跟bbs
# django处理static的方法是把各个app各自的static合并到一处
# 比如:
# mysite/mysite/static 放置公共静态文件
# mysite/bbs/static 放置该app自己的静态文件
# mysite/blog/static 放置该app自己的静态文件
# 可以这么设置：
# STATIC_ROOT = '/www/mysite/mysite/static '
# STATIC_URL = '/static/'
# STATICFILES_DIRS = (
# 'mysite/static',
# 'bbs/static/',
# 'blog/static/',
# )
# 使用命令
# manage.py collectstatic
# 就会自动把所有静态文件全部复制到STATIC_ROOT中
# 如果开启了admin，这一步是很必要的，不然部署到生产环境的时候会找不到样式文件
# 不要把你项目的静态文件放到这个目录。这个目录只有在运行python manage.py collectstatic时才会用到