我愛Flask框架之Debug模式設定

2020-10-16 14:00:33

黃色標註部分重點注意

1. Debug模式的設定

       •預設情況下flask庫不會開啟DEBUG模式,開啟DEBUG模式後,flask會在每次儲存程式碼的時候自動的重新載入程式碼,並且如果程式碼有錯誤,會在終端提示。

執行測試:

       •在first_flask()函數中加入錯誤程式碼進行測試:

from flask import Flask

app = Flask(__name__)


# 裝飾器,將當前路由對映到對應函數
@app.route('/')
def first_flask():
    result = 1 / 0 # 出現錯誤
    return 'Hello Flask'


if __name__ == '__main__':
    app.run()

       •執行開啟服務後,會在瀏覽器發現:
在這裡插入圖片描述
       •在編譯器的紀錄檔也會發現以下報錯:

[2020-10-15 13:14:29,845] ERROR in app: Exception on / [GET]
Traceback (most recent call last):
  File "D:\envs\Flaskframe-UbajLYNV\lib\site-packages\flask\app.py", line 2447, in wsgi_app
    response = self.full_dispatch_request()
  File "D:\envs\Flaskframe-UbajLYNV\lib\site-packages\flask\app.py", line 1952, in full_dispatch_request
    rv = self.handle_user_exception(e)
  File "D:\envs\Flaskframe-UbajLYNV\lib\site-packages\flask\app.py", line 1821, in handle_user_exception
    reraise(exc_type, exc_value, tb)
  File "D:\envs\Flaskframe-UbajLYNV\lib\site-packages\flask\_compat.py", line 39, in reraise
    raise value
  File "D:\envs\Flaskframe-UbajLYNV\lib\site-packages\flask\app.py", line 1950, in full_dispatch_request
    rv = self.dispatch_request()
  File "D:\envs\Flaskframe-UbajLYNV\lib\site-packages\flask\app.py", line 1936, in dispatch_request
    return self.view_functions[rule.endpoint](**req.view_args)
  File "D:/Flaskframe/第一講/first_flask.py", line 9, in first_flask
    result = 1 / 0
ZeroDivisionError: division by zero
127.0.0.1 - - [15/Oct/2020 13:14:29] "GET / HTTP/1.1" 500 -

       •這種執行方式顯然很麻煩,且每次修改之後必須重新執行,而且錯誤資訊只能在紀錄檔中看到。
       •這時我們就需要開啟Debug模式,這樣每次修改程式碼儲存程式碼都會重新執行,並且程式碼有問題也會顯示錯誤資訊

注意:修改程式碼後要儲存才能重新執行,大部分編譯器儲存程式碼的快捷鍵都是(Crtl+S)

開啟Debug的幾種方法:

       •在run()方法中設定debug引數為True:

if __name__ == '__main__':
    app.run(debug=True) #debug引數為True

       •設定app物件範例的debug屬性為True:

if __name__ == '__main__':
    app.debug = True #範例的debug屬性為True
    app.run()

       •通過設定引數config的屬性設定:

if __name__ == '__main__':
    app.config.update(DEBUG=True)
    app.run()

       •config是繼承於字典型別的,可以使用字典型別的update()方法。
開啟Debug模式測試如下:

from flask import Flask

app = Flask(__name__)


# 裝飾器,將當前路由對映到指定函數
@app.route('/')
def first_flask():
    result = 1 / 0
    return 'Hello Flask'


if __name__ == '__main__':
    app.run(debug=True)

       •儲存並執行,檢視網頁:
在這裡插入圖片描述
       •控制檯中也會提示已開啟Debug模式

 * Serving Flask app "first_flask" (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: on  # on表示Debug模式已開啟
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 338-200-360
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

       •當Debug模式開啟後,修改完程式碼並儲存,都會自動載入程式碼重新啟動服務,不需要再手動關閉服務再重新啟動了。

2. 設定與組態檔

       •Flask專案的各種設定,都是通過app.config物件來進行設定的。
       •如果要設定一個Flask專案處於Debug模式下執行,那麼可以使用app.config[‘DEBUG’] = True來進行設定使得此Flask專案在Debug模式下執行。

專案設定的幾種不同方法:

   1. 直接寫死
寫死的方式不靈活,不便於進行復用(多次使用)。

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

   2. 通過字典的update()方法
       •因為app.config是flask.config.Config的範例,而Config類是繼承於字典型別,因此可以通過update()方法進行設定。

app.config.update(
   DEBUG=True,
   SECRET_KEY='...'
)

   3. 通過模組from_object()方法
       •當需要設定項非常多時,可以把所有需要的設定項都放在一個模組中,然後通過載入模組的方式進行設定。
       •假設有一個settings.py模組,專門用來儲存設定項的,此時你可以通過app.config.from_object()方法進行載入設定項,並且該方法既可以接收模組的字串名稱,也可以是模組物件

兩種不同形式載入設定項:
# 1. 通過模組字串
app.config.from_object('settings')
# 2. 通過模組物件
import settings
app.config.from_object(settings)

       •新增組態檔後,將設定項都放在該檔案中,其他檔案直接參照該組態檔中的設定項,提高了程式碼的複用性、降低了耦合度。同時,在組態檔中修改了設定項時,其他程式碼中均不需要修改,從而大大提高了程式碼的靈活性。

將Debug模式設定新增到組態檔中:

       •新建一個config.py檔案,新增設定項如下:

# 設定Debug模式為True,開啟Debug模式
DEBUG = True

# 指定HOST
HOST = '127.0.0.1'

       •在所需檔案中匯入組態檔:

from flask import Flask
import config

app = Flask(__name__)


# 裝飾器,將當前路由對映到指定函數
@app.route('/')
def first_flask():
    result = 1 / 0
    return 'Hello Flask'


if __name__ == '__main__':
    app.config.from_object(config)
    app.run()

       •再執行,即可開啟Debug模式。
   也可通過字串形式匯入

if __name__ == '__main__':
    app.config.from_object('config')
    app.run()

   4. 通過from_pyfile()方法
       •app.config.from_pyfile()方法傳入一個檔名,通常是以.py結尾的檔案,也可使用其它字尾的檔案。
       •通過匯入Python檔案的形式匯入組態檔:

if __name__ == '__main__':
    app.config.from_pyfile('config.py')
    app.run()

       •from_pyfile()方法中有一個silent引數,設定為True時,如果組態檔不存在也不會出現報錯
       •不僅支援Python格式的組態檔,也支援.ini等其它格式組態檔。

有問題可以在評論指正,歡迎討論,謝謝大家!!