IncrementalDecoder Class Reference

Inheritance diagram for IncrementalDecoder:

Collaboration diagram for IncrementalDecoder:

Public Member Functions
	__init__ (self, fallback_encoding, errors='replace')
	decode (self, input, final=False)

Data Fields
	encoding

Protected Attributes
	_fallback_encoding
	_errors
	_buffer
	_decoder

Detailed Description

“Push”-based decoder.

:param fallback_encoding:
    An :class:`Encoding` object or a label string.
    The encoding to use if :obj:`input` does note have a BOM.
:param errors: Type of error handling. See :func:`codecs.register`.
:raises: :exc:`~exceptions.LookupError` for an unknown encoding label.

Definition at line 272 of file __init__.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			fallback_encoding,
			errors = 'replace'
	)

Definition at line 283 of file __init__.py.

    def __init__(self, fallback_encoding, errors='replace'):
        # Fail early if `encoding` is an invalid label.
        self._fallback_encoding = _get_encoding(fallback_encoding)
        self._errors = errors
        self._buffer = b''
        self._decoder = None
        #: The actual :class:`Encoding` that is being used,
        #: or :obj:`None` if that is not determined yet.
        #: (Ie. if there is not enough input yet to determine
        #: if there is a BOM.)
        self.encoding = None  # Not known yet.
 

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

decode()

decode	(		self,
			input,
			final = False
	)

Decode one chunk of the input.

:param input: A byte string.
:param final:
    Indicate that no more input is available.
    Must be :obj:`True` if this is the last call.
:returns: An Unicode string.

Definition at line 295 of file __init__.py.

    def decode(self, input, final=False):
        """Decode one chunk of the input.
 
        :param input: A byte string.
        :param final:
            Indicate that no more input is available.
            Must be :obj:`True` if this is the last call.
        :returns: An Unicode string.
 
        """
        decoder = self._decoder
        if decoder is not None:
            return decoder(input, final)
 
        input = self._buffer + input
        encoding, input = _detect_bom(input)
        if encoding is None:
            if len(input) < 3 and not final:  # Not enough data yet.
                self._buffer = input
                return ''
            else:  # No BOM
                encoding = self._fallback_encoding
        decoder = encoding.codec_info.incrementaldecoder(self._errors).decode
        self._decoder = decoder
        self.encoding = encoding
        return decoder(input, final)
 
 

References Unpacker._buffer, Packer._buffer, Console._buffer(), Console._buffer, IncrementalDecoder._buffer, HTTPResponse._decoder, IncrementalDecoder._decoder, pip._vendor.webencodings._detect_bom(), IncrementalDecoder._errors, IncrementalDecoder._fallback_encoding, IndexContent.encoding, StreamWrapper.encoding(), ResultDict.encoding, Formatter.encoding, HtmlFormatter.encoding, FontManager.encoding, ImageFormatter.encoding, RawTokenFormatter.encoding, SvgFormatter.encoding, Lexer.encoding, Response.encoding, ConsoleOptions.encoding, Console.encoding(), IncrementalDecoder.encoding, and i.

Here is the call graph for this function:

Field Documentation

_buffer

_buffer

protected

Definition at line 287 of file __init__.py.

Referenced by Console._check_buffer(), Unpacker._get_extradata(), Unpacker._got_extradata(), Packer._pack(), Packer._pack_array_header(), Packer._pack_bin_header(), Packer._pack_map_header(), Packer._pack_raw_header(), Unpacker._read(), Unpacker._read_header(), Unpacker._reserve(), Packer.bytes(), Console.control(), IncrementalDecoder.decode(), Console.end_capture(), Unpacker.feed(), Packer.getbuffer(), Console.log(), Packer.pack(), Packer.pack_array_header(), Packer.pack_ext_type(), Packer.pack_map_header(), Packer.pack_map_pairs(), Console.print(), Packer.reset(), and Console.update_screen_lines().

_decoder

_decoder

protected

Definition at line 288 of file __init__.py.

Referenced by HTTPResponse._decode(), HTTPResponse._flush_decoder(), HTTPResponse._init_decoder(), and IncrementalDecoder.decode().

_errors

_errors

protected

Definition at line 286 of file __init__.py.

Referenced by IncrementalDecoder.decode().

_fallback_encoding

_fallback_encoding

protected

Definition at line 285 of file __init__.py.

Referenced by IncrementalDecoder.decode().

encoding

encoding

Definition at line 293 of file __init__.py.

Referenced by TestcaseFormatter.__init__(), HtmlFormatter._decodeifneeded(), HtmlFormatter._wrap_full(), ConsoleOptions.ascii_only(), IncrementalDecoder.decode(), Formatter.format(), NullFormatter.format(), TestcaseFormatter.format(), LatexFormatter.format_unencoded(), SvgFormatter.format_unencoded(), Response.json(), Console.options(), and Response.text().

---

The documentation for this class was generated from the following file:

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_vendor/webencodings/__init__.py