Flaskソース解読(一)
11948 ワード
FlaskはPythonを用いて作成された軽量級Webアプリケーションフレームワークである.Flask自体はWerkezugとJinja 2の間の橋渡しにすぎず,前者は適切なWSGIアプリケーションを実現し,後者はテンプレートを処理する.もちろん、Flaskにはloggingなどの一般的な標準ライブラリパッケージもバインドされています.それ以外のすべては拡張に任せて実現します.簡単なFlaskAppの実行を追跡し、requestとresponseがどのように実現されているかを見てみましょう.以下は簡単なflask appコードで、ブラウザでアクセスできます.
pdbスナップスタックの呼び出し状況により、
/home/steinliber/flask-source-code/route/a.py(18)()-> app.run() /home/steinliber/flask-source-code/env/local/lib/python2.7/site-packages/flask/app.py(772)run()-> run_simple(host, port, self, **options) /home/steinliber/flask-source-code/env/local/lib/python2.7/site-packages/werkzeug/serving.py(692)run_simple()-> inner() /home/steinliber/flask-source-code/env/local/lib/python2.7/site-packages/werkzeug/serving.py(657)inner()-> srv.serve_forever() /home/steinliber/flask-source-code/env/local/lib/python2.7/site-packages/werkzeug/serving.py(497)serve_forever()-> HTTPServer.serve_forever(self)これはキャプチャされたflaskサーバ呼び出しを開始する関数であり、appがFlaskのインスタンスであるためappが呼び出されることがわかる.run()はFlaskクラスのrun()を呼び出しますが、run()メソッドはhostとportにデフォルト値を設定するだけでwerkzeugのrun_を呼び出します.simple()
werkzeugでのrun_シンプル()関数
これはrun_シンプル()の主な役割部分で、最初の2つの判断文はdebugモードと静的ファイルのパッケージです.ShareDataMiddlewareは、サーバが許容できるResponse形式にファイルを変換する役割を果たすミドルウェアです.
use_reloaderは、appコードが変更されたときにサーバを再起動するかどうかを決定するために使用されます.Trueの場合、can_open_by_fdはsocketでfromfdフィーチャーによって決定されるかどうか、環境変数にfdを格納して再起動後の多重化を行うことができる場合、socketはリスニングを開始し、run_を呼び出す.with_reloader、関数innerも受け入れています.use_にかかわらずreloaderがTrueかどうかは、関数内部のinner関数を呼び出します.inner関数内では、環境でWERKZEUG_SERVER_FDというkeyは多重化可能なsocketを格納しており,なければNoneとし,関数make_を呼び出す.server,これはパラメータprocessとthreadsに基づいて適切なサーバを選択し,サーバオブジェクトを取得するとメソッドrun_を呼び出す.forever、このサーバーも起動しました.、werkzeugは、基本的な単一スレッド単一プロセスサーバである複数のオプションサーバを提供しています.
このサーバは基本的なHTTPServerを継承しており、HTTPServerは作成したポートでデータを受け取り、結果をRequestHandlerClassに渡すことができます.具体的には公式ドキュメントを参照してください.https://docs.python.org/2/library/basehttpserver.html
コードでrequest_queue_sizeはリクエストキューの最大接続数を指定し、_init__関数のhandlerは要求されたプロセッサであり、パラメータが指定されている場合はデフォルト値に設定され、使用可能なsocket,ssl_が得られます.contextは主にSSLの実現を支援する.また、HTTPServerを簡単に書き換える方法もあります.serve_foreverではHTTPServerのメソッドを呼び出してサーバ機能を実現しています.
以上、flaskの基本的なサーバの実装として、SSL、socketの多重化、サーバの再ロードなど、簡単なサーバに多くの機能を追加する方法が見られます.次にreloaderとSSLの実装です.
#!/usr/bin/env python
# encoding: utf-8
from flask import Flask
app = Flask(__name__)
@app.route('/')
def index():
import pdb;pdb.set_trace()
return '<h1>Hello world!</h1>'
@app.route('/user/<name>')
def user(name):
import pdb;pdb.set_trace()
return '<h1>Hello,%s!</h1>' % name
if __name__ == '__main__':
app.run()
pdbスナップスタックの呼び出し状況により、
/home/steinliber/flask-source-code/route/a.py(18)
werkzeugでのrun_シンプル()関数
def run_simple(hostname, port, application, use_reloader=False,
use_debugger=False, use_evalex=True,
extra_files=None, reloader_interval=1,
reloader_type='auto', threaded=False,
processes=1, request_handler=None, static_files=None,
passthrough_errors=False, ssl_context=None):
if use_debugger:
from werkzeug.debug import DebuggedApplication
application = DebuggedApplication(application, use_evalex)
if static_files:
from werkzeug.wsgi import SharedDataMiddleware
application = SharedDataMiddleware(application, static_files)
def log_startup(sock):
display_hostname = hostname not in ('', '*') and hostname or 'localhost'
if ':' in display_hostname:
display_hostname = '[%s]' % display_hostname
quit_msg = '(Press CTRL+C to quit)'
port = sock.getsockname()[1]
_log('info', ' * Running on %s://%s:%d/ %s',
ssl_context is None and 'http' or 'https',
display_hostname, port, quit_msg)
def inner():
try:
fd = int(os.environ['WERKZEUG_SERVER_FD'])
except (LookupError, ValueError):
fd = None
srv = make_server(hostname, port, application, threaded,
processes, request_handler,
passthrough_errors, ssl_context,
fd=fd)
if fd is None:
log_startup(srv.socket)
srv.serve_forever()
if use_reloader:
# If we're not running already in the subprocess that is the
# reloader we want to open up a socket early to make sure the
# port is actually available.
if os.environ.get('WERKZEUG_RUN_MAIN') != 'true':
if port == 0 and not can_open_by_fd:
raise ValueError('Cannot bind to a random port with enabled '
'reloader if the Python interpreter does '
'not support socket opening by fd.')
# Create and destroy a socket so that any exceptions are
# raised before we spawn a separate Python interpreter and
# lose this ability.
address_family = select_ip_version(hostname, port)
s = socket.socket(address_family, socket.SOCK_STREAM)
s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
s.bind((hostname, port))
if hasattr(s, 'set_inheritable'):
s.set_inheritable(True)
# If we can open the socket by file descriptor, then we can just
# reuse this one and our socket will survive the restarts.
if can_open_by_fd:
os.environ['WERKZEUG_SERVER_FD'] = str(s.fileno())
s.listen(LISTEN_QUEUE)
log_startup(s)
else:
s.close()
from ._reloader import run_with_reloader
run_with_reloader(inner, extra_files, reloader_interval,
reloader_type)
else:
inner()
これはrun_シンプル()の主な役割部分で、最初の2つの判断文はdebugモードと静的ファイルのパッケージです.ShareDataMiddlewareは、サーバが許容できるResponse形式にファイルを変換する役割を果たすミドルウェアです.
use_reloaderは、appコードが変更されたときにサーバを再起動するかどうかを決定するために使用されます.Trueの場合、can_open_by_fdはsocketでfromfdフィーチャーによって決定されるかどうか、環境変数にfdを格納して再起動後の多重化を行うことができる場合、socketはリスニングを開始し、run_を呼び出す.with_reloader、関数innerも受け入れています.use_にかかわらずreloaderがTrueかどうかは、関数内部のinner関数を呼び出します.inner関数内では、環境でWERKZEUG_SERVER_FDというkeyは多重化可能なsocketを格納しており,なければNoneとし,関数make_を呼び出す.server,これはパラメータprocessとthreadsに基づいて適切なサーバを選択し,サーバオブジェクトを取得するとメソッドrun_を呼び出す.forever、このサーバーも起動しました.、werkzeugは、基本的な単一スレッド単一プロセスサーバである複数のオプションサーバを提供しています.
class BaseWSGIServer(HTTPServer, object):
"""Simple single-threaded, single-process WSGI server."""
multithread = False
multiprocess = False
request_queue_size = LISTEN_QUEUE
def __init__(self, host, port, app, handler=None,
passthrough_errors=False, ssl_context=None, fd=None):
if handler is None:
handler = WSGIRequestHandler
self.address_family = select_ip_version(host, port)
if fd is not None:
real_sock = socket.fromfd(fd, self.address_family,
socket.SOCK_STREAM)
port = 0
HTTPServer.__init__(self, (host, int(port)), handler)
self.app = app
self.passthrough_errors = passthrough_errors
self.shutdown_signal = False
self.host = host
self.port = port
# Patch in the original socket.
if fd is not None:
self.socket.close()
self.socket = real_sock
self.server_address = self.socket.getsockname()
if ssl_context is not None:
if isinstance(ssl_context, tuple):
ssl_context = load_ssl_context(*ssl_context)
if ssl_context == 'adhoc':
ssl_context = generate_adhoc_ssl_context()
# If we are on Python 2 the return value from socket.fromfd
# is an internal socket object but what we need for ssl wrap
# is the wrapper around it :(
sock = self.socket
if PY2 and not isinstance(sock, socket.socket):
sock = socket.socket(sock.family, sock.type, sock.proto, sock)
self.socket = ssl_context.wrap_socket(sock, server_side=True)
self.ssl_context = ssl_context
else:
self.ssl_context = None
def log(self, type, message, *args):
_log(type, message, *args)
def serve_forever(self):
self.shutdown_signal = False
try:
HTTPServer.serve_forever(self)
except KeyboardInterrupt:
pass
finally:
self.server_close()
def handle_error(self, request, client_address):
if self.passthrough_errors:
raise
return HTTPServer.handle_error(self, request, client_address)
def get_request(self):
con, info = self.socket.accept()
return con, info
このサーバは基本的なHTTPServerを継承しており、HTTPServerは作成したポートでデータを受け取り、結果をRequestHandlerClassに渡すことができます.具体的には公式ドキュメントを参照してください.https://docs.python.org/2/library/basehttpserver.html
コードでrequest_queue_sizeはリクエストキューの最大接続数を指定し、_init__関数のhandlerは要求されたプロセッサであり、パラメータが指定されている場合はデフォルト値に設定され、使用可能なsocket,ssl_が得られます.contextは主にSSLの実現を支援する.また、HTTPServerを簡単に書き換える方法もあります.serve_foreverではHTTPServerのメソッドを呼び出してサーバ機能を実現しています.
以上、flaskの基本的なサーバの実装として、SSL、socketの多重化、サーバの再ロードなど、簡単なサーバに多くの機能を追加する方法が見られます.次にreloaderとSSLの実装です.