Context Navigation

Changeset 2978 in products

Timestamp:

Nov 5, 2010 12:21:35 PM (14 years ago)

Author:

mylan

Message:

#228: minor docstring update for getBOFiltered method

File:

-                      r2945
+                      r2978
     def getBOFiltered(self, objects):
         """Return blkack-out filtered objects
+        """Return black-out filtered objects
           Every record in blackout_list filter should follow the spec:
             [<filter name>:]<filter arguments>
 …
 ->filter name is "foo_filter" (must be registered IBlackoutFilter,
              named "foo_filter"), which get filter arguments: arg-1, arg-2
+          class FooFilterUtility(object):
+              def __init__(self, context, request):
+                  self.context = context
+                  self.request = request
+              def filterOut(self, fdata, fargs):
+                  # some logic to filter-out fdata by fargs with taking into
+                  # consideration self.context and self.request, if needed.
+        """
+          Detailed explanation look in filters.txt doctest.
+        """
         blackout_list = self.context.getBlackout_list()
         for frec in blackout_list:

Note: See TracChangeset for help on using the changeset viewer.