Package: incoming
incomingis a JSON validation framework.OverviewValidating anything can get really messy. JSON being one of the most used
formats for data exchange,incomingaims at solving the problem of
validating JSON with structure and ease.incomingis a small framework for validating JSON. It’s up to you where and
how to use it. A common use-case (and the primary reason why I wrote this
framework) is validating incoming JSON when writing HTTP servers.FeaturesClasses that can be sub-classed for writing structured validators.Basic validators (ordatatypes) for performing common validations, like
string, numbers, booleans, lists, nested JSON, etc.Allows extending validators (datatypes) to write your own.Allows writing callables for validating values.Captures errors during validation and returns a complete report of errors.Allows reporting different errors for different validation test failures for
the same value.InstallationInstallation is simple.pipinstallincomingBasic Usageimportjsonfromdatetimeimportdatefromincomingimportdatatypes,PayloadValidatorclassMovieValidator(PayloadValidator):name=datatypes.String()rating=datatypes.Function('validate_rating',error='Rating must be in between 1 and 10.',)actors=datatypes.Array()is_3d=datatypes.Boolean()release_year=datatypes.Function('validate_release_year',error='Release year must be in between 1800 and current year.',)# validation method can be a regular methoddefvalidate_rating(self,val,*args,**kwargs):returnisinstance(val,int)andval>=1andval<=10# validation method can be a staticmethod as well@staticmethoddefvalidate_release_year(val,*args,**kwargs):returnall((isinstance(val,int),val>=1800,val<=date.today().year,))payload={'name':'Avengers','rating':5,'actors':['Robert Downey Jr.','Samuel L. Jackson','Scarlett Johansson','Mark Ruffalo'],'is_3d':True,'release_year':2012}result,errors=MovieValidator().validate(payload)assertresultanderrorsisNone,'Validation failed.\n%s'%json.dumps(errors,indent=2)payload={'name':'Avengers','rating':11,'actors':['Robert Downey Jr.','Samuel L. Jackson','Scarlett Johansson','Mark Ruffalo'],'is_3d':'True','release_year':9000}result,errors=MovieValidator().validate(payload)assertresultanderrorsisNone,'Validation failed.\n%s'%json.dumps(errors,indent=2)If you run the above script, you will get:Traceback (most recent call last):
  File "code.py", line 67, in <module>
    assert result and errors is None, 'Validation failed.\n%s' % json.dumps(errors, indent=2)
AssertionError: Validation failed.
{
  "rating": [
    "Rating must be in between 1 and 10."
  ],
  "is_3d": [
    "Invalid data. Expected a boolean value."
  ],
  "release_year": [
    "Release year must be in between 1800 and current year."
  ]
}DocumentationDocumentation is available onRead The Docs.TestsSimply run:python setup.py testor:py.test incomingContributorsVaidik Kapoor(Author)Dhruv BaldawaJames RoweLicenceSeeLICENCE.The MIT License (MIT)Copyright (c) 2013 Vaidik KapoorPermission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the “Software”), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.CHANGELOGDevelopment Version0.3.1Documentation changes on using Nested JSON validators. Passing name of nested
class toincoming.datatypes.JSONis now discouraged. This means that the
inner class has to be correctly scoped.Read more here.0.3.0Pass only the error list of a field in payload to its validator method.Pass errors and payload as keyword arguments.For fields that are not required and have Function as their type, call the
validation method/function even if the field is missing in payload.0.2.6Support Python 3.0.2.5Abstract out datatypes that perform just Python type checks to reduce code.0.2.4Fix tests for Python 2.5 and 2.6. Fix README.0.2.3Package setup changes - added classifiers and manifest file.0.2.1First public release of Incoming.