1. 程式人生 > >實例化flask的參數及對app的配置

實例化flask的參數及對app的配置

tin 存在 復用 其它 功能 nbsp 編碼 所有 url路徑

Flask 是一個非常靈活且短小精幹的web框架 , 那麽靈活性從什麽地方體現呢?

有一個神奇的東西叫 Flask配置 , 這個東西怎麽用呢? 它能給我們帶來怎麽樣的方便呢?

首先展示一下:

from flask import Flask

app = Flask(__name__)  # type:Flask
app.config["DEBUG"] = True

這句 app.config["DEBUG"] = True 可以實現的功能可刺激了

代碼只要發生改動,自動重啟Flask程序(app.run)

在控制臺打印的信息非常全面

以上兩個功能就是傳說中的 DEBUG 模式(調試模式)

Flask的配置就是在 app.config 中添加一個鍵值對,但是你存進去的鍵必須是config中應該存在的,如果不再存在的話,它會默認無用,就這麽放著

config中有多少有用的key 呢?

{
    ‘DEBUG‘: False,  # 是否開啟Debug模式
    ‘TESTING‘: False,  # 是否開啟測試模式
    ‘PROPAGATE_EXCEPTIONS‘: None,  # 異常傳播(是否在控制臺打印LOG) 當Debug或者testing開啟後,自動為True
    ‘PRESERVE_CONTEXT_ON_EXCEPTION‘: None,  # 一兩句話說不清楚,一般不用它
    ‘SECRET_KEY‘: None,  # 之前遇到過,在啟用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加密字符串的名字
    ‘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,都可以被改寫,當然他們也都是有默認值存在的,如果沒有特殊情況,不要改寫它的默認值

修改配置的方式大約是兩種

1.直接對app.config進行修改

app.config["DEBUG"] = True

2.使用類的方式導入

首先要有一個settings.py的文件

class FlaskSetting:
    DEBUG = True
    SECRET_KEY = "DragonFire"

然後我們在Flask的啟動文件中就可以這麽寫

from flask import Flask


app = Flask(__name__)  # type:Flask
app.config.from_object("settings.FlaskSetting")

這叫做類導入配置

這是針對一個已經實例化的app進行的配置

那麽在Flask實例化的時候,傳遞的參數是什麽鬼呢?

其實可以理解為對Flask實例進行的初始配置,這裏面的參數是非常好理解,註意關鍵字是非常非常非常好理解

static_folder = ‘static‘,  # 靜態文件目錄的路徑 默認當前項目中的static目錄
static_host = None,  # 遠程靜態文件所用的Host地址,默認為空
static_url_path = None,  # 靜態文件目錄的url路徑 默認不寫是與static_folder同名,遠程靜態文件時復用
# host_matching是否開啟host主機位匹配,是要與static_host一起使用,如果配置了static_host, 則必須賦值為True
# 這裏要說明一下,@app.route("/",host="localhost:5000") 就必須要這樣寫
# host="localhost:5000" 如果主機頭不是 localhost:5000 則無法通過當前的路由
host_matching = False,  # 如果不是特別需要的話,慎用,否則所有的route 都需要host=""的參數
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的配置