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