]> Cypherpunks.ru repositories - pyderasn.git/blob - doc/news.rst
Defaulted values are checked by default
[pyderasn.git] / doc / news.rst
1 News
2 ====
3
4 .. _release4.0:
5
6 4.0
7 ---
8 * Default value is checked also for Sets, not for Sequences only
9 * **Incompatible** change: defaulted values in Sequence/Set are always
10   strictly checked, unless ``allow_default_values`` context option is
11   set. ``strict_default_existence`` option disappeared
12
13 .. _release3.14:
14
15 3.14
16 ----
17 * Additional encoding validness check: explicit tag must contain exactly
18   one object inside. Throw DecodeError otherwise
19 * ``allow_expl_oob`` context and command-line options allow skipping of
20   that check
21
22 .. _release3.13:
23
24 3.13
25 ----
26 * DecodeError's decode paths are separated with ``:``, instead of ``.``,
27   because of colliding with dots in OIDs
28 * Ability to print element decode paths with ``--print-decode-path``
29   command line option (and corresponding keyword argument)
30 * Ability to print tree's branch specified with ``--decode-path-only``
31
32 .. _release3.12:
33
34 3.12
35 ----
36 * Fix possible uncaught TypeError in Py2 with zero bytes inside the value
37 * Fix SequenceOf/SetOf raising BoundsError instead of DecodeError
38
39 .. _release3.11:
40
41 3.11
42 ----
43 * Fix uncaught UTCTime/GeneralizedTime decode error when dealing with
44   non ASCII-encoded values
45
46 .. _release3.10:
47
48 3.10
49 ----
50 * Fix long-standing bug with explicitly tagged objects inside the
51   Choice. If Choice had explicitly tagged value, then its ``.tlvlen``
52   reports the size without taking value's explicit tag in advance
53 * Add ``.fulllen`` and ``.fulloffset`` properties for all objects
54
55 .. _release3.9:
56
57 3.9
58 ---
59 * SEQUENCE's values are printed with field's name. Previously there was
60   the following output::
61
62     AlgorithmIdentifier SEQUENCE[OBJECT IDENTIFIER 1.3.14.3.2.26, [UNIV 5] ANY 0500 OPTIONAL]
63
64   now it is::
65
66     AlgorithmIdentifier SEQUENCE[algorithm: OBJECT IDENTIFIER 1.3.14.3.2.26; parameters: [UNIV 5] ANY 0500 OPTIONAL]
67 * Fixed EOC (Unicode character) repr printing issues under Python2
68
69 .. _release3.8:
70
71 3.8
72 ---
73 BER's EOC is explicitly shown during pprinting. Following notation::
74
75       15-2 [0,0,1576]-4  . content: [0] EXPLICIT [UNIV 16] ANY
76
77 is replaced with::
78
79       15-2∞ [0,0,1576]∞  . content: [0] EXPLICIT [UNIV 16] ANY
80     [...]
81     1587    [1,1,   0]   . content:  BER EOC
82     1589    [1,1,   0]   . content: EXPLICIT BER EOC
83
84 .. _release3.7:
85
86 3.7
87 ---
88 * BER decoding support
89 * BitString's ''H notation support
90 * ``termcolor`` package is included in the tarball
91
92 .. _release3.6:
93
94 3.6
95 ---
96 * Ability to set values during Sequence initialization
97
98 .. _release3.5:
99
100 3.5
101 ---
102 * Fix TagMismatch exception completeness during Choice and Set decoding.
103   Previously we will loose offset and decode_path information about
104   concrete TagMismatched entity
105
106 .. _release3.4:
107
108 3.4
109 ---
110 * Strict NumericString's value sanitation
111 * Invalid encoding in string types will raise ``DecodeError`` exception,
112   instead of ``Unicode*Error``
113 * Fixed DecodePathDefBy workability with Python 2.x
114
115 .. _release3.3:
116
117 3.3
118 ---
119 * Fix nasty BitString decoding bug: it could fail when data follows
120   encoded BitString value. There weren't any problems when BitString is
121   at the end of Sequence
122
123 .. _release3.2:
124
125 3.2
126 ---
127 * Slightly corrected colours, now visible on white background
128
129 .. _release3.1:
130
131 3.1
132 ---
133 * Fix bug related to DecodeError showing with DecodePathDefBy entities
134 * Respect ``NO_COLOR`` environment variable
135
136 .. _release3.0:
137
138 3.0
139 ---
140 * :py:func:`pyderasn.decode_path_defby` is replaced with
141   :py:class:`pyderasn.DecodePathDefBy`
142 * Ability to turn colourized terminal output by calling
143   ``pprint(..., with_colours=True)``. You will need
144   `termcolor package <https://pypi.org/project/termcolor/>`__
145
146 .. _release2.1:
147
148 2.1
149 ---
150 * Fixed invalid offset calculation when dealing with DEFINED BY objects
151   having explicit tags
152
153 .. _release2.0:
154
155 2.0
156 ---
157 * BIT STRINGs can also be :ref:`DEFINED BY <definedby>`
158 * Decoding process can be governed with optional :ref:`ctx <ctx>`
159   keyword argument to ``decode()`` method
160 * :ref:`defines_by_path <defines_by_path_ctx>` option is now
161   :ref:`decode context <ctx>` option, not a keyword argument
162 * Ability to do :ref:`strict validation <strict_default_existence_ctx>`
163   of defaulted values met in sequence, raising an exception
164
165 .. _release1.6:
166
167 1.6
168 ---
169 Ability to skip specified number of bytes (``--skip``) in command line
170 utility.
171
172 .. _release1.5:
173
174 1.5
175 ---
176 * Generic decoder's scheme and pretty printer
177   (:py:func:`pyderasn.generic_decoder`) can be used in libraries
178 * Ability to specify :ref:`defines_by_path <defines_by_path_ctx>`
179   during command line invocation
180
181 .. _release1.4:
182
183 1.4
184 ---
185 Ability to automatically decode :ref:`DEFINED BY <definedby>` fields
186 inside SEQUENCEs.
187
188 .. _release1.3:
189
190 1.3
191 ---
192 Removed ``__lt__``/``__eq__`` from base class, as pylint likes it.
193
194 .. _release1.2:
195
196 1.2
197 ---
198 Full rich comparison operators added.
199
200
201 .. _release1.1:
202
203 1.1
204 ---
205 Trivial README addition.
206
207 .. _release1.0:
208
209 1.0
210 ---
211 Initial release.