-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCHANGES
178 lines (120 loc) · 5.99 KB
/
CHANGES
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
~~~~~~~~~
Changelog
~~~~~~~~~
Version 0.14-dev
----------------
* Added support for inverted validators. If `IsA(str)` allows any `str`
instance, then `~IsA(str)` allows anything but a `str` instance.
* Replaced validator `NotExists` with invertible `Exists`.
* Added validators `ListOfAll` and `ListOfAny`; the older `ListOf` becomes
an alias for `ListOfAll`. Both are thin subclasses of the new `BaseListOf`
which allows implementation of different error toleration strategies.
* Added simple validators `Contains` and `HasAttr`.
* Exception messages and validator representations have been made more
friendly to these humans that may try reading them someday.
* Dropped support for Python 3.3 and 3.4, added for 3.5.
* Fixed some MongoDB-specific tests.
Version 0.13.2
--------------
* Fixed bug in shortcut `opt_key`: it would construct a validator
of wrong class from a `str` value under Python 2.x.
Version 0.13.1
--------------
* Added shortcut `opt_key` to fix the problem with `optional('x')` as
dictionary key. A change in design may follow.
Version 0.13
------------
The library has been completely rewritten.
Improvements
............
* Validation is ~2× faster!
* Very complex rules can be now created by *combining* basic validators;
* Custom validators are easy to write;
* Validators can be plugged right into the schema — they *are* the schema;
* The old top-level "natural" syntax works as before on top of this one.
Migration notes
...............
The good stuff comes at a cost; **your old code will probably break**
unless it only used plain Python specs.
This release maintains backwards compatibility only on the "natural syntax"
level. The underlying mechanism has been completely replaced. Any code
that relied on Rules must be updated before upgrade. This should be rather
easy as the new mechanism is much more powerful and expressive.
An example of what you may need to do:
.. code-block:: python
old_spec = {
'foo': OneOf([str, int], as_rules=True),
'bar': Rule(datatype=int, validators=[in_range(0, 5)]),
'quux': int,
}
new_spec = {
'foo': IsA(str) | IsA(int), # or: Any([str, int])
'bar': IsA(int) & InRange(0, 5), # or: InRange(0,5) & int
'quux': int,
}
Changes
.......
* Added a new validation mechanism instead of the Rule/OneOf-based one.
* Added validators/combinators: `Any`, `All`.
* Added validators/requirements: `Anything`, `IsA`, `Equals`, `InRange`,
`Length`, `ListOf`, `DictOf`, `NotExists`.
* List validation and list item validation are now separated. The natural
syntax works as before. The underlying ``IsA(list)`` or ``ListOf(xs)``
can be combined with other validators such as `Length` for greater precision.
* Dictionary validation is implemented via ``DictOf(pairs)`` with `pairs` of
key and value validators. The syntax is somewhat cumbersome but it's always
possible to use the natural notation. Note that while the natural notation
remains the same as before — ``{'foo': int}`` — the key spec translates to
``Equals('foo')`` in verbose notation only if the whole dictionary spec
is defined in the natural notation. Note that normally ``'foo'`` is
translated as ``IsA(str, default='foo')`` which is too broad for a key
validator.
Removed (after deprecation):
* `unfold_to_list` (deprecated since 0.10)
* `unfold_to_list_of_dicts` (deprecated since 0.10)
**Removed/replaced without deprecation stage**:
* `Rule` class is replaced with concrete validators.
* `OneOf` class is replaced with `Any` combinator.
* `any_value` shortcut is replaced with `Anything` validator.
* `any_or_none` shortcut is dropped.
* `canonize()` is replaced with `translate()`
* custom validators to be used within a `Rule` are replaced with stand-alone
validators/mergers.
* mergers are integrated into stand-alone validators/mergers; therefore
custom type-specific merger functions are dropped.
The function `merge_defaults` has been radically simplified and
it does not support `mergers` and `fallback` arguments anymore.
* all validation logic has been integrated into stand-alone validators;
therefore there are no more type-specific validation functions.
Deprecated:
* `one_of` shortcut is deprecated in favour of `Any` combinator.
* `in_range` shortcut is deprecated in favour of `InRange` validator.
Changed some details of validation behaviour:
* `ValidationError` is raised in most cases by most validators instead of more
concrete exceptions. This may change in the future.
Validators must never raise exceptions from other branches of the class tree
(`TypeError`, `KeyError`, etc.) unless the problem is not in the data.
* `None` is now treated as an ordinary value, therefore:
* `None` does not trigger the `MissingValue` exception anymore but it does
trigger validation error if found instead or something else.
* the `optional(x)` shortcut does not allow `x` being `None` anymore; it only
allows dict/list elements to be missing::
* to mark a value as nullable ("something or `None`"), the `nullable()`
shortcut must be used instead of `optional()` (or, if appropriate, the
underlying syntax should be used: ``IsA(str) | Equals(None)``).
Changed some details of merging behaviour:
* empty dictionaries are not created anymore if only a type `dict` was
specified by the schema.
Example: ``merge_defaults(dict, None)`` now returns `None` (was ``{}``).
* optional keys are not inserted into dictionaries anymore.
Example: ``merge_defaults({optional('a'): 1})`` returns `None` (was ``{'a': 1}``).
* default value is not chosen over `None` if the value is nullable
("something or None").
Version 0.12
------------
* Added ability to specify alternative rules (introducing `OneOf`, a sibling
of `Rule`). This functionality is also available in `one_of` with
`as_rules=True`.
* The MongoDB-related requirements are now optional.
* Dropped official support for Python 3.3 in favour of 3.4.
* The InvalidKey exception now uses `repr()` to format invalid values.