""" Flask backend .. note:: 在 CoroutineBasedSession 会话中,若在协程任务函数内调用 asyncio 中的协程函数,需要使用 asyncio_coroutine """ import json import logging import threading from flask import Flask, request, send_from_directory, Response from .httpbased import HttpContext, HttpHandler, run_event_loop from .utils import make_applications from ..utils import STATIC_PATH, iscoroutinefunction, isgeneratorfunction from ..utils import get_free_port logger = logging.getLogger(__name__) class FlaskHttpContext(HttpContext): backend_name = 'flask' def __init__(self): self.response = Response() self.request_data = request.get_data() def request_obj(self): """返回当前请求对象""" return request._get_current_object() def request_method(self): """返回当前请求的方法,大写""" return request.method def request_headers(self): """返回当前请求的header字典""" return request.headers def request_url_parameter(self, name, default=None): """返回当前请求的URL参数""" return request.args.get(name, default=default) def request_json(self): """返回当前请求的json反序列化后的内容,若请求数据不为json格式,返回None""" try: return json.loads(self.request_data) except Exception: return None def set_header(self, name, value): """为当前响应设置header""" self.response.headers[name] = value def set_status(self, status: int): """为当前响应设置http status""" self.response.status_code = status def set_content(self, content, json_type=False): """设置相应的内容 :param content: :param bool json_type: content是否要序列化成json格式,并将 content-type 设置为application/json """ if json_type: self.set_header('content-type', 'application/json') self.response.data = json.dumps(content) else: self.response.data = content def get_response(self): """获取当前的响应对象,用于在私图函数中返回""" return self.response def get_client_ip(self): """获取用户的ip""" return request.remote_addr def webio_view(applications, session_expire_seconds=None, session_cleanup_interval=None, allowed_origins=None, check_origin=None): """获取在Flask中运行PyWebIO任务的视图函数。基于http请求与前端页面进行通讯 :param list/dict/callable applications: PyWebIO应用。 :param int session_expire_seconds: 会话不活跃过期时间。 :param int session_cleanup_interval: 会话清理间隔。 :param list allowed_origins: 除当前域名外,服务器还允许的请求的来源列表。 :param callable check_origin: 请求来源检查函数。 关于各参数的详细说明见 :func:`pywebio.platform.flask.start_server` 的同名参数。 :return: Flask视图函数 """ handler = HttpHandler(applications=applications, session_expire_seconds=session_expire_seconds, session_cleanup_interval=session_cleanup_interval, allowed_origins=allowed_origins, check_origin=check_origin) def view_func(): context = FlaskHttpContext() return handler.handle_request(context) view_func.__name__ = 'webio_view' return view_func def start_server(applications, port=8080, host='localhost', allowed_origins=None, check_origin=None, session_expire_seconds=None, session_cleanup_interval=None, debug=False, **flask_options): """启动一个 Flask server 将PyWebIO应用作为Web服务提供。 :param list/dict/callable applications: PyWebIO应用. 格式同 :func:`pywebio.platform.tornado.start_server` 的 ``applications`` 参数 :param int port: 服务监听的端口。设置为 ``0`` 时,表示自动选择可用端口。 :param str host: 服务绑定的地址。 ``host`` 可以是IP地址或者为hostname。如果为hostname,服务会监听所有与该hostname关联的IP地址。 通过设置 ``host`` 为空字符串或 ``None`` 来将服务绑定到所有可用的地址上。 :param list allowed_origins: 除当前域名外,服务器还允许的请求的来源列表。 来源包含协议、域名和端口部分,允许使用 Unix shell 风格的匹配模式(全部规则参见 `Python文档 `_ ): - ``*`` 为通配符 - ``?`` 匹配单个字符 - ``[seq]`` 匹配seq中的字符 - ``[!seq]`` 匹配不在seq中的字符 比如 ``https://*.example.com`` 、 ``*://*.example.com`` :param callable check_origin: 请求来源检查函数。接收请求来源(包含协议、域名和端口部分)字符串, 返回 ``True/False`` 。若设置了 ``check_origin`` , ``allowed_origins`` 参数将被忽略 :param int session_expire_seconds: 会话过期时间。若 session_expire_seconds 秒内没有收到客户端的请求,则认为会话过期。 :param int session_cleanup_interval: 会话清理间隔(秒)。服务端会周期性清理过期的会话,释放会话占用的资源。 :param bool debug: 是否开启Flask Server的debug模式,开启后,代码发生修改后服务器会自动重启。 :param flask_options: 传递给 ``flask.Flask.run`` 函数的额外的关键字参数 可设置项参考: https://flask.palletsprojects.com/en/1.1.x/api/#flask.Flask.run """ if not host: host = '0.0.0.0' if port == 0: port = get_free_port() app = Flask(__name__) app.add_url_rule('/io', 'webio_view', webio_view( applications=applications, session_expire_seconds=session_expire_seconds, session_cleanup_interval=session_cleanup_interval, allowed_origins=allowed_origins, check_origin=check_origin ), methods=['GET', 'POST', 'OPTIONS']) @app.route('/') @app.route('/') def serve_static_file(static_file='index.html'): return send_from_directory(STATIC_PATH, static_file) has_coro_target = any(iscoroutinefunction(target) or isgeneratorfunction(target) for target in make_applications(applications).values()) if has_coro_target: threading.Thread(target=run_event_loop, daemon=True).start() if not debug: logging.getLogger('werkzeug').setLevel(logging.WARNING) app.run(host=host, port=port, debug=debug, **flask_options)