Flask 框架

1. Flask基础

• flask理念：一切从简为服务器减轻压力

1. 框架对比

Django	Flask
Admin - Model	原生无
Model	原生无
Form	原生无
session	有-颠覆认知(存储到服务端内存中，浏览器的cookies中)
教科书式框架	第三方组件非常丰富。一切从简
优势对比
组件、功能全，教科书	轻，快
劣势对比
占用资源，cpu，ram	先天不足，第三方组件稳定性较差
创建项目复杂度高

2. Flask安装

1. 安装：pip3 install Flask
   • 直接创建python文件
   • ps：不要使用工具中的插件创建Flask项目
2. 三行启动flask项目
3. Flask：框架源码
   • Jinja2：模版语言
   • MarkupSafe：render基于此，防止xss攻击
   • Werkzeug：类似django的uwsgi底层都是基于wsgi，承载flask服务，类似tomcat

3. 创建项目

1. 创建py文件

• 设置DEBUG：项目会自动重启

from flask import Flask
# 命名
app = Flask('app.py')
# 或 app = Flask(__name__)
app.config['DEBUG'] = True
# 或 app.debug = True

@app.route('/')
def home():
  	return 'AH, you are visiting Flask-site!'

if __name__ == '__main__':
	# 监听地址和端口，默认是127.0.0.1:5000
	app.run('0.0.0.0', 5000)
# werkzeug调用run_simple
# wsgi处理请求头(网关接口)
# wsgi处理后的数据，environment。		

2. response

• content type：浏览器根据此参数，判断响应类型

1. "xxx"

• django中的 HttpResponse('hello')，Flask是 'hello'

@app.route('/index')
def index():
  	return  'hello world i am Flask'

2. render_template

• 响应模版，默认存放路径 templates，打开模版并替换，依赖包 MarkupSafe中的 Markup 发送给浏览器

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

3. redirect

• 在Response Header中加入 Location: '/login'

@app.route('/login')
def login():
  	return render_template('/index')

• 以上是web框架的三剑客

4. send_file()

• response instance：流媒体类型
• 打开文件并自动识别文件类型，在content-type中添加文件类型，content-type:文件类型
• 浏览器特性：可识别的 content-type 自动渲染，不识别时，自动下载该文件

content-type(6)

1. text/html
2. text/plain，保留当前文件格式
3. image/jepg或者 image/png
4. audio/mpeg：<video> ，应该是<audio>，chrome完成
5. video/mp4：<video> 标签
6. application/x-msdownload：xx.exe

• 文件类型：一般是文件第一行就是文件类型

from flask import send_file
@app.route('/get_file')
def get_file():
  	# 返回文件内容，自动识别文件类型
  	return send_file('app.py')

5. jsonify

• flask 1.1.1 版本中，dict直接作为返回值返回，无须 jsonify
• 返回标准json格式字符串，api接口，先序列化字典，并设置content-type: Application/json

@app.route('/get_json')
def get_json():
  	d = {'k':'v'}
    return jsonify(d)

4. request(11)

• request在flask中是公共变量(顶头小写)，请求上下文保存机制
• 从reqeust中获取的数据类型为：ImmutableMultiDict([('id', '1')])

# 请求方式和数据 5
1. request.method			# 获取请求的方式
2. request.form				# 获取 FormData 中数据(ajax)
   .to_dict()	  			# request.from.to_dict()：返回对应的字典
   							# 类型：ImmutableMultiDict([])
3. request.args				# 获取url中的参数
4. reqeust.values			# 获取 url 和 FormData 中的数据，如果key相同 url中的会覆盖 form中数据
							# CombinedMultiDict([ImmutableMultiDict([('id', '1')]), ImmutableMultiDict([])])
5. request.files			# 获取 Form 中文件，返回 FileStroage中有 save() 方法和 filename属性
	.save(文件路径)
    .filename

# 请求来源相关 3
6. request.host				# ip + port
7. request.path				# url路由地址
8. request.url				# 完整路径，如：http://127.0.0.1:5000/detail?id=2

# cookies相关 1
9. request.cookies			# 字典，获取浏览器请求时带上的cookies

# 特殊数据封装 3
10.request.data				# Content-type 中不包含 Form 或 FormData，保留请求体中的原始数据，b""类型
11.request.json				# 请求头的 Content-type:application/json
   							# 请求体中的数据被序列化到request.json中，以字典的形式存放

from flask import Flask
app = Flask(__name__)

@app.route('/login', methods=['GET','POST',])
def login():
  	# 优先判断请求方式
    # 如果是GET请求
    if request.method == 'GET':
      	return render_template('login.html')
    # 如果是POST请求，获取 用户名，密码 校验
    else: # 405 请求方式不被允许
      	# request.form.to_dict()
        my_file = request.files.get('my_file')
        filename = my_file.filename
        filepath = os.path.join('avatar', filename)
        my_file.save(filepath)
        if request.form.get('username') == 'xxx':
          	return 'Login OK!'
    return '200 ok'

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

• ImmutableMultiDict类型数据用法和dict类型相同，都有 values(), items()，keys() 方法

5. Jinja2(5)

1. 与django不同(4)

1. {{ my_input(arg1, arg2...) }}：引用或执行，函数必须有括号
2. {% %}：逻辑，方法需要有()
3. dict类型可以使用 info['username']
4. 如果变量没有定义会报错

2. 传递变量(关键字传参)

app.config['DEBUG'] = True
或 app.debug = True

@app.route('/')
def stu():
  	return render_template('stu.html', stu=STUDENT,)
app.run('0.0.0.0:9527')

3. 传递函数

• @app.template_global()：项目中任何地方都可以使用被装饰的函数

@app.template_global()
def ab(a,b):
  	return a+b

@app.route('/a')
def homea():
  	return render_template('a.html', ab=ab)

4. 宏指令

• 在jinja2模版中使用

{% macro my_input(na, ty) %}
	<input type="{{ ty }}" name="{{ na }}">
{% endmacro %}
{{ my_input('username', 'text') }}

5. Markup

• 在view 函数中，生成标签在使用

from markupsafe import Markup

@app.route('/a')
def homea():
  	inp = Markup("<input type='submit' value='xxx'>")
    return render_template('a.html', btn=inp)

def my_input(na, ty):
  	s = f"<input type='{ty}' value='{na}'>"
    return Markup(s)

{{ btn | safe }}
{{ my_input('username', 'text') }}

6. session(5)

1. 基于请求上下文
2. 一般和 request 一起导入
3. 交由客户端保管机制，加密后存到浏览器的cookies中。保存一串字符串
4. 原生：不建议添加过多的 key:values，健值对越多，浏览器需要保存的cookies越长，Flask会先对健值对进行压缩和加密
5. flask-session：把加密后的session从浏览器，移动到服务端

from flask import session
# 密钥不能为空
app.secret_key = "1!@#$8943:''.,xvzn;5lk12@!lg)*743%^&"
# 装饰器

def warpper(func):
  	def inner(*args, **kwargs):
      	# 校验登录状态、校验session中有没有 user key
      	if session.get('user'):
          	return func()
        else:  # 校验失败，跳转到登录页面
          	return redirect('/login')
		return inner

@app.route('/login', methods=['GET', 'POST'])
def login():
  	if request.method == 'GET':
      	return render_template('login.html')
    else:
      	if request.form.get('username') == 'henry':
          	return 'Login OK!'
        else:
        		return 'failed'

@app.route('/')
@warpper
def homea():
    return render_template('a.html')

2. Flask项目

1. 路由

1. 装饰器装饰多个函数

1. 自定义装饰器最终会出现多个 inner 函数最终为 endpoint，flask中通过endpoint查找view
2. 基于functools 修改 __name__，functools.wraps，在装饰器的inner上添加functors.wraps(func)
3. 添加endpoint参数

@app.route('/a', endpoint='end_a')
@warpper
def a():
    pass
  
@app.route('/b', endpoint='end_b')
@warpper
def b():
    pass
  
@app.route('/', endpoint='home')
@warpper
def home():
    pass

• endpoint值必须唯一

2. route参数(5)

1. methods=[]/()

• 请求方式不区分大小写

@app.route(rule, methods=['get', 'POST', 'options'])

• getatter() or ('GET', )
• set(item.upper() for item in methods)

2. endpoint=None

• 解决装饰器不能装饰多个函数的问题
• 路由地址和endpoint的mapping
• 路由地址和视图之间mapping
• 默认是视图函数名

@app.route('/', endpoint=None)
def home():
    return 'ok!'

3. defaults={'count': 20}

• 默认参数
• path = url_for(endpoint)：返回路由地址

from flask import Flask
url_for('end_a')
url_for('home')
# {'end_a':'/a', 'home': '/'}

@app.route(rule, endpoint=None, defaults={'count':20})
def home(count):
    count = request.args.get('count', count)
    return f'200 ok!{count}'

4. strict_slashes=False

• 是否严格遵循地址匹配

@app.route(rule, endpoint=None, strict_slashes=True)
def home():
    return f'200 ok!{count}'

5. redirect_to='/'

• 永久重定向，状态码，308/301
• 不进入视图函数，直接重定向

@app.route(rule, endpoint=None, redirect_to='/')

3. 动态参数路由

• str：可以收一切，默认是 string 类型
• rule：/home/<filename>， /home/<int:page>， /home/<ty>_<page>_<id>，分页、获取文件、解决分类，解决正则路由
• send_file()：需要限定文件目录

@app.route('/home/<int:page>', endpoint='home',)
def home(page):
    print(type(page))
    return '200 ok!'
  
@app.route('/home/<page>_<ty>_...', endpoint='home',)
def home(page, ty, ...):
    pass
  
@app.route('/home/<filename>', endpoint='home',)
def home(filename):
    return send_file(f'media/{filename}')

2. Flask配置

• static_host=None：静态文件的服务器

1. 初始化配置(3)

1. template_folder=''

• 指定模板存放路径，默认时templates

app = Flask(__name__, template_folder='templates')

2. staic_folder='static'

• 锁定访问目录，静态文件存放目录，默认：static

app = Flask(__name__, static_folder='img', static_url_path='/static')
# http://127.0.0.1:5000/static/1.jpeg

3. static_url_path='/static'

• 静态文件访问路径，默认/staic_folder
• 自动拼接 host：http://127.0.0.1:5000/

<img src='访问地址'>
<img src='static/1.jpg'>

• static_host=None：其他主机
• instance_path：多app

2. 实例配置(app配置)

1. default_config

• default_config = {} ：默认配置
• 'TESTING'：True，日志级别为Debug，修改代码后不自动重启，错误环境不透传，接近生产环境
• ''：31days(默认)
• JSONIFY_MIMETYPE='application/json'

# 开启 debug 模式，自动重启、透传错误信息、log级别较低 debug 级别
app.debug = True
# 使用session
app.secret_key = 'R&w34hr*&%^R7ysdjh9qw78r^*&A%863'
# session名称
app.session_cookie_name = 'ah'
# session生命周期，20s过期为 None
app.permanent_session_lifetime = 20
# respone头中content-type:xxx
app.config['JSONIFY_MIMETYPE']='xxx'

2. settings.py

import hashlib

class DubugConfig(object):
    DEBUG = True
    SECRET_KEY = '#$%^&fguyhij&^$EHBksdj`109u23'
    PERMANENT_SESSION_LIFETIME = 3600
    SESSION_COOKIE_NAME = 'ah'

class TestConfig(object):
    TESTING = True
    SECRET_KEY = hashlib.md5(f'{time.time()}#$%^&124:"hfag(&sfdgh3ir;dfguyhij&^$EHBksdj`109u23{time.time()}'.encode('utf-8')).hexdigest()
	PERMANENT_SESSION_LIFETIME = 360000
    SESSION_COOKIE_NAME = '$%^&124:"hfag('

3. 配置生效

from settings.py import DubugConfig,TestConfig
app.config.from_object(DubugConfig)
app.config.from_object(TestConfig)

3. Blueprint

• 不能被run的flask实例，不存在config
• app的功能隔离
• 视图路由分割

from flask import Blueprint
# 蓝图标识必须唯一
bp = Blueprint('app01', __name__,url_prefix='/car')
or
bp = Blueprint(__name__, __name__,url_prefix='/car')

@bp.route('/user')
def user():
    return 'I am app01!'

# 或 bp.add_url_rule()
# 访问当前蓝图中的装饰器
@bp.before_request
@bp.after_request
@bp.errorhandler(Http错误码)

from app01 import bp
app.register_blueprint(bp)

4. 特殊装饰器

• requset校验没过时，绕过view 执行全部after_request
• 只要有响应返回，af全部执行

1. @app.before_request

• 在请求进入视图函数之前，作出处理

@app.before_reqeust
def be1():
    print('i am be1')
    
@app.before_reqeust
def be2():
    print('i am be2')

2. @app.after_request

• 在响应返回客户端之前，结束view之后
• 会有response参数
• 执行顺序与定义顺序相反

@app.after_request
def af1(res):
    print('i am in af1')
    return res

@app.after_request
def af2(res):
    print('i am in af2')
    return res

3. @app.errorhandler(404)

• 监听状态码只能是 4xx和5xx
• 需要接受错误信息
• 返回值为响应，af会挨个执行

@app.errorhandler(404)
def error404(error_message):
    print(error_message)
    return 'xxx' 		# 5种类型

3. CBV&session

1. CBV

1. views.MethodView：继承让当前class可以成为视图类
2. 定义视图类支持的请求方式
3. 添加路由，as_view(name='login_login')。name就是endpoint(endpoint=None的情况下)
4. 可以添加类变量：methods / decorator = ['is_login']

# CBV
from flask import views
app.add_url_rule('/login', view_func = Login.as_view(name='login_login'))

@app.before_request
def is_login():
  	return 1

@app.after_request
def login_ok(res):
  	return res

# methods：默认是类对应的方法
class Login(views.MethodView):
  	# decorators = []
  	def get(self):
      	return 'here is get.'
    def post(self):
      	pass

• add_url_rule()：添加路由

def add_url_rule(self, rule, endpoint=None, view_func=None, **options):pass
# self：flask对象
# rule：路由
# endpoint=None，地址反解析使用，如果为None，则使用view_func的name
# view_func，视图函数，视图类.as_view(name='xxx')

• view_func()：返回一个 view 函数

def as_view(cls, name, *class_args, **class_kwargs):pass
# cls：视图类
# name：视图函数名

from flask import views
class Index(views.MethodView):
  	def get(self, *args, **kwargs):
      	pass
    ...

app.add_url_rule('/index', endpoint=None, view_func=Login.as_vxwiews(name='login')

2. redis

1. 安装

# win
下载redis到指定目录，配置PATH即可
# mac
brew install redis

2. 使用

1. redis使用 key:value 方式存储，哈希存储结构{key:value}
2. 多次设置同一个key 会被覆盖

# 终端
redis-cli
# 总共 16 个库，0-15，用来数据隔离
select 8					# 切换 8 号库，默认 0 号库
set key value				# 设置一个健值对，哈希存储结构{key:value}
keys pattern				# 查询当前数据库中所有的key,如keys * 查询当前数据库中所有key
		 a*					# 查询以 a开头
  	 *n*					# 包含 n
...
get key						# 查询 key 对应的 value

3. python操作redis

1. --protected-mode no：测试使用，没有设置密码可以使用主机ip
2. redis只能存储：byte, string or number

from redis import Redis
redis_cli = Redis(host='127.0.0.1', port=6379, db=6)
redis_cli.set('name', 'echo')

3. Flask-session

1. 三方组件：pip install flask-session
2. app.config最终在 app.default_config中
3. settings.py中的DebugConfig中，不是大写英文的一律丢弃不管
4. 使用pickle作为序列化器

from flask import Flask, request, session
from flask_session import Session

app = Flask(__name__)
# app.secret_key = '%^&*JBHJ%$*lkdsj'
# 使用 flask_session并使用 redis 存储session
app.config['SESSION_TYPE'] = 'redis'
app.config['SESSION_REDIS'] = Redis('127.0.0.1', 6379, db=10)
Session(app)

@app.route('/sets')
def sets():
  	session['key'] = 'henry'
  	return 'set ok!'
 
@app.route('/gets')
def gets():
  	return session.get('key')

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

• flask 利用session_interface，选择session存放位置和机制

app.session_interface			
# session_interface = self._get_interface(app)
app.config['SESSION_TYPE'] = 'redis'
app.config['SESSION_REDIS'] = Redis(host='192.168.12.9', 6379, db=10)
# redis通过pickle序列化，secret_key只有原生的config需要

4. Flask上下文

传送门：7 张图搞懂 Flask 请求上下文

1. 偏函数

# flask中的 requst 和 session
from functools import partial

def ab(a, b):
    return a+b

new_func = partial(ab, 1, 3)

print(new_func())

2. 线程安全

import time
# local：{线程号1:{变量名:值},...}
from threading import local

class Foo(local):
    num = 0
foo = Foo()

def addi(i):
    foo.num = i
    time.sleep(0.2) 		# 相当于 i/o 操作
   	print(foo.num)

from threading import Thread
for i in range(20):
    th = Thread(target=addi, args=(i,))
    th.strat()    

3. werkzeug 搭建app

# werkzeug 搭建app
from werkzeug.wrappers import Response, Request
from werkzeug.serving import run_simple

@Request.application
def app(req):
    print(req, req.method)
    return Response('200 ok')

run_simple('0.0.0.0', 5000, app)

# environ：wsgi 处理requset后的结果，请求原始信息
# 对象相当于dict
__slots__ = ('__stroage__', '__ident_func__')