用Python寫一個簡單的Web框架

時間  2019-12-07
標籤 python 一個 簡單 web 框架 欄目 Python 简体版
原文   原文鏈接

1、概述

在Python中，WSGI（Web Server Gateway Interface）定義了Web服務器與Web應用（或Web框架）之間的標準接口。在WSGI的規範下，各類各樣的Web服務器和Web框架均可以很好的交互。html

因爲WSGI的存在，用Python寫一個簡單的Web框架也變得很是容易。然而，同不少其餘的強大軟件同樣，要實現一個功能豐富、健壯高效的Web框架並不是易事；若是您打算這麼作，可能使用一個現成的Web框架（如 Django、Tornado、web.py 等）會是更合適的選擇。python

本文嘗試寫一個相似web.py的Web框架。好吧，我認可我誇大其辭了：首先，web.py並不簡單；其次，本文只重點實現了 URL調度（URL dispatch）部分。git

2、從demo_app開始

首先，做爲一個初步體驗，咱們能夠藉助 wsgiref.simple_server 來搭建一個簡單無比（trivial）的Web應用：github

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from wsgiref.simple_server import make_server, demo_app

httpd = make_server('', 8086, demo_app)
sa = httpd.socket.getsockname()
print 'http://{0}:{1}/'.format(*sa)

# Respond to requests until process is killed
httpd.serve_forever()

運行腳本：web

$ python code.py
http://0.0.0.0:8086/

打開瀏覽器，輸入http://0.0.0.0:8086/後能夠看到：一行"Hello world!" 和 衆多環境變量值。django

3、WSGI中的application

WSGI中規定：application是一個 可調用對象（callable object），它接受 environ 和 start_response 兩個參數，並返回一個 字符串迭代對象。瀏覽器

其中，可調用對象 包括 函數、方法、類 或者 具備__call__方法的 實例；environ 是一個字典對象，包括CGI風格的環境變量（CGI-style environment variables）和 WSGI必需的變量（WSGI-required variables）；start_response 是一個可調用對象，它接受兩個 常規參數（status，response_headers）和 一個 默認參數（exc_info）；字符串迭代對象 能夠是 字符串列表、生成器函數 或者 具備__iter__方法的可迭代實例。更多細節參考 Specification Details。服務器

The Application/Framework Side 中給出了一個典型的application實現：markdown

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""application.py"""

def simple_app(environ, start_response):
    """Simplest possible application object"""
    status = '200 OK'
    response_headers = [('Content-type', 'text/plain')]
    start_response(status, response_headers)
    return ['Hello world!\n']

如今用simple_app來替換demo_app：app

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""code.py"""

from wsgiref.simple_server import make_server
from application import simple_app as app

if __name__ == '__main__':
    httpd = make_server('', 8086, app)
    sa = httpd.socket.getsockname()
    print 'http://{0}:{1}/'.format(*sa)

    # Respond to requests until process is killed
    httpd.serve_forever()

運行腳本code.py後，訪問http://0.0.0.0:8086/就能夠看到那行熟悉的句子：Hello world!

4、區分URL

倒騰了一陣子後，您會發現無論如何改變URL中的path部分，獲得的響應都是同樣的。由於simple_app只識別host+port部分。

爲了對URL中的path部分進行區分處理，須要修改application.py的實現。

首先，改用 類 來實現application：

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""application.py"""

class my_app:
    def __init__(self, environ, start_response):
        self.environ = environ
        self.start = start_response

    def __iter__(self):
        status = '200 OK'
        response_headers = [('Content-type', 'text/plain')]
        self.start(status, response_headers)
        yield "Hello world!\n"

而後，增長對URL中path部分的區分處理：

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""application.py"""

class my_app:
    def __init__(self, environ, start_response):
        self.environ = environ
        self.start = start_response

    def __iter__(self):
        path = self.environ['PATH_INFO']
        if path == "/":
            return self.GET_index()
        elif path == "/hello":
            return self.GET_hello()
        else:
            return self.notfound()

    def GET_index(self):
        status = '200 OK'
        response_headers = [('Content-type', 'text/plain')]
        self.start(status, response_headers)
        yield "Welcome!\n"

    def GET_hello(self):
        status = '200 OK'
        response_headers = [('Content-type', 'text/plain')]
        self.start(status, response_headers)
        yield "Hello world!\n"

    def notfound(self):
        status = '404 Not Found'
        response_headers = [('Content-type', 'text/plain')]
        self.start(status, response_headers)
        yield "Not Found\n"

修改code.py中的from application import simple_app as app，用my_app來替換simple_app後便可體驗效果。

5、重構

上面的代碼雖然奏效，可是在編碼風格和靈活性方面有不少問題，下面逐步對其進行重構。

一、正則匹配URL

消除URL硬編碼，增長URL調度的靈活性：

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""application.py"""

import re ##########修改點

class my_app:

    urls = (
        ("/", "index"),
        ("/hello/(.*)", "hello"),
    ) ##########修改點

    def __init__(self, environ, start_response):
        self.environ = environ
        self.start = start_response

    def __iter__(self): ##########修改點
        path = self.environ['PATH_INFO']
        method = self.environ['REQUEST_METHOD']

        for pattern, name in self.urls:
            m = re.match('^' + pattern + '$', path)
            if m:
                # pass the matched groups as arguments to the function
                args = m.groups()
                funcname = method.upper() + '_' + name
                if hasattr(self, funcname):
                    func = getattr(self, funcname)
                    return func(*args)

        return self.notfound()

    def GET_index(self):
        status = '200 OK'
        response_headers = [('Content-type', 'text/plain')]
        self.start(status, response_headers)
        yield "Welcome!\n"

    def GET_hello(self, name): ##########修改點
        status = '200 OK'
        response_headers = [('Content-type', 'text/plain')]
        self.start(status, response_headers)
        yield "Hello %s!\n" % name

    def notfound(self):
        status = '404 Not Found'
        response_headers = [('Content-type', 'text/plain')]
        self.start(status, response_headers)
        yield "Not Found\n"

二、DRY

消除GET_*方法中的重複代碼，而且容許它們返回字符串：

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""application.py"""

import re

class my_app:

    urls = (
        ("/", "index"),
        ("/hello/(.*)", "hello"),
    )

    def __init__(self, environ, start_response): ##########修改點
        self.environ = environ
        self.start = start_response
        self.status = '200 OK'
        self._headers = []

    def __iter__(self): ##########修改點
        result = self.delegate()
        self.start(self.status, self._headers)

        # 將返回值result（字符串 或者 字符串列表）轉換爲迭代對象
        if isinstance(result, basestring):
            return iter([result])
        else:
            return iter(result)

    def delegate(self): ##########修改點
        path = self.environ['PATH_INFO']
        method = self.environ['REQUEST_METHOD']

        for pattern, name in self.urls:
            m = re.match('^' + pattern + '$', path)
            if m:
                # pass the matched groups as arguments to the function
                args = m.groups()
                funcname = method.upper() + '_' + name
                if hasattr(self, funcname):
                    func = getattr(self, funcname)
                    return func(*args)

        return self.notfound()

    def header(self, name, value): ##########修改點
        self._headers.append((name, value))

    def GET_index(self): ##########修改點
        self.header('Content-type', 'text/plain')
        return "Welcome!\n"

    def GET_hello(self, name): ##########修改點
        self.header('Content-type', 'text/plain')
        return "Hello %s!\n" % name

    def notfound(self): ##########修改點
        self.status = '404 Not Found'
        self.header('Content-type', 'text/plain')
        return "Not Found\n"

三、抽象出框架

爲了將類my_app抽象成一個獨立的框架，須要做出如下修改：

  • 剝離出其中的具體處理細節：urls配置 和 GET_*方法（改爲在多個類中實現相應的GET方法）
  • 把方法header實現爲類方法（classmethod），以方便外部做爲功能函數調用
  • 改用 具備__call__方法的 實例 來實現application

修改後的application.py（最終版本）：

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""application.py"""

import re

class my_app:
    """my simple web framework"""

    headers = []

    def __init__(self, urls=(), fvars={}):
        self._urls = urls
        self._fvars = fvars

    def __call__(self, environ, start_response):
        self._status = '200 OK' # 默認狀態OK
        del self.headers[:] # 清空上一次的headers

        result = self._delegate(environ)
        start_response(self._status, self.headers)

        # 將返回值result（字符串 或者 字符串列表）轉換爲迭代對象
        if isinstance(result, basestring):
            return iter([result])
        else:
            return iter(result)

    def _delegate(self, environ):
        path = environ['PATH_INFO']
        method = environ['REQUEST_METHOD']

        for pattern, name in self._urls:
            m = re.match('^' + pattern + '$', path)
            if m:
                # pass the matched groups as arguments to the function
                args = m.groups()
                funcname = method.upper() # 方法名大寫（如GET、POST）
                klass = self._fvars.get(name) # 根據字符串名稱查找類對象
                if hasattr(klass, funcname):
                    func = getattr(klass, funcname)
                    return func(klass(), *args)

        return self._notfound()

    def _notfound(self):
        self._status = '404 Not Found'
        self.header('Content-type', 'text/plain')
        return "Not Found\n"

    @classmethod
    def header(cls, name, value):
        cls.headers.append((name, value))

對應修改後的code.py（最終版本）：

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""code.py"""

from application import my_app

urls = (
    ("/", "index"),
    ("/hello/(.*)", "hello"),
)

wsgiapp = my_app(urls, globals())

class index:
    def GET(self):
        my_app.header('Content-type', 'text/plain')
        return "Welcome!\n"

class hello:
    def GET(self, name):
        my_app.header('Content-type', 'text/plain')
        return "Hello %s!\n" % name

if __name__ == '__main__':
    from wsgiref.simple_server import make_server
    httpd = make_server('', 8086, wsgiapp)

    sa = httpd.socket.getsockname()
    print 'http://{0}:{1}/'.format(*sa)

    # Respond to requests until process is killed
    httpd.serve_forever()

固然，您還能夠在code.py中配置更多的URL映射，並實現相應的類來對請求做出響應。

6、參考

本文主要參考了 How to write a web framework in Python（做者 anandology 是web.py代碼的兩位維護者之一，另外一位則是大名鼎鼎卻英年早逝的 Aaron Swartz），在此基礎上做了一些調整和修改，並摻雜了本身的一些想法。

若是您還以爲意猶未盡，Why so many Python web frameworks? 也是一篇很好的文章，也許它會讓您對Python中Web框架的敬畏之心蕩然無存:-)

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程