flask基礎入門
Flask是一個基於Python開發並且依賴jinja2模板和Werkzeug WSGI服務的一個微型框架,對於Werkzeug本質是Socket服務端,其用於接收http請求並對請求進行預處理,然後觸發Flask框架,開發人員基於Flask框架提供的功能對請求進行相應的處理,並返回給使用者,如果要返回給使用者複雜的內容時,需要藉助jinja2模板來實現對模板的處理,即:將模板和資料進行渲染,將渲染後的字串返回給使用者瀏覽器。
“微”(micro) 並不表示你需要把整個 Web 應用塞進單個 Python 檔案(雖然確實可以 ),也不意味著 Flask 在功能上有所欠缺。微框架中的“微”意味著 Flask 旨在保持核心簡單而易於擴充套件。Flask 不會替你做出太多決策——比如使用何種資料庫。而那些 Flask 所選擇的——比如使用何種模板引擎——則很容易替換。除此之外的一切都由可由你掌握。如此,Flask 可以與您珠聯璧合。
預設情況下,Flask 不包含資料庫抽象層、表單驗證,或是其它任何已有多種庫可以勝任的功能。然而,Flask 支援用擴充套件來給應用新增這些功能,如同是 Flask 本身實現的一樣。眾多的擴充套件提供了資料庫整合、表單驗證、上傳處理、各種各樣的開放認證技術等功能。Flask 也許是“微小”的,但它已準備好在需求繁雜的生產環境中投入使用。
?1 |
pip3 install flask |
from werkzeug.wrappers import Request, Response @Request.application def hello(request): return Response('Hello World!') if __name__ == '__main__': from werkzeug.serving import run_simple run_simple('localhostwerkzeug', 4000, hello)
一. 基本使用
?1 2 3 4 5 6 7 8 9 |
from
flask
import
Flask
app
=
Flask(__name__)
@app
.route(
'/'
)
def
hello_world():
return
'Hello World!'
if
__name__
=
=
'__main__'
:
app.run()
|
二、配置檔案
+ View Code ?1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
flask中的配置檔案是一個flask.config.Config物件(繼承字典),預設配置為:
{
'DEBUG'
: get_debug_flag(default
=
False
), 是否開啟Debug模式
'TESTING'
:
False
, 是否開啟測試模式
'PROPAGATE_EXCEPTIONS'
:
None
,
'PRESERVE_CONTEXT_ON_EXCEPTION'
:
None
,
'SECRET_KEY'
:
None
,
'PERMANENT_SESSION_LIFETIME'
: timedelta(days
=
31
),
'USE_X_SENDFILE'
:
False
,
'LOGGER_NAME'
:
None
,
'LOGGER_HANDLER_POLICY'
:
'always'
,
'SERVER_NAME'
:
None
,
'APPLICATION_ROOT'
:
None
,
'SESSION_COOKIE_NAME'
:
'session'
,
'SESSION_COOKIE_DOMAIN'
:
None
,
'SESSION_COOKIE_PATH'
:
None
,
'SESSION_COOKIE_HTTPONLY'
:
True
,
'SESSION_COOKIE_SECURE'
:
False
,
'SESSION_REFRESH_EACH_REQUEST'
:
True
,
'MAX_CONTENT_LENGTH'
:
None
,
'SEND_FILE_MAX_AGE_DEFAULT'
: timedelta(hours
=
12
),
'TRAP_BAD_REQUEST_ERRORS'
:
False
,
'TRAP_HTTP_EXCEPTIONS'
:
False
,
'EXPLAIN_TEMPLATE_LOADING'
:
False
,
'PREFERRED_URL_SCHEME'
:
'http'
,
'JSON_AS_ASCII'
:
True
,
'JSON_SORT_KEYS'
:
True
,
'JSONIFY_PRETTYPRINT_REGULAR'
:
True
,
'JSONIFY_MIMETYPE'
:
'application/json'
,
'TEMPLATES_AUTO_RELOAD'
:
None
,
}
方式一:
app.config[
'DEBUG'
]
=
True
PS: 由於Config物件本質上是字典,所以還可以使用app.config.update(...)
方式二:
app.config.from_pyfile(
"python檔名稱"
)
如:
settings.py
DEBUG
=
True
app.config.from_pyfile(
"settings.py"
)
app.config.from_envvar(
"環境變數名稱"
)
環境變數的值為python檔名稱名稱,內部呼叫from_pyfile方法
app.config.from_json(
"json檔名稱"
)
JSON檔名稱,必須是json格式,因為內部會執行json.loads
app.config.from_mapping({
'DEBUG'
:
True
})
字典格式
app.config.from_object(
"python類或類的路徑"
)
app.config.from_object(
'pro_flask.settings.TestingConfig'
)
settings.py
class
Config(
object
):
DEBUG
=
False
TESTING
=
False
DATABASE_URI
=
'sqlite://:memory:'
class
ProductionConfig(Config):
DATABASE_URI
=
'mysql://[email protected]/foo'
class
DevelopmentConfig(Config):
DEBUG
=
True
class
TestingConfig(Config):
TESTING
=
True
PS: 從sys.path中已經存在路徑開始寫
PS: settings.py檔案預設路徑要放在程式root_path目錄,如果instance_relative_config為
True
,則就是instance_path目錄
|
三、路由系統
- @app.route('/user/<username>')
- @app.route('/post/<int:post_id>')
- @app.route('/post/<float:post_id>')
- @app.route('/post/<path:path>')
- @app.route('/login', methods=['GET', 'POST'])
常用路由系統有以上五種,所有的路由系統都是基於一下對應關係來處理:
?1 2 3 4 5 6 7 8 9 |
DEFAULT_CONVERTERS
=
{
'default'
: UnicodeConverter,
'string'
: UnicodeConverter,
'any'
: AnyConverter,
'path'
: PathConverter,
'int'
: IntegerConverter,
'float'
: FloatConverter,
'uuid'
: UUIDConverter,
}
|
def auth(func): def inner(*args, **kwargs): print('before') result = func(*args, **kwargs) print('after') return result return inner @app.route('/index.html',methods=['GET','POST'],endpoint='index') @auth def index(): return 'Index' 或 def index(): return "Index" self.add_url_rule(rule='/index.html', endpoint="index", view_func=index, methods=["GET","POST"]) or app.add_url_rule(rule='/index.html', endpoint="index", view_func=index, methods=["GET","POST"]) app.view_functions['index'] = index 或 def auth(func): def inner(*args, **kwargs): print('before') result = func(*args, **kwargs) print('after') return result return inner class IndexView(views.View): methods = ['GET'] decorators = [auth, ] def dispatch_request(self): print('Index') return 'Index!' app.add_url_rule('/index', view_func=IndexView.as_view(name='index')) # name=endpoint 或 class IndexView(views.MethodView): methods = ['GET'] decorators = [auth, ] def get(self): return 'Index.GET' def post(self): return 'Index.POST' app.add_url_rule('/index', view_func=IndexView.as_view(name='index')) # name=endpoint @app.route和app.add_url_rule引數: rule, URL規則 view_func, 檢視函式名稱 defaults=None, 預設值,當URL中無引數,函式需要引數時,使用defaults={'k':'v'}為函式提供引數 endpoint=None, 名稱,用於反向生成URL,即: url_for('名稱') methods=None, 允許的請求方式,如:["GET","POST"] strict_slashes=None, 對URL最後的 / 符號是否嚴格要求, 如: @app.route('/index',strict_slashes=False), 訪問 http://www.xx.com/index/ 或 http://www.xx.com/index均可 @app.route('/index',strict_slashes=True) 僅訪問 http://www.xx.com/index redirect_to=None, 重定向到指定地址 如: @app.route('/index/<int:nid>', redirect_to='/home/<nid>') 或 def func(adapter, nid): return "/home/888" @app.route('/index/<int:nid>', redirect_to=func) subdomain=None, 子域名訪問 from flask import Flask, views, url_for app = Flask(import_name=__name__) app.config['SERVER_NAME'] = 'wupeiqi.com:5000' @app.route("/", subdomain="admin") def static_index(): """Flask supports static subdomains This is available at static.your-domain.tld""" return "static.your-domain.tld" @app.route("/dynamic", subdomain="<username>") def username_index(username): """Dynamic subdomains are also supported Try going to user1.your-domain.tld/dynamic""" return username + ".your-domain.tld" if __name__ == '__main__': app.run()a.註冊路由原理
from flask import Flask, views, url_for from werkzeug.routing import BaseConverter app = Flask(import_name=__name__) class RegexConverter(BaseConverter): """ 自定義URL匹配正則表示式 """ def __init__(self, map, regex): super(RegexConverter, self).__init__(map) self.regex = regex def to_python(self, value): """ 路由匹配時,匹配成功後傳遞給檢視函式中引數的值 :param value: :return: """ return int(value) def to_url(self, value): """ 使用url_for反向生成URL時,傳遞的引數經過該方法處理,返回的值用於生成URL中的引數 :param value: :return: """ val = super(RegexConverter, self).to_url(value) return val # 新增到flask中 app.url_map.converters['regex'] = RegexConverter @app.route('/index/<regex("\d+"):nid>') def index(nid): print(url_for('index', nid='888')) return 'Index' if __name__ == '__main__': app.run()b. 自定製正則路由匹配
四、模板
1、模板的使用
Flask使用的是Jinja2模板,所以其語法和Django無差別
2、自定義模板方法
Flask中自定義模板方法的方式和Bottle相似,建立一個函式並通過引數的形式傳入render_template,如:
<!DOCTYPE html> <html> <head lang="en"> <meta charset="UTF-8"> <title></title> </head> <body> <h1>自定義函式</h1> {{ww()|safe}} </body> </html>html
#!/usr/bin/env python # -*- coding:utf-8 -*- from flask import Flask,render_template app = Flask(__name__) def wupeiqi(): return '<h1>Wupeiqi</h1>' @app.route('/login', methods=['GET', 'POST']) def login(): return render_template('login.html', ww=wupeiqi) app.run()run.py
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> {% macro input(name, type='text', value='') %} <input type="{{ type }}" name="{{ name }}" value="{{ value }}"> {% endmacro %} {{ input('n1') }} {% include 'tp.html' %} <h1>asdf{{ v.k1}}</h1> </body> </html>其他
注意:Markup等價django的mark_safe
五、請求和響應
from flask import Flask from flask import request from flask import render_template from flask import redirect from flask import make_response app = Flask(__name__) @app.route('/login.html', methods=['GET', "POST"]) def login(): # 請求相關資訊 # request.method # request.args # request.form # request.values # request.cookies # request.headers # request.path # request.full_path # request.script_root # request.url # request.base_url # request.url_root # request.host_url # request.host # request.files # obj = request.files['the_file_name'] # obj.save('/var/www/uploads/' + secure_filename(f.filename)) # 響應相關資訊 # return "字串" # return render_template('html模板路徑',**{}) # return redirect('/index.html') # response = make_response(render_template('index.html')) # response是flask.wrappers.Response型別 # response.delete_cookie('key') # response.set_cookie('key', 'value') # response.headers['X-Something'] = 'A value' # return response return "內容" if __name__ == '__main__': app.run()View Code
六、Session
除請求物件之外,還有一個 session 物件。它允許你在不同請求間儲存特定使用者的資訊。它是在 Cookies 的基礎上實現的,並且對 Cookies 進行金鑰簽名要使用會話,你需要設定一個金鑰。
-
設定:session['username'] = 'xxx'
- 刪除:session.pop('username', None)
from flask import Flask, session, redirect, url_for, escape, request app = Flask(__name__) @app.route('/') def index(): if 'username' in session: return 'Logged in as %s' % escape(session['username']) return 'You are not logged in' @app.route('/login', methods=['GET', 'POST']) def login(): if request.method == 'POST': session['username'] = request.form['username'] return redirect(url_for('index')) return ''' <form action="" method="post"> <p><input type=text name=username> <p><input type=submit value=Login> </form> ''' @app.route('/logout') def logout(): # remove the username from