-
Notifications
You must be signed in to change notification settings - Fork 55
Expand file tree
/
Copy pathmodel_utils.py
More file actions
1881 lines (1630 loc) · 71.5 KB
/
Copy pathmodel_utils.py
File metadata and controls
1881 lines (1630 loc) · 71.5 KB
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
# This product includes software developed at Datadog (https://www.datadoghq.com/).
# Copyright 2019-Present Datadog, Inc.
from contextlib import suppress
from datetime import date, datetime
from uuid import UUID
import enum
import inspect
import io
import os
import pprint
import re
import tempfile
from types import MappingProxyType
from typing import Collection, Mapping, Union, overload
from typing_extensions import Final, Self
from dateutil.parser import parse
from datadog_api_client.exceptions import (
ApiKeyError,
ApiAttributeError,
ApiTypeError,
ApiValueError,
)
none_type = type(None)
file_type = io.IOBase
empty_dict = MappingProxyType({}) # type: ignore
def _make_hashable(obj):
"""Convert potentially unhashable objects to hashable representations for caching."""
if isinstance(obj, (list, tuple)):
return tuple(_make_hashable(item) for item in obj)
elif isinstance(obj, dict):
return tuple(sorted((_make_hashable(k), _make_hashable(v)) for k, v in obj.items()))
elif isinstance(obj, set):
return tuple(sorted(_make_hashable(item) for item in obj))
else:
try:
hash(obj)
return obj
except TypeError:
return str(obj)
class UnsetType(enum.Enum):
unset = 0
unset: Final = UnsetType.unset
class cached_property(object):
# This caches the result of the function call for fn with no inputs
# use this as a decorator on function methods that you want converted
# into cached properties
result_key = "_results"
def __init__(self, fn):
self._fn = fn
def __get__(self, instance, cls=None):
if self.result_key in vars(self):
return vars(self)[self.result_key]
else:
result = self._fn(instance)
setattr(self, self.result_key, result)
return result
PRIMITIVE_TYPES = (list, float, int, bool, datetime, date, str, UUID, file_type)
def allows_single_value_input(cls):
"""
This function returns True if the input composed schema model or any
descendant model allows a value only input.
"""
if issubclass(cls, ModelSimple) or cls in PRIMITIVE_TYPES:
return True
elif issubclass(cls, ModelComposed):
if not cls._composed_schemas["oneOf"]:
return False
return any(allows_single_value_input(c) for c in cls._composed_schemas["oneOf"] if not isinstance(c, list))
return False
def composed_model_input_classes(cls):
"""
This function returns a list of the possible models that can be accepted as
inputs.
"""
# Handle list types (e.g., [str], [float])
if isinstance(cls, list):
return [cls]
if issubclass(cls, ModelSimple) or cls in PRIMITIVE_TYPES:
return [cls]
elif issubclass(cls, ModelNormal):
return [cls]
elif issubclass(cls, ModelComposed):
if not cls._composed_schemas["oneOf"]:
return []
input_classes = []
for c in cls._composed_schemas["oneOf"]:
input_classes.extend(composed_model_input_classes(c))
return input_classes
return []
class OpenApiModel:
"""The base class for all OpenAPIModels.
:var attribute_map: The key is attribute name and the value is json
key in definition.
:type attribute_map: dict
:var validations: The key is the name of the attribute. The value is a dict
that stores validations for max_length, min_length, max_items,
min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
inclusive_minimum, and regex.
:type validations: dict
:var additional_properties_type: A tuple of classes accepted
as additional properties values.
:type additional_properties_type: tuple
"""
_composed_schemas = empty_dict
additional_properties_type = (
bool,
date,
datetime,
dict,
float,
int,
list,
str,
UUID,
none_type,
)
attribute_map: Mapping[str, str] = empty_dict
_nullable = False
validations: Mapping[str, Mapping[str, Union[int, float]]] = empty_dict
openapi_types = empty_dict
read_only_vars: Collection[str] = frozenset()
def set_attribute(self, name, value):
# this is only used to set properties on self
path_to_item = []
if self._path_to_item:
path_to_item.extend(self._path_to_item)
path_to_item.append(name)
if name in self.openapi_types:
required_types_mixed = self.openapi_types[name]
elif self.additional_properties_type is None:
raise ApiAttributeError("{0} has no attribute '{1}'".format(type(self).__name__, name), path_to_item)
elif self.additional_properties_type is not None:
required_types_mixed = self.additional_properties_type
if get_simple_class(name) != str:
error_msg = type_error_message(var_name=name, var_value=name, valid_classes=(str,), key_type=True)
raise ApiTypeError(error_msg, path_to_item=path_to_item, valid_classes=(str,), key_type=True)
if self._check_type and value is not None:
value = validate_and_convert_types(
value,
required_types_mixed,
path_to_item,
self._spec_property_naming,
self._check_type,
configuration=self._configuration,
)
if isinstance(value, list):
for x in value:
if isinstance(x, UnparsedObject):
self._unparsed = True
if name in self.validations:
check_validations(self.validations[name], name, value, self._configuration)
self.__dict__["_data_store"][name] = value
if isinstance(value, OpenApiModel) and value._unparsed:
self._unparsed = True
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __ne__(self, other):
"""Returns true if both objects are not equal"""
return not self == other
def __setattr__(self, attr, value):
"""Set the value of an attribute using dot notation: `instance.attr = val`."""
self[attr] = value
def __getattr__(self, attr):
"""Get the value of an attribute using dot notation: `instance.attr`."""
return self.__getitem__(attr)
@overload
def __new__(cls, arg: None) -> None: # type: ignore
...
@overload
def __new__(cls, arg: "ModelComposed") -> Self:
...
@overload
def __new__(cls, *args, **kwargs) -> Self:
...
def __new__(cls, *args, **kwargs):
if len(args) == 1:
arg = args[0]
if arg is None and is_type_nullable(cls):
# The input data is the 'null' value and the type is nullable.
return None
if issubclass(cls, ModelComposed) and allows_single_value_input(cls):
model_kwargs = {}
oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg)
return oneof_instance
return super().__new__(cls)
def __init__(self, kwargs):
"""
:param _check_type: If True, values for parameters in openapi_types
will be type checked and a TypeError will be raised if the wrong type is input.
Defaults to True.
:type _check_type: bool
:param _path_to_item: This is a list of keys or values to drill down to
the model in received_data when deserializing a response.
:type _path_to_item: tuple/list
:param _spec_property_naming: True if the variable names in the input
data are serialized names, as specified in the OpenAPI document. False if the
variable names in the input data are pythonic names, e.g. snake case (default).
:type _spec_property_naming: bool
:param _configuration: The instance to use when deserializing a
file_type parameter. If passed, type conversion is attempted If omitted no
type conversion is done.
:type _configuration: Configuration
"""
_check_type = kwargs.pop("_check_type", True)
_spec_property_naming = kwargs.pop("_spec_property_naming", False)
_path_to_item = kwargs.pop("_path_to_item", ())
_configuration = kwargs.pop("_configuration", None)
self._data_store = {}
self._check_type = _check_type
self._spec_property_naming = _spec_property_naming
self._path_to_item = _path_to_item
self._configuration = _configuration
self._unparsed = False
def _check_pos_args(self, args):
if args:
raise ApiTypeError(
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments."
% (
args,
self.__class__.__name__,
),
path_to_item=self._path_to_item,
valid_classes=(self.__class__,),
)
def _check_kw_args(self, kwargs):
if kwargs:
raise ApiTypeError(
"Invalid named arguments=%s passed to %s. Remove those invalid named arguments."
% (
kwargs,
self.__class__.__name__,
),
path_to_item=self._path_to_item,
valid_classes=(self.__class__,),
)
class ModelSimple(OpenApiModel):
"""
The parent class of models whose type != object in their
swagger/openapi.
:var allowed_values: Set of allowed values.
:type allowed_values: set
"""
allowed_values: Collection[Union[str, int]] = frozenset()
required_properties = set(
[
"_data_store",
"_check_type",
"_spec_property_naming",
"_path_to_item",
"_configuration",
"_unparsed",
]
)
def __init__(self, value, **kwargs):
super().__init__(kwargs)
self.value = value
self._check_kw_args(kwargs)
def __setitem__(self, name, value):
"""Set the value of an attribute using square-bracket notation: `instance[attr] = val`."""
if name in self.required_properties:
self.__dict__[name] = value
return
if self.allowed_values and name == "value":
try:
check_allowed_values(self.allowed_values, name, value)
except ApiValueError:
self.__dict__["_data_store"][name] = value
self._unparsed = True
return
self.set_attribute(name, value)
def get(self, name, default=None):
"""Returns the value of an attribute or some default value if the attribute was not set."""
if name in self.required_properties:
return self.__dict__[name]
return self.__dict__["_data_store"].get(name, default)
def __getitem__(self, name):
"""Get the value of an attribute using square-bracket notation: `instance[attr]`."""
if name in self:
return self.get(name)
raise ApiAttributeError(
"{0} has no attribute '{1}'".format(type(self).__name__, name), [e for e in (self._path_to_item, name) if e]
)
def __contains__(self, name):
"""Used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`."""
if name in self.required_properties:
return name in self.__dict__
return name in self.__dict__["_data_store"]
def to_str(self):
"""Returns the string representation of the model"""
return str(self.value)
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, self.__class__):
return False
this_val = self._data_store["value"]
that_val = other._data_store["value"]
return this_val == that_val
class ModelNormal(OpenApiModel):
"""
The parent class of models whose type == object in their swagger/openapi.
"""
required_properties = set(
[
"_data_store",
"_check_type",
"_spec_property_naming",
"_path_to_item",
"_configuration",
"_unparsed",
]
)
def __setitem__(self, name, value):
"""Set the value of an attribute using square-bracket notation: `instance[attr] = val`."""
if name in self.required_properties:
self.__dict__[name] = value
return
self.set_attribute(name, value)
def get(self, name, default=None):
"""Returns the value of an attribute or some default value if the attribute was not set."""
if name in self.required_properties:
return self.__dict__[name]
return self.__dict__["_data_store"].get(name, default)
def __getitem__(self, name):
"""Get the value of an attribute using square-bracket notation: `instance[attr]`."""
if name in self:
return self.get(name)
raise ApiAttributeError(
"{0} has no attribute '{1}'".format(type(self).__name__, name), [e for e in (self._path_to_item, name) if e]
)
def __contains__(self, name):
"""Used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`."""
if name in self.required_properties:
return name in self.__dict__
return name in self.__dict__["_data_store"]
def to_dict(self):
"""Returns the model properties as a dict"""
return model_to_dict(self, serialize=False)
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, self.__class__):
return False
if not set(self._data_store.keys()) == set(other._data_store.keys()):
return False
for _var_name, this_val in self._data_store.items():
that_val = other._data_store[_var_name]
if this_val != that_val:
return False
return True
def __init__(self, kwargs):
super().__init__(kwargs)
for var_name, var_value in kwargs.items():
setattr(self, var_name, var_value)
if not self._spec_property_naming and var_name in self.read_only_vars:
raise ApiAttributeError(f"`{var_name}` is a read-only attribute.")
class ModelComposed(OpenApiModel):
"""
The parent class of models whose type == object in their swagger/openapi
and have oneOf.
When one sets a property we use var_name_to_model_instances to store the value in
the correct class instances + run any type checking + validation code.
When one gets a property we use var_name_to_model_instances to get the value
from the correct class instances.
This allows multiple composed schemas to contain the same property with additive
constraints on the value.
:var _composed_schemas: Stores the oneOf classes.
:type _composed_schemas: dict
:var _composed_instances: Stores a list of instances of the composed schemas
defined in _composed_schemas. When properties are accessed in the self instance,
they are returned from the self._data_store or the data stores in the instances
in self._composed_schemas.
:type _composed_schemas: list
:var _var_name_to_model_instances: Map between a variable name on self and
the composed instances (self included) which contain that data.
:type _var_name_to_model_instances: dict
"""
required_properties = set(
[
"_data_store",
"_check_type",
"_spec_property_naming",
"_path_to_item",
"_configuration",
"_composed_instances",
"_var_name_to_model_instances",
"_additional_properties_model_instances",
"_unparsed",
]
)
def __init__(self, kwargs):
super().__init__(kwargs)
constant_args = {
"_check_type": self._check_type,
"_path_to_item": self._path_to_item,
"_spec_property_naming": self._spec_property_naming,
"_configuration": self._configuration,
}
composed_info = validate_get_composed_info(constant_args, kwargs, self)
self._composed_instances = composed_info[0]
self._var_name_to_model_instances = composed_info[1]
self._additional_properties_model_instances = composed_info[2]
self._unparsed = any(
isinstance(composed_instance, UnparsedObject) for composed_instance in self._composed_instances
)
def __setitem__(self, name, value):
"""Set the value of an attribute using square-bracket notation: `instance[attr] = val`."""
if name in self.required_properties:
self.__dict__[name] = value
return
# Set attribute on composed instances
for model_instance in self._composed_instances:
setattr(model_instance, name, value)
if name not in self._var_name_to_model_instances:
# we assigned an additional property
self.__dict__["_var_name_to_model_instances"][name] = self._composed_instances + [self]
return None
__unset_attribute_value__ = object()
def get(self, name, default=None):
"""Returns the value of an attribute or some default value if the attribute was not set."""
if name in self.required_properties:
return self.__dict__[name]
# get the attribute from the correct instance
model_instances = self._var_name_to_model_instances.get(name)
values = []
# A composed model stores self and child (oneof) models under
# self._var_name_to_model_instances.
# Any property must exist in self and all model instances
# The value stored in all model instances must be the same
if model_instances:
for model_instance in model_instances:
if name in model_instance._data_store:
v = model_instance._data_store[name]
if v not in values:
values.append(v)
len_values = len(values)
if len_values == 0:
return default
elif len_values == 1:
return values[0]
elif len_values > 1:
raise ApiValueError(
"Values stored for property {0} in {1} differ when looking "
"at self and self's composed instances. All values must be "
"the same".format(name, type(self).__name__),
[e for e in (self._path_to_item, name) if e],
)
def __getitem__(self, name):
"""Get the value of an attribute using square-bracket notation: `instance[attr]`."""
value = self.get(name, self.__unset_attribute_value__)
if value is self.__unset_attribute_value__:
raise ApiAttributeError(
"{0} has no attribute '{1}'".format(type(self).__name__, name),
[e for e in (self._path_to_item, name) if e],
)
return value
def __contains__(self, name):
"""Used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`."""
if name in self.required_properties:
return name in self.__dict__
model_instances = self._var_name_to_model_instances.get(name, self._additional_properties_model_instances)
if model_instances:
for model_instance in model_instances:
if name in model_instance._data_store:
return True
return False
def to_dict(self):
"""Returns the model properties as a dict"""
return model_to_dict(self, serialize=False)
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def get_oneof_instance(self):
"""Returns the oneOf instance"""
return self._composed_instances[0]
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, self.__class__):
return False
if not set(self._data_store.keys()) == set(other._data_store.keys()):
return False
for _var_name, this_val in self._data_store.items():
that_val = other._data_store[_var_name]
if this_val != that_val:
return False
return True
COERCION_INDEX_BY_TYPE = {
ModelComposed: 0,
ModelNormal: 1,
ModelSimple: 2,
none_type: 3, # The type of 'None'.
list: 4,
dict: 5,
float: 6,
int: 7,
bool: 8,
datetime: 9,
date: 10,
str: 11,
UUID: 12,
file_type: 13, # 'file_type' is an alias for the built-in 'file' or 'io.IOBase' type.
}
# these are used to limit what type conversions we try to do
# when we have a valid type already and we want to try converting
# to another type
UPCONVERSION_TYPE_PAIRS = (
(str, datetime),
(str, date),
# (str, UUID), # Strings shouldn't always be converted to UUIDs, only when the format is a UUID explicitly.
(int, float), # A float may be serialized as an integer, e.g. '3' is a valid serialized float.
(list, ModelComposed),
(dict, ModelComposed),
(bool, ModelComposed),
(str, ModelComposed),
(int, ModelComposed),
(float, ModelComposed),
(list, ModelComposed),
(list, ModelNormal),
(dict, ModelNormal),
(bool, ModelSimple),
(str, ModelSimple),
(int, ModelSimple),
(float, ModelSimple),
(list, ModelSimple),
)
COERCIBLE_TYPE_PAIRS = {
False: ( # client instantiation of a model with client data
# (dict, ModelComposed),
# (list, ModelComposed),
# (dict, ModelNormal),
# (list, ModelNormal),
# (str, ModelSimple),
# (int, ModelSimple),
# (float, ModelSimple),
# (list, ModelSimple),
# (str, int),
# (str, float),
# (str, datetime),
# (str, date),
# (int, str),
# (float, str),
),
True: ( # server -> client data
(dict, ModelComposed),
(list, ModelComposed),
(dict, ModelNormal),
(list, ModelNormal),
(bool, ModelSimple),
(str, ModelSimple),
(int, ModelSimple),
(float, ModelSimple),
(list, ModelSimple),
# (str, int),
# (str, float),
(str, datetime),
(str, date),
(str, UUID),
# (int, str),
# (float, str),
(str, file_type),
),
}
def get_simple_class(input_value):
"""Returns an input_value's simple class that we will use for type checking.
:param input_value: The item for which we will return the simple class.
:type input_value: class/class_instance
"""
if isinstance(input_value, type):
# input_value is a class
return input_value
elif isinstance(input_value, tuple):
return tuple
elif isinstance(input_value, list):
return list
elif isinstance(input_value, dict):
return dict
elif input_value is None:
return none_type
elif isinstance(input_value, file_type):
return file_type
elif isinstance(input_value, bool):
# this must be higher than the int check because
# isinstance(True, int) == True
return bool
elif isinstance(input_value, int):
return int
elif isinstance(input_value, datetime):
# this must be higher than the date check because
# isinstance(datetime_instance, date) == True
return datetime
elif isinstance(input_value, date):
return date
elif isinstance(input_value, str):
return str
elif isinstance(input_value, UUID):
return UUID
return type(input_value)
def check_allowed_values(allowed_values, input_variable, input_values):
"""Raises an exception if the input_values are not allowed.
:type allowed_values: set
:param input_variable: The name of the input variable.
:type input_variable: str
:param input_values: The values that we are checking to see if they are in
allowed_values.
:type input_values: list/str/int/float/date/datetime/uuid
"""
if isinstance(input_values, list) and not set(input_values).issubset(allowed_values):
invalid_values = (", ".join(map(str, set(input_values) - allowed_values)),)
raise ApiValueError(
"Invalid values for `%s` [%s], must be a subset of [%s]"
% (input_variable, invalid_values, ", ".join(str(v) for v in allowed_values))
)
elif isinstance(input_values, dict) and not set(input_values.keys()).issubset(allowed_values):
invalid_values = ", ".join(map(str, set(input_values.keys()) - allowed_values))
raise ApiValueError(
"Invalid keys in `%s` [%s], must be a subset of [%s]"
% (input_variable, invalid_values, ", ".join(str(v) for v in allowed_values))
)
elif not isinstance(input_values, (list, dict)) and input_values not in allowed_values:
raise ApiValueError(
"Invalid value for `%s` (%s), must be one of %s" % (input_variable, input_values, allowed_values)
)
def is_json_validation_enabled(schema_keyword, configuration=None):
"""
Returns True if JSON schema validation is enabled for the specified
validation keyword. This can be used to skip JSON schema structural validation
as requested in the configuration.
:param schema_keyword: The name of a JSON schema validation keyword.
:type schema_keyword: string
:param configuration: The configuration instance.
:type configuration: Configuration
"""
return (
configuration is None
or not hasattr(configuration, "_disabled_client_side_validations")
or schema_keyword not in configuration._disabled_client_side_validations
)
def check_validations(validations, input_variable, input_values, configuration=None):
"""Raises an exception if the input_values are invalid.
:param validations: The validation dictionary.
:type validations: dict
:param input_variable: The name of the input variable.
:type input_variable: str
:param input_values: The values that we are checking.
:type input_values: list/str/int/float/date/datetime/uuid
:param configuration: The configuration instance.
:type configuration: Configuration
"""
if input_values is None:
return
if (
is_json_validation_enabled("multipleOf", configuration)
and "multiple_of" in validations
and isinstance(input_values, (int, float))
and not (float(input_values) / validations["multiple_of"]).is_integer()
):
# Note 'multipleOf' will be as good as the floating point arithmetic.
raise ApiValueError(
"Invalid value for `%s`, value must be a multiple of " "`%s`" % (input_variable, validations["multiple_of"])
)
if (
is_json_validation_enabled("maxLength", configuration)
and "max_length" in validations
and len(input_values) > validations["max_length"]
):
raise ApiValueError(
"Invalid value for `%s`, length must be less than or equal to "
"`%s`" % (input_variable, validations["max_length"])
)
if (
is_json_validation_enabled("minLength", configuration)
and "min_length" in validations
and len(input_values) < validations["min_length"]
):
raise ApiValueError(
"Invalid value for `%s`, length must be greater than or equal to "
"`%s`" % (input_variable, validations["min_length"])
)
if (
is_json_validation_enabled("maxItems", configuration)
and "max_items" in validations
and len(input_values) > validations["max_items"]
):
raise ApiValueError(
"Invalid value for `%s`, number of items must be less than or "
"equal to `%s`" % (input_variable, validations["max_items"])
)
if (
is_json_validation_enabled("minItems", configuration)
and "min_items" in validations
and len(input_values) < validations["min_items"]
):
raise ValueError(
"Invalid value for `%s`, number of items must be greater than or "
"equal to `%s`" % (input_variable, validations["min_items"])
)
items = ("exclusive_maximum", "inclusive_maximum", "exclusive_minimum", "inclusive_minimum")
if any(item in validations for item in items):
if isinstance(input_values, list):
max_val = max(input_values)
min_val = min(input_values)
elif isinstance(input_values, dict):
max_val = max(input_values.values())
min_val = min(input_values.values())
else:
max_val = input_values
min_val = input_values
if (
is_json_validation_enabled("exclusiveMaximum", configuration)
and "exclusive_maximum" in validations
and max_val >= validations["exclusive_maximum"]
):
raise ApiValueError(
"Invalid value for `%s`, must be a value less than `%s`"
% (input_variable, validations["exclusive_maximum"])
)
if (
is_json_validation_enabled("maximum", configuration)
and "inclusive_maximum" in validations
and max_val > validations["inclusive_maximum"]
):
raise ApiValueError(
"Invalid value for `%s`, must be a value less than or equal to "
"`%s`" % (input_variable, validations["inclusive_maximum"])
)
if (
is_json_validation_enabled("exclusiveMinimum", configuration)
and "exclusive_minimum" in validations
and min_val <= validations["exclusive_minimum"]
):
raise ApiValueError(
"Invalid value for `%s`, must be a value greater than `%s`"
% (input_variable, validations["exclusive_maximum"])
)
if (
is_json_validation_enabled("minimum", configuration)
and "inclusive_minimum" in validations
and min_val < validations["inclusive_minimum"]
):
raise ApiValueError(
"Invalid value for `%s`, must be a value greater than or equal "
"to `%s`" % (input_variable, validations["inclusive_minimum"])
)
flags = validations.get("regex", {}).get("flags", 0)
if (
is_json_validation_enabled("pattern", configuration)
and "regex" in validations
and not re.search(validations["regex"]["pattern"], input_values, flags=flags)
):
err_msg = r"Invalid value for `%s`, must match regular expression `%s`" % (
input_variable,
validations["regex"]["pattern"],
)
if flags != 0:
# Don't print the regex flags if the flags are not
# specified in the OAS document.
err_msg = r"%s with flags=`%s`" % (err_msg, flags)
raise ApiValueError(err_msg)
def order_response_types(required_types):
"""Returns the required types sorted in coercion order.
:param required_types: Collection of classes or instance of
list or dict with class information inside it.
:type required_types: list/tuple
:return: Coercion order sorted collection of classes or instance
of list or dict with class information inside it.
:rtype: list
"""
def index_getter(class_or_instance):
if isinstance(class_or_instance, list):
return COERCION_INDEX_BY_TYPE[list]
elif isinstance(class_or_instance, dict):
return COERCION_INDEX_BY_TYPE[dict]
elif inspect.isclass(class_or_instance) and issubclass(class_or_instance, ModelComposed):
return COERCION_INDEX_BY_TYPE[ModelComposed]
elif inspect.isclass(class_or_instance) and issubclass(class_or_instance, ModelNormal):
return COERCION_INDEX_BY_TYPE[ModelNormal]
elif inspect.isclass(class_or_instance) and issubclass(class_or_instance, ModelSimple):
return COERCION_INDEX_BY_TYPE[ModelSimple]
elif class_or_instance in COERCION_INDEX_BY_TYPE:
return COERCION_INDEX_BY_TYPE[class_or_instance]
raise ApiValueError("Unsupported type: %s" % class_or_instance)
sorted_types = sorted(required_types, key=index_getter)
return tuple(sorted_types)
def remove_uncoercible(required_types_classes, current_item, spec_property_naming, must_convert=True):
"""Only keeps the type conversions that are possible.
:param required_types_classes: Classes that are required, these should be
ordered by COERCION_INDEX_BY_TYPE.
:type required_types_classes: tuple
:param spec_property_naming: True if the variable names in the input data
are serialized names as specified in the OpenAPI document. False if the
variables names in the input data are python variable names in PEP-8 snake
case.
:type spec_property_naming: bool
:param current_item: The current item (input data) to be converted.
:param must_convert: If True the item to convert is of the wrong type and
we want a big list of coercibles if False, we want a limited list of coercibles.
:type must_convert: bool
:return: The remaining coercible required types, classes only.
:rtype: list
"""
current_type_simple = get_simple_class(current_item)
return list(
_remove_uncoercible_impl(required_types_classes, current_type_simple, spec_property_naming, must_convert)
)
def _remove_uncoercible_impl(required_types_classes, current_type_simple, spec_property_naming, must_convert=True):
"""Implementation of remove_uncoercible logic."""
results_classes = []
for required_type_class in required_types_classes:
# convert our models to OpenApiModel
required_type_class_simplified = required_type_class
if isinstance(required_type_class_simplified, type):
if issubclass(required_type_class_simplified, ModelComposed):
required_type_class_simplified = ModelComposed
elif issubclass(required_type_class_simplified, ModelNormal):
required_type_class_simplified = ModelNormal
elif issubclass(required_type_class_simplified, ModelSimple):
required_type_class_simplified = ModelSimple
if required_type_class_simplified == current_type_simple:
# don't consider converting to one's own class
continue
class_pair = (current_type_simple, required_type_class_simplified)
if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[spec_property_naming]:
results_classes.append(required_type_class)
elif class_pair in UPCONVERSION_TYPE_PAIRS:
results_classes.append(required_type_class)
return tuple(results_classes)
def get_possible_classes(cls, from_server_context):
possible_classes = [cls]
if from_server_context:
return possible_classes
if issubclass(cls, ModelComposed):
possible_classes.extend(composed_model_input_classes(cls))
return possible_classes
_type_classes_cache: dict = {}
def get_required_type_classes(required_types_mixed, spec_property_naming):
"""Converts the tuple required_types into a tuple and a dict described below.
:param required_types_mixed: Will contain either classes or instance of
list or dict.
:type required_types_mixed: tuple/list
:param spec_property_naming: if True these values came from the server, and
we use the data types in our endpoints. If False, we are client side and we
need to include oneOf classes inside the data types in our endpoints.
:type spec_property_naming: bool