[譯]Python Bottle框架文檔

Bottle是一個小巧的Python Web開放框架，源碼只有一個文件，約34K，不到1000行。

這是本人第一次翻譯，不好之處請勿調戲。

最新文檔地址：http://pynotes.appspot.com/static/bottle/docs.htm

這份文檔會不斷更新. 如果在文檔裏沒有找到答案,請在版本跟蹤中提出issue .

基本映射

映射使用在根據不同URLs請求來產生相對應的返回內容.Bottle使用route() 修飾器來實現映射.

from bottle import route, run

@route('/hello')

def hello():

    return "Hello World!"

run() # This starts the HTTP server

運行這個程序,訪問http://localhost:8080/hello 將會在瀏覽器裏看到 "Hello World!".

GET, POST, HEAD, ...

這個映射裝飾器有可選的關鍵字method 默認是method='GET' . 還有可能是POST ,PUT ,DELETE ,HEAD 或者監聽其他的HTTP請求方法.

from bottle import route, request

@route('/form/submit', method='POST')

def form_submit():

    form_data = request.POST

    do_something(form_data)

    return "Done"

動態映射

你可以提取URL的部分來建立動態變量名的映射.

@route('/hello/:name')

def hello(name):

    return "Hello %s!" % name

默認情況下, 一個:placeholder 會一直匹配到下一個斜線.需要修改的話,可以把正則字符加入到# s之間:

@route('/get_object/:id#[0-9]+#')

def get(id):

    return "Object ID: %d" % int(id)

或者使用完整的正則匹配組來實現:

@route('/get_object/(?P<id>[0-9]+)')

def get(id):

    return "Object ID: %d" % int(id)

正如你看到的,URL參數仍然是字符串, 即使你正則裏面是數字.你必須顯式的進行類型強制轉換.

@validate() 裝飾器

Bottle 提供一個方便的裝飾器validate() 來校驗多個參數.它可以通過關鍵字和過濾器來對每一個URL參數進行處理然後返回請求.

from bottle import route, validate

# /test/validate/1/2.3/4,5,6,7

@route('/test/validate/:i/:f/:csv')

@validate(i=int, f=float, csv=lambda x: map(int, x.split(',')))

def validate_test(i, f, csv):

    return "Int: %d, Float:%f, List:%s" % (i, f, repr(csv))

你可能需要在校驗參數失敗時拋出ValueError .

返回文件流和JSON

WSGI規範不能處理文件對象或字符串.Bottle自動轉換字符串類型爲iter對象.下面的例子可以在Bottle下運行, 但是不能運行在純WSGI環境下.

@route('/get_string')

def get_string():

    return "This is not a list of strings, but a single string"

@route('/file')

def get_file():

    return open('some/file.txt','r')

字典類型也是允許的.會轉換成json 格式,自動返回Content-Type: application/json .

@route('/api/status')

def api_status():

    return {'status':'online', 'servertime':time.time()}

你可以關閉這個特性:bottle.default_app().autojson = False

Cookies

Bottle是把cookie存儲在request.COOKIES 變量中.新建cookie的方法是response.set_cookie(name, value[, **params]) . 它可以接受額外的參數,屬於SimpleCookie 的有有效參數.

from bottle import response

response.set_cookie('key','value', path='/', domain='example.com', secure=True, expires=+500, ...)

設置max-age 屬性(它不是個有效的Python參數名) 你可以在實例中修改 cookie.SimpleCookie in response.COOKIES .

from bottle import response

response.COOKIES['key'] = 'value'

response.COOKIES['key']['max-age'] = 500

模板

Bottle使用自帶的小巧的模板.你可以使用調用template(template_name, **template_arguments) 並返回結果.

@route('/hello/:name')

def hello(name):

    return template('hello_template', username=name)

這樣就會加載hello_template.tpl ,並提取URL:name 到變量username ,返回請求.

hello_template.tpl 大致這樣:

<h1>Hello {{username}}</h1>

<p>How are you?</p>

模板搜索路徑

模板是根據bottle.TEMPLATE_PATH 列表變量去搜索.默認路徑包含['./%s.tpl', './views/%s.tpl'] .

模板緩存

模板在編譯後在內存中緩存.修改模板不會更新緩存,直到你清楚緩存.調用bottle.TEMPLATES.clear() .

模板語法

模板語法是圍繞Python很薄的一層.主要目的就是確保正確的縮進塊.下面是一些模板語法的列子:

%... Python代碼開始.不必處理縮進問題.Bottle會爲你做這些.
%end 關閉一些語句%if ... ,%for ... 或者其他.關閉塊是必須的.
{{...}} 打印出Python語句的結果.
%include template_name optional_arguments 包括其他模板.
每一行返回爲文本.

Example:

%header = 'Test Template'

%items = [1,2,3,'fly']

%include http_header title=header, use_js=['jquery.js', 'default.js']

<h1>{{header.title()}}</h1>

<ul>

%for item in items:

  <li>

    %if isinstance(item, int):

      Zahl: {{item}}

    %else:

      %try:

        Other type: ({{type(item).__name__}}) {{repr(item)}}

      %except:

        Error: Item has no string representation.

      %end try-block (yes, you may add comments here)

    %end

    </li>

  %end

</ul>

%include http_footer

Key/Value數據庫

Bottle(>0.4.6)通過bottle.db 模塊變量提供一個key/value數據庫.你可以使用key或者屬性來來存取一個數據庫對象.調用 bottle.db.bucket_name.key_name 和bottle.db[bucket_name][key_name] .

只要確保使用正確的名字就可以使用,而不管他們是否已經存在.

存儲的對象類似dict字典, keys和values必須是字符串.不支持 items() and values() 這些方法.找不到將會拋出KeyError .

持久化

對於請求,所有變化都是緩存在本地內存池中. 在請求結束時,自動保存已修改部分,以便下一次請求返回更新的值.數據存儲在bottle.DB_PATH 文件裏.要確保文件能訪問此文件.

Race conditions

一般來說不需要考慮鎖問題,但是在多線程或者交叉環境裏仍是個問題.你可以調用 bottle.db.save() 或者botle.db.bucket_name.save() 去刷新緩存,但是沒有辦法檢測到其他環境對數據庫的操作,直到調用bottle.db.save() 或者離開當前請求.

Example

from bottle import route, db

@route('/db/counter')

def db_counter():

    if 'hits' not in db.counter:

        db.counter.hits = 0

    db['counter']['hits'] += 1

    return "Total hits: %d!" % db.counter.hits

使用WSGI和中間件

bottle.default_app() 返回一個WSGI應用.如果喜歡WSGI中間件模塊的話,你只需要聲明bottle.run() 去包裝應用,而不是使用默認的.

from bottle import default_app, run

app = default_app()

newapp = YourMiddleware(app)

run(app=newapp)

默認default_app()工作

Bottle創建一個bottle.Bottle() 對象和裝飾器,調用bottle.run() 運行. bottle.default_app() 是默認.當然你可以創建自己的bottle.Bottle() 實例.

from bottle import Bottle, run

mybottle = Bottle()

@mybottle.route('/')

def index():

  return 'default_app'

run(app=mybottle)

發佈

Bottle默認使用wsgiref.SimpleServer 發佈.這個默認單線程服務器是用來早期開發和測試,但是後期可能會成爲性能瓶頸.

有三種方法可以去修改:

使用多線程的適配器
負載多個Bottle實例應用
或者兩者

多線程服務器

最簡單的方法是安裝一個多線程和WSGI規範的HTTP服務器比如Paste , flup , cherrypy or fapws3 並使用相應的適配器.

from bottle import PasteServer, FlupServer, FapwsServer, CherryPyServer

bottle.run(server=PasteServer) # Example

如果缺少你喜歡的服務器和適配器,你可以手動修改HTTP服務器並設置bottle.default_app() 來訪問你的WSGI應用.

def run_custom_paste_server(self, host, port):

    myapp = bottle.default_app()

    from paste import httpserver

    httpserver.serve(myapp, host=host, port=port)

多服務器進程

一個Python程序只能使用一次一個CPU,即使有更多的CPU.關鍵是要利用CPU資源來負載平衡多個獨立的Python程序.

單實例Bottle應用,你可以通過不同的端口來啓動(localhost:8080, 8081, 8082, ...).高性能負載作爲反向代理和遠期每一個隨機瓶進程的新要求，平衡器的行爲，傳播所有可用的支持與服務器實例的負載.這樣，您就可以使用所有的 CPU核心，甚至分散在不同的物理服務器之間的負載。.

但也有點缺點:

多個Python進程裏不能共享數據.
同一時間可能需要大量內存來運行Python和Bottle應用和副本.

最快的一個負載是pound 當然其他一些HTTP服務器同樣可以做的很好.

不久我會加入lighttpd 和Apache 使用.

Apache mod_wsgi

發佈你的應用當然不是用Bottle自帶的方法,你可以再Apache server 使用 mod_wsgi 模板和Bottles WSGI接口.

你需要建立app.wsgi 文件並提供 application 對象.這個對象是用使用mod_wsgi啓動你的程序並遵循WSGI規範可調用.

# /var/www/yourapp/app.wsgi

import bottle

# ... add or import your bottle app code here ...

# import myapp

application = bottle.default_app()

# Do NOT use bottle.run() with mod_wsgi

Apache配置可能如下:

<VirtualHost *>

    ServerName example.com


    WSGIDaemonProcess yourapp user=www-data group=www-data processes=1 threads=5

    WSGIScriptAlias / /var/www/yourapp/app.wsgi


    <Directory /var/www/yourapp>

        WSGIProcessGroup yourapp

        WSGIApplicationGroup %{GLOBAL}

        Order deny,allow

        Allow from all

    </Directory>

</VirtualHost>

Google AppEngine

import bottle

from google.appengine.ext.webapp import util 

# ... add or import your bottle app code here ...

# import myapp

# Do NOT use bottle.run() with AppEngine

util.run_wsgi_app(bottle.default_app())

smallfish_xy

發佈了44 篇原創文章 · 獲贊 3 · 訪問量 5萬+

私信關注

[譯]Python Bottle框架文檔

Bottle是一個小巧的Python Web開放框架，源碼只有一個文件，約34K，不到1000行。

這是本人第一次翻譯，不好之處請勿調戲。

最新文檔地址：http://pynotes.appspot.com/static/bottle/docs.htm

基本映射

GET, POST, HEAD, ...

動態映射

@validate() 裝飾器

返回文件流和JSON

Cookies

模板

模板搜索路徑

模板緩存

模板語法

Key/Value數據庫

持久化

Race conditions

Example

使用WSGI和中間件

默認default_app()工作

發佈

多線程服務器

多服務器進程

Apache mod_wsgi

Google AppEngine

apache mod_perl實現 url rewrite

memcached java && python client api 共享

python 千分位輸出 1,233,232格式

pexpect通過ssh執行遠程命令

expect telnet 發送郵件

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

[譯]Python Bottle框架文檔

Bottle是一個小巧的Python Web開放框架，源碼只有一個文件，約34K，不到1000行。 這是本人第一次翻譯，不好之處請勿調戲。 最新文檔地址：http://pynotes.appspot.com/static/bottle/docs.htm

基本映射

GET, POST, HEAD, ...

動態映射

@validate() 裝飾器

返回文件流和JSON

Cookies

模板

模板搜索路徑

模板緩存

模板語法

Key/Value數據庫

持久化

Race conditions

Example

使用WSGI和中間件

默認default_app()工作

發佈

多線程服務器

多服務器進程

Apache mod_wsgi

Google AppEngine

Bottle是一個小巧的Python Web開放框架，源碼只有一個文件，約34K，不到1000行。

這是本人第一次翻譯，不好之處請勿調戲。

最新文檔地址：http://pynotes.appspot.com/static/bottle/docs.htm