Skip to content

Schema

KoshSchema

Bases: object

Source code in kosh/schema.py 
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
class KoshSchema(object):
    def __init__(self, required={}, optional={}):
        """Schema for Kosh objects
        :param required: Dictionary of required keys and their validation function(s).
        :type required: dict
        :param optional: Dictionary of optional keys and their validation function(s)
        :type optional: dict
        Validation functions must be pickable.
        If multiple validation functions are provided (in a list),
        then the attribute is valid if ANY function return True.
        Validation function must return True, False or raise an Exception.
        """
        self.required = required
        self.optional = optional

    def __str__(self):
        """string representation"""
        st = """Kosh Validation Object
        Required attributes and their validations:
        {}
        Optional attributes and their validations:
        {}""".format(self.required, self.optional)
        return st

    def validate(self, obj, level=None):
        """validate an object through a schema
        Checks that the obj has all the required attribute
        and that both required and present optional attributes pass
        validation functions.

        :param obj: object to validate
        :type obj: str
        :param level: Dataset or Ensemble level, used for `ensemble_tags`
        :type level: str
        :raises ValueError: obj does not validate through the schema
        :return: True if validates
        "rtype: bool
        """
        # First check all the required keys
        req_errors = {}
        for k, v in self.required.items():
            try:
                if isinstance(obj, dict):
                    value = obj[k]
                else:
                    value = getattr(obj, k)
                validate_value(value, v)
            except Exception as err:
                req_errors[k] = err
        opt_errors = {}
        for k, v in self.optional.items():
            try:
                if isinstance(obj, dict):
                    value = obj[k]
                else:
                    value = getattr(obj, k)
            except AttributeError:
                continue
            try:
                validate_value(value, v)
            except Exception as err:
                opt_errors[k] = err

        if len(req_errors) != 0 or len(opt_errors) != 0:
            if isinstance(obj, dict):
                obj_level = level
            else:
                obj_level = obj.id
            raise ValueError(
                "Could not validate {}\n"
                "{} required attribute errors: {}\n"
                "{} optional attributes errors: {}".format(
                    obj_level, len(req_errors), req_errors, len(opt_errors), opt_errors))
        return True

    def validate_attribute(self, attribute, value):
        """validate_attribute validates a value for a specific attribute

        :param attribute: attribute to validate
        :type attribute: str
        :param value: value to validate
        :type value: any
        :return: True or False
        "rtype: bool
        """
        if attribute in self.required:
            result = validate_value(value, self.required[attribute])
        elif attribute in self.optional:
            result = validate_value(value, self.optional[attribute])
        else:
            result = True
        return result

__init__(required={}, optional={})

Schema for Kosh objects

Parameters:

Name Type Description Default
required dict

Dictionary of required keys and their validation function(s).

 {}
optional dict Validation functions must be pickable. If multiple validation functions are provided (in a list), then the attribute is valid if ANY function return True. Validation function must return True, False | raise an Exception.

Dictionary of optional keys and their validation function(s)

 {}
Source code in kosh/schema.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
def __init__(self, required={}, optional={}):
    """Schema for Kosh objects
    :param required: Dictionary of required keys and their validation function(s).
    :type required: dict
    :param optional: Dictionary of optional keys and their validation function(s)
    :type optional: dict
    Validation functions must be pickable.
    If multiple validation functions are provided (in a list),
    then the attribute is valid if ANY function return True.
    Validation function must return True, False or raise an Exception.
    """
    self.required = required
    self.optional = optional

__str__()

string representation

Source code in kosh/schema.py 
71
72
73
74
75
76
77
78
def __str__(self):
    """string representation"""
    st = """Kosh Validation Object
    Required attributes and their validations:
    {}
    Optional attributes and their validations:
    {}""".format(self.required, self.optional)
    return st

validate(obj, level=None)

validate an object through a schema Checks that the obj has all the required attribute and that both required and present optional attributes pass validation functions.

Parameters:

Name Type Description Default
obj str

object to validate

 required
level str

Dataset or Ensemble level, used for ensemble_tags

 None

Returns:

Type Description

True if validates "rtype: bool

Raises:

Type Description
ValueError

obj does not validate through the schema
Source code in kosh/schema.py 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def validate(self, obj, level=None):
    """validate an object through a schema
    Checks that the obj has all the required attribute
    and that both required and present optional attributes pass
    validation functions.

    :param obj: object to validate
    :type obj: str
    :param level: Dataset or Ensemble level, used for `ensemble_tags`
    :type level: str
    :raises ValueError: obj does not validate through the schema
    :return: True if validates
    "rtype: bool
    """
    # First check all the required keys
    req_errors = {}
    for k, v in self.required.items():
        try:
            if isinstance(obj, dict):
                value = obj[k]
            else:
                value = getattr(obj, k)
            validate_value(value, v)
        except Exception as err:
            req_errors[k] = err
    opt_errors = {}
    for k, v in self.optional.items():
        try:
            if isinstance(obj, dict):
                value = obj[k]
            else:
                value = getattr(obj, k)
        except AttributeError:
            continue
        try:
            validate_value(value, v)
        except Exception as err:
            opt_errors[k] = err

    if len(req_errors) != 0 or len(opt_errors) != 0:
        if isinstance(obj, dict):
            obj_level = level
        else:
            obj_level = obj.id
        raise ValueError(
            "Could not validate {}\n"
            "{} required attribute errors: {}\n"
            "{} optional attributes errors: {}".format(
                obj_level, len(req_errors), req_errors, len(opt_errors), opt_errors))
    return True

validate_attribute(attribute, value)

validate_attribute validates a value for a specific attribute

Parameters:

Name Type Description Default
attribute str

attribute to validate

 required
value any

value to validate

 required

Returns:

Type Description

True or False "rtype: bool
Source code in kosh/schema.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
def validate_attribute(self, attribute, value):
    """validate_attribute validates a value for a specific attribute

    :param attribute: attribute to validate
    :type attribute: str
    :param value: value to validate
    :type value: any
    :return: True or False
    "rtype: bool
    """
    if attribute in self.required:
        result = validate_value(value, self.required[attribute])
    elif attribute in self.optional:
        result = validate_value(value, self.optional[attribute])
    else:
        result = True
    return result

auto_valid(validation)

auto_valid converts class type to their 'isinstance' function in the future other keyword maybe added to the list

Parameters:

Name Type Description Default
validation type

class def or type

 required

Returns:

Type Description
function

isinstance lambda function or validation function
Source code in kosh/schema.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
def auto_valid(validation):
    """auto_valid converts class type
    to their 'isinstance' function in the future other
    keyword maybe added to the list

    :param validation: class def or type
    :type validation: type
    :return: isinstance lambda function or validation function
    :rtype: function
    """
    if isinstance(validation, type):
        def lmb(x): return isinstance(x, validation)
        return lmb
    return validation

validate_value(value, validation)

validate_value Validates a value for a given validation function (or list of)

Parameters:

Name Type Description Default
value any

value to validate

 required
validation callable

validation function (or list of)

 required

Returns:

Type Description
bool

True if validates

Raises:

Type Description
ValueError

value does not vaidate
Source code in kosh/schema.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def validate_value(value, validation):
    """validate_value Validates a value for a given validation function (or list of)

    :param value: value to validate
    :type value: any
    :param validation: validation function (or list of)
    :type validation: callable
    :raises ValueError: value does not vaidate
    :return: True if validates
    :rtype: bool
    """
    if validation is None:
        return True
    validation = auto_valid(validation)
    if callable(validation):
        res = validation(value)
        if not res:
            raise ValueError("value {value} failed validation".format(value=value))
    elif isinstance(validation, list):
        success = False
        for item in validation:  # Loop thru elements to get a possible success
            item = auto_valid(item)
            if callable(item):
                try:
                    res = item(value)
                    success += res
                    if success:
                        break  # no need to check further
                except Exception:
                    pass
            elif value == item:
                success += True
                break  # no need to check further

        if not success:  # All options failed
            raise ValueError("Could not validate value '{value}'".format(value=value))
    return True