doc/news.rst

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