Changeset 5318

Timestamp:

08/30/08 12:53:17 (4 months ago)

Author:

chrisz

Message:

Ported r5311-5317 from TG 1.0 to 1.1 and 1.5 (#1889, make paginate work with tg.strict_parameters=False).

Files:

• branches/1.1/turbogears/controllers.py (modified) (1 diff)
• branches/1.1/turbogears/paginate.py (modified) (4 diffs)
• branches/1.1/turbogears/tests/test_paginate.py (modified) (3 diffs)
• branches/1.1/turbogears/util.py (modified) (2 diffs)
• branches/1.5/turbogears/controllers.py (modified) (1 diff)
• branches/1.5/turbogears/paginate.py (modified) (3 diffs)
• branches/1.5/turbogears/tests/test_paginate.py (modified) (3 diffs)
• branches/1.5/turbogears/util.py (modified) (2 diffs)

branches/1.1/turbogears/controllers.py

@@ -371 +371 @@
-            + config.get("tg.ignore_parameters", []))
-    else:
+        # get special parameters used by upstream decorators like paginate
+        try:
+            tg_kw = dict([(k, v) for k, v in kw.items() if k in func._tg_args])
+        except AttributeError:
+            tg_kw = {}
+        # remove excessive parameters
-        args, kw = tg_util.adapt_call(func, args, kw)
+        # add special parameters again
+        kw.update(tg_kw)
-    if config.get('server.environment', 'development') == 'development':
-        # Only output this in development mode: If it's a field storage object,

branches/1.1/turbogears/paginate.py

@@ -22 +22 @@
-from formencode.variabledecode import variable_encode
-from turbogears.widgets import PaginateDataGrid
+from turbogears.util import add_tg_args
-
-log = logging.getLogger("turbogears.paginate")
+
-
-# lists of databases that lack support for OFFSET
@@ -101 +103 @@
-    def entangle(func):
-
+        get = turbogears.config.get
+
-        def decorated(func, *args, **kw):
-
-            get = turbogears.config.get
-
-            def kwpop(name, default=None):
@@ -135 +137 @@
-            ordering = kwpop('ordering')
-
-an
+na
-                page, limit_, order)
-
@@ -268 +270 @@
-
-            return output
+
+        if not get('tg.strict_parameters', False):
+            # add hint that paginate parameters shall be left intact
+            add_tg_args(func, (var_name + '_tgp_' + arg
+                for arg in ('no', 'limit', 'order', 'ordering')))
-        return decorated
+
-    return weak_signature_decorator(entangle)
-

branches/1.1/turbogears/tests/test_paginate.py

@@ -19 +19 @@
-query_methods = 'Q QA SO SL'.split()
-
-
-
+
-
-# sqlalchemy setup
@@ -420 +419 @@
-        Spy.assert_ok(self.body, 'pages', xrange(4, 8))
-
+    def test_strict_parameters(self):
+        config.update({'tg.strict_parameters': True})
+        try:
+            # check that paginate works with strict parameters as well
+            self.request("/basic?data_tgp_no=2", status=200)
+            assert '"data": [4, 5, 6, 7]' in self.body
+            Spy.assert_ok(self.body, 'current_page', 2)
+            self.request('/custom_limit?data_tgp_limit=2', status=200)
+            assert '"data": [0, 1]' in self.body
+            Spy.assert_ok(self.body, 'limit', 2)
+            self.request("/default_max_pages?data_tgp_no=5", status=200)
+            assert '"data": [40, 41, 42, ' in self.body
+            Spy.assert_ok(self.body, 'pages', xrange(3, 8))
+            # check that wrong and old style parameters are not accepted
+            self.request("/basic?data_tgp_rubbish=2", status = 500)
+            assert ("basic() got an unexpected keyword argument"
+                " 'data_tgp_rubbish'") in self.body
+            self.request("/basic?tg_paginate_no=2", status=500)
+            assert ("basic() got an unexpected keyword argument"
+                " 'tg_paginate_no'") in self.body
+        finally:
+            config.update({'tg.strict_parameters': False})
+
-    def test_invalid_dynamic_limit(self):
-        self.request("/invalid_dynamic", status=500)
@@ -778 +800 @@
-                Spy.assert_ok(self.body, 'ordering', ['street'])
-
+    def test_strict_parameters(self):
+        config.update({'tg.strict_parameters': True})
+        try:
+            # check that paginate ordering works with strict parameters as well
+            self.request("/basic1?method=Q&data_tgp_ordering=street", status=200)
+            self.assert_order(16, 2, 3, 4, 5, 6, 7, 8, 9, 10)
+            Spy.assert_ok(self.body, 'ordering', ['street'])
+            # check that old style ordering is not accepted any more
+            self.request("/basic1?method=Q&tg_paginate_ordering=street", status=500)
+            assert ("got an unexpected keyword argument"
+                " 'tg_paginate_ordering'") in self.body
+        finally:
+            config.update({'tg.strict_parameters': False})
+
-    def test_reversed(self):
-        for test in "reversed1", "reversed2":

branches/1.1/turbogears/util.py

@@ -329 +329 @@
-    args, kw = inject_args(func, injections, args, kw)
-    return func(*args, **kw)
+
+
+def add_tg_args(func, args):
+    """Add hint for special arguments that shall not be removed."""
+    try:
+        tg_args = func._tg_args
+    except AttributeError:
+        tg_args = set()
+    tg_args.update(args)
+    func._tg_args = tg_args
-
-
@@ -687 +697 @@
-           "get_package_name", "get_model", "load_project_config",
-           "ensure_sequence", "has_arg", "to_kw", "from_kw", "adapt_call",
-
-
+
+
+
-           "request_available", "flatten_sequence", "load_class",
-           "parse_http_accept_header", "simplify_http_accept_header",

branches/1.5/turbogears/controllers.py

@@ -371 +371 @@
-            + request.config.get("tg.ignore_parameters", []))
-    else:
+        # get special parameters used by upstream decorators like paginate
+        try:
+            tg_kw = dict([(k, v) for k, v in kw.items() if k in func._tg_args])
+        except AttributeError:
+            tg_kw = {}
+        # remove excessive parameters
-        args, kw = tg_util.adapt_call(func, args, kw)
+        # add special parameters again
+        kw.update(tg_kw)
-    if request.config.get('server.environment', 'development') == 'development':
-        # Only output this in development mode: If it's a field storage object,

branches/1.5/turbogears/paginate.py

@@ -22 +22 @@
-from formencode.variabledecode import variable_encode
-from turbogears.widgets import PaginateDataGrid
+from turbogears.util import add_tg_args
-
-log = logging.getLogger("turbogears.paginate")
+
-
-# lists of databases that lack support for OFFSET
@@ -135 +137 @@
-            ordering = kwpop('ordering')
-
-an
+na
-                page, limit_, order)
-
@@ -268 +270 @@
-
-            return output
+
+        if not turbogears.config.server.get('tg.strict_parameters', False):
+            # add hint that paginate parameters shall be left intact
+            add_tg_args(func, (var_name + '_tgp_' + arg
+                for arg in ('no', 'limit', 'order', 'ordering')))
-        return decorated
+
-    return weak_signature_decorator(entangle)
-

branches/1.5/turbogears/tests/test_paginate.py

@@ -19 +19 @@
-query_methods = 'Q QA SO SL'.split()
-
-
-
+
-
-# sqlalchemy setup
@@ -424 +423 @@
-        Spy.assert_ok(self.body, 'pages', xrange(4, 8))
-
+    def test_strict_parameters(self):
+        config.update({'tg.strict_parameters': True})
+        try:
+            # check that paginate works with strict parameters as well
+            self.request("/basic?data_tgp_no=2", status=200)
+            assert '"data": [4, 5, 6, 7]' in self.body
+            Spy.assert_ok(self.body, 'current_page', 2)
+            self.request('/custom_limit?data_tgp_limit=2', status=200)
+            assert '"data": [0, 1]' in self.body
+            Spy.assert_ok(self.body, 'limit', 2)
+            self.request("/default_max_pages?data_tgp_no=5", status=200)
+            assert '"data": [40, 41, 42, ' in self.body
+            Spy.assert_ok(self.body, 'pages', xrange(3, 8))
+            # check that wrong and old style parameters are not accepted
+            self.request("/basic?data_tgp_rubbish=2", status = 500)
+            assert ("basic() got an unexpected keyword argument"
+                " 'data_tgp_rubbish'") in self.body
+            self.request("/basic?tg_paginate_no=2", status=500)
+            assert ("basic() got an unexpected keyword argument"
+                " 'tg_paginate_no'") in self.body
+        finally:
+            config.update({'tg.strict_parameters': False})
+
-    def test_invalid_dynamic_limit(self):
-        self.request("/invalid_dynamic", status=500)
@@ -782 +804 @@
-                Spy.assert_ok(self.body, 'ordering', ['street'])
-
+    def test_strict_parameters(self):
+        config.update({'tg.strict_parameters': True})
+        try:
+            # check that paginate ordering works with strict parameters as well
+            self.request("/basic1?method=Q&data_tgp_ordering=street", status=200)
+            self.assert_order(16, 2, 3, 4, 5, 6, 7, 8, 9, 10)
+            Spy.assert_ok(self.body, 'ordering', ['street'])
+            # check that old style ordering is not accepted any more
+            self.request("/basic1?method=Q&tg_paginate_ordering=street", status=500)
+            assert ("got an unexpected keyword argument"
+                " 'tg_paginate_ordering'") in self.body
+        finally:
+            config.update({'tg.strict_parameters': False})
+
-    def test_reversed(self):
-        for test in "reversed1", "reversed2":

branches/1.5/turbogears/util.py

@@ -329 +329 @@
-    args, kw = inject_args(func, injections, args, kw)
-    return func(*args, **kw)
+
+
+def add_tg_args(func, args):
+    """Add hint for special arguments that shall not be removed."""
+    try:
+        tg_args = func._tg_args
+    except AttributeError:
+        tg_args = set()
+    tg_args.update(args)
+    func._tg_args = tg_args
-
-
@@ -684 +694 @@
-           "get_package_name", "get_model", "load_project_config",
-           "ensure_sequence", "has_arg", "to_kw", "from_kw", "adapt_call",
-
-
+
+
+
-           "request_available", "flatten_sequence", "load_class",
-           "parse_http_accept_header", "simplify_http_accept_header",