pyzim.util.ioutil

module documentation

Various I/O related utility functions.

Function	`read_n_bytes`	Read n bytes in total from f.
Function	`read_until_zero`	Read a zero-terminated bytestring from a file.

def read_n_bytes(f, n, raise_on_incomplete=False): ¶

Read n bytes in total from f.

If raise_on_incomplete is zero, this may return less bytes on EOF. Otherwise, an exception is raised.

Parameters
f:file-like	file-like object to read from
n:`int`	number of bytes to read
raise_on_incomplete:`bool`	if nonzero, raise an Exception if unable to read full n bytes

Returns
`bytes`	the content read

Raises
`IOError`	when raise_in_incomplete is nonzero and unable to read full n bytes.

def read_until_zero(f, encoding=None, strip_zero=True): ¶

Read a zero-terminated bytestring from a file.

Parameters
f:file-like object	file-like object to read from
encoding:`str` or `None`	if specified, decode the string using this encoding
strip_zero:`bool`	if nonzero (default), do not add the zero to the result string

Returns
`bytes` or `str` if an encoding was specified	the parsed string.