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