1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 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 54 55 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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
|
from copy import deepcopy
from typing import Any
from typing import Dict
from typing import Hashable
from typing import ItemsView
from typing import Iterator
from typing import List
from typing import Mapping
from typing import Union
from jsonschema._keywords import allOf as _allOf
from jsonschema._keywords import anyOf as _anyOf
from jsonschema._keywords import oneOf as _oneOf
from jsonschema._utils import extras_msg
from jsonschema._utils import find_additional_properties
from jsonschema.exceptions import FormatError
from jsonschema.exceptions import ValidationError
from jsonschema.protocols import Validator
def handle_discriminator(
validator: Validator, _: Any, instance: Any, schema: Mapping[Hashable, Any]
) -> Iterator[ValidationError]:
"""
Handle presence of discriminator in anyOf, oneOf and allOf.
The behaviour is the same in all 3 cases because at most 1 schema will match.
"""
discriminator = schema["discriminator"]
prop_name = discriminator["propertyName"]
prop_value = instance.get(prop_name)
if not prop_value:
# instance is missing $propertyName
yield ValidationError(
f"{instance!r} does not contain discriminating property {prop_name!r}",
context=[],
)
return
# Use explicit mapping if available, otherwise try implicit value
ref = (
discriminator.get("mapping", {}).get(prop_value)
or f"#/components/schemas/{prop_value}"
)
if not isinstance(ref, str):
# this is a schema error
yield ValidationError(
"{!r} mapped value for {!r} should be a string, was {!r}".format(
instance, prop_value, ref
),
context=[],
)
return
try:
validator._validate_reference(ref=ref, instance=instance)
except:
yield ValidationError(
f"{instance!r} reference {ref!r} could not be resolved",
context=[],
)
return
yield from validator.descend(instance, {"$ref": ref})
def anyOf(
validator: Validator,
anyOf: List[Mapping[Hashable, Any]],
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
if "discriminator" not in schema:
yield from _anyOf(validator, anyOf, instance, schema)
else:
yield from handle_discriminator(validator, anyOf, instance, schema)
def oneOf(
validator: Validator,
oneOf: List[Mapping[Hashable, Any]],
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
if "discriminator" not in schema:
yield from _oneOf(validator, oneOf, instance, schema)
else:
yield from handle_discriminator(validator, oneOf, instance, schema)
def allOf(
validator: Validator,
allOf: List[Mapping[Hashable, Any]],
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
if "discriminator" not in schema:
yield from _allOf(validator, allOf, instance, schema)
else:
yield from handle_discriminator(validator, allOf, instance, schema)
def type(
validator: Validator,
data_type: str,
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
if instance is None:
# nullable implementation based on OAS 3.0.3
# * nullable is only meaningful if its value is true
# * nullable: true is only meaningful in combination with a type
# assertion specified in the same Schema Object.
# * nullable: true operates within a single Schema Object
if "nullable" in schema and schema["nullable"] == True:
return
yield ValidationError("None for not nullable")
if not validator.is_type(instance, data_type):
data_repr = repr(data_type)
yield ValidationError(f"{instance!r} is not of type {data_repr}")
def format(
validator: Validator,
format: str,
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
if instance is None:
return
if validator.format_checker is not None:
try:
validator.format_checker.check(instance, format)
except FormatError as error:
yield ValidationError(str(error), cause=error.cause)
def items(
validator: Validator,
items: Mapping[Hashable, Any],
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
if not validator.is_type(instance, "array"):
return
for index, item in enumerate(instance):
yield from validator.descend(item, items, path=index)
def required(
validator: Validator,
required: List[str],
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
if not validator.is_type(instance, "object"):
return
for property in required:
if property not in instance:
prop_schema = schema.get("properties", {}).get(property)
if prop_schema:
read_only = prop_schema.get("readOnly", False)
write_only = prop_schema.get("writeOnly", False)
if (
getattr(validator, "write", True)
and read_only
or getattr(validator, "read", True)
and write_only
):
continue
yield ValidationError(f"{property!r} is a required property")
def read_required(
validator: Validator,
required: List[str],
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
if not validator.is_type(instance, "object"):
return
for property in required:
if property not in instance:
prop_schema = schema.get("properties", {}).get(property)
if prop_schema:
write_only = prop_schema.get("writeOnly", False)
if getattr(validator, "read", True) and write_only:
continue
yield ValidationError(f"{property!r} is a required property")
def write_required(
validator: Validator,
required: List[str],
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
if not validator.is_type(instance, "object"):
return
for property in required:
if property not in instance:
prop_schema = schema.get("properties", {}).get(property)
if prop_schema:
read_only = prop_schema.get("readOnly", False)
if read_only:
continue
yield ValidationError(f"{property!r} is a required property")
def additionalProperties(
validator: Validator,
aP: Union[Mapping[Hashable, Any], bool],
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
if not validator.is_type(instance, "object"):
return
extras = set(find_additional_properties(instance, schema))
if not extras:
return
if validator.is_type(aP, "object"):
for extra in extras:
for error in validator.descend(instance[extra], aP, path=extra):
yield error
elif validator.is_type(aP, "boolean"):
if not aP:
error = "Additional properties are not allowed (%s %s unexpected)"
yield ValidationError(error % extras_msg(extras))
def write_readOnly(
validator: Validator,
ro: bool,
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
yield ValidationError(f"Tried to write read-only property with {instance}")
def read_writeOnly(
validator: Validator,
wo: bool,
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
yield ValidationError(f"Tried to read write-only property with {instance}")
def not_implemented(
validator: Validator,
value: Any,
instance: Any,
schema: Mapping[Hashable, Any],
) -> Iterator[ValidationError]:
return
yield
|