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