Note that open() seeks to the start of file objects

This commit is contained in:
Andrew Murray 2023-04-17 16:10:29 +10:00
parent aec7a8d14b
commit cc84ff5e7d

View File

@ -3156,7 +3156,8 @@ def open(fp, mode="r", formats=None):
:param fp: A filename (string), pathlib.Path object or a file object. :param fp: A filename (string), pathlib.Path object or a file object.
The file object must implement ``file.read``, The file object must implement ``file.read``,
``file.seek``, and ``file.tell`` methods, ``file.seek``, and ``file.tell`` methods,
and be opened in binary mode. and be opened in binary mode. The file object will also seek to zero
before reading.
:param mode: The mode. If given, this argument must be "r". :param mode: The mode. If given, this argument must be "r".
:param formats: A list or tuple of formats to attempt to load the file in. :param formats: A list or tuple of formats to attempt to load the file in.
This can be used to restrict the set of formats checked. This can be used to restrict the set of formats checked.