【Flask实例化参数及对app的配置】 򕃌

时间：2022-06-26 17:55:08

原文: http://blog.gqylpy.com/gqy/338

Flask是一个非常灵活且短小精干的Web框架，那么灵活性从什么地方体现呢？

有一个神奇的东西叫做Flask配置，这个东西怎么用呢？它能给我们带来怎么样的方便呢？

首先展示一下：

from flask import Flask
app = Flask(__name__)
app.config['DEBUG'] = True

这句app.config[‘DEBUG‘] = True能实现的功能可就刺激了：

  1. 代码只要发生改动，便自动重新加载Flask程序(app.run)。
  2. 在控制台的打印信息也非常的全面。

以上两个功能就是传说中的DEBUE模式(调试模式)。

Flask的配置就是在app.config中添加一个键值对。
但添加的键必须是config存在的，如果不存在，则默认无用，就这么放着。

config中存在多少key呢？

{
    'DEBUG': False,  # 是否开启调试模式
    'TESTING': False,  # 是否开启测试模式
    'PROPAGATE_EXCEPTIONS': None,  # 异常传播（是否在控制台打印log）当DEBUG或TESTING开始时，自动为True
    'PRESERVE_CONTEXT_ON_EXCEPTION': None  #
    'SECRET_KEY': None,  # 在启用Session时，必须使用它，它用于给Session提供加密字符串
    'PERMANENT_SESSION_LIFETIME': 31,  # days, Session的生命周期(天)，默认31天
    'USE_X_SENDFILE': False,  # 是否弃用x_sendfile
    'LOGGER_NAME': None,  # 日志记录器的名称
    'LOGGER_HANDLER_POLICY': 'always',  #
    'SERVER_NAME': None,  # 服务访问域名
    'APPLICATION_ROOT': None,  # 项目的完整路径
    'SESSION_COOKIE_NAME': 'session',  # 在cookies中存放session加密字符串的key
    'SESSION_COOKIE_DOMAIN': None,  # 在哪个域名下会产生session记录在cookies中
    'SESSION_COOKIE_PATH': None,  # cookies的路径
    'SESSION_COOKIE_HTTPONLY': True,  # 控制cookie是否应被设置httponly的标志
    'SESSION_COOKIE_SECURE': False,  # 控制cookie是否应被设置安全标志
    'SESSION_REFRESH_EACH_REQUEST': True,  # 这个标示控制永久会话如何刷新
    'MAX_CONTENT_LENGTH': None,
    # 如果设置为字节数，Flask会拒绝内容长度大于此值的请求进入，并返回一个413状态码
    'SEND_FILE_MAX_AGE_DEFAULT': 12,  # hours 默认缓存控制的最大期限
    'TRAP_BAD_REQUEST_ERRORS': False,
    # 如果这个值被设置为 True ，Flask不会执行 HTTP 异常的错误处理，而是像对待其它异常一样，
    # 通过异常栈让它冒泡地抛出。这对于需要找出 HTTP 异常源头的可怕调试情形是有用的。
    'TRAP_HTTP_EXCEPTIONS': False,
    # Werkzeug 处理请求中的特定数据的内部数据结构会抛出同样也是“错误的请求”异常的特殊的 key errors 。
    # 同样地，为了保持一致，许多操作可以显式地抛出 BadRequest 异常。
    # 因为在调试中，你希望准确地找出异常的原因，这个设置用于在这些情形下调试。
    # 如果这个值被设置为 True ，你只会得到常规的回溯。
    'EXPLAIN_TEMPLATE_LOADING': False,
    'PREFERRED_URL_SCHEME': 'http',  # 生成URL的时候如果没有可用的 URL 模式话将使用这个值
    'JSON_AS_ASCII': True,
    # 默认情况下 Flask 使用 ascii 编码来序列化对象。如果这个值被设置为 False ，
    # Flask不会将其编码为 ASCII，并且按原样输出，返回它的 unicode 字符串。
    # 比如 jsonfiy 会自动地采用 utf-8 来编码它然后才进行传输。
    'JSON_SORT_KEYS': True,
    # 默认情况下 Flask 按照 JSON 对象的键的顺序来序来序列化它。
    # 这样做是为了确保键的顺序不会受到字典的哈希种子的影响,
    # 从而返回的值每次都是一致的，不会造成无用的额外 HTTP 缓存。
    # 你可以通过修改这个配置的值来覆盖默认的操作，
    # 但这是不被推荐的做法因为这个默认的行为可能会给你在性能的代价上带来改善。
    'JSONIFY_PRETTYPRINT_REGULAR': True,
    'JSONIFY_MIMETYPE': 'application/json',
    'TEMPLATES_AUTO_RELOAD': None,
}

以上这些Key，都可以被改写，当然它们也都是有默认值的，如果没有特殊情况，尽量不要改写它。

下面展示两种修改配置的方式
***
方式一：直接对app.config进行修改

app.config['DEBUG'] = True

方式二：类导入配置

首先，要有一个配置文件：

# 文件名：setting.py

# 定义配置类
class FlaskSetting:
  DEBUG = True  # 开启调试模式
  SECRET_KEY = 'Encrypted string'

# 定义其它配置类
class xx:
  pass

然后，导入配置类并使用：

from flask import Flask
import settings  # 导入配置文件

app = Flask(__name__)
app.config.from_object('settings.FlaskSetting')  # 使用配置类

上面的配置是针对一个已经实例化的app进行的配置。

那么，在Flask实例化的时候，传递的参数是什么呢？

其实可以理解为对Flask实例进行的初始配置，如下：

static_folder = 'static',  # 静态文件目录的路径，默认为当前项目中的static目录
static_host = None,  # 远程静态文件所用的Host地址，这个是要与host_matching一起使用的
static_url_path = None,  # 静态文件目录的url路径，默认不写是与static_folder同名，远程静态文件时复用
host_matching = False,  # 如果不是特别需要的话,慎用,否则所有的route都需要host=""的参数
# host_matching是否开启host主机位匹配,这个是要与static_host一起使用的,如果配置了static_host, 则必须赋值为True
# 这里要说明一下,@app.route("/",host="localhost:5000") 就必须要这样写
# host="localhost:5000" 如果主机头不是 localhost:5000 则无法通过当前的路由
subdomain_matching = False,  # 理论上来说是用来限制SERVER_NAME子域名的,但是目前还没有感觉出来区别在哪里
template_folder = 'templates'  # template模版目录，默认为当前项目中的templates目录
instance_path = None,  # 指向另一个Flask实例的路径
instance_relative_config = False,  # 是否加载另一个实例的配置
root_path = None,  # 主模块所在的目录的绝对路径，默认为项目目录

这里面，常用的有这三个：

static_folder = 'static',
 # 静态文件目录的路径，默认为当前项目中的static目录

static_url_path = None,
# 静态文件目录的url路径，默认不写是与static_folder同名，远程静态文件时复用

template_folder = 'templates'
# template模版目录，摩尔你为当前项目中的templates目录

下面的示例将详细讲解这三个配置的用法
***
我们的项目目录结构如下：
【Flask实例化参数及对app的配置】 򕃌

test.py文件：

from flask import Flask, render_template

app = Flask(__name__, template_folder='temp', static_folder='img', static_url_path='/xx/img')
# template_folder='temp'  # 指定模版文件为当前项目下的temp目录
# static_folder='img'  # 指定静态文件为当前项目下的img目录
# static_url_path  # 用于重新定义静态文件url路径

app.config['DEBUG'] = True  # 开启调试模式


@app.route('/test01')
def test01():
    return render_template('test01.html')


app.run()

test01.html文件：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
</head>
<body>
<h1>This is test01 page.</h1>
<img src="xx/img/image01.png" alt="image01">
</body>
</html>

启动项目后打开浏览器访问，可正常获取html页面和静态资源。

原文: http://blog.gqylpy.com/gqy/338

相关文章