mmengine.fileio.get_text — mmengine 0.10.7 documentation (original) (raw)

mmengine.fileio.get_text(filepath, encoding='utf-8', backend_args=None)[source]¶

Read text from a given filepath with ‘r’ mode.

Parameters:

• filepath (str or Path) – Path to read data.
• encoding (str) – The encoding format used to open the filepath. Defaults to ‘utf-8’.
• backend_args (dict, optional) – Arguments to instantiate the corresponding backend. Defaults to None.

Returns:

Expected text reading from filepath.

Return type:

str

Examples

filepath = '/path/of/file' get_text(filepath) 'hello world'