mmengine.fileio.get_local_path¶

mmengine.fileio.get_local_path(filepath, backend_args=None)[source]¶

Download data from filepath and write the data to local path.

get_local_path is decorated by contxtlib.contextmanager(). It can be called with with statement, and when exists from the with statement, the temporary path will be released.

Note

If the filepath is a local path, just return itself and it will not be released (removed).

Parameters

filepath (str or Path) – Path to be read data.
backend_args (dict, optional) – Arguments to instantiate the corresponding backend. Defaults to None.

Yields

Iterable[str] – Only yield one path.

Return type

Generator[Union[str, pathlib.Path], None, None]

Examples

>>> with get_local_path('s3://bucket/abc.jpg') as path:
...     # do something here