Coverage for python/lsst/daf/butler/script/pruneCollection.py : 19%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# This file is part of daf_butler.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <http://www.gnu.org/licenses/>.
22from .. import Butler
23from .. import (
24 PurgeWithoutUnstorePruneCollectionsError,
25 RunWithoutPurgePruneCollectionsError,
26 PurgeUnsupportedPruneCollectionsError,
27)
30def pruneCollection(repo, collection, purge, unstore):
31 """Remove a collection and possibly prune datasets within it.
33 Parameters
34 ----------
35 repo : `str`
36 Same as the ``config`` argument to ``Butler.__init__``
37 collection : `str`
38 Same as the ``name`` argument to ``Butler.pruneCollection``.
39 purge : `bool`, optional
40 Same as the ``purge`` argument to ``Butler.pruneCollection``.
41 unstore: `bool`, optional
42 Same as the ``unstore`` argument to ``Butler.pruneCollection``.
43 """
44 butler = Butler(repo, writeable=True)
45 try:
46 butler.pruneCollection(collection, purge, unstore)
47 except PurgeWithoutUnstorePruneCollectionsError as e:
48 raise TypeError("Cannot pass --purge without --unstore.") from e
49 except RunWithoutPurgePruneCollectionsError as e:
50 raise TypeError(f"Cannot prune RUN collection {e.collectionType.name} without --purge.") from e
51 except PurgeUnsupportedPruneCollectionsError as e:
52 raise TypeError(
53 f"Cannot prune {e.collectionType} collection {e.collectionType.name} with --purge.") from e