Issue warning from butler query-dataset-types if --[no-]components used

lsst · Jan 5, 2024 · cbbeb84 · cbbeb84
1 parent 4280299
commit cbbeb84
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/python/lsst/daf/butler/cli/cmd/commands.py b/python/lsst/daf/butler/cli/cmd/commands.py
@@ -443,7 +443,10 @@ def query_collections(*args: Any, **kwargs: Any) -> None:
 def query_dataset_types(*args: Any, **kwargs: Any) -> None:
     """Get the dataset types in a repository."""
     # Drop the components option.
-    kwargs.pop("components")
+    components = kwargs.pop("components")
+    if components is not None:
+        comp_opt_str = "" if components else "no-"
+        click.echo(f"WARNING: --{comp_opt_str}components option is deprecated and will be removed after v27.")
     table = script.queryDatasetTypes(*args, **kwargs)
     if table:
         table.pprint_all()

diff --git a/python/lsst/daf/butler/cli/opt/options.py b/python/lsst/daf/butler/cli/opt/options.py
@@ -111,12 +111,12 @@ def makeCollectionTypes(
 
 components_option = MWOptionDecorator(
     "--components/--no-components",
-    default=False,
+    default=None,
     help=unwrap(
         """For --components, apply all expression patterns to
         component dataset type names as well. For --no-components,
         never apply patterns to components. Only --no-components
-        is now supported."""
+        is now supported. Option will be removed after v27."""
     ),
 )