mmengine.fileio.copytree¶

mmengine.fileio.copytree(src, dst, backend_args=None)[source]¶

Recursively copy an entire directory tree rooted at src to a directory named dst and return the destination directory.

src and dst should have the same prefix and dst must not already exist.

Parameters:

src (str or Path) – A directory to be copied.
dst (str or Path) – Copy directory to dst.
backend_args (dict, optional) – Arguments to instantiate the corresponding backend. Defaults to None.

Returns:

The destination directory.

Return type:

str

Raises:

FileExistsError – If dst had already existed, a FileExistsError will be raised.

Examples

>>> src = '/path/of/dir1'
>>> dst = '/path/of/dir2'
>>> copytree(src, dst)
'/path/of/dir2'