pip_services3_commons.validate.MapSchema module
pip_services3_commons.validate.MapSchema
Map schema implementation
- copyright
Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.
- license
MIT, see LICENSE for more details.
-
class
pip_services3_commons.validate.MapSchema.
MapSchema
(key_type: Any = None, value_type: Any = None, required: bool = None, rules: List[pip_services3_commons.validate.IValidationRule.IValidationRule] = None) Bases:
pip_services3_commons.validate.Schema.Schema
Schema to validate maps.
Example:
schema = MapSchema(TypeCode.String, TypeCode.Integer) schema.validate({ "key1": "A", "key2": "B" }) # Result: no errors schema.validate({ "key1": 1, "key2": 2 }) # Result: element type mismatch schema.validate([ 1, 2, 3 ]) # Result: type mismatch
-
get_key_type
() → Any Gets the type of map keys. None means that keys may have any type.
- Returns
the type of map keys.
-
get_value_type
() → Any Gets the type of map values. None means that values may have any type.
- Returns
the type of map values.
-
set_key_type
(value: Any) Sets the type of map keys. None means that keys may have any type.
- Parameters
value – a type of map keys.
-
set_value_type
(value: Any) Sets the type of map values. Null means that values may have any type.
- Returns
a type of map values.
-