猎鹰分页助手
falcon-pagination的Python项目详细描述
一个小的falcon钩子来解析请求中的分页元素。
目前,它解析基于偏移量的分页。
用法
使用此挂钩的最简单方法如下:
@falcon.before(PaginationFromRequestHook())defon_get(self,req,resp,user):# Here req['context']['pagination'] is set# with 2 keys: 'offset' and 'limit'
钩子将在查询参数中查找2个键:
- 偏移量:分页偏移量
- 限制:分页限制
它将创建一个分页dict到可在req.context['pagination']
访问的请求上下文中。
此分页dict将包含2个值:
- 限制:要应用的限制。如果没有找到限制,则应用默认限制(20)。如果该值大于最大值(100),则也将应用默认限制。
配置选项
可以将一些参数传递给钩子:
- default_limit:如果在请求查询中找不到任何限制或限制超出范围,则应用的限制。默认为20
- offset_key:保存偏移值的请求参数的名称。默认为“偏移”
- limit_key:保存限制值的请求参数的名称。默认为“限制”
这里设置了一个缺省限制为10,最大限制为500,偏移键为“PaqOxOffice”和“ReultStimeLime:”的限制键:
@falcon.before(PaginationFromRequestHook(default_limit=10,max_limit=500,offset_key='page_offset',limit_key='result_limit'))defon_get(self,req,resp,user):# Get request