Merge pull request #884 from lsst/tickets/DM-40450

DM-40450: Change default value for components to False

python/lsst/daf/butler/cli/opt/options.py

@@ -104,15 +104,13 @@ def makeCollectionTypes(
 
 components_option = MWOptionDecorator(
     "--components/--no-components",
-    default=None,
+    default=False,
     help=unwrap(
         """For --components, apply all expression patterns to
-                                                  component dataset type names as well. For --no-components,
-                                                  never apply patterns to components. Default (where neither
-                                                  is specified) is to apply patterns to components only if
-                                                  their parent datasets were not matched by the expression.
-                                                  Fully-specified component datasets (`str` or `DatasetType`
-                                                  instances) are always included."""
+        component dataset type names as well. For --no-components,
+        never apply patterns to components. Default is False.
+        Fully-specified component datasets (`str` or `DatasetType`
+        instances) are always included."""
     ),
 )
 

python/lsst/daf/butler/registries/remote.py

@@ -448,7 +448,7 @@ def queryDatasetTypes(
         self,
         expression: Any = ...,
         *,
-        components: bool | None = None,
+        components: bool | None = False,
         missing: list[str] | None = None,
     ) -> Iterable[DatasetType]:
         # Docstring inherited from lsst.daf.butler.registry.Registry
@@ -522,7 +522,7 @@ def queryDatasets(  # type: ignore
         dataId: DataId | None = None,
         where: str = "",
         findFirst: bool = False,
-        components: bool | None = None,
+        components: bool | None = False,
         bind: Mapping[str, Any] | None = None,
         check: bool = True,
         **kwargs: Any,
@@ -568,7 +568,7 @@ def queryDataIds(  # type: ignore
         datasets: Any = None,
         collections: CollectionArgType | None = None,
         where: str = "",
-        components: bool | None = None,
+        components: bool | None = False,
         bind: Mapping[str, Any] | None = None,
         check: bool = True,
         **kwargs: Any,
@@ -618,7 +618,7 @@ def queryDimensionRecords(  # type: ignore
         datasets: Any = None,
         collections: CollectionArgType | None = None,
         where: str = "",
-        components: bool | None = None,
+        components: bool | None = False,
         bind: Mapping[str, Any] | None = None,
         check: bool = True,
         **kwargs: Any,

python/lsst/daf/butler/registries/sql.py

@@ -908,7 +908,7 @@ def queryDatasetTypes(
         self,
         expression: Any = ...,
         *,
-        components: bool | None = None,
+        components: bool | None = False,
         missing: list[str] | None = None,
     ) -> Iterable[DatasetType]:
         # Docstring inherited from lsst.daf.butler.registry.Registry
@@ -1124,7 +1124,7 @@ def queryDatasets(
         dataId: DataId | None = None,
         where: str = "",
         findFirst: bool = False,
-        components: bool | None = None,
+        components: bool | None = False,
         bind: Mapping[str, Any] | None = None,
         check: bool = True,
         **kwargs: Any,

python/lsst/daf/butler/registry/_registry.py

@@ -1029,7 +1029,7 @@ def queryDatasetTypes(
         self,
         expression: Any = ...,
         *,
-        components: bool | None = None,
+        components: bool | None = False,
         missing: list[str] | None = None,
     ) -> Iterable[DatasetType]:
         """Iterate over the dataset types whose names match an expression.
@@ -1045,7 +1045,7 @@ def queryDatasetTypes(
         components : `bool`, optional
             If `True`, apply all expression patterns to component dataset type
             names as well.  If `False`, never apply patterns to components.
-            If `None` (default), apply patterns to components only if their
+            If `None`, apply patterns to components only if their
             parent datasets were not matched by the expression.
             Fully-specified component datasets (`str` or `DatasetType`
             instances) are always included.
@@ -1136,7 +1136,7 @@ def queryDatasets(
         dataId: DataId | None = None,
         where: str = "",
         findFirst: bool = False,
-        components: bool | None = None,
+        components: bool | None = False,
         bind: Mapping[str, Any] | None = None,
         check: bool = True,
         **kwargs: Any,
@@ -1184,7 +1184,7 @@ def queryDatasets(
         components : `bool`, optional
             If `True`, apply all dataset expression patterns to component
             dataset type names as well.  If `False`, never apply patterns to
-            components.  If `None` (default), apply patterns to components only
+            components.  If `None`, apply patterns to components only
             if their parent datasets were not matched by the expression.
             Fully-specified component datasets (`str` or `DatasetType`
             instances) are always included.
@@ -1257,7 +1257,7 @@ def queryDataIds(
         datasets: Any = None,
         collections: CollectionArgType | None = None,
         where: str = "",
-        components: bool | None = None,
+        components: bool | None = False,
         bind: Mapping[str, Any] | None = None,
         check: bool = True,
         **kwargs: Any,
@@ -1302,7 +1302,7 @@ def queryDataIds(
         components : `bool`, optional
             If `True`, apply all dataset expression patterns to component
             dataset type names as well.  If `False`, never apply patterns to
-            components.  If `None` (default), apply patterns to components only
+            components.  If `None`, apply patterns to components only
             if their parent datasets were not matched by the expression.
             Fully-specified component datasets (`str` or `DatasetType`
             instances) are always included.
@@ -1367,7 +1367,7 @@ def queryDimensionRecords(
         datasets: Any = None,
         collections: CollectionArgType | None = None,
         where: str = "",
-        components: bool | None = None,
+        components: bool | None = False,
         bind: Mapping[str, Any] | None = None,
         check: bool = True,
         **kwargs: Any,

python/lsst/daf/butler/registry/datasets/byDimensions/_manager.py

@@ -354,7 +354,7 @@ def register(self, datasetType: DatasetType) -> tuple[DatasetRecordStorage, bool
     def resolve_wildcard(
         self,
         expression: Any,
-        components: bool | None = None,
+        components: bool | None = False,
         missing: list[str] | None = None,
         explicit_only: bool = False,
         components_deprecated: bool = True,

python/lsst/daf/butler/registry/interfaces/_datasets.py

@@ -515,7 +515,7 @@ def remove(self, name: str) -> None:
     def resolve_wildcard(
         self,
         expression: Any,
-        components: bool | None = None,
+        components: bool | None = False,
         missing: list[str] | None = None,
         explicit_only: bool = False,
         components_deprecated: bool = True,
@@ -530,7 +530,7 @@ def resolve_wildcard(
         components : `bool`, optional
             If `True`, apply all expression patterns to component dataset type
             names as well.  If `False`, never apply patterns to components.  If
-            `None` (default), apply patterns to components only if their parent
+            `None`, apply patterns to components only if their parent
             datasets were not matched by the expression.  Fully-specified
             component datasets (`str` or `DatasetType` instances) are always
             included.

python/lsst/daf/butler/registry/tests/_registry.py

@@ -621,7 +621,8 @@ def testDatasetTypeComponentQueries(self):
         # that component dataset type if components=None.
         with self.assertWarns(FutureWarning):
             self.assertEqual(
-                {"bias.wcs"}, NamedValueSet(registry.queryDatasetTypes(re.compile(r"^bias\.wcs"))).names
+                {"bias.wcs"},
+                NamedValueSet(registry.queryDatasetTypes(re.compile(r"^bias\.wcs"), components=None)).names,
             )
         self.assertEqual(
             set(),

tests/test_cliCmdQueryDatasetTypes.py

@@ -40,7 +40,7 @@ class QueryDatasetTypesCmdTest(CliCmdTestBase, unittest.TestCase):
 
     @staticmethod
     def defaultExpected():
-        return dict(repo=None, verbose=False, glob=(), components=None)
+        return dict(repo=None, verbose=False, glob=(), components=False)
 
     @staticmethod
     def command():