Merge pull request #854 from lsst/tickets/DM-39751

DM-39751: Clarify where a warning comes from and hide it

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

@@ -32,6 +32,7 @@
 import sqlalchemy
 from lsst.daf.relation import LeafRelation, Relation
 from lsst.resources import ResourcePathExpression
+from lsst.utils.introspection import find_outside_stacklevel
 from lsst.utils.iteration import ensure_iterable
 
 from ..core import (
@@ -415,7 +416,13 @@ def removeDatasetType(self, name: str | tuple[str, ...]) -> None:
         # Docstring inherited from lsst.daf.butler.registry.Registry
 
         for datasetTypeExpression in ensure_iterable(name):
-            datasetTypes = list(self.queryDatasetTypes(datasetTypeExpression))
+            # Catch any warnings from the caller specifying a component
+            # dataset type. This will result in an error later but the
+            # warning could be confusing when the caller is not querying
+            # anything.
+            with warnings.catch_warnings():
+                warnings.simplefilter("ignore", category=FutureWarning)
+                datasetTypes = list(self.queryDatasetTypes(datasetTypeExpression))
             if not datasetTypes:
                 _LOG.info("Dataset type %r not defined", datasetTypeExpression)
             else:
@@ -1103,6 +1110,7 @@ def _standardize_query_dataset_args(
                 warnings.warn(
                     f"Dataset type(s) {missing} are not registered; this will be an error after v26.",
                     FutureWarning,
+                    stacklevel=find_outside_stacklevel("lsst.daf.butler"),
                 )
             doomed_by.extend(f"Dataset type {name} is not registered." for name in missing)
         elif collections:

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

@@ -8,6 +8,7 @@
 from typing import TYPE_CHECKING, Any
 
 import sqlalchemy
+from lsst.utils.introspection import find_outside_stacklevel
 
 from ....core import DatasetId, DatasetIdGenEnum, DatasetRef, DatasetType, DimensionUniverse, ddl
 from ..._collection_summary import CollectionSummary
@@ -371,7 +372,9 @@ def resolve_wildcard(
         for name, dataset_type in wildcard.values.items():
             parent_name, component_name = DatasetType.splitDatasetTypeName(name)
             if component_name is not None and components_deprecated:
-                warnings.warn(deprecation_message, FutureWarning)
+                warnings.warn(
+                    deprecation_message, FutureWarning, stacklevel=find_outside_stacklevel("lsst.daf.butler")
+                )
             if (found_storage := self.find(parent_name)) is not None:
                 found_parent = found_storage.datasetType
                 if component_name is not None:
@@ -412,7 +415,11 @@ def resolve_wildcard(
                             and not already_warned
                             and components_deprecated
                         ):
-                            warnings.warn(deprecation_message, FutureWarning)
+                            warnings.warn(
+                                deprecation_message,
+                                FutureWarning,
+                                stacklevel=find_outside_stacklevel("lsst.daf.butler"),
+                            )
                             already_warned = True
                     except KeyError as err:
                         _LOG.warning(
@@ -426,6 +433,7 @@ def resolve_wildcard(
                 warnings.warn(
                     "Passing wildcard patterns here is deprecated and will be prohibited after v26.",
                     FutureWarning,
+                    stacklevel=find_outside_stacklevel("lsst.daf.butler"),
                 )
             for storage in self._byName.values():
                 if any(p.fullmatch(storage.datasetType.name) for p in wildcard.patterns):
@@ -451,7 +459,11 @@ def resolve_wildcard(
                         ):
                             result[storage.datasetType].add(component_name)
                             if not already_warned and components_deprecated:
-                                warnings.warn(deprecation_message, FutureWarning)
+                                warnings.warn(
+                                    deprecation_message,
+                                    FutureWarning,
+                                    stacklevel=find_outside_stacklevel("lsst.daf.butler"),
+                                )
                                 already_warned = True
         return {k: list(v) for k, v in result.items()}
 

python/lsst/daf/butler/registry/obscore/_manager.py

@@ -35,6 +35,7 @@
 from lsst.daf.butler import Config, DataCoordinate, DatasetRef, DimensionRecordColumnTag, DimensionUniverse
 from lsst.daf.relation import Join
 from lsst.sphgeom import Region
+from lsst.utils.introspection import find_outside_stacklevel
 from lsst.utils.iteration import chunk_iterable
 
 from ..interfaces import ObsCoreTableManager, VersionTuple
@@ -313,6 +314,7 @@ def update_exposure_regions(self, instrument: str, region_data: Iterable[tuple[i
                 warnings.warn(
                     f"Failed to convert region for exposure={exposure} detector={detector}: {exc}",
                     category=RegionTypeWarning,
+                    stacklevel=find_outside_stacklevel("lsst.daf.butler"),
                 )
                 continue
 

python/lsst/daf/butler/registry/obscore/_records.py

@@ -32,6 +32,7 @@
 
 import astropy.time
 from lsst.daf.butler import DataCoordinate, DatasetRef, Dimension, DimensionRecord, DimensionUniverse
+from lsst.utils.introspection import find_outside_stacklevel
 
 from ._config import ExtraColumnConfig, ExtraColumnType, ObsCoreConfig
 from ._spatial import RegionTypeError, RegionTypeWarning
@@ -197,6 +198,7 @@ def __call__(self, ref: DatasetRef, context: SqlQueryContext) -> Record | None:
             warnings.warn(
                 f"Failed to convert region for obscore dataset {ref.id}: {exc}",
                 category=RegionTypeWarning,
+                stacklevel=find_outside_stacklevel("lsst.daf.butler"),
             )
         else:
             record.update(plugin_records)