Metadata-Version: 1.0
Name: py-value-validator
Version: 0.0.2
Summary: Value validation module
Home-page: http://pypi.python.org/pypi/py_value_validator/
Author: Andrew Seaman
Author-email: andrewseaman35@gmail.com
License: MIT
Description: ==================
        py_value_validator
        ==================
        
        This is a Python module that provides an easy way to validate values in
        other projects. The base class provides some generic comparisons and should
        be overridden in order to define comparisons for other classes. 
        
        Installation
        ============
        
        Add the source as a submodule to your project.
        
            $ git submodule add https://github.com/andrewseaman35/py-value-validator.git
            $ git submodule init
        
        Usage
        =====
        
        By overriding the functions class, validation functions can be added by data type
        or to the generic function list. Any function that is specified as generic may be
        used by any data of any type being validated.
        
            class ValidatorFunctions(GenericValidatorFunctions):
                def _add_typed_functions(self):
                    self._add_function(str, "contains", contains)
                    self._add_function("generic", "is_not_none", is_not_none)
        
            def contains(mine, yours):
                return yours in mine
        
            def is_not_none(mine, yours=None):
                return mine is not None
        
        Create a validator with an instance of the function class.
        
            _validator_functions = ValidatorFunctions()
            validator = ValueValidator(_validator_functions)
        
        Define a list of tuples that define the validation for the given value.
        
            validations = [('contains', 'ell'), ('is_not_none', None)]
        
        Run the validations against a value and keep an eye out for a ValidationError.
        
            try:
                validator.validate("hello, world!", validations)
            except ValidationError as validation_error:
                print("Value did not pass validation!")
        
Platform: UNKNOWN
