PyDocs

Nav

Binary Data Services

StreamReader.read

  • StreamReader.read(size=-1, chars=-1, firstline=False)
Decodes data from the stream self.stream and returns the
resulting object.

chars indicates the number of decoded code points or bytes to
return. read() will never return more data than requested,
but it might return less, if there is not enough available.

size indicates the approximate maximum number of decoded
bytes or code points to read for decoding. The decoder
can modify this setting as appropriate. The default value
-1 indicates to read and decode as much as possible.  size
is intended to prevent having to decode huge files in one
step.

If firstline is true, and a UnicodeDecodeError happens
after the first line terminator in the input only the first line
will be returned, the rest of the input will be kept until the
next call to read().

The method should use a greedy read strategy, meaning that
it should read as much data as is allowed within the
definition of the encoding and the given size, e.g.  if
optional encoding endings or state markers are available
on the stream, these should be read too.
0 Examples
No examples for codecs/StreamReader.read.
See Also
No see-alsos for codecs/StreamReader.read
0 Notes
No notes for StreamReader.read