免费注册 查看新帖 |

Chinaunix

  平台 论坛 博客 文库
最近访问板块 发新帖
查看: 6621 | 回复: 4

[译]Python Bottle框架文档 [复制链接]

论坛徽章:
0
发表于 2009-09-21 16:05 |显示全部楼层
Bottle是一个小巧的Python Web开放框架,源码只有一个文件,约34K,不到1000行。

这是本人第一次翻译,不好之处请勿调戏。

排版不喜欢的可以查看

百度博客:http://hi.baidu.com/smallfish_xy/blog/item/ff0f184596524288b3b7dc20.html

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

Bottle文档这份文档会不断更新. 如果在文档里没有找到答案,请在版本跟踪中提出issue.
译者: smallfish <smallfish.xy@gmail.com>
原文: http://bottle.paws.de/page/docs
基本映射映射使用在根据不同URLs请求来产生相对应的返回内容.Bottle使用route() 修饰器来实现映射.
1
2
3
4
5            
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请求方法.
1
2
3
4
5
6            
from bottle import route, request
@route('/form/submit', method='POST')
def form_submit():
    form_data = request.POST
    do_something(form_data)
    return "Done"            
            
动态映射你可以提取URL的部分来建立动态变量名的映射.
1
2
3            
@route('/hello/:name')
def hello(name):
    return "Hello %s!" % name            
            
默认情况下, 一个:placeholder会一直匹配到下一个斜线.需要修改的话,可以把正则字符加入到#s之间:
1
2
3            
@route('/get_object/:id#[0-9]+#')
def get(id):
    return "Object ID: %d" % int(id)            
            
或者使用完整的正则匹配组来实现:
1
2
3            
@route('/get_object/(?P<id>[0-9]+)')
def get(id):
    return "Object ID: %d" % int(id)            
            
正如你看到的,URL参数仍然是字符串, 即使你正则里面是数字.你必须显式的进行类型强制转换.
@validate() 装饰器Bottle 提供一个方便的装饰器validate() 来校验多个参数.它可以通过关键字和过滤器来对每一个URL参数进行处理然后返回请求.
1
2
3
4
5
6            
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.
返回文件流和JSONWSGI规范不能处理文件对象或字符串.Bottle自动转换字符串类型为iter对象.下面的例子可以在Bottle下运行, 但是不能运行在纯WSGI环境下.
1
2
3
4
5
6            
@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.
1
2
3            
@route('/api/status')
def api_status():
    return {'status':'online', 'servertime':time.time()}            
            
你可以关闭这个特性:bottle.default_app().autojson = False
CookiesBottle是把cookie存储在request.COOKIES变量中.新建cookie的方法是response.set_cookie(name, value[, **params]). 它可以接受额外的参数,属于SimpleCookie的有有效参数.
1
2            
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.
1
2
3            
from bottle import response
response.COOKIES['key'] = 'value'
response.COOKIES['key']['max-age'] = 500            
            
模板Bottle使用自带的小巧的模板.你可以使用调用template(template_name, **template_arguments)并返回结果.
1
2
3            
@route('/hello/:name')
def hello(name):
    return template('hello_template', username=name)            
            
这样就会加载hello_template.tpl,并提取URL:name到变量username,返回请求.
hello_template.tpl大致这样:
1
2            
<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:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20            
%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
1
2
3
4
5
6
7            
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()去包装应用,而不是使用默认的.
            1
2
3
4            
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()实例.
1
2
3
4
5
6            
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并使用相应的适配器.
1
2            
from bottle import PasteServer, FlupServer, FapwsServer, CherryPyServer
bottle.run(server=PasteServer) # Example            
            
如果缺少你喜欢的服务器和适配器,你可以手动修改HTTP服务器并设置bottle.default_app()来访问你的WSGI应用.
1
2
3
4            
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服务器同样可以做的很好.
不久我会加入lighttpdApache使用.
Apache mod_wsgi发布你的应用当然不是用Bottle自带的方法,你可以再Apache server使用 mod_wsgi模板和Bottles WSGI接口.
你需要建立app.wsgi文件并提供 application对象.这个对象是用使用mod_wsgi启动你的程序并遵循WSGI规范可调用.
1
2
3
4
5
6            
# /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配置可能如下:
1
2
3
4
5
6
7
8
9
10
11
12
13            
<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                        
1
2
3
4
5
6            
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 于 2009-9-24 08:26 编辑 ]

论坛徽章:
0
发表于 2009-09-22 10:37 |显示全部楼层
谢谢,看看

论坛徽章:
0
发表于 2009-09-23 14:31 |显示全部楼层
虽然不做web开发,但是仍然要顶!谢谢分享

论坛徽章:
0
发表于 2009-09-23 17:18 |显示全部楼层
我试了下还不错,感觉概念比较少容易接受。比django有些东西清晰的多。

论坛徽章:
0
发表于 2009-09-24 08:23 |显示全部楼层
原帖由 t6760915 于 2009-9-23 17:18 发表
我试了下还不错,感觉概念比较少容易接受。比django有些东西清晰的多。

恩,确实比较简单。个人觉得还是可以学习下,看下源码。
因为功能比较单一容易掌握。
您需要登录后才可以回帖 登录 | 注册

本版积分规则 发表回复

SACC2019中国系统架构师大会

【数字转型 架构演进】SACC2019中国系统架构师大会,8.5折限时优惠重磅来袭!
2019年10月31日~11月2日第11届中国系统架构师大会(SACC2019)将在北京隆重召开。四大主线并行的演讲模式,1个主会场、20个技术专场、超千人参与的会议规模,100+来自互联网、金融、制造业、电商等领域的嘉宾阵容,将为广大参会者提供一场最具价值的技术交流盛会。

限时8.5折扣期:2019年9月30日前


----------------------------------------

大会官网>>
  

北京盛拓优讯信息技术有限公司. 版权所有 16024965号-6 北京市公安局海淀分局网监中心备案编号:11010802020122
中国互联网协会会员  联系我们:huangweiwei@it168.com
感谢所有关心和支持过ChinaUnix的朋友们 转载本站内容请注明原作者名及出处

清除 Cookies - ChinaUnix - Archiver - WAP - TOP