# HG changeset patch # User Jan Pipek <jan.pipek@gmail.com> # Date 1568123590 -7200 # Tue Sep 10 15:53:10 2019 +0200 # Node ID 6039001c7b9de147e4dc142f03c5b8f50fdfc138 # Parent 90e70ae8ecbff0d9db9ee0038afd2a51fd4c0db2 Docstrings in requested format. diff --git a/pyasn1/codec/ber/decoder.py b/pyasn1/codec/ber/decoder.py --- a/pyasn1/codec/ber/decoder.py +++ b/pyasn1/codec/ber/decoder.py @@ -34,10 +34,20 @@ def asSeekableStream(substrate): - """Convert object to seekable bytes stream. + """Convert object to seekable byte-stream. + + Parameters + ---------- + substrate: :py:class:`bytes` or :py:class:`io.IOBase` or :py:class:`univ.OctetString` - :type substrate: Union[bytes, IOBase, univ.OctetString] - :rtype: IOBase + Returns + ------- + : :py:class:`io.IOBase` + + Raises + ------ + ~pyasn1.error.PyAsn1Error + If the supplied substrate cannot be converted to a seekable stream. """ if isinstance(substrate, bytes): return BytesIO(substrate) @@ -56,10 +66,19 @@ def endOfStream(substrate): - """Check whether we have reached an end of stream. + """Check whether we have reached the end of a stream. + + Although it is more effective to read and catch exceptions, this + function - :type substrate: IOBase - :rtype: bool + Parameters + ---------- + substrate: :py:class:`IOBase` + Stream to check + + Returns + ------- + : :py:class:`bool` """ if isinstance(substrate, BytesIO): cp = substrate.tell() @@ -72,9 +91,20 @@ def peek(substrate, size=-1): - """Peak the stream + """Peek the stream. + + Parameters + ---------- + substrate: :py:class:`IOBase` + Stream to read from. - :param size: + size: :py:class:`int` + How many bytes to peek (-1 = all available) + + Returns + ------- + : :py:class:`bytes` or :py:class:`str` + The return type depends on Python major version """ if hasattr(substrate, "peek"): return substrate.peek(size)