netsight.async 1.1.1

基本用法

首先，从BaseAsyncView类继承。您可能通常会在视图类的__call__方法中编写代码以执行某些过程，而是将其放置在__run__方法中。

>>> import time
>>> from netsight.async.browser.BaseAsyncView import BaseAsyncView
>>> class MyView(BaseAsyncView):
...
...    def __run__(self, *args, **kwargs):
...         time.sleep(30)
...         return "Hello world!"
...
>>>

当您从浏览器调用此视图时，它将显示正常配置的任何输出。但是，当您向视图执行POST请求时，后台将调用__run__方法，就像调用视图类的__call__方法一样。同时，将向浏览器返回显示旋转器的页面，并在__run__定义的过程完成之前每5秒轮询一次。

__run__方法完成后，浏览器将重定向到结果页面。

与页面模板一起使用

如果您已经为您的视图类配置了带有在ZCML中指定的页面模板文件的浏览器视图，则首次调用视图时将默认显示该模板。如果向视图提交POST请求，则将启动过程。您可以通过重写视图的initial_page和run_process方法来更改初始模板和启动过程的条件。

>>> from Products.Five.browser.pagetemplatefile import \
...      ViewPageTemplateFile
>>>
>>> class MyView(BaseAsyncView):
...
...     def run_process(self):
...         return 'run' in self.request.form
...
...     initial_page = \
...         ViewPageTemplateFile('templates/my_template.pt')
...
>>>

或者，您也可以使用一个方法

>>> class MyView(BaseAsyncView):
...
...     def initial_page(self, *args, **kwargs):
...         return 'Hello world!'
...
>>>

您还可以通过重写processing_page方法来覆盖启动过程后返回给浏览器的页面。

如果您想在__run__方法中调用ZCML中定义的模板，并且如果您的run_process方法通常会再次启动过程，则可以在调用方法中传递一个名为no_process的值为True的参数。

>>> class MyView(BaseAsyncView):
...
...     def __run__(self, *args, **kwargs):
...         return self.__call__(message="Hello world",
...                              no_process=True)
...
>>>

检查状态和检索结果

一旦启动了您的__run__方法，结果响应将重定向到处理视图，其中包含新启动过程的唯一ID，作为GET变量process_id。

此过程ID可以用来检索关于过程状态及其结果的信息。

通过将过程ID传递给视图的completed方法，将返回一个表示完成状态的True或False，或者表示100%（稍后详细介绍进度记录）。如果可选参数output_json设置为某些评估为True的值，则方法返回一个包含单个键completed的JSON对象，其中包含相同的True、False或数值。

如果您的过程在完成之前死亡，它将引发错误，或者如果选择JSON输出，则返回字符串值ERROR作为completed。

一旦__run__方法完成，请使用过程ID调用视图的result方法来检索结果。

如果您的过程在完成之前死亡，这也会引发错误，或者如果选择JSON输出，则返回字符串值ERROR作为completed。

如果调用result时过程尚未完成，将返回None。

从您的任务设置过程进度

如果您想让您的任务返回某些完成度，可以调用带有过程ID和一些数值的set_progress方法。

>>> class MyView(BaseAsyncView):
...
...    def __run__(self, process_id=None, *args, **kwargs):
...         time.sleep(15)
...         self.set_progress(process_id, 50)
...         time.sleep(15)
...         return "Hello world!"
...
>>>

当您的任务完成而不引发异常时，进度将自动设置为100，因此不需要在方法返回之前设置此值。

1.1.1 - (2011-10-27)

• 修复了进度设置为 100 时的进程完成检测。

1.1.0 - (2011-10-27)

• 使 Python 2.4 兼容。

• 进程进度/结果存储现在在 ZODB 中，而不是在 Python 实例的内存中。

1.0.1 - (2011-10-19)

• 修复了包清单。

• 修复了处理页面上的标记。

1.0.0 - (2011-10-19)

初始版本。