Support clobber/no-clobber when writing Zip archive

python/lsst/daf/butler/_butler.py

@@ -992,6 +992,7 @@ def retrieve_artifacts_zip(
         self,
         refs: Iterable[DatasetRef],
         destination: ResourcePathExpression,
+        overwrite: bool = True,
     ) -> ResourcePath:
         """Retrieve artifacts from a Butler and place in ZIP file.
 
@@ -1003,6 +1004,9 @@ def retrieve_artifacts_zip(
             Directory to write the new ZIP file. This directory will
             also be used as a staging area for the datasets being downloaded
             from the datastore.
+        overwrite : `bool`, optional
+            If `False` the output Zip will not be written if a file of the
+            same name is already present in ``destination``.
 
         Returns
         -------

python/lsst/daf/butler/_quantum_backed.py

@@ -503,6 +503,7 @@ def retrieve_artifacts_zip(
         self,
         refs: Iterable[DatasetRef],
         destination: ResourcePathExpression,
+        overwrite: bool = True,
     ) -> ResourcePath:
         """Retrieve artifacts from the graph and place in ZIP file.
 
@@ -514,6 +515,9 @@ def retrieve_artifacts_zip(
             Directory to write the new ZIP file. This directory will
             also be used as a staging area for the datasets being downloaded
             from the datastore.
+        overwrite : `bool`, optional
+            If `False` the output Zip will not be written if a file of the
+            same name is already present in ``destination``.
 
         Returns
         -------
@@ -525,7 +529,7 @@ def retrieve_artifacts_zip(
         ValueError
             Raised if there are no refs to retrieve.
         """
-        return retrieve_and_zip(refs, destination, self._datastore.retrieveArtifacts)
+        return retrieve_and_zip(refs, destination, self._datastore.retrieveArtifacts, overwrite)
 
     def extract_provenance_data(self) -> QuantumProvenanceData:
         """Extract provenance information and datastore records from this

python/lsst/daf/butler/datastores/file_datastore/retrieve_artifacts.py

@@ -485,6 +485,7 @@ def retrieve_and_zip(
     refs: Iterable[DatasetRef],
     destination: ResourcePathExpression,
     retrieval_callback: RetrievalCallable,
+    overwrite: bool = True,
 ) -> ResourcePath:
     """Retrieve artifacts from a Butler and place in ZIP file.
 
@@ -501,6 +502,9 @@ def retrieve_and_zip(
         Bound method for a function that can retrieve the artifacts and
         return the metadata necessary for creating the zip index. For example
         `lsst.daf.butler.datastore.Datastore.retrieveArtifacts`.
+    overwrite : `bool`, optional
+        If `False` the output Zip will not be written if a file of the
+        same name is already present in ``destination``.
 
     Returns
     -------
@@ -550,6 +554,8 @@ def retrieve_and_zip(
         # Use unique name based on files in Zip.
         zip_file_name = index.calculate_zip_file_name()
         zip_path = outdir.join(zip_file_name, forceDirectory=False)
+        if not overwrite and zip_path.exists():
+            raise FileExistsError(f"Output Zip at {zip_path} already exists but cannot overwrite.")
         with zipfile.ZipFile(zip_path.ospath, "w") as zip:
             zip.write(index_path.ospath, index_path.basename())
             for path, name in index.calc_relative_paths(tmpdir_path, list(artifact_map)).items():

python/lsst/daf/butler/direct_butler/_direct_butler.py

@@ -1296,8 +1296,9 @@ def retrieve_artifacts_zip(
         self,
         refs: Iterable[DatasetRef],
         destination: ResourcePathExpression,
+        overwrite: bool = True,
     ) -> ResourcePath:
-        return retrieve_and_zip(refs, destination, self._datastore.retrieveArtifacts)
+        return retrieve_and_zip(refs, destination, self._datastore.retrieveArtifacts, overwrite)
 
     def retrieveArtifacts(
         self,

python/lsst/daf/butler/remote_butler/_remote_butler.py

@@ -479,8 +479,9 @@ def retrieve_artifacts_zip(
         self,
         refs: Iterable[DatasetRef],
         destination: ResourcePathExpression,
+        overwrite: bool = True,
     ) -> ResourcePath:
-        return retrieve_and_zip(refs, destination, self._retrieve_artifacts)
+        return retrieve_and_zip(refs, destination, self._retrieve_artifacts, overwrite)
 
     def retrieveArtifacts(
         self,

python/lsst/daf/butler/script/retrieveArtifacts.py

@@ -126,7 +126,7 @@ def retrieveArtifacts(
             refs, destination=destination, transfer=transfer, preserve_path=preserve_path, overwrite=clobber
         )
     else:
-        zip_file = butler.retrieve_artifacts_zip(refs, destination=destination)
+        zip_file = butler.retrieve_artifacts_zip(refs, destination=destination, overwrite=clobber)
         transferred = [zip_file]
 
     return transferred

python/lsst/daf/butler/tests/hybrid_butler.py

@@ -210,8 +210,9 @@ def retrieve_artifacts_zip(
         self,
         refs: Iterable[DatasetRef],
         destination: ResourcePathExpression,
+        overwrite: bool = True,
     ) -> ResourcePath:
-        return self._remote_butler.retrieve_artifacts_zip(refs, destination)
+        return self._remote_butler.retrieve_artifacts_zip(refs, destination, overwrite)
 
     def retrieveArtifacts(
         self,