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