歡迎光臨
每天分享高質量文章

用 Python 寫一個簡單的Web框架

(點擊上方快速關註並設置為星標,一起學Python)

來源:RussellLuo 

www.cnblogs.com/russellluo/p/3338616.html

 

  • 一、概述
  • 二、從demo_app開始
  • 三、WSGI中的application
  • 四、區分URL
  • 五、重構
    • 1、正則匹配URL
    • 2、DRY
    • 3、抽象出框架
  • 六、參考

     

 

 

一、概述

 

在Python中,WSGI(Web Server Gateway Interface)定義了Web服務器與Web應用(或Web框架)之間的標準接口。在WSGI的規範下,各種各樣的Web服務器和Web框架都可以很好的交互。

 

由於WSGI的存在,用Python寫一個簡單的Web框架也變得非常容易。然而,同很多其他的強大軟體一樣,要實現一個功能豐富、健壯高效的Web框架並非易事;如果您打算這麼做,可能使用一個現成的Web框架(如 Django、Tornado、web.py 等)會是更合適的選擇。

 

本文嘗試寫一個類似web.py的Web框架。好吧,我承認我誇大其辭了:首先,web.py並不簡單;其次,本文只重點實現了 URL調度(URL dispatch)部分。

 

二、從demo_app開始

 

首先,作為一個初步體驗,我們可以借助 wsgiref.simple_server 來搭建一個簡單無比(trivial)的Web應用:

#!/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()

運行腳本:

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

打開瀏覽器,輸入http://0.0.0.0:8086/後可以看到:一行”Hello world!” 和 眾多環境變數值。

 

三、WSGI中的application

 

WSGI中規定:application是一個 可呼叫物件(callable object),它接受 environ 和 start_response 兩個引數,並傳回一個 字串迭代物件。

 

其中,可呼叫物件 包括 函式、方法、類 或者 具有__call__方法的 實體;environ 是一個字典物件,包括CGI風格的環境變數(CGI-style environment variables)和 WSGI必需的變數(WSGI-required variables);start_response 是一個可呼叫物件,它接受兩個 常規引數(status,response_essay-headers)和 一個 預設引數(exc_info);字串迭代物件 可以是 字串串列、生成器函式 或者 具有__iter__方法的可迭代實體。更多細節參考 Specification Details。

 

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

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

"""application.py"""

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

現在用simple_app來替換demo_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!

 

四、區分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_essay-headers = [('Content-type', 'text/plain')]
        self.start(status, response_essay-headers)
        yield "Hello world! "

然後,增加對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_essay-headers = [('Content-type', 'text/plain')]
        self.start(status, response_essay-headers)
        yield "Welcome! "

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

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

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

 

五、重構

 

上面的代碼雖然奏效,但是在編碼風格和靈活性方面有很多問題,下麵逐步對其進行重構。

 

1、正則匹配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_essay-headers = [('Content-type', 'text/plain')]
        self.start(status, response_essay-headers)
        yield "Welcome! "

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

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

2、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._essay-headers = []

    def __iter__(self): ##########修改點
        result = self.delegate()
        self.start(self.status, self._essay-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 essay-header(self, name, value): ##########修改點
        self._essay-headers.append((name, value))

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

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

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

3、抽象出框架

 

為了將類my_app抽象成一個獨立的框架,需要作出以下修改:

 

  • 剝離出其中的具體處理細節:urls配置 和 GET_*方法(改成在多個類中實現相應的GET方法)
  • 把方法essay-header實現為類方法(classmethod),以方便外部作為功能函式呼叫
  • 改用 具有__call__方法的 實體 來實現application

 

修改後的application.py(最終版本):

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

"""application.py"""

import re

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

    essay-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.essay-headers[:] # 清空上一次的essay-headers

        result = self._delegate(environ)
        start_response(self._status, self.essay-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.essay-header('Content-type', 'text/plain')
        return "Not Found "

    @classmethod
    def essay-header(cls, name, value):
        cls.essay-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.essay-header('Content-type', 'text/plain')
        return "Welcome! "

class hello:
    def GET(self, name):
        my_app.essay-header('Content-type', 'text/plain')
        return "Hello %s! " % 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映射,並實現相應的類來對請求作出響應。

 

六、參考

 

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

 

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

赞(0)

分享創造快樂