Skip to content

robot.utils.filereader

FileReader 

1
FileReader(source: Source, accept_text: bool = False)

Utility to ease reading different kind of source files.

Supports different sources where to read the data:

  • The source can be a path to a file, either as a string or as a pathlib.Path instance. The file itself must be UTF-8 encoded.

  • Alternatively the source can be an already opened file object, including a StringIO or BytesIO object. The file can contain either Unicode text or UTF-8 encoded bytes.

  • The third options is giving the source as Unicode text directly. This requires setting accept_text=True when creating the reader.

In all cases bytes are automatically decoded to Unicode and possible BOM removed.

Source code in src/robot/utils/filereader.py 
46
47
def __init__(self, source: Source, accept_text: bool = False):
    self.file, self._opened = self._get_file(source, accept_text)