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