-
Notifications
You must be signed in to change notification settings - Fork 146
/
__init__.py
1981 lines (1646 loc) · 71.1 KB
/
__init__.py
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
import datetime
import decimal
import time
import itertools
import pprint
import re
import translationstring
import warnings
from .compat import (
text_,
text_type,
string_types,
xrange,
is_nonstr_iter,
)
from . import iso8601
_ = translationstring.TranslationStringFactory('colander')
required = object()
_marker = required # bw compat
class _null(object):
""" Represents a null value in colander-related operations. """
def __nonzero__(self):
return False
# py3 compat
__bool__ = __nonzero__
def __repr__(self):
return '<colander.null>'
def __reduce__(self):
return 'null' # when unpickled, refers to "null" below (singleton)
null = _null()
def interpolate(msgs):
for s in msgs:
if hasattr(s, 'interpolate'):
yield s.interpolate()
else:
yield s
class Invalid(Exception):
"""
An exception raised by data types and validators indicating that
the value for a particular node was not valid.
The constructor receives a mandatory ``node`` argument. This must
be an instance of the :class:`colander.SchemaNode` class, or at
least something with the same interface.
The constructor also receives an optional ``msg`` keyword
argument, defaulting to ``None``. The ``msg`` argument is a
freeform field indicating the error circumstance.
The constructor additionally may receive an optional ``value``
keyword, indicating the value related to the error.
"""
pos = None
positional = False
def __init__(self, node, msg=None, value=None):
Exception.__init__(self, node, msg)
self.node = node
self.msg = msg
self.value = value
self.children = []
def messages(self):
""" Return an iterable of error messages for this exception using the
``msg`` attribute of this error node. If the ``msg`` attribute is
iterable, it is returned. If it is not iterable, and is
non-``None``, a single-element list containing the ``msg`` value is
returned. If the value is ``None``, an empty list is returned."""
if is_nonstr_iter(self.msg):
return self.msg
if self.msg is None:
return []
return [self.msg]
def add(self, exc, pos=None):
""" Add a child exception; ``exc`` must be an instance of
:class:`colander.Invalid` or a subclass.
``pos`` is a value important for accurate error reporting. If
it is provided, it must be an integer representing the
position of ``exc`` relative to all other subexceptions of
this exception node. For example, if the exception being
added is about the third child of the exception which is
``self``, ``pos`` might be passed as ``3``.
If ``pos`` is provided, it will be assigned to the ``pos``
attribute of the provided ``exc`` object.
"""
if self.node and isinstance(self.node.typ, Positional):
exc.positional = True
if pos is not None:
exc.pos = pos
self.children.append(exc)
def __setitem__(self, name, msg):
""" Add a subexception related to a child node with the
message ``msg``. ``name`` must be present in the names of the
set of child nodes of this exception's node; if this is not
so, a :exc:`KeyError` is raised.
For example, if the exception upon which ``__setitem__`` is
called has a node attribute, and that node attribute has
children that have the names ``name`` and ``title``, you may
successfully call ``__setitem__('name', 'Bad name')`` or
``__setitem__('title', 'Bad title')``. But calling
``__setitem__('wrong', 'whoops')`` will result in a
:exc:`KeyError`.
This method is typically only useful if the ``node`` attribute
of the exception upon which it is called is a schema node
representing a mapping.
"""
for num, child in enumerate(self.node.children):
if child.name == name:
exc = Invalid(child, msg)
self.add(exc, num)
return
raise KeyError(name)
def paths(self):
""" A generator which returns each path through the exception
graph. Each path is represented as a tuple of exception
nodes. Within each tuple, the leftmost item will represent
the root schema node, the rightmost item will represent the
leaf schema node."""
def traverse(node, stack):
stack.append(node)
if not node.children:
yield tuple(stack)
for child in node.children:
for path in traverse(child, stack):
yield path
stack.pop()
return traverse(self, [])
def _keyname(self):
if self.positional:
return str(self.pos)
return str(self.node.name)
def asdict(self):
""" Return a dictionary containing a basic
(non-language-translated) error report for this exception"""
paths = self.paths()
errors = {}
for path in paths:
keyparts = []
msgs = []
for exc in path:
exc.msg and msgs.extend(exc.messages())
keyname = exc._keyname()
keyname and keyparts.append(keyname)
errors['.'.join(keyparts)] = '; '.join(interpolate(msgs))
return errors
def __str__(self):
""" Return a pretty-formatted string representation of the
result of an execution of this exception's ``asdict`` method"""
return pprint.pformat(self.asdict())
class All(object):
""" Composite validator which succeeds if none of its
subvalidators raises an :class:`colander.Invalid` exception"""
def __init__(self, *validators):
self.validators = validators
def __call__(self, node, value):
excs = []
for validator in self.validators:
try:
validator(node, value)
except Invalid as e:
excs.append(e)
if excs:
exc = Invalid(node, [exc.msg for exc in excs])
for e in excs:
exc.children.extend(e.children)
raise exc
class Function(object):
""" Validator which accepts a function and an optional message;
the function is called with the ``value`` during validation.
If the function returns anything falsy (``None``, ``False``, the
empty string, ``0``, an object with a ``__nonzero__`` that returns
``False``, etc) when called during validation, an
:exc:`colander.Invalid` exception is raised (validation fails);
its msg will be the value of the ``message`` argument passed to
this class' constructor.
If the function returns a stringlike object (a ``str`` or
``unicode`` object) that is *not* the empty string , a
:exc:`colander.Invalid` exception is raised using the stringlike
value returned from the function as the exeption message
(validation fails).
If the function returns anything *except* a stringlike object
object which is truthy (e.g. ``True``, the integer ``1``, an
object with a ``__nonzero__`` that returns ``True``, etc), an
:exc:`colander.Invalid` exception is *not* raised (validation
succeeds).
The default value for the ``message`` when not provided via the
constructor is ``Invalid value``.
"""
def __init__(self, function, message=_('Invalid value')):
self.function = function
self.message = message
def __call__(self, node, value):
result = self.function(value)
if not result:
raise Invalid(
node, translationstring.TranslationString(
self.message, mapping={'val':value}))
if isinstance(result, string_types):
raise Invalid(
node, translationstring.TranslationString(
result, mapping={'val':value}))
class Regex(object):
""" Regular expression validator.
Initialize it with the string regular expression ``regex``
that will be compiled and matched against ``value`` when
validator is called. If ``msg`` is supplied, it will be the
error message to be used; otherwise, defaults to 'String does
not match expected pattern'.
The ``regex`` argument may also be a pattern object (the
result of ``re.compile``) instead of a string.
When calling, if ``value`` matches the regular expression,
validation succeeds; otherwise, :exc:`colander.Invalid` is
raised with the ``msg`` error message.
"""
def __init__(self, regex, msg=None):
if isinstance(regex, string_types):
self.match_object = re.compile(regex)
else:
self.match_object = regex
if msg is None:
self.msg = _("String does not match expected pattern")
else:
self.msg = msg
def __call__(self, node, value):
if self.match_object.match(value) is None:
raise Invalid(node, self.msg)
class Email(Regex):
""" Email address validator. If ``msg`` is supplied, it will be
the error message to be used when raising :exc:`colander.Invalid`;
otherwise, defaults to 'Invalid email address'.
"""
def __init__(self, msg=None):
if msg is None:
msg = _("Invalid email address")
super(Email, self).__init__(
text_('(?i)^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$'), msg=msg)
class Range(object):
""" Validator which succeeds if the value it is passed is greater
or equal to ``min`` and less than or equal to ``max``. If ``min``
is not specified, or is specified as ``None``, no lower bound
exists. If ``max`` is not specified, or is specified as ``None``,
no upper bound exists.
``min_err`` is used to form the ``msg`` of the
:exc:`colander.Invalid` error when reporting a validation failure
caused by a value not meeting the minimum. If ``min_err`` is
specified, it must be a string. The string may contain the
replacement targets ``${min}`` and ``${val}``, representing the
minimum value and the provided value respectively. If it is not
provided, it defaults to ``'${val} is less than minimum value
${min}'``.
``max_err`` is used to form the ``msg`` of the
:exc:`colander.Invalid` error when reporting a validation failure
caused by a value exceeding the maximum. If ``max_err`` is
specified, it must be a string. The string may contain the
replacement targets ``${max}`` and ``${val}``, representing the
maximum value and the provided value respectively. If it is not
provided, it defaults to ``'${val} is greater than maximum value
${max}'``.
"""
min_err = _('${val} is less than minimum value ${min}')
max_err = _('${val} is greater than maximum value ${max}')
def __init__(self, min=None, max=None, min_err=None, max_err=None):
self.min = min
self.max = max
if min_err is not None:
self.min_err = min_err
if max_err is not None:
self.max_err = max_err
def __call__(self, node, value):
if self.min is not None:
if value < self.min:
min_err = _(self.min_err, mapping={'val':value, 'min':self.min})
raise Invalid(node, min_err)
if self.max is not None:
if value > self.max:
max_err = _(self.max_err, mapping={'val':value, 'max':self.max})
raise Invalid(node, max_err)
class Length(object):
""" Validator which succeeds if the value passed to it has a
length between a minimum and maximum. The value is most often a
string."""
def __init__(self, min=None, max=None):
self.min = min
self.max = max
def __call__(self, node, value):
if self.min is not None:
if len(value) < self.min:
min_err = _('Shorter than minimum length ${min}',
mapping={'min':self.min})
raise Invalid(node, min_err)
if self.max is not None:
if len(value) > self.max:
max_err = _('Longer than maximum length ${max}',
mapping={'max':self.max})
raise Invalid(node, max_err)
class OneOf(object):
""" Validator which succeeds if the value passed to it is one of
a fixed set of values """
def __init__(self, choices):
self.choices = choices
def __call__(self, node, value):
if not value in self.choices:
choices = ', '.join(['%s' % x for x in self.choices])
err = _('"${val}" is not one of ${choices}',
mapping={'val':value, 'choices':choices})
raise Invalid(node, err)
def luhnok(node, value):
""" Validator which checks to make sure that the value passes a luhn
mod-10 checksum (credit cards). ``value`` must be a string, not an
integer."""
try:
sum = _luhnok(value)
except:
raise Invalid(node,
'%r is not a valid credit card number' % value)
if not (sum % 10) == 0:
raise Invalid(node,
'%r is not a valid credit card number' % value)
def _luhnok(value):
sum = 0
num_digits = len(value)
oddeven = num_digits & 1
for count in range(0, num_digits):
digit = int(value[count])
if not (( count & 1 ) ^ oddeven ):
digit = digit * 2
if digit > 9:
digit = digit - 9
sum = sum + digit
return sum
class SchemaType(object):
""" Base class for all schema types """
def flatten(self, node, appstruct, prefix='', listitem=False):
result = {}
if listitem:
selfname = prefix
else:
selfname = '%s%s' % (prefix, node.name)
result[selfname] = appstruct
return result
def unflatten(self, node, paths, fstruct):
name = node.name
assert paths == [name], "paths should be [name] for leaf nodes."
return fstruct[name]
def set_value(self, node, appstruct, path, value):
raise AssertionError("Can't call 'set_value' on a leaf node.")
def get_value(self, node, appstruct, path):
raise AssertionError("Can't call 'get_value' on a leaf node.")
def cstruct_children(self, node, cstruct):
return []
class Mapping(SchemaType):
""" A type which represents a mapping of names to nodes.
The subnodes of the :class:`colander.SchemaNode` that wraps
this type imply the named keys and values in the mapping.
The constructor of this type accepts one extra optional keyword
argument that other types do not: ``unknown``. An attribute of
the same name can be set on a type instance to control the
behavior after construction.
unknown
``unknown`` controls the behavior of this type when an unknown
key is encountered in the cstruct passed to the
``deserialize`` method of this instance. All the potential
values of ``unknown`` are strings. They are:
- ``ignore`` means that keys that are not present in the schema
associated with this type will be ignored during
deserialization.
- ``raise`` will cause a :exc:`colander.Invalid` exception to
be raised when unknown keys are present in the cstruct
during deserialization.
- ``preserve`` will preserve the 'raw' unknown keys and values
in the appstruct returned by deserialization.
Default: ``ignore``.
Special behavior is exhibited when a subvalue of a mapping is
present in the schema but is missing from the mapping passed to
either the ``serialize`` or ``deserialize`` method of this class.
In this case, the :attr:`colander.null` value will be passed to
the ``serialize`` or ``deserialize`` method of the schema node
representing the subvalue of the mapping respectively. During
serialization, this will result in the behavior described in
:ref:`serializing_null` for the subnode. During deserialization,
this will result in the behavior described in
:ref:`deserializing_null` for the subnode.
If the :attr:`colander.null` value is passed to the serialize
method of this class, a dictionary will be returned, where each of
the values in the returned dictionary is the serialized
representation of the null value for its type.
"""
def __init__(self, unknown='ignore'):
self.unknown = unknown
def _set_unknown(self, value):
if not value in ('ignore', 'raise', 'preserve'):
raise ValueError(
'unknown attribute must be one of "ignore", "raise", '
'or "preserve"')
self._unknown = value
def _get_unknown(self):
return self._unknown
unknown = property(_get_unknown, _set_unknown)
def _validate(self, node, value):
try:
return dict(value)
except Exception as e:
raise Invalid(node,
_('"${val}" is not a mapping type: ${err}',
mapping = {'val':value, 'err':e})
)
def cstruct_children(self, node, cstruct):
if cstruct is null:
value = {}
else:
value = self._validate(node, cstruct)
children = []
for subnode in node.children:
name = subnode.name
subval = value.get(name, _marker)
if subval is _marker:
subval = subnode.serialize(null)
children.append(subval)
return children
def _impl(self, node, value, callback):
value = self._validate(node, value)
error = None
result = {}
for num, subnode in enumerate(node.children):
name = subnode.name
subval = value.pop(name, null)
try:
result[name] = callback(subnode, subval)
except Invalid as e:
if error is None:
error = Invalid(node)
error.add(e, num)
if self.unknown == 'raise':
if value:
raise Invalid(
node,
_('Unrecognized keys in mapping: "${val}"',
mapping={'val':value})
)
elif self.unknown == 'preserve':
result.update(value)
if error is not None:
raise error
return result
def serialize(self, node, appstruct):
if appstruct is null:
appstruct = {}
def callback(subnode, subappstruct):
return subnode.serialize(subappstruct)
return self._impl(node, appstruct, callback)
def deserialize(self, node, cstruct):
if cstruct is null:
return null
def callback(subnode, subcstruct):
return subnode.deserialize(subcstruct)
return self._impl(node, cstruct, callback)
def flatten(self, node, appstruct, prefix='', listitem=False):
result = {}
if listitem:
selfprefix = prefix
else:
if node.name:
selfprefix = '%s%s.' % (prefix, node.name)
else:
selfprefix = prefix
for subnode in node.children:
name = subnode.name
substruct = appstruct.get(name, null)
result.update(subnode.typ.flatten(subnode, substruct,
prefix=selfprefix))
return result
def unflatten(self, node, paths, fstruct):
return _unflatten_mapping(node, paths, fstruct)
def set_value(self, node, appstruct, path, value):
if '.' in path:
next_name, rest = path.split('.', 1)
next_node = node[next_name]
next_appstruct = appstruct[next_name]
appstruct[next_name] = next_node.typ.set_value(
next_node, next_appstruct, rest, value)
else:
appstruct[path] = value
return appstruct
def get_value(self, node, appstruct, path):
if '.' in path:
name, rest = path.split('.', 1)
next_node = node[name]
return next_node.typ.get_value(next_node, appstruct[name], rest)
return appstruct[path]
class Positional(object):
"""
Marker abstract base class meaning 'this type has children which
should be addressed by position instead of name' (e.g. via seq[0],
but never seq['name']). This is consulted by Invalid.asdict when
creating a dictionary representation of an error tree.
"""
class Tuple(Positional, SchemaType):
""" A type which represents a fixed-length sequence of nodes.
The subnodes of the :class:`colander.SchemaNode` that wraps
this type imply the positional elements of the tuple in the order
they are added.
This type is willing to serialize and deserialized iterables that,
when converted to a tuple, have the same number of elements as the
number of the associated node's subnodes.
If the :attr:`colander.null` value is passed to the serialize
method of this class, the :attr:`colander.null` value will be
returned.
"""
def _validate(self, node, value):
if not hasattr(value, '__iter__'):
raise Invalid(
node,
_('"${val}" is not iterable', mapping={'val':value})
)
valuelen, nodelen = len(value), len(node.children)
if valuelen != nodelen:
raise Invalid(
node,
_('"${val}" has an incorrect number of elements '
'(expected ${exp}, was ${was})',
mapping={'val':value, 'exp':nodelen, 'was':valuelen})
)
return list(value)
def cstruct_children(self, node, cstruct):
childlen = len(node.children)
if cstruct is null:
cstruct = []
structlen = len(cstruct)
if structlen < childlen:
missing_children = node.children[structlen:]
cstruct = list(cstruct)
for child in missing_children:
cstruct.append(child.serialize(null))
elif structlen > childlen:
cstruct = cstruct[:childlen]
else:
cstruct = list(cstruct)
return cstruct
def _impl(self, node, value, callback):
value = self._validate(node, value)
error = None
result = []
for num, subnode in enumerate(node.children):
subval = value[num]
try:
result.append(callback(subnode, subval))
except Invalid as e:
if error is None:
error = Invalid(node)
error.add(e, num)
if error is not None:
raise error
return tuple(result)
def serialize(self, node, appstruct):
if appstruct is null:
return null
def callback(subnode, subappstruct):
return subnode.serialize(subappstruct)
return self._impl(node, appstruct, callback)
def deserialize(self, node, cstruct):
if cstruct is null:
return null
def callback(subnode, subval):
return subnode.deserialize(subval)
return self._impl(node, cstruct, callback)
def flatten(self, node, appstruct, prefix='', listitem=False):
result = {}
if listitem:
selfprefix = prefix
else:
selfprefix = '%s%s.' % (prefix, node.name)
for num, subnode in enumerate(node.children):
substruct = appstruct[num]
result.update(subnode.typ.flatten(subnode, substruct,
prefix=selfprefix))
return result
def unflatten(self, node, paths, fstruct):
mapstruct = _unflatten_mapping(node, paths, fstruct)
appstruct = []
for subnode in node.children:
appstruct.append(mapstruct[subnode.name])
return tuple(appstruct)
def set_value(self, node, appstruct, path, value):
appstruct = list(appstruct)
if '.' in path:
next_name, rest = path.split('.', 1)
else:
next_name, rest = path, None
for index, next_node in enumerate(node.children):
if next_node.name == next_name:
break
else:
raise KeyError(next_name)
if rest is not None:
next_appstruct = appstruct[index]
appstruct[index] = next_node.typ.set_value(
next_node, next_appstruct, rest, value)
else:
appstruct[index] = value
return tuple(appstruct)
def get_value(self, node, appstruct, path):
if '.' in path:
name, rest = path.split('.', 1)
else:
name, rest = path, None
for index, next_node in enumerate(node.children):
if next_node.name == name:
break
else:
raise KeyError(name)
if rest is not None:
return next_node.typ.get_value(next_node, appstruct[index], rest)
return appstruct[index]
class SequenceItems(list):
"""
List marker subclass for use by Sequence.cstruct_children, which indicates
to a caller of that method that the result is from a sequence type.
Usually these values need to be treated specially, because all of the
children of a Sequence are not present in a schema.
"""
class Sequence(Positional, SchemaType):
"""
A type which represents a variable-length sequence of nodes,
all of which must be of the same type.
The type of the first subnode of the
:class:`colander.SchemaNode` that wraps this type is considered the
sequence type.
The optional ``accept_scalar`` argument to this type's constructor
indicates what should happen if the value found during serialization or
deserialization does not have an ``__iter__`` method or is a
mapping type.
If ``accept_scalar`` is ``True`` and the value does not have an
``__iter__`` method or is a mapping type, the value will be turned
into a single element list.
If ``accept_scalar`` is ``False`` and the value does not have an
``__iter__`` method or is a mapping type, an
:exc:`colander.Invalid` error will be raised during serialization
and deserialization.
The default value of ``accept_scalar`` is ``False``.
If the :attr:`colander.null` value is passed to the serialize
method of this class, the :attr:`colander.null` value is returned.
"""
def __init__(self, accept_scalar=False):
self.accept_scalar = accept_scalar
def _validate(self, node, value, accept_scalar):
if hasattr(value, '__iter__') and not hasattr(value, 'get'):
return list(value)
if accept_scalar:
return [value]
else:
raise Invalid(node, _('"${val}" is not iterable',
mapping={'val':value})
)
def cstruct_children(self, node, cstruct):
if cstruct is null:
return SequenceItems([])
return SequenceItems(cstruct)
def _impl(self, node, value, callback, accept_scalar):
if accept_scalar is None:
accept_scalar = self.accept_scalar
value = self._validate(node, value, accept_scalar)
error = None
result = []
for num, subval in enumerate(value):
try:
result.append(callback(node.children[0], subval))
except Invalid as e:
if error is None:
error = Invalid(node)
error.add(e, num)
if error is not None:
raise error
return result
def serialize(self, node, appstruct, accept_scalar=None):
"""
Along with the normal ``node`` and ``appstruct`` arguments,
this method accepts an additional optional keyword argument:
``accept_scalar``. This keyword argument can be used to
override the constructor value of the same name.
If ``accept_scalar`` is ``True`` and the ``appstruct`` does
not have an ``__iter__`` method or is a mapping type, the
value will be turned into a single element list.
If ``accept_scalar`` is ``False`` and the ``appstruct`` does
not have an ``__iter__`` method or is a mapping type, an
:exc:`colander.Invalid` error will be raised during
serialization and deserialization.
The default of ``accept_scalar`` is ``None``, which means
respect the default ``accept_scalar`` value attached to this
instance via its constructor.
"""
if appstruct is null:
return null
def callback(subnode, subappstruct):
return subnode.serialize(subappstruct)
return self._impl(node, appstruct, callback, accept_scalar)
def deserialize(self, node, cstruct, accept_scalar=None):
"""
Along with the normal ``node`` and ``cstruct`` arguments, this
method accepts an additional optional keyword argument:
``accept_scalar``. This keyword argument can be used to
override the constructor value of the same name.
If ``accept_scalar`` is ``True`` and the ``cstruct`` does not
have an ``__iter__`` method or is a mapping type, the value
will be turned into a single element list.
If ``accept_scalar`` is ``False`` and the ``cstruct`` does not have an
``__iter__`` method or is a mapping type, an
:exc:`colander.Invalid` error will be raised during serialization
and deserialization.
The default of ``accept_scalar`` is ``None``, which means
respect the default ``accept_scalar`` value attached to this
instance via its constructor.
"""
if cstruct is null:
return null
def callback(subnode, subcstruct):
return subnode.deserialize(subcstruct)
return self._impl(node, cstruct, callback, accept_scalar)
def flatten(self, node, appstruct, prefix='', listitem=False):
result = {}
if listitem:
selfprefix = prefix
else:
selfprefix = '%s%s.' % (prefix, node.name)
childnode = node.children[0]
for num, subval in enumerate(appstruct):
subname = '%s%s' % (selfprefix, num)
subprefix = subname + '.'
result.update(childnode.typ.flatten(
childnode, subval, prefix=subprefix, listitem=True))
return result
def unflatten(self, node, paths, fstruct):
only_child = node.children[0]
child_name = only_child.name
def get_child(name):
return only_child
def rewrite_subpath(subpath):
if '.' in subpath:
suffix = subpath.split('.', 1)[1]
return '%s.%s' % (child_name, suffix)
return child_name
mapstruct = _unflatten_mapping(node, paths, fstruct,
get_child, rewrite_subpath)
return [mapstruct[str(index)] for index in xrange(len(mapstruct))]
def set_value(self, node, appstruct, path, value):
if '.' in path:
next_name, rest = path.split('.', 1)
index = int(next_name)
next_node = node.children[0]
next_appstruct = appstruct[index]
appstruct[index] = next_node.typ.set_value(
next_node, next_appstruct, rest, value)
else:
index = int(path)
appstruct[index] = value
return appstruct
def get_value(self, node, appstruct, path):
if '.' in path:
name, rest = path.split('.', 1)
index = int(name)
next_node = node.children[0]
return next_node.typ.get_value(next_node, appstruct[index], rest)
return appstruct[int(path)]
Seq = Sequence
class String(SchemaType):
""" A type representing a Unicode string.
This type constructor accepts one argument:
``encoding``
Represents the encoding which should be applied to value
serialization and deserialization, for example ``utf-8``. If
``encoding`` is passed as ``None``, the ``serialize`` method of
this type will not do any special encoding of the appstruct it is
provided, nor will the ``deserialize`` method of this type do
any special decoding of the cstruct it is provided; inputs and
outputs will be assumed to be Unicode. ``encoding`` defaults
to ``None``.
If ``encoding`` is ``None``:
- A Unicode input value to ``serialize`` is returned untouched.
- A non-Unicode input value to ``serialize`` is run through the
``unicode()`` function without an ``encoding`` parameter
(``unicode(value)``) and the result is returned.
- A Unicode input value to ``deserialize`` is returned untouched.
- A non-Unicode input value to ``deserialize`` is run through the
``unicode()`` function without an ``encoding`` parameter
(``unicode(value)``) and the result is returned.
If ``encoding`` is not ``None``:
- A Unicode input value to ``serialize`` is run through the
``unicode`` function with the encoding parameter
(``unicode(value, encoding)``) and the result (a ``str``
object) is returned.
- A non-Unicode input value to ``serialize`` is converted to a
Unicode using the encoding (``unicode(value, encoding)``);
subsequently the Unicode object is reeencoded to a ``str``
object using the encoding and returned.
- A Unicode input value to ``deserialize`` is returned
untouched.
- A non-Unicode input value to ``deserialize`` is converted to
a ``str`` object using ``str(value``). The resulting str
value is converted to Unicode using the encoding
(``unicode(value, encoding)``) and the result is returned.
A corollary: If a string (as opposed to a unicode object) is
provided as a value to either the serialize or deserialize
method of this type, and the type also has an non-None
``encoding``, the string must be encoded with the type's
encoding. If this is not true, an :exc:`colander.Invalid`
error will result.
The subnodes of the :class:`colander.SchemaNode` that wraps
this type are ignored.
"""
def __init__(self, encoding=None):
self.encoding = encoding
def serialize(self, node, appstruct):
if not appstruct:
return null
try:
if isinstance(appstruct, (text_type, bytes)):
encoding = self.encoding
if encoding:
result = text_(appstruct, encoding).encode(encoding)
else:
result = text_type(appstruct)
else:
result = text_type(appstruct)
return result
except Exception as e:
raise Invalid(node,
_('${val} cannot be serialized: ${err}',