web框架之Flask
阿新 • • 發佈：2017-10-31
路徑 contex put logger loading function bad ubd erro 
Flask是一個基於Python開發並且依賴jinja2模板和Werkzeug WSGI服務的一個微型框架，對於Werkzeug本質是Socket服務端，其用於接收http請求並對請求進行預處理，然後觸發Flask框架，開發人員基於Flask框架提供的功能對請求進行相應的處理，並返回給用戶，如果要返回給用戶復雜的內容時，需要借助jinja2模板來實現對模板的處理，即：將模板和數據進行渲染，將渲染後的字符串返回給用戶瀏覽器。
“微”(micro) 並不表示你需要把整個 Web 應用塞進單個 Python 文件（雖然確實可以 ），也不意味著 Flask 在功能上有所欠缺。微框架中的“微”意味著 Flask 旨在保持核心簡單而易於擴展。Flask 不會替你做出太多決策——比如使用何種數據庫。而那些 Flask 所選擇的——比如使用何種模板引擎——則很容易替換。除此之外的一切都由可由你掌握。如此，Flask 可以與您珠聯璧合。
默認情況下，Flask 不包含數據庫抽象層、表單驗證，或是其它任何已有多種庫可以勝任的功能。然而，Flask 支持用擴展來給應用添加這些功能，如同是 Flask 本身實現的一樣。眾多的擴展提供了數據庫集成、表單驗證、上傳處理、各種各樣的開放認證技術等功能。Flask 也許是“微小”的，但它已準備好在需求繁雜的生產環境中投入使用。
安裝Flask
pip3 install flask
Werkzeug :
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(‘localhost‘, 4000, hello)
基本使用
from flask import Flask
app = Flask(__name__)
@app.route(‘/‘)
def hello_world():
return ‘Hello World!‘
if __name__ == ‘__main__‘:
app.run()
配置文件
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://user@localhost/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‘])
常用路由系統有以上五種，所有的路由系統都是基於一下對應關系來處理：
DEFAULT_CONVERTERS = {
‘default‘: UnicodeConverter,
‘string‘: UnicodeConverter,
‘any‘: AnyConverter,
‘path‘: PathConverter,
‘int‘: IntegerConverter,
‘float‘: FloatConverter,
‘uuid‘: UUIDConverter,
}
a.註冊路由
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.註冊路由原理View Code
b.自定義正則路由匹配
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. 自定制正則路由匹配View Code
模板
1、模板的使用
Flask使用的是Jinja2模板，所以其語法和Django無差別
2、自定義模板方法
Flask中自定義模板方法的方式和Bottle相似，創建一個函數並通過參數的形式傳入render_template，如：
html
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8">
<title></title>
</head>
<body>
<h1>自定義函數</h1>
{{ww()|safe}}
</body>
</html>
run.py
#!/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()
請求和響應
復制代碼
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()
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 the session if it‘s there
session.pop(‘username‘, None)
return redirect(url_for(‘index‘))
# set the secret key. keep this really secret:
app.secret_key = ‘A0Zr98j/3yX R~XHH!jmN]LWX/,?RT‘
自定義session
pip3 install Flask-Session run.py from flask import Flask from flask import session from pro_flask.utils.session import MySessionInterface app = Flask(__name__) app.secret_key = ‘A0Zr98j/3yX R~XHH!jmN]LWX/,?RT‘ app.session_interface = MySessionInterface() @app.route(‘/login.html‘, methods=[‘GET‘, "POST"]) def login(): print(session) session[‘user1‘] = ‘alex‘ session[‘user2‘] = ‘alex‘ del session[‘user2‘] return "內容" if __name__ == ‘__main__‘: app.run() session.py #!/usr/bin/env python # -*- coding:utf-8 -*- import uuid import json from flask.sessions import SessionInterface from flask.sessions import SessionMixin from itsdangerous import Signer, BadSignature, want_bytes class MySession(dict, SessionMixin): def __init__(self, initial=None, sid=None): self.sid = sid self.initial = initial super(MySession, self).__init__(initial or ()) def __setitem__(self, key, value): super(MySession, self).__setitem__(key, value) def __getitem__(self, item): return super(MySession, self).__getitem__(item) def __delitem__(self, key): super(MySession, self).__delitem__(key) class MySessionInterface(SessionInterface): session_class = MySession container = {} def __init__(self): import redis self.redis = redis.Redis() def _generate_sid(self): return str(uuid.uuid4()) def _get_signer(self, app): if not app.secret_key: return None return Signer(app.secret_key, salt=‘flask-session‘, key_derivation=‘hmac‘) def open_session(self, app, request): """ 程序剛啟動時執行，需要返回一個session對象 """ sid = request.cookies.get(app.session_cookie_name) if not sid: sid = self._generate_sid() return self.session_class(sid=sid) signer = self._get_signer(app) try: sid_as_bytes = signer.unsign(sid) sid = sid_as_bytes.decode() except BadSignature: sid = self._generate_sid() return self.session_class(sid=sid) # session保存在redis中 # val = self.redis.get(sid) # session保存在內存中 val = self.container.get(sid) if val is not None: try: data = json.loads(val) return self.session_class(data, sid=sid) except: return self.session_class(sid=sid) return self.session_class(sid=sid) def save_session(self, app, session, response): """ 程序結束前執行，可以保存session中所有的值 如： 保存到resit 寫入到用戶cookie """ domain = self.get_cookie_domain(app) path = self.get_cookie_path(app) httponly = self.get_cookie_httponly(app) secure = self.get_cookie_secure(app) expires = self.get_expiration_time(app, session) val = json.dumps(dict(session)) # session保存在redis中 # self.redis.setex(name=session.sid, value=val, time=app.permanent_session_lifetime) # session保存在內存中 self.container.setdefault(session.sid, val) session_id = self._get_signer(app).sign(want_bytes(session.sid)) response.set_cookie(app.session_cookie_name, session_id, expires=expires, httponly=httponly, domain=domain, path=path, secure=secure) 自定義SessionView Code
message
message是一個基於Session實現的用於保存數據的集合，其特點是：使用一次就刪除。
from flask import Flask, flash, redirect, render_template, request, get_flashed_messages
app = Flask(__name__)
app.secret_key = ‘some_secret‘
@app.route(‘/‘)
def index1():
messages = get_flashed_messages()
print(messages)
return "Index1"
@app.route(‘/set‘)
def index2():
v = request.args.get(‘p‘)
flash(v)
return ‘ok‘
if __name__ == "__main__":
app.run()
中間件
from flask import Flask, flash, redirect, render_template, request
app = Flask(__name__)
app.secret_key = ‘some_secret‘
@app.route(‘/‘)
def index1():
return render_template(‘index.html‘)
@app.route(‘/set‘)
def index2():
v = request.args.get(‘p‘)
flash(v)
return ‘ok‘
class MiddleWare:
def __init__(self,wsgi_app):
self.wsgi_app = wsgi_app
def __call__(self, *args, **kwargs):
return self.wsgi_app(*args, **kwargs)
if __name__ == "__main__":
app.wsgi_app = MiddleWare(app.wsgi_app)
app.run(port=9999)
web框架之Flask