Merge lp:~kernevil/ubuntu/saucy/pylons/fix-useless-import into lp:ubuntu/saucy/pylons

[Kernevil]

[lp:~kernevil/ubuntu/saucy/pylons/fix-useless-import]

14. By Kernevil on 2014-03-14

Fix useless import

[Sebastien Bacher (seb128)]

Thank you for your work there. The issue is fixed in trusty, if you want a stable update to saucy could you update the bug to include the SRU informations (https://wiki.ubuntu.com/StableReleaseUpdates) and add a changelog entry to your update?

review: Needs Fixing

Unmerged revisions

14. By Kernevil on 2014-03-14

Fix useless import

=== added file '.pc/.quilt_patches'
--- .pc/.quilt_patches	1970-01-01 00:00:00 +0000
+++ .pc/.quilt_patches	2014-03-14 14:46:27 +0000
@@ -0,0 +1,1 @@
+debian/patches
 
=== added file '.pc/.quilt_series'
--- .pc/.quilt_series	1970-01-01 00:00:00 +0000
+++ .pc/.quilt_series	2014-03-14 14:46:27 +0000
@@ -0,0 +1,1 @@
+series
 
=== modified file '.pc/applied-patches'
--- .pc/applied-patches	2011-08-02 21:17:36 +0000
+++ .pc/applied-patches	2014-03-14 14:46:27 +0000
@@ -1,2 +1,3 @@
 move_data_outside_site-packages.patch
 ipython_0.11_compatibility.patch
+fix-useless-import.patch
 
=== added directory '.pc/fix-useless-import.patch'
=== added file '.pc/fix-useless-import.patch/.timestamp'
=== added directory '.pc/fix-useless-import.patch/pylons'
=== added directory '.pc/fix-useless-import.patch/pylons/decorators'
=== added file '.pc/fix-useless-import.patch/pylons/decorators/__init__.py'
--- .pc/fix-useless-import.patch/pylons/decorators/__init__.py	1970-01-01 00:00:00 +0000
+++ .pc/fix-useless-import.patch/pylons/decorators/__init__.py	2014-03-14 14:46:27 +0000
@@ -0,0 +1,207 @@
+"""Pylons Decorators
+
+Common decorators intended for use in controllers. Additional
+decorators for use with controllers are in the
+:mod:`~pylons.decorators.cache`, :mod:`~pylons.decorators.rest` and
+:mod:`~pylons.decorators.secure` modules.
+
+"""
+import logging
+import sys
+import warnings
+
+import formencode
+import simplejson
+from decorator import decorator
+from formencode import api, htmlfill, variabledecode
+from webob.multidict import UnicodeMultiDict
+
+from pylons.decorators.util import get_pylons
+from pylons.i18n import _ as pylons_gettext
+
+__all__ = ['jsonify', 'validate']
+
+log = logging.getLogger(__name__)
+
+@decorator
+def jsonify(func, *args, **kwargs):
+    """Action decorator that formats output for JSON
+
+    Given a function that will return content, this decorator will turn
+    the result into JSON, with a content-type of 'application/json' and
+    output it.
+    
+    """
+    pylons = get_pylons(args)
+    pylons.response.headers['Content-Type'] = 'application/json'
+    data = func(*args, **kwargs)
+    if isinstance(data, (list, tuple)):
+        msg = "JSON responses with Array envelopes are susceptible to " \
+              "cross-site data leak attacks, see " \
+              "http://pylonshq.com/warnings/JSONArray"
+        warnings.warn(msg, Warning, 2)
+        log.warning(msg)
+    log.debug("Returning JSON wrapped action output")
+    return simplejson.dumps(data)
+
+
+def validate(schema=None, validators=None, form=None, variable_decode=False,
+             dict_char='.', list_char='-', post_only=True, state=None,
+             on_get=False, **htmlfill_kwargs):
+    """Validate input either for a FormEncode schema, or individual
+    validators
+
+    Given a form schema or dict of validators, validate will attempt to
+    validate the schema or validator list.
+
+    If validation was successful, the valid result dict will be saved
+    as ``self.form_result``. Otherwise, the action will be re-run as if
+    it was a GET, and the output will be filled by FormEncode's
+    htmlfill to fill in the form field errors.
+
+    ``schema``
+        Refers to a FormEncode Schema object to use during validation.
+    ``form``
+        Method used to display the form, which will be used to get the 
+        HTML representation of the form for error filling.
+    ``variable_decode``
+        Boolean to indicate whether FormEncode's variable decode
+        function should be run on the form input before validation.
+    ``dict_char``
+        Passed through to FormEncode. Toggles the form field naming 
+        scheme used to determine what is used to represent a dict. This
+        option is only applicable when used with variable_decode=True.
+    ``list_char``
+        Passed through to FormEncode. Toggles the form field naming
+        scheme used to determine what is used to represent a list. This
+        option is only applicable when used with variable_decode=True.
+    ``post_only``
+        Boolean that indicates whether or not GET (query) variables
+        should be included during validation.
+        
+        .. warning::
+            ``post_only`` applies to *where* the arguments to be
+            validated come from. It does *not* restrict the form to
+            only working with post, merely only checking POST vars.
+    ``state``
+        Passed through to FormEncode for use in validators that utilize
+        a state object.
+    ``on_get``
+        Whether to validate on GET requests. By default only POST
+        requests are validated.
+
+    Example::
+
+        class SomeController(BaseController):
+
+            def create(self, id):
+                return render('/myform.mako')
+
+            @validate(schema=model.forms.myshema(), form='create')
+            def update(self, id):
+                # Do something with self.form_result
+                pass
+
+    """
+    if state is None:
+        state = PylonsFormEncodeState
+    def wrapper(func, self, *args, **kwargs):
+        """Decorator Wrapper function"""
+        request = self._py_object.request
+        errors = {}
+        
+        # Skip the validation if on_get is False and its a GET
+        if not on_get and request.environ['REQUEST_METHOD'] == 'GET':
+            return func(self, *args, **kwargs)
+        
+        # If they want post args only, use just the post args
+        if post_only:
+            params = request.POST
+        else:
+            params = request.params
+        
+        params = params.mixed()
+        if variable_decode:
+            log.debug("Running variable_decode on params")
+            decoded = variabledecode.variable_decode(params, dict_char,
+                                                     list_char)
+        else:
+            decoded = params
+
+        if schema:
+            log.debug("Validating against a schema")
+            try:
+                self.form_result = schema.to_python(decoded, state)
+            except formencode.Invalid, e:
+                errors = e.unpack_errors(variable_decode, dict_char, list_char)
+        if validators:
+            log.debug("Validating against provided validators")
+            if isinstance(validators, dict):
+                if not hasattr(self, 'form_result'):
+                    self.form_result = {}
+                for field, validator in validators.iteritems():
+                    try:
+                        self.form_result[field] = \
+                            validator.to_python(decoded.get(field), state)
+                    except formencode.Invalid, error:
+                        errors[field] = error
+        if errors:
+            log.debug("Errors found in validation, parsing form with htmlfill "
+                      "for errors")
+            request.environ['REQUEST_METHOD'] = 'GET'
+            self._py_object.tmpl_context.form_errors = errors
+
+            # If there's no form supplied, just continue with the current
+            # function call.
+            if not form:
+                return func(self, *args, **kwargs)
+
+            request.environ['pylons.routes_dict']['action'] = form
+            response = self._dispatch_call()
+
+            # If the form_content is an exception response, return it
+            if hasattr(response, '_exception'):
+                return response
+
+            htmlfill_kwargs2 = htmlfill_kwargs.copy()
+            htmlfill_kwargs2.setdefault('encoding', request.charset)
+            return htmlfill.render(response, defaults=params, errors=errors,
+                                   **htmlfill_kwargs2)
+        return func(self, *args, **kwargs)
+    return decorator(wrapper)
+
+
+def pylons_formencode_gettext(value):
+    """Translates a string ``value`` using pylons gettext first and if
+    that fails, formencode gettext.
+    
+    This allows to "merge" localized error messages from built-in
+    FormEncode's validators with application-specific validators.
+
+    """
+    trans = pylons_gettext(value)
+    if trans == value:
+        # translation failed, try formencode
+        trans = api._stdtrans(value)
+    return trans
+
+
+class PylonsFormEncodeState(object):
+    """A ``state`` for FormEncode validate API that includes smart
+    ``_`` hook.
+
+    The FormEncode library used by validate() decorator has some
+    provision for localizing error messages. In particular, it looks
+    for attribute ``_`` in the application-specific state object that
+    gets passed to every ``.to_python()`` call. If it is found, the
+    ``_`` is assumed to be a gettext-like function and is called to
+    localize error messages.
+
+    One complication is that FormEncode ships with localized error
+    messages for standard validators so the user may want to re-use
+    them instead of gathering and translating everything from scratch.
+    To allow this, we pass as ``_`` a function which looks up
+    translation both in application and formencode message catalogs.
+    
+    """
+    _ = staticmethod(pylons_formencode_gettext)
 
=== added file '.pc/ipython_0.11_compatibility.patch/.timestamp'
=== added file '.pc/move_data_outside_site-packages.patch/.timestamp'
=== modified file 'debian/changelog'
--- debian/changelog	2011-08-02 21:17:36 +0000
+++ debian/changelog	2014-03-14 14:46:27 +0000
@@ -1,3 +1,9 @@
+pylons (1.0-3) unstable; urgency=low
+
+  * Add fix-useless-import.patch (closes: #1292505)
+
+ -- Samuel Cabrero <[e-mail]>  Fri, 14 Mar 2014 15:28:15 +0100
+
 pylons (1.0-2) unstable; urgency=low
 
   * Add ipython_0.11_compatibility patch (thanks to Julian Taylor)
 
=== added file 'debian/patches/fix-useless-import.patch'
--- debian/patches/fix-useless-import.patch	1970-01-01 00:00:00 +0000
+++ debian/patches/fix-useless-import.patch	2014-03-14 14:46:27 +0000
@@ -0,0 +1,12 @@
+Index: fix-useless-import/pylons/decorators/__init__.py
+===================================================================
+--- fix-useless-import.orig/pylons/decorators/__init__.py	2014-03-14 15:25:49.079736000 +0100
++++ fix-useless-import/pylons/decorators/__init__.py	2014-03-14 15:26:55.106453748 +0100
+@@ -14,7 +14,6 @@
+ import simplejson
+ from decorator import decorator
+ from formencode import api, htmlfill, variabledecode
+-from webob.multidict import UnicodeMultiDict
+ 
+ from pylons.decorators.util import get_pylons
+ from pylons.i18n import _ as pylons_gettext
 
=== modified file 'debian/patches/ipython_0.11_compatibility.patch'
--- debian/patches/ipython_0.11_compatibility.patch	2011-08-02 21:17:36 +0000
+++ debian/patches/ipython_0.11_compatibility.patch	2014-03-14 14:46:27 +0000
@@ -1,8 +1,8 @@
-Index: pylons-0.10/pylons/commands.py
+Index: fix-useless-import/pylons/commands.py
 ===================================================================
---- pylons-0.10.orig/pylons/commands.py	2011-07-24 15:28:25.708719706 +0200
-+++ pylons-0.10/pylons/commands.py	2011-07-24 15:28:31.848719709 +0200
-@@ -514,10 +514,14 @@
+--- fix-useless-import.orig/pylons/commands.py	2014-03-14 15:43:20.402418528 +0100
++++ fix-useless-import/pylons/commands.py	2014-03-14 15:43:20.398418528 +0100
+@@ -560,10 +560,14 @@
                  raise ImportError()
  
              # try to use IPython if possible
 
=== modified file 'debian/patches/move_data_outside_site-packages.patch'
--- debian/patches/move_data_outside_site-packages.patch	2009-11-30 00:26:47 +0000
+++ debian/patches/move_data_outside_site-packages.patch	2014-03-14 14:46:27 +0000
@@ -3,11 +3,11 @@
 # note that paster is modified in Debian to look for templates in
 # /usr/share/paster_templates/ so this part of the code doesn't have to
 # be patched
-Index: pylons-0.9.7/setup.py
+Index: fix-useless-import/setup.py
 ===================================================================
---- pylons-0.9.7.orig/setup.py
-+++ pylons-0.9.7/setup.py
-@@ -74,7 +74,7 @@ the `Pylons download page <http://pylons
+--- fix-useless-import.orig/setup.py	2014-03-14 15:43:20.382418528 +0100
++++ fix-useless-import/setup.py	2014-03-14 15:43:20.378418529 +0100
+@@ -74,7 +74,7 @@
      url='http://www.pylonshq.com/',
      packages=find_packages(exclude=['ez_setup', 'tests', 'tests.*']),
      zip_safe=False,
@@ -16,11 +16,11 @@
      test_suite='nose.collector',
      tests_require=tests_require,
      install_requires=[
-Index: pylons-0.9.7/pylons/middleware.py
+Index: fix-useless-import/pylons/middleware.py
 ===================================================================
---- pylons-0.9.7.orig/pylons/middleware.py
-+++ pylons-0.9.7/pylons/middleware.py
-@@ -24,7 +24,7 @@ __all__ = ['ErrorDocuments', 'ErrorHandl
+--- fix-useless-import.orig/pylons/middleware.py	2014-03-14 15:43:20.382418528 +0100
++++ fix-useless-import/pylons/middleware.py	2014-03-14 15:43:20.378418529 +0100
+@@ -18,7 +18,7 @@
  
  log = logging.getLogger(__name__)
  
@@ -29,11 +29,11 @@
  
  head_html = """\
  <link rel="stylesheet" href="{{prefix}}/media/pylons/style/itraceback.css" \
-Index: pylons-0.9.7/pylons/commands.py
+Index: fix-useless-import/pylons/commands.py
 ===================================================================
---- pylons-0.9.7.orig/pylons/commands.py
-+++ pylons-0.9.7/pylons/commands.py
-@@ -169,7 +169,7 @@ class ControllerCommand(Command):
+--- fix-useless-import.orig/pylons/commands.py	2014-03-14 15:43:20.382418528 +0100
++++ fix-useless-import/pylons/commands.py	2014-03-14 15:43:29.000000000 +0100
+@@ -170,7 +170,7 @@
      def command(self):
          """Main command to create controller"""
          try:
@@ -42,7 +42,7 @@
              try:
                  name, directory = file_op.parse_path_name_args(self.args[0])
              except:
-@@ -276,7 +276,7 @@ class RestControllerCommand(Command):
+@@ -279,7 +279,7 @@
      def command(self):
          """Main command to create controller"""
          try:
 
=== modified file 'debian/patches/series'
--- debian/patches/series	2011-08-02 21:17:36 +0000
+++ debian/patches/series	2014-03-14 14:46:27 +0000
@@ -1,2 +1,3 @@
 move_data_outside_site-packages.patch
 ipython_0.11_compatibility.patch
+fix-useless-import.patch
 
=== modified file 'pylons/decorators/__init__.py'
--- pylons/decorators/__init__.py	2011-08-02 21:17:36 +0000
+++ pylons/decorators/__init__.py	2014-03-14 14:46:27 +0000
@@ -14,7 +14,6 @@
 import simplejson
 from decorator import decorator
 from formencode import api, htmlfill, variabledecode
-from webob.multidict import UnicodeMultiDict
 
 from pylons.decorators.util import get_pylons
 from pylons.i18n import _ as pylons_gettext