Merge pull request #894 from lsst/tickets/DM-41116

DM-41116: Make Butler an abstract class, with DirectButler as default implementation

doc/changes/DM-41116.api.md

@@ -0,0 +1,3 @@
+- `Butler` class becomes an abstract base class, original `Butler` was renamed to `DirectButler`.
+- Clients that need an access to `DirectButler` class will have to import it from `lsst.daf.butler.direct_butler`.
+- `Butler.from_config(...)` should be used to make `Butler` instances. `Butler(...)` still works and is identical to `Butler.from_config(...)`, but will generate `mypy` errors.

python/lsst/daf/butler/_quantum_backed.py

@@ -661,7 +661,7 @@ class QuantumProvenanceData(_BaseModelCompat):
     def collect_and_transfer(
         butler: Butler, quanta: Iterable[Quantum], provenance: Iterable[QuantumProvenanceData]
     ) -> None:
-        """Transfer output datasets from multiple quanta to a more permantent
+        """Transfer output datasets from multiple quanta to a more permanent
         `Butler` repository.
 
         Parameters

python/lsst/daf/butler/_registry_shim.py

@@ -54,7 +54,7 @@
 from .registry.queries import DataCoordinateQueryResults, DatasetQueryResults, DimensionRecordQueryResults
 
 if TYPE_CHECKING:
-    from ._butler import Butler
+    from .direct_butler import DirectButler
     from .registry._registry import CollectionArgType
     from .registry.interfaces import ObsCoreTableManager
 
@@ -64,7 +64,7 @@ class RegistryShim(Registry):
 
     Parameters
     ----------
-    butler : `Butler`
+    butler : `DirectButler`
         Data butler instance.
 
     Notes
@@ -75,7 +75,7 @@ class RegistryShim(Registry):
     while we perform re-structuring of Registry and Butler implementations.
     """
 
-    def __init__(self, butler: Butler):
+    def __init__(self, butler: DirectButler):
         self._butler = butler
         self._registry = butler._registry