Skip to content

Copy

obstore.copy

copy(
    store: ObjectStore, from_: str, to: str, *, overwrite: bool = True
) -> None

Copy an object from one path to another in the same object store.

Parameters:

  • store (ObjectStore) –

    The ObjectStore instance to use.

  • from_ (str) –

    Source path

  • to (str) –

    Destination path

Other Parameters:

  • overwrite (bool) –

    If True, if there exists an object at the destination, it will be overwritten. Performs an atomic operation if the underlying object storage supports it. If atomic operations are not supported by the underlying object storage (like S3) it will return an error.

    If False, will return an error if the destination already has an object.

obstore.copy_async async

copy_async(
    store: ObjectStore, from_: str, to: str, *, overwrite: bool = True
) -> None

Call copy asynchronously.

Refer to the documentation for copy.