Merge pull request #62 from sloria/marshmallow

Use marshmallow to define args and do validation

.travis.yml

@@ -12,11 +12,9 @@ python:
     - "pypy"
 
 install:
-    - pip install -U -r dev-requirements.txt
     - pip install -U .
+    - pip install -U -r dev-requirements.txt
 
 before_script: flake8 webargs
 
 script: py.test
-
-

AUTHORS.rst

@@ -1,8 +1,15 @@
 =======
-Credits
+Authors
 =======
 
+Lead
+----
+
 * Steven Loria <sloria1@gmail.com>
+
+Contributors (chronological)
+----------------------------
+
 * @venuatu <https://github.com/venuatu>
 * Javier Santacruz @jvrsantacruz <javier.santacruz.lc@gmail.com>
 * Josh Carp <https://github.com/jmcarp>

CHANGELOG.rst

@@ -1,6 +1,63 @@
 Changelog
 ---------
 
+0.16.0 (unreleased)
+*******************
+
+The major change in this release is that webargs now depends on `marshmallow <https://marshmallow.readthedocs.org/en/latest/>`_ for defining arguments and for validation.
+
+Your code will need to be updated to use ``Fields`` rather than ``Args``.
+
+.. code-block:: python
+
+    # Old API
+    from webargs import Arg
+
+    args = {
+        'name': Arg(str, required=True)
+        'password': Arg(str, validate=lambda p: len(p) >= 6),
+        'display_per_page': Arg(int, default=10),
+        'nickname': Arg(multiple=True),
+        'Content-Type': Arg(dest='content_type', location='headers'),
+        'location': Arg({
+            'city': Arg(str),
+            'state': Arg(str)
+        })
+    }
+
+    # New API
+    from webargs import fields
+
+    args = {
+        'name': fields.Str(required=True)
+        'password': fields.Str(validate=lambda p: len(p) >= 6),
+        'display_per_page': fields.Int(missing=10),
+        'nickname': fields.List(fields.Str()),
+        'content_type': fields.Str(load_from='Content-Type'),
+        'location': fields.Nested({
+            'city': fields.Str(),
+            'state': fields.Str()
+        })
+    }
+
+Features:
+
+* Error messages for all arguments are "bundled" (:issue:`58`).
+
+Changes:
+
+* *Backwards-incompatible*: Replace ``Args`` with marshmallow fields (:issue:`61`).
+* *Backwards-incompatible*: When using ``use_kwargs``, missing arguments will have the special value ``missing`` rather than ``None``.
+* ``TornadoParser`` raises a custom ``HTTPError`` with a ``messages`` attribute when validation fails.
+
+Bug fixes:
+
+* Fix required validation of nested arguments (:issue:`39`, :issue:`51`). These are fixed by virtue of using marshmallow's ``Nested`` field. Thanks :user:`ewang` and :user:`chavz` for reporting.
+
+Support:
+
+* Updated docs.
+
 0.15.0 (2015-08-22)
 *******************
 

README.rst

@@ -15,13 +15,13 @@ webargs is a Python library for parsing HTTP request arguments, with built-in su
 .. code-block:: python
 
     from flask import Flask
-    from webargs import Arg
+    from webargs import fields
     from webargs.flaskparser import use_args
 
     app = Flask(__name__)
 
     hello_args = {
-        'name': Arg(str, required=True)
+        'name': fields.Str(required=True)
     }
 
     @app.route('/')

dev-requirements.txt

@@ -20,3 +20,8 @@ webapp2>=2.5.2
 
 # Syntax checking
 flake8==2.4.0
+
+# TODO: Remove me
+# webargs will eventually depend on 2.0 final
+# Depend on dev branch until it's released
+git+https://github.com/marshmallow-code/marshmallow.git@dev

docs/_themes/LICENSE

@@ -1,45 +1,11 @@
-Modifications: 
-
-Copyright (c) 2010 Kenneth Reitz.
-
-
-Original Project: 
-
-Copyright (c) 2010 by Armin Ronacher.
-
+Copyright (c) Juan-Pablo Scaletti
 
 Some rights reserved.
 
-Redistribution and use in source and binary forms of the theme, with or
-without modification, are permitted provided that the following conditions
-are met:
-
-* Redistributions of source code must retain the above copyright
-  notice, this list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above
-  copyright notice, this list of conditions and the following
-  disclaimer in the documentation and/or other materials provided
-  with the distribution.
-
-* The names of the contributors may not be used to endorse or
-  promote products derived from this software without specific
-  prior written permission.
+Redistribution and use in source and binary forms of the software as well as documentation, with or without modification, are permitted provided that the following conditions are met:
 
-We kindly ask you to only use these themes in an unmodified manner just
-for Flask and Flask-related products, not for unrelated projects.  If you
-like the visual style and want to use it for your own projects, please
-consider making some larger changes to the themes (such as changing
-font faces, sizes, colors or margins).
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* The names of the contributors may not be used to endorse or promote products derived from this software without specific prior written permission.
 
-THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE AND DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.