Python的Bottle框架基本知识总结
基本映射
映射使用在根据不同URLs请求来产生相对应的返回内容.Bottle使用route()修饰器来实现映射.
frombottleimportroute,run
@route('/hello')
defhello():
return"HelloWorld!"
run()#ThisstartstheHTTPserver
运行这个程序,访问http://localhost:8080/hello将会在浏览器里看到"HelloWorld!".
GET,POST,HEAD,...
这个射装饰器有可选的关键字method默认是method='GET'.还有可能是POST,PUT,DELETE,HEAD或者监听其他的HTTP请求方法.
frombottleimportroute,request
@route('/form/submit',method='POST')
defform_submit():
form_data=request.POST
do_something(form_data)
return"Done"
动态映射
你可以提取URL的部分来建立动态变量名的映射.
@route('/hello/:name')
defhello(name):
return"Hello%s!"%name
默认情况下,一个:placeholder会一直匹配到下一个斜线.需要修改的话,可以把正则字符加入到#s之间:
@route('/get_object/:id#[0-9]+#')
defget(id):
return"ObjectID:%d"%int(id)
或者使用完整的正则匹配组来实现:
@route('/get_object/(?P<id>[0-9]+)')
defget(id):
return"ObjectID:%d"%int(id)
正如你看到的,URL参数仍然是字符串,即使你正则里面是数字.你必须显式的进行类型强制转换.
@validate()装饰器
Bottle提供一个方便的装饰器validate()来校验多个参数.它可以通过关键字和过滤器来对每一个URL参数进行处理然后返回请求.
frombottleimportroute,validate
#/test/validate/1/2.3/4,5,6,7
@route('/test/validate/:i/:f/:csv')
@validate(i=int,f=float,csv=lambdax:map(int,x.split(',')))
defvalidate_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')
defget_string():
return"Thisisnotalistofstrings,butasinglestring"
@route('/file')
defget_file():
returnopen('some/file.txt','r')
字典类型也是允许的.会转换成json格式,自动返回Content-Type:application/json.
@route('/api/status')
defapi_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的有有效参数.
frombottleimportresponse
response.set_cookie('key','value',path='/',domain='example.com',secure=True,expires=+500,...)
设置max-age属性(它不是个有效的Python参数名)你可以在实例中修改cookie.SimpleCookieinresponse.COOKIES.
frombottleimportresponse response.COOKIES['key']='value' response.COOKIES['key']['max-age']=500
模板
Bottle使用自带的小巧的模板.你可以使用调用template(template_name,**template_arguments)并返回结果.
@route('/hello/:name')
defhello(name):
returntemplate('hello_template',username=name)
这样就会加载hello_template.tpl,并提取URL:name到变量username,返回请求.
hello_template.tpl大致这样:
<h1>Hello{{username}}</h1>
<p>Howareyou?</p>
模板搜索路径
模板是根据bottle.TEMPLATE_PATH列表变量去搜索.默认路径包含['./%s.tpl','./views/%s.tpl'].
模板缓存
模板在编译后在内存中缓存.修改模板不会更新缓存,直到你清除缓存.调用bottle.TEMPLATES.clear().
模板语法
模板语法是围绕Python很薄的一层.主要目的就是确保正确的缩进块.下面是一些模板语法的列子:
- %...Python代码开始.不必处理缩进问题.Bottle会为你做这些.
- %end关闭一些语句%if...,%for...或者其他.关闭块是必须的.
- {{...}}打印出Python语句的结果.
- %includetemplate_nameoptional_arguments包括其他模板.
- 每一行返回为文本.
Example:
%header='TestTemplate'
%items=[1,2,3,'fly']
%includehttp_headertitle=header,use_js=['jquery.js','default.js']
<h1>{{header.title()}}</h1>
<ul>
%foriteminitems:
<li>
%ifisinstance(item,int):
Zahl:{{item}}
%else:
%try:
Othertype:({{type(item).__name__}}){{repr(item)}}
%except:
Error:Itemhasnostringrepresentation.
%endtry-block(yes,youmayaddcommentshere)
%end
</li>
%end
</ul>
%includehttp_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()andvalues()这些方法.找不到将会抛出KeyError.
持久化
对于请求,所有变化都是缓存在本地内存池中.在请求结束时,自动保存已修改部分,以便下一次请求返回更新的值.数据存储在bottle.DB_PATH文件里.要确保文件能访问此文件.
Raceconditions
一般来说不需要考虑锁问题,但是在多线程或者交叉环境里仍是个问题.你可以调用bottle.db.save()或者botle.db.bucket_name.save()去刷新缓存,但是没有办法检测到其他环境对数据库的操作,直到调用bottle.db.save()或者离开当前请求.
Example
frombottleimportdefault_app,run app=default_app() newapp=YourMiddleware(app) run(app=newapp)
frombottleimportroute,db
@route('/db/counter')
defdb_counter():
if'hits'notindb.counter:
db.counter.hits=0
db['counter']['hits']+=1
return"Totalhits:%d!"%db.counter.hits
使用WSGI和中间件
bottle.default_app()返回一个WSGI应用.如果喜欢WSGI中间件模块的话,你只需要声明bottle.run()去包装应用,而不是使用默认的.
默认default_app()工作
Bottle创建一个bottle.Bottle()对象和装饰器,调用bottle.run()运行.bottle.default_app()是默认.当然你可以创建自己的bottle.Bottle()实例.
frombottleimportBottle,run
mybottle=Bottle()
@mybottle.route('/')
defindex():
return'default_app'
run(app=mybottle)
发布
Bottle默认使用wsgiref.SimpleServer发布.这个默认单线程服务器是用来早期开发和测试,但是后期可能会成为性能瓶颈.
有三种方法可以去修改:
- 使用多线程的适配器
- 负载多个Bottle实例应用
- 或者两者
多线程服务器
最简单的方法是安装一个多线程和WSGI规范的HTTP服务器比如Paste,flup,cherrypyorfapws3并使用相应的适配器.
frombottleimportPasteServer,FlupServer,FapwsServer,CherryPyServer bottle.run(server=PasteServer)#Example
如果缺少你喜欢的服务器和适配器,你可以手动修改HTTP服务器并设置bottle.default_app()来访问你的WSGI应用.
defrun_custom_paste_server(self,host,port): myapp=bottle.default_app() frompasteimporthttpserver 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使用.
Apachemod_wsgi
发布你的应用当然不是用Bottle自带的方法,你可以再Apacheserver使用mod_wsgi模板和BottlesWSGI接口.
你需要建立app.wsgi文件并提供application对象.这个对象是用使用mod_wsgi启动你的程序并遵循WSGI规范可调用.
#/var/www/yourapp/app.wsgi importbottle #...addorimportyourbottleappcodehere... #importmyapp application=bottle.default_app() #DoNOTusebottle.run()withmod_wsgi
Apache配置可能如下:
<VirtualHost*>
ServerNameexample.com
WSGIDaemonProcessyourappuser=www-datagroup=www-dataprocesses=1threads=5
WSGIScriptAlias//var/www/yourapp/app.wsgi
<Directory/var/www/yourapp>
WSGIProcessGroupyourapp
WSGIApplicationGroup%{GLOBAL}
Orderdeny,allow
Allowfromall
</Directory>
</VirtualHost>
GoogleAppEngine
importbottle fromgoogle.appengine.ext.webappimportutil #...addorimportyourbottleappcodehere... #importmyapp #DoNOTusebottle.run()withAppEngine util.run_wsgi_app(bottle.default_app())
CGI模式
运行缓缓,但可以正常工作.
importbottle #...addorimportyourbottleappcodehere... bottle.run(server=bottle.CGIServer)