Merge pull request #1099 from lsst/tickets/DM-46496

DM-46496: Include advanced query system objects in docs
lsst · Oct 17, 2024 · bde5552 · bde5552
2 parents be031d3 + f27bf9f
commit bde5552
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/doc/lsst.daf.butler/index.rst b/doc/lsst.daf.butler/index.rst
@@ -104,6 +104,17 @@ Python API reference
    :no-inherited-members:
    :skip: RegistryConfig
 
+Advanced query system
+---------------------
+
+.. automodapi:: lsst.daf.butler.queries
+   :headings: ^"
+   :no-main-docstr:
+
+.. automodapi:: lsst.daf.butler.queries.expression_factory
+   :headings: ^"
+   :no-main-docstr:
+
 Example datastores
 ------------------
 
@@ -173,6 +184,17 @@ Datastore utilities
    :headings: ^"
    :skip: Datastore
 
+Advanced query system internals
+-------------------------------
+
+.. automodapi:: lsst.daf.butler.queries.tree
+   :no-main-docstr:
+   :no-inherited-members:
+   :headings: ^"
+   :include: Predicate
+   :skip: DataCoordinateUploadKey
+   :skip: MaterializationKey
+
 Registry utilities and interfaces
 ---------------------------------
 

diff --git a/python/lsst/daf/butler/queries/_query.py b/python/lsst/daf/butler/queries/_query.py
@@ -82,7 +82,7 @@ class Query(QueryBase):
     Notes
     -----
     `Query` objects should never be constructed directly by users; use
-    `Butler._query` instead.
+    `Butler.query` instead.
 
     A `Query` object represents the first stage of query construction, in which
     constraints and joins are defined (roughly corresponding to the WHERE and
@@ -135,6 +135,7 @@ def constraint_dimensions(self) -> DimensionGroup:
     @property
     def expression_factory(self) -> ExpressionFactory:
         """A factory for column expressions using overloaded operators.
+        (`~lsst.daf.butler.queries.expression_factory.ExpressionFactory`).
 
         Notes
         -----

diff --git a/python/lsst/daf/butler/queries/tree/__init__.py b/python/lsst/daf/butler/queries/tree/__init__.py
@@ -30,11 +30,10 @@
 from ._column_literal import *
 from ._column_reference import *
 from ._column_set import *
+from ._predicate import LogicalNot as _LogicalNot
 from ._predicate import *
-from ._predicate import LogicalNot
 from ._query_tree import *
 
-LogicalNot.model_rebuild()
-del LogicalNot
+_LogicalNot.model_rebuild()
 
 Predicate.model_rebuild()