Shortcuts

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
Read the Docs v: v0.8.3
Versions
latest
stable
v0.8.3
v0.8.2
v0.8.1
v0.8.0
v0.7.4
v0.7.3
v0.7.2
v0.7.1
v0.7.0
v0.6.0
v0.5.0
v0.4.0
v0.3.0
v0.2.0
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.