Skip to main content

Validobj gives you valid objects

Project description

Tests Coverage PyPI Conda Version RTD

Validobj

Validobj is library that takes semistructured data (for example JSON and YAML configuration files) and converts it to more structured Python objects. It places the emphasis on:

  • Good error messages (rather than avoiding extra work in the error handling code).
  • Schema defined in terms of dataclasses and other high level objects such as enums, as well as a subset of the typing module.
  • Simplicity of implementation (rather than full generality).

Validobj requires Python 3.7 and has no other dependencies.

Documentation

https://validobj.readthedocs.io/en/latest/

Example

  1. Define a using dataclasses
    import dataclasses
    import enum
    from typing import Mapping, Set, Tuple, List
    
    
    
    class DiskPermissions(enum.Flag):
    	READ = enum.auto()
    	WRITE = enum.auto()
    	EXECUTE = enum.auto()
    
    
    class OS(enum.Enum):
    	mac = enum.auto()
    	windows = enum.auto()
    	linux = enum.auto()
    
    
    @dataclasses.dataclass
    class Job:
    	name: str
    	os: Set[OS]
    	script_path: str
    	framework_version: Tuple[int, int] = (1, 0)
    	disk_permissions: DiskPermissions = DiskPermissions.READ
    
    
    @dataclasses.dataclass
    class CIConf:
    	stages: List[Job]
    	global_environment: Mapping[str, str] = dataclasses.field(default_factory=dict)
    
  2. Process a dictionary input into it using Validobj
    from validobj import parse_input
    
    inp = {
    	'global_environment': {'CI_ACTIVE': '1'},
    	'stages': [
    		{
    			'name': 'compile',
    			'os': ['linux', 'mac'],
    			'script_path': 'build.sh',
    			'disk_permissions': ['READ', 'WRITE', 'EXECUTE'],
    		},
    		{
    			'name': 'test',
    			'os': ['linux', 'mac'],
    			'script_path': 'test.sh',
    			'framework_version': [4, 0],
    		},
    	],
    }
    print(parse_input(inp, CIConf))
    # This results in a dataclass instance with the correct types:
    #
    #CIConf(
    #    stages=[
    #        Job(
    #            name='compile',
    #            os={<OS.linux: 3>, <OS.mac:1>},
    #            script_path='build.sh',
    #            framework_version=(1, 0),
    #            disk_permissions=<DiskPermissions.EXECUTE|WRITE|READ: 7>,
    #        ),
    #        Job(
    #            name='test',
    #            os={<OS.linux: 3>, <OS.mac: 1>},
    #            script_path='test.sh',
    #            framework_version=(4, 0),
    #            disk_permissions='<DiskPermissions.READ: 1>',
    #        ),
    #    ],
    #    global_environment={'CI_ACTIVE': '1'},
    #)
    #
    

The set of applied transformations is described in the documentation

Installation

The package can be installed with pip:

python3 -m pip install validobj

As well as with conda, from the conda-forge channel:

conda install validobj -c conda-forge

The code is hosted at

https://github.com/Zaharid/validobj

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for validobj, version 0.3.10
Filename, size File type Python version Upload date Hashes
Filename, size validobj-0.3.10-py2.py3-none-any.whl (10.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size validobj-0.3.10.tar.gz (18.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page