lazr.batchnavigator 2.0.0

批导航提供了一种通过提供URL链接到结果的下页、上页和编号页来在网页中导航批处理结果的方法。

它使用四个查询/POST参数来控制分批。

• memo：批处理位置的底层存储索引指针的记录。

• direction：指示memo是否在批处理的开始或结束。

• start：外观 - 用于计算明显的位置（但请注意，由于批处理重复访问的并发性，实际偏移量可能不同 - 然而，集合不会跳过或显示项目两次。为了与保存的URL兼容，如果memo和direction都缺失，则使用start在集合中进行列表切片。

• batch：控制每个批处理显示的项目数量。如果它与创建批处理时设置的默认值不同，则将出现。

除非同时传递force_start=True，否则这些值可以在请求中覆盖，这将使start参数（再次，默认为0）始终被选中。

导入

>>> from lazr.batchnavigator import BatchNavigator, ListRangeFactory
>>> from zope.publisher.browser import TestRequest
>>> from zope.publisher.http import HTTPCharsets
>>> from zope.component import getSiteManager
>>> sm = getSiteManager()
>>> sm.registerAdapter(HTTPCharsets)

>>> def build_request(query_string_args=None, method='GET'):
...   if query_string_args is None:
...       query_string = ''
...   else:
...       if getattr(query_string_args, 'items', None) is not None:
...           query_string_args = query_string_args.items()
...       query_string = "&".join(
...           ["%s=%s" % (k,v) for k,v in query_string_args])
...   request = TestRequest(SERVER_URL='http://www.example.com/foo',
...                                  method=method,
...                                  environ={'QUERY_STRING': query_string})
...   request.processInputs()
...   return request

一个示例请求对象

一些示例数据。

>>> reindeer = ['Dasher', 'Dancer', 'Prancer', 'Vixen', 'Comet',
...             'Cupid', 'Donner', 'Blitzen', 'Rudolph']

由于切片大型集合可能非常昂贵，BatchNavigator提供了一种确定批处理边缘的非切片协议。range_factory提供实现了IRangeFactory的对象，并管理此协议。ListRangeFactory是一个简单的内置实现，如果没有提供range_factory，BatchNavigator将使用它。

>>> _ = BatchNavigator(reindeer, build_request(),
...     range_factory=ListRangeFactory(reindeer))

对于文档中的示例，我们让BatchNavigator隐式构建range_factory。

>>> safe_reindeer = reindeer
>>> safe_reindeer_batch_navigator = BatchNavigator(
...     safe_reindeer, build_request(), size=3)

lazr.batchnavigator的一个重要特性是它不倾向于对底层数据集调用len()。len()可能是一个昂贵的操作，提供的好处很少，因此此库将尽量不调用len()，除非绝对必要。为了展示这一点，我们将定义一个Python列表类型的子类，当调用len()时会崩溃。

>>> class ListWithExplosiveLen(list):
...     """A list subclass that doesn't like its len() being called."""
...     def __len__(self):
...         raise RuntimeError

除非另有说明，否则我们将在此测试中独家使用此列表，以验证len()只有在需要时才会调用。

>>> explosive_reindeer = ListWithExplosiveLen(reindeer)
>>> reindeer_batch_navigator = BatchNavigator(
...     explosive_reindeer, build_request(), size=3)

BatchNavigator实现了IBatchNavigator。我们需要在这里使用“安全”的批处理导航器，因为verifyObject调查传递给它的对象的所有方法，包括__len__。

>>> from zope.interface.verify import verifyObject
>>> from lazr.batchnavigator.interfaces import IBatchNavigator

>>> verifyObject(IBatchNavigator, safe_reindeer_batch_navigator)
True

BatchNavigator类提供IBatchNavigatorFactory。这可以用于将批处理导航器工厂注册为实用工具，例如。

>>> from lazr.batchnavigator.interfaces import IBatchNavigatorFactory

>>> verifyObject(IBatchNavigatorFactory, BatchNavigator)
True

您可以要求导航器获取当前显示的结果块（例如，为了在ZPT中渲染而迭代它们）

>>> list(reindeer_batch_navigator.currentBatch())
['Dasher', 'Dancer', 'Prancer']

您可以请求第一个、上一个、下一个和最后一个结果的链接

>>> reindeer_batch_navigator.firstBatchURL()
''
>>> reindeer_batch_navigator.prevBatchURL()
''
>>> reindeer_batch_navigator.nextBatchURL()
'http://www.example.com/foo?memo=3&start=3'

没有方法可以获取到最后一批的URL，除非知道整个列表的长度，所以我们将使用安全批处理导航器来演示lastBatchURL()

>>> safe_reindeer_batch_navigator.lastBatchURL()
'http://www.example.com/foo?direction=backwards&start=6'

当没有更多结果时，下一个链接将为空

>>> request = build_request({"start": "3", "batch": "20"})
>>> last_reindeer_batch_navigator = BatchNavigator(reindeer, request=request)
>>> last_reindeer_batch_navigator.nextBatchURL()
''

即使我们从0和批处理大小之间的某个点开始，第一个和上一个链接也应该出现

>>> request = build_request({"start": "2", "batch": "3"})
>>> last_reindeer_batch_navigator = BatchNavigator(reindeer, request=request)

在这里，我们还可以看到批处理参数作为URL的一部分出现。这是因为请求在创建Batch对象时请求了与默认值不同的尺寸，默认情况下是5。

>>> last_reindeer_batch_navigator.firstBatchURL()
'http://www.example.com/foo?batch=3'

>>> last_reindeer_batch_navigator.prevBatchURL()
'http://www.example.com/foo?batch=3&direction=backwards&memo=2'

这也可以与查询字符串中的其他值一起工作

>>> request = build_request({'fnorb': 'bar',
...                          'start': '3',
...                          'batch': '3'})
>>> reindeer_batch_navigator_with_qs = BatchNavigator(
...     reindeer, request, size=3)
>>> safe_reindeer_batch_navigator_with_qs = BatchNavigator(
...     safe_reindeer, request, size=3)

在这种情况下，我们使用默认大小为“3”创建了BatchNavigator，请求的确实是每批次的那个数量，因此，我们不需要在URL中显示“批次”。

>>> reindeer_batch_navigator_with_qs.firstBatchURL()
'http://www.example.com/foo?fnorb=bar'
>>> reindeer_batch_navigator_with_qs.prevBatchURL()
'http://www.example.com/foo?fnorb=bar&direction=backwards&memo=3'
>>> reindeer_batch_navigator_with_qs.nextBatchURL()
'http://www.example.com/foo?fnorb=bar&memo=6&start=6'

(同样，不知道整个列表的大小，就无法获取最后一个批次。)

>>> safe_reindeer_batch_navigator_with_qs.lastBatchURL()
'http://www.example.com/foo?fnorb=bar&direction=backwards&start=6'

参数force_start允许你忽略请求中的起始值。例如，当过滤器发生变化，需要从0开始重新启动时，这非常有用。

>>> reindeer_batch_navigator_with_qs = BatchNavigator(
...     reindeer, request, size=3, force_start=True)
>>> reindeer_batch_navigator_with_qs.currentBatch().start
0
>>> reindeer_batch_navigator_with_qs.nextBatchURL()
'http://www.example.com/foo?fnorb=bar&memo=3&start=3'
>>> reindeer[:3] == list(reindeer_batch_navigator_with_qs.currentBatch())
True

我们确保在POST操作中也会观察到URL中提供的批量参数。

>>> request = build_request({'fnorb': 'bar',
...                          'start': '3',
...                          'batch': '3'}, method='POST')
>>> reindeer_batch_navigator_post_with_qs = BatchNavigator(
...     reindeer, request)

>>> reindeer_batch_navigator_post_with_qs.start
3
>>> reindeer_batch_navigator_post_with_qs.nextBatchURL()
'http://www.example.com/foo?fnorb=bar&batch=3&memo=6&start=6'

我们确保在URL中提供的多个大小和批量参数不会使应用程序崩溃。首选第一个。

>>> request = build_request(
...     [('batch', '1'), ('batch', '7'), ('start', '2'), ('start', '10')])
>>> navigator = BatchNavigator(reindeer, request=request)
>>> navigator.nextBatchURL()
'http://www.example.com/foo?batch=1&memo=3&start=3'

批量参数必须是正数。其他数字将被忽略，并使用默认的批量大小。

>>> from six.moves.urllib.parse import parse_qs
>>> request = build_request({'batch': '0'})
>>> navigator = BatchNavigator(range(99), request=request)
>>> print('batch' in parse_qs(navigator.nextBatchURL()))
False

>>> request = build_request({'batch': '-1'})
>>> navigator = BatchNavigator(range(99), request=request)
>>> print('batch' in parse_qs(navigator.nextBatchURL()))
False