mmengine.fileio.copyfile_to_local¶
- mmengine.fileio.copyfile_to_local(src, dst, backend_args=None)[source]¶
Copy the file src to local dst and return the destination file.
If dst specifies a directory, the file will be copied into dst using the base filename from src. If dst specifies a file that already exists, it will be replaced.
Note
If the backend is the instance of LocalBackend, it does the same thing with
copyfile()
.- Parameters:
- Returns:
If dst specifies a directory, the file will be copied into dst using the base filename from src.
- Return type:
Examples
>>> # dst is a file >>> src = 's3://openmmlab/mmengine/file' >>> dst = '/path/of/file' >>> # src will be copied to '/path/of/file' >>> copyfile_to_local(src, dst) '/path/of/file'
>>> # dst is a directory >>> dst = '/path/of/dir' >>> # src will be copied to '/path/of/dir/file' >>> copyfile_to_local(src, dst) '/path/of/dir/file'