Changeset 5239

Timestamp:

08/25/08 18:00:58 (5 months ago)

Author:

deets

Message:

added paginate decorator

Files:

• trunk/tg/decorators.py (modified) (11 diffs)
• trunk/tg/__init__.py (modified) (4 diffs)

trunk/tg/decorators.py

@@ -1 +1 @@
-"""Decorators use by the TurboGears controllers
-
- 
- 
- 
+
+
+
-needed to support these decorators."""
-
-import formencode
-from paste.util.mimeparse import best_match
+
+from webob.multidict import MultiDict
+from webhelpers.paginate import Page
+from tg.config import Bunch
+from functools import partial
+# this can't be tg, as we are circular importing then!
+from pylons import request
+from pylons import tmpl_context as c
+
-
-class Decoration(object):
@@ -50 +59 @@
-        require a template.
-        """
-
+
-        if content_type is None:
-            content_type = '*/*'
@@ -70 +79 @@
-        content_type = best_match(self.engines.keys(), accept_types)
-        engine, template, exclude_names = self.engines[content_type]
-
+
-        if 'charset' not in content_type and (
-           content_type.startswith('text') or content_type  == 'application/json'):
-            content_type = '%s; charset=utf-8' % content_type
-
+
-        return content_type, engine, template, exclude_names
-
@@ -90 +99 @@
-
-class _hook_decorator(object):
- 
+
-    """
-    # must be overridden by a particular hook
@@ -121 +130 @@
-class after_render(_hook_decorator):
-    """A list of callables to be run after the template is rendered.
-
+
-    Will be run before it is returned returned up the WSGI stack"""
-
+
-    hook_name = 'after_render'
-
@@ -177 +186 @@
-            engine, template = template.split(':', 1)
-        elif template:
- 
- 
+
+
-            engine = config['buffet.template_engines'][0]['engine']
-        else:
@@ -201 +210 @@
-
-def override_template(controller, template):
- 
- 
+
+
-    dynamically."""
-    if hasattr(controller, 'decoration'):
@@ -212 +221 @@
-    else:
-        return
-
+
-    text_engine = engines.get('text/html')
-    template = template.split(':')
@@ -221 +230 @@
-class validate(object):
-    """Regesters which validators ought to be applied
-
- 
+
+
-    you can use the ``@validate()`` decorator to regester
-   
-
+
+
-    :Parameters:
-      validators
- 
- 
+
+
-      error_handler
-        Pass in the controller method which shoudl be used
@@ -235 +244 @@
-      form
-        Pass in a ToscaWidget based form with validators
-
- 
+
+
-    a FormEncode schema validator, or a callable which acts like a FormEncode
- 
-
+
+
-    """
-    def __init__(self, validators=None, error_handler=None, form=None):
@@ -252 +261 @@
-        deco.validation = self
-        return func
+
+
+def paginate(name, items_per_page=10, use_prefix=False):
+    """
+    Paginate a given collection.
+
+    This decorator is mainly exposing the functionality
+    of webhelpers.paginate.
+
+    To render the actual pager, use
+
+      ${c.paginators.<name>.pager()}
+
+    where c is the tmpl_context.
+
+
+    :Parameters:
+      name
+        the collection to be paginated.
+      items_per_page
+        the number of items to be rendered. Defaults to 10
+      use_prefix
+        if True, the parameters the paginate
+        decorator renders and reacts to are prefixed with
+        "name_". This allows for multi-pagination.
+
+    """
+    prefix = ""
+    if use_prefix:
+        prefix = name + "_"
+    own_parameters = dict(
+        page="%spage" % prefix,
+        items_per_page="%sitems_per_page" % prefix
+        )
+    #@decorator
+    def _d(f):
+        def _w(*args, **kwargs):
+            page = int(kwargs.pop(own_parameters["page"], 1))
+            real_items_per_page = int(kwargs.pop(own_parameters['items_per_page'], items_per_page))
+            res = f(*args, **kwargs)
+            if isinstance(res, dict) and name in res:
+                additional_parameters = MultiDict()
+                for key, value in request.str_params.iteritems():
+                    if key not in own_parameters:
+                        additional_parameters.add(key, value)
+                collection = res[name]
+                page = Page(
+                    collection,
+                    page,
+                    items_per_page=real_items_per_page,
+                    **additional_parameters.dict_of_lists()
+                    )
+                # wrap the pager so that it will render
+                # the proper page-parameter
+                page.pager = partial(page.pager, page_param=own_parameters["page"])
+                res[name] = page
+                # this is a bit strange - it appears
+                # as if c returns an empty
+                # string for everything it dosen't know.
+                # I didn't find that documented, so I
+                # just put this in here and hope it works.
+                if type(c.paginators) == str:
+                    c.paginators = Bunch()
+                c.paginators[name] = page
+            return res
+        return _w
+    return _d
+
+

trunk/tg/__init__.py

@@ -26 +26 @@
-    * URL Dispatching: Object dispatch
-    * Form Handling: ToscaWidgets
-
+
-The zen of TurboGears is::
-
@@ -48 +48 @@
-
-Sensible defaults encourage code re-use within TurboGears because
- 
+
-assumptions about how things will work.
-"""
@@ -54 +54 @@
-from tg.controllers import TGController, redirect, url, use_wsgi_app
-from tg.configuration import config
-
+, paginate
-from tg.flash import flash, get_flash, get_status
-
@@ -61 +61 @@
-__all__ = [
-    'expose', 'validate', 'TGController', 'tmpl_context', 'app_globals',
- 
+
-    'use_wsgi_app', 'TGApp', 'app_globals'
-]