DJango 1.11 配置文件 settings.py 详解

当我们创建好一个 DJango 工程准备大展身手的时候,第一步要做的就是修改 settings.py 文件配置工程。下面以 DJango 1.11 为例,一起来看看 settings.py 文件中各项配置的含义,以便于我们能全面地 hold 住整个工程。

OK,在开始之前,先来看看 settings.py 配置文件的一些特点:

  • 配置项
    settings.py 配置文件中的所有配置项都是大写的。
  • 默认值
    settings.py 在项目创建时,就初始化了一些默认配置,这些默认配置承载着最基础的项目信息。
  • 配置规则
    可以从 global_settings.py 中导入全局配置,常规情况下,这是不必要的在配置过程中,我们可以随时通过 python manage.py diffsettings 来查看当前 settings.py 文件和默认设置的不同之处。
    可以通过 django.conf.settings 模块中导入变量,在代码中访问配置信息,这样的话,就可以在程序运行过程中进行动态的 settings 配置修改。
  • 安全性
    对于 settings.py 文件包含的信息,涉密的情况很多,需要严格控制 settings.py 文件的访问权限,在共享主机的情况下,这一点格外重要。

配置项说明:

ABSOLUTE_URL_OVERRIDES:默认值:{} 
一个字典映射“app_label_module_name”字符串到一个函数,该函数接收一个Model对象作为参数并返回它的url,这是一个安装上覆盖get_absolute_url()方法的方式

ADMIN_FOR:默认值:() 
用于admin-site settings模块,如果当前站点是admin,它是一个由settings模块组成的tuple字典

ADMIN_MEDIA_PREFIX:默认值:”/media/” 
用于给admin模块设置媒体、CSS、JS和图片的前缀,请确保正确的使用它

ADMINS:默认值:() 
一个包含2个元素的字典,列出了有权接收代码错误提示的邮件列表,当DEBUG=False时,如果一个view引发了异常,Django会将详细信息用电子邮件的方式发送给这些邮件地址,内容格式一般是(名称,邮箱),如:((“管理员A”,[email protected]),(“管理员B”,[email protected]))

ALLOWED_INCLUDE_ROOTS:默认值:() 
一个字符擦混字典,列表中的元素为前缀的模板Django才可以以{%ssi%}形式方法,处于安全考虑,在不应该访问时即使是模板的坐着也不能访问这些文件

APPEND_SLASH:默认值:True 
是否给URL添加一个结尾的斜线,只有安装了CommonMiddleware之后,该选项才起作用

CACHE_BACKEND:默认值:’simple://’ 
后盾使用的cache缓存

CACHE_MIDDLEWARE_KEY_PREFIX:默认值:"" 
cache中间件使用的cache key前缀

DATABASE_ENGINE:默认值:"postgresql"
后端使用的数据库引擎:“posgresql”、”mysql”、”sqlite3”或者”ado_mssql”中的任意一个

DATABASE_HOST:默认值:”“
数据库所在主机,空字符串意味着使用localhost SQLite.如果你使用MYSQL并且该选项以一个斜线”/”开始,MySQL会通过一个Unix socket连接到指定更多socket

DATABASE_NAME:默认值:”“
要使用的数据库名称,默认的SQLite数据库不需要该项

DATABASE_PASSWORD:默认值:”“
连接数据库时的登录密码,默认的SQLite数据库不需要该项

DATABASE_PORT:默认值:”“
连接数据库时使用的端口,默认的SQLite不需要该项

DATABASE_USER:默认值:”“
连接数据库时使用的用户名,SQLite不需要该项

DATE_FORMAT:默认值:”N j, Y” 
对日期字段使用的默认日期格式

DEBUG:默认值:False 
一个开关,用于是否打开调试模式

DEFAULT_CHARSET:默认值:”utf-8”
设置所有HttpResponse对象的默认字符集,构建Content-Type头数据

DEFAULT_CONTENT_TYPE:默认值:”text/html” 
设置所有HttpResponse对对象的默认数据格式,构建Content-type头数据

EMAIL_HOST:默认值:“localhost”
用来发送e-mail电子邮件的主机

EMAIL_HOST_PASSWORD:默认值:”“
EMAIL_HOST选项中定义的SMPT邮箱服务器登录密码,如果为空~Django就不会尝试进行认证

EMAIL_HOST_USER:默认值:”“
EMAIL_HOST选项中定义的SMTP服务器使用的用户名,如果为空~Django将不会尝试进行认证

EMAIL_PORT:默认值:25
EMAIL_HOST选项指定的SMTP服务器使用的端口号

ENABLE_PSYCO:默认值:False 
确定是否使用pscyo优化python代码,需要依赖psyco模块

IGNORABLE_404_STARTS:默认值:(‘/cgi-bin/’, ‘/vti_bin’, ‘/_vti_inf’) 
一个字符串 tuple . 以该tuple中元素为开头的 URL 应该被 404 e-mailer 忽略

INSTALLED_APPS:默认值:() (空的 tuple)
一个字符串tuple ,内容是本 Django 安装中的所有应用. 每个字符串应该是一个包含Django应用程序的Python包的路径全称, django-admin.py startapp 会自动往其中添加内容.

INTERNAL_IPS:默认值:() (空的 tuple) 
一个 ip 地址的 tuple(字符串形式), 当 DEBUG 为 True 时,参阅调试务注解接收 X 头(若 XViewMiddleware 已安装), (参阅 middleware 文档)JING_PATH默认值:'/usr/bin/jing'

LANGUAGE_CODE:默认值:'en-us'
表示默认语言的一个字符串. 必须是标准语言格式. 举例来说, U.S. English 就是 “en-us”. 参阅internationalization docs.

LANGUAGES:默认值:一个 tuple (内容为所有可用语言)
目前它的值是:
LANGUAGES = ( 
	(‘bn’, (‘Bengali’)), 
	(‘cs’, (‘Czech’)), 
	(‘cy’, (‘Welsh’)), 
	(‘da’, (‘Danish’)), 
	(‘de’, (‘German’)), 
	(‘en’, (‘English’)), 
	(‘es’, (‘Spanish’)), 
	(‘fr’, (‘French’)), 
	(‘gl’, (‘Galician’)), 
	(‘is’,*(‘Icelandic’)), 
	(‘it’, (‘Italian’)), 
	(‘no’, (‘Norwegian’)), 
	(‘pt-br’, (‘Brazilian’)), 
	(‘ro’, (‘Romanian’)), 
	(‘ru’, (‘Russian’)), 
	(‘sk’, (‘Slovak’)), 
	(‘sr’, (‘Serbian’)), 
	(‘sv’, (‘Swedish’)), 
	(‘zh-cn’, (‘Simplified Chinese’)), 
)

MANAGERS:默认值:ADMINS (不论 ADMINS 是否已经设置) 
一个和 ADMINS 同样格式的 tuple , 当 SEND_BROKEN_LINK_EMAILS=True 时, 这些人有权接收死链接通知信息.

MEDIA_ROOT:默认值:"" (空的字符串) 
一个绝对路径, 用于保存媒体文件

MEDIA_URL默认值:"" (空的字符串) 
处理媒体服务的URL(媒体文件来自 MEDIA_ROOT)

PREPEND_WWW:默认值:False 
是否为没有 “www.” 前缀的域名添加 “www.” 前缀. 当且仅当安装有 CommonMiddleware 后该选项才有效

ROOT_URLCONF:默认值:Not defined 
一个字符串,表示你的根 URLconf 的模块名. 举例来说:”mydjangoapps.urls”. 参阅 Django如何处理一个请求.

ECRET_KEY:默认值:"" (空的字符串) 
一个密码. 用于为密码哈希算法提供一个种子.将其设置为一个随机字符串 越长越好. django-admin.py startproject 会自动给你创建一个.

SEND_BROKEN_LINK_EMAILS:默认值:False 
当有人从一个有效Django-powered页面访问另一个Django-powered页面时发现404错误(也就是发现一个死链接)时, 是否发送一封邮件给 MANAGERS. 当且仅当 安装有 CommonMiddleware 时该选项才有效

SERVER_EMAIL:默认值:[‘root@localhost’](mailto:’root@localhost’) 用来发送错误信息的邮件地址, 比如发送给 ADMINS 和 MANAGERS 的邮件.

SESSION_COOKIE_AGE:默认值: 1209600 (2周, 以秒计)session cookies 的生命周期, 以秒计. 参阅 session docs.

SESSION_COOKIE_DOMAIN:默认值: Nonesession cookies 
有效的域. 将其值设置为类似 “.lawrence.com” 这样 cookie 就可以跨域生效, 或者使用None 作为一个标准的域 cookie. 参阅 session docs.

SESSION_COOKIE_NAME:默认值:‘sessionid’ 
session 使用的cookie 名字. 参阅 session docs.

SESSION_SAVE_EVERY_REQUEST:默认值:False 
是否每次请求都保存session

SITE_ID:默认值:Not defined 
是一个整数, 表示 django_site 表中的当前站点. 当一个数据包含多个站点数据时,你的程序可以据此 ID 访问特定站点的数据.

TEMPLATE_DEBUG:默认值:False 
一个布尔值,用来开关模板调试模式.若设置为 True, 如果有任何 TemplateSyntaxError,一个详细的错误报告信息页将被显示给你.这个报告包括有关的模板片断,相应的行会自动高亮.注意 Django 仅在 DEBUG 为 True 时显示这个信息页面.

TEMPLATE_DIRS:默认值:() (空的 tuple) 
模板源文件目录列表,按搜索顺序. 注意要使用 Unix-风格的前置斜线(即’/’), 即便是在 Windows 上.

TEMPLATE_LOADERS:默认值:(‘django.template.loaders.filesystem.load_template_source’,) 
一个元素为可调用对象(字符串形式的)的 tuple. 这些对象知道如何导入 templates 从各种源中. 参阅 template documentation.

EMPLATE_STRING_IF_INVALID:默认值:"" (空的字符串) 
输出文本, 作为一个字符串. 模板系统将会在出错 (比如说拼错了) 时使用该变量. 参阅 How invalid variables are handled.

TIME_FORMAT默认值:'P' (举例来说 4 p.m.) 
Django admin change-list 使用的默认时间格式. 有可能系统的其它部分也使用该格式. 参阅 allowed date format strings.

TIME_ZONE默认值:'America/Chicago' (我们可以用 ‘Asia/Shanghai PRC’ ) 
一个表示当前时区的字符串. 参阅 选择项列表.Django 据此设置转换所有的日期/时间 – 并不考虑服务器的时区设置. 举例来说, 一台服务器可以服务多个Django-powered 站点,每个站点使用一个独立的时区设置.

USE_ETAGS默认值:False 
一个布尔值.指定是否输出 “Etag” 头. 这个选项可以节省网络带宽,但损失性能. 只有安装 CommonMiddleware 后这个选项才有用(参阅 middleware 文档)

DJANGO_SETTING_MODULE 环境变量:让 settings 模块被包含到 Python 可以找到的目录下。开发情况下不需要,我们通常会在当前目录运行,这样 Python 解释器就可以搜索到;如果需要运行在其他服务器上,就必须指定该变量。

一个 Django 的 settings 文件不需要我们手动去设置所有项目,因为系统已经默认设置好了,我们只需要修改我们使用的设定就好了。默认的设置在 django/conf/global_settings.py,具体安装目录可通过如下命令查看:

$ pip3 show django
Name: Django
Version: 1.11.11
Summary: A high-level Python Web framework that encourages rapid development and clean, pragmatic design.
Home-page: https://www.djangoproject.com/
Author: Django Software Foundation
Author-email: [email protected]
License: BSD
Location: /usr/local/lib/python3.5/dist-packages
Requires: pytz
Required-by: 

你可能感兴趣的:(Python,Python,全栈)