doc/examples.rst | 8 ++++---- pyderasn.py | 33 ++++++++++++++++++++------------- diff --git a/doc/examples.rst b/doc/examples.rst index 5799391c0794165c9c967b6ea015b526683948396560c52c4aa52c5ca32e2a2d..e8f807b218f5428974340804a9016514769a972e93d73dca0af5a647c3b259d8 100644 --- a/doc/examples.rst +++ b/doc/examples.rst @@ -184,12 +184,12 @@ version: [0] EXPLICIT Version INTEGER v3 OPTIONAL; serialNumber: CertificateSerialNumber INTEGER 61595; signature: AlgorithmIdentifier SEQUENCE[OBJECT IDENTIFIER 1.2.840.113549.1.1.5... -:ref:`Look here ` for better pretty printing. +.. seealso:: :ref:`Better pretty printing ` As command line utility ----------------------- -:ref:`Look here `. +.. seealso:: :ref:`cmdline` Descriptive errors ------------------ @@ -327,8 +327,8 @@ . . . . . . . 13:18:49:6E:74:65:72:6E:65:74:20:57:69:64:67:69 . . . . . . . 74:73:20:50:74:79:20:4C:74:64 95 [1,1, 24] . . . . . . . DEFINED BY (2.5.4.10): PrintableString PrintableString Internet Widgits Pty Ltd -:ref:`Read more ` about that feature. +.. seealso:: :ref:`definedby` Streaming and dealing with huge structures ------------------------------------------ -:ref:`Look here `. +.. seealso:: :ref:`streaming` diff --git a/pyderasn.py b/pyderasn.py index 7b32e2b823b1e2319de8d76f4b1146d1535cef0ed8ec01c42cfc3dc13946436c..094ba31ba36112845f0d4dbc783cad2d3a930454db56daa43c33bd7b8ae91b45 100755 --- a/pyderasn.py +++ b/pyderasn.py @@ -763,6 +763,8 @@ schema = Attribute() bounds = (1, 32) der_forced = True +.. _agg_octet_string: + agg_octet_string ________________ @@ -1759,13 +1761,13 @@ return self.tag_order @property def tlen(self): - """See :ref:`decoding` + """.. seealso:: :ref:`decoding` """ return len(self.tag) @property def tlvlen(self): - """See :ref:`decoding` + """.. seealso:: :ref:`decoding` """ return self.tlen + self.llen + self.vlen @@ -1921,7 +1923,8 @@ """Decode with evgen mode on That method is identical to :py:meth:`pyderasn.Obj.decode`, but it returns the generator producing ``(decode_path, obj, tail)`` - values. See :ref:`evgen mode `. + values. + .. seealso:: :ref:`evgen mode `. """ if ctx is None: ctx = {} @@ -2070,25 +2073,25 @@ return self.decod(hexdec(data), *args, **kwargs) @property def expled(self): - """See :ref:`decoding` + """.. seealso:: :ref:`decoding` """ return self._expl is not None @property def expl_tag(self): - """See :ref:`decoding` + """.. seealso:: :ref:`decoding` """ return self._expl @property def expl_tlen(self): - """See :ref:`decoding` + """.. seealso:: :ref:`decoding` """ return len(self._expl) @property def expl_llen(self): - """See :ref:`decoding` + """.. seealso:: :ref:`decoding` """ if self.expl_lenindef: return 1 @@ -2096,31 +2099,31 @@ return len(len_encode(self.tlvlen)) @property def expl_offset(self): - """See :ref:`decoding` + """.. seealso:: :ref:`decoding` """ return self.offset - self.expl_tlen - self.expl_llen @property def expl_vlen(self): - """See :ref:`decoding` + """.. seealso:: :ref:`decoding` """ return self.tlvlen @property def expl_tlvlen(self): - """See :ref:`decoding` + """.. seealso:: :ref:`decoding` """ return self.expl_tlen + self.expl_llen + self.expl_vlen @property def fulloffset(self): - """See :ref:`decoding` + """.. seealso:: :ref:`decoding` """ return self.expl_offset if self.expled else self.offset @property def fulllen(self): - """See :ref:`decoding` + """.. seealso:: :ref:`decoding` """ return self.expl_tlvlen if self.expled else self.tlvlen @@ -4074,6 +4077,8 @@ the data evgens are generated on :param writer: buffer.write where string is going to be saved :param writer: where string is going to be saved. Must comply with ``io.RawIOBase.write`` behaviour + + .. seealso:: :ref:`agg_octet_string` """ decode_path_len = len(decode_path) for dp, obj, _ in evgens: @@ -4291,7 +4296,9 @@ :py:func:`pyderasn.abs_decode_path`. Second tuple element is ``{OID: pyderasn.Obj()}`` dictionary, mapping between current OID value and structure applied to defined field. - :ref:`Read about DEFINED BY ` + + .. seealso:: :ref:`definedby` + :param bytes impl: override default tag with ``IMPLICIT`` one :param bytes expl: override default tag with ``EXPLICIT`` one :param default: set default value. Type same as in ``value``