from __future__ import annotations __lazy_modules__ = { "plumbum.machines.local", "plumbum.path.base", "plumbum.path.local", "plumbum.path.remote", } import os from plumbum.machines.local import local from plumbum.path.base import Path from plumbum.path.local import LocalPath from plumbum.path.remote import RemotePath def delete(*paths: str | Path) -> None: """Deletes the given paths. The arguments can be either strings, :class:`local paths `, :class:`remote paths `, or iterables of such. No error is raised if any of the paths does not exist (it is silently ignored) """ for p in paths: if isinstance(p, Path): p.delete() elif isinstance(p, str): local.path(p).delete() elif hasattr(p, "__iter__"): delete(*p) else: raise TypeError(f"Cannot delete {p!r}") def _move(src: Path | str, dst: Path | str) -> Path: ret = copy(src, dst) delete(src) return ret def move(src: Path | str, dst: Path | str) -> Path: """Moves the source path onto the destination path; ``src`` and ``dst`` can be either strings, :class:`LocalPaths ` or :class:`RemotePath `; any combination of the three will work. .. versionadded:: 1.3 ``src`` can also be a list of strings/paths, in which case ``dst`` must not exist or be a directory. """ if not isinstance(dst, Path): dst = local.path(dst) if isinstance(src, (tuple, list)): if not dst.exists(): dst.mkdir() elif not dst.is_dir(): raise ValueError( f"When using multiple sources, dst {dst!r} must be a directory" ) for src2 in src: move(src2, dst) return dst if not isinstance(src, Path): src = local.path(src) if isinstance(src, LocalPath): return src.move(dst) if isinstance(dst, LocalPath) else _move(src, dst) if isinstance(dst, LocalPath): return _move(src, dst) if ( isinstance(src, RemotePath) and isinstance(dst, RemotePath) and src.remote == dst.remote ): return src.move(dst) return _move(src, dst) def copy(src: str | Path, dst: str | Path) -> Path: """ Copy (recursively) the source path onto the destination path; ``src`` and ``dst`` can be either strings, :class:`LocalPaths ` or :class:`RemotePath `; any combination of the three will work. .. versionadded:: 1.3 ``src`` can also be a list of strings/paths, in which case ``dst`` must not exist or be a directory. """ if not isinstance(dst, Path): dst = local.path(dst) if isinstance(src, (tuple, list)): if not dst.exists(): dst.mkdir() elif not dst.is_dir(): raise ValueError( f"When using multiple sources, dst {dst!r} must be a directory" ) for src2 in src: copy(src2, dst) return dst if not isinstance(src, Path): src = local.path(src) if isinstance(src, LocalPath): if isinstance(dst, LocalPath): return src.copy(dst) assert isinstance(dst, RemotePath) dst.remote.upload(src, dst) return dst assert isinstance(src, RemotePath) if isinstance(dst, LocalPath): src.remote.download(src, dst) return dst assert isinstance(dst, RemotePath) if src.remote == dst.remote: return src.copy(dst) with local.tempdir() as tmp: copy(src, tmp) copy(tmp / src.name, dst) return dst def gui_open(filename: str | Path) -> None: """This selects the proper gui open function. This can also be achieved with webbrowser, but that is not supported.""" if hasattr(os, "startfile"): os.startfile(filename) else: local.get("xdg-open", "open")(filename) __all__ = [ "copy", "delete", "gui_open", "move", ] def __dir__() -> list[str]: return list(__all__)