sphinx.util.inventory.InventoryFileReader

class documentation

class InventoryFileReader: (source)

View In Hierarchy

A file reader for an inventory file. This reader supports mixture of texts and compressed texts.

Method __init__ Undocumented
Method read_buffer Undocumented
Method read_compressed_chunks Undocumented
Method read_compressed_lines Undocumented
Method readline Undocumented
Method readlines Undocumented
Instance Variable buffer Undocumented
Instance Variable eof Undocumented
Instance Variable stream Undocumented
def __init__(self, stream): (source)

Undocumented

Parameters
stream:IOUndocumented
def read_buffer(self): (source)

Undocumented

def read_compressed_chunks(self): (source)

Undocumented

Returns
Iterator[bytes]Undocumented
def read_compressed_lines(self): (source)

Undocumented

Returns
Iterator[str]Undocumented
def readline(self): (source)

Undocumented

Returns
strUndocumented
def readlines(self): (source)

Undocumented

Returns
Iterator[str]Undocumented
buffer: bytes = (source)

Undocumented

eof: bool = (source)

Undocumented

stream = (source)

Undocumented