Merge pull request #62 from lsst/tickets/DM-37635

DM-37635: Cleanup analysis_tools to fix pipelines docs build failure

doc/lsst.analysis.tools/index.rst

@@ -49,3 +49,4 @@ Python API reference
 .. automodapi:: lsst.analysis.tools
    :no-main-docstr:
    :no-inheritance-diagram:
+   :include-all-objects:

python/lsst/analysis/tools/actions/keyedData/summaryStatistics.py

@@ -20,18 +20,14 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
 
+__all__ = ("SummaryStatisticAction",)
+
 from lsst.pex.config import Field
 
 from ...interfaces import KeyedData
-from ...statistics import sigmaMad
 from ..scalar import CountAction, MedianAction, SigmaMadAction
 from .keyedDataActions import KeyedScalars
 
-__all__ = (
-    "sigmaMad",
-    "SummaryStatisticAction",
-)
-
 
 class SummaryStatisticAction(KeyedScalars):
     vectorKey = Field[str](doc="Column key to compute scalars")

python/lsst/analysis/tools/actions/plot/colorColorFitPlot.py

@@ -21,6 +21,8 @@
 
 from __future__ import annotations
 
+__all__ = ("ColorColorFitPlot",)
+
 from typing import Mapping, cast
 
 import matplotlib.patheffects as pathEffects

python/lsst/analysis/tools/actions/plot/skyPlot.py

@@ -21,6 +21,8 @@
 
 from __future__ import annotations
 
+__all__ = ("SkyPlot",)
+
 from typing import Mapping, Optional
 
 import matplotlib.patheffects as pathEffects

python/lsst/analysis/tools/actions/plot/xyPlot.py

@@ -21,10 +21,10 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Mapping
-
 __all__ = ("XYPlot",)
 
+from typing import TYPE_CHECKING, Any, Mapping
+
 import matplotlib.pyplot as plt
 from lsst.pex.config import ChoiceField, DictField, Field, FieldValidationError
 

python/lsst/analysis/tools/actions/scalar/scalarActions.py

@@ -1,5 +1,20 @@
 from __future__ import annotations
 
+__all__ = (
+    "MedianAction",
+    "MeanAction",
+    "StdevAction",
+    "SigmaMadAction",
+    "CountAction",
+    "CountUniqueAction",
+    "ApproxFloor",
+    "FracThreshold",
+    "MaxAction",
+    "MinAction",
+    "FracInRange",
+    "FracNan",
+)
+
 import operator
 from typing import cast
 

python/lsst/analysis/tools/actions/vector/vectorActions.py

@@ -20,6 +20,23 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
 
+__all__ = (
+    "DownselectVector",
+    "MultiCriteriaDownselectVector",
+    "MagColumnNanoJansky",
+    "FractionalDifference",
+    "Sn",
+    "ConstantValue",
+    "SubtractVector",
+    "DivideVector",
+    "LoadVector",
+    "MagDiff",
+    "SNCalculator",
+    "ExtinctionCorrectedMagDiff",
+    "AstromDiff",
+    "PerGroupStatistic",
+)
+
 import logging
 from typing import Optional, cast
 

python/lsst/analysis/tools/analysisMetrics/fluxMetrics.py

@@ -1,3 +1,5 @@
+__all__ = ("CentralTendency",)
+
 from lsst.analysis.tools.actions.scalar import MeanAction, MedianAction
 from lsst.analysis.tools.interfaces import AnalysisMetric
 

python/lsst/analysis/tools/analysisParts/baseFluxRatio.py

@@ -1,3 +1,5 @@
+__all__ = ("BasePsfApRatio",)
+
 from lsst.analysis.tools.actions.vector import DivideVector, LoadVector
 from lsst.analysis.tools.interfaces import AnalysisTool
 

python/lsst/analysis/tools/analysisParts/shapeSizeFractional.py

@@ -21,6 +21,11 @@
 
 from __future__ import annotations
 
+__all__ = (
+    "ShapeSizeFractionalScalars",
+    "BasePsfResidualMixin",
+)
+
 from lsst.pex.config import Field
 from lsst.pipe.tasks.configurableActions import ConfigurableActionField
 

python/lsst/analysis/tools/analysisParts/stellarLocus.py

@@ -1,5 +1,15 @@
 from __future__ import annotations
 
+__all__ = (
+    "StellarLocusBase",
+    "WPerpPSF",
+    "WPerpCModel",
+    "XPerpPSF",
+    "XPerpCModel",
+    "YPerpPSF",
+    "YPerpCModel",
+)
+
 from ..actions.keyedData.stellarLocusFit import StellarLocusFitAction
 from ..actions.scalar import ApproxFloor
 from ..actions.vector import (

python/lsst/analysis/tools/contexts/_contexts.py

@@ -24,6 +24,7 @@
 be a subclass of `Context`, and should contain a description of what the
 context is for as it's docstring.
 """
+__all__ = ("VisitContext", "CoaddContext", "MatchedRefDiffContext", "MatchedRefChiContext")
 
 from ._baseContext import Context
 

python/lsst/analysis/tools/tasks/associatedSourcesTractAnalysis.py

@@ -20,6 +20,8 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
 
+__all__ = ("AssociatedSourcesTractAnalysisConfig", "AssociatedSourcesTractAnalysisTask")
+
 import numpy as np
 import pandas as pd
 from lsst.geom import Box2D

python/lsst/analysis/tools/tasks/base.py

@@ -31,6 +31,8 @@
 connection classes and should specify a unique name
 """
 
+__all__ = ("AnalysisBaseConfig", "AnalysisPipelineTask")
+
 from collections import abc
 from typing import TYPE_CHECKING, Any, Iterable, Mapping, MutableMapping, cast
 

python/lsst/analysis/tools/tasks/catalogMatch.py

@@ -19,6 +19,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
+__all__ = ("CatalogMatchConfig", "CatalogMatchTask", "AstropyMatchConfig", "AstropyMatchTask")
+
 import astropy.units as units
 import lsst.geom
 import lsst.pex.config as pexConfig
@@ -39,8 +41,6 @@
     VisitPlotFlagSelector,
 )
 
-__all__ = ["CatalogMatchConfig", "CatalogMatchTask", "AstropyMatchConfig", "AstropyMatchTask"]
-
 
 class AstropyMatchConfig(pexConfig.Config):
 

python/lsst/analysis/tools/tasks/ccdVisitTableAnalysis.py

@@ -20,7 +20,7 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
 
-__all__ = ("CcdVisitTableAnalysisTask",)
+__all__ = ("CcdVisitTableAnalysisConfig", "CcdVisitTableAnalysisTask")
 
 from lsst.cp.pipe._lookupStaticCalibration import lookupStaticCalibration
 from lsst.pex.config import Field

python/lsst/analysis/tools/tasks/diaObjectTableAssocAnalysis.py

@@ -1,14 +1,14 @@
 from __future__ import annotations
 
-from lsst.pipe.base import connectionTypes as ct
-
-from .base import AnalysisBaseConfig, AnalysisBaseConnections, AnalysisPipelineTask
-
-__all__ = [
+__all__ = (
     "DiaObjectTableAnalysisConnections",
     "DiaObjectTableAnalysisConfig",
     "DiaObjectTableAssociatedSourcesTask",
-]
+)
+
+from lsst.pipe.base import connectionTypes as ct
+
+from .base import AnalysisBaseConfig, AnalysisBaseConnections, AnalysisPipelineTask
 
 
 class DiaObjectTableAnalysisConnections(

python/lsst/analysis/tools/tasks/diaSourceTableVisitAnalysis.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+__all__ = ("DiaSourceTableCcdVisitAnalysisConfig", "DiaSourceTableCcdVisitAnalysisTask")
+
 from lsst.pipe.base import connectionTypes as ct
 
 from .base import AnalysisBaseConfig, AnalysisBaseConnections, AnalysisPipelineTask

python/lsst/analysis/tools/tasks/diffMatchedAnalysis.py

@@ -20,6 +20,8 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
 
+__all__ = ("DiffMatchedAnalysisConfig", "DiffMatchedAnalysisTask")
+
 from lsst.pipe.base import connectionTypes as ct
 
 from .base import AnalysisBaseConfig, AnalysisBaseConnections, AnalysisPipelineTask

python/lsst/analysis/tools/tasks/objectTableTractAnalysis.py

@@ -20,9 +20,10 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
 
-__all__ = [
+__all__ = (
+    "ObjectTableTractAnalysisConfig",
     "ObjectTableTractAnalysisTask",
-]
+)
 
 from lsst.pipe.base import connectionTypes as ct
 from lsst.skymap import BaseSkyMap

python/lsst/analysis/tools/tasks/reconstructor.py

@@ -20,7 +20,7 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
 
-__all__ = ["reconstructAnalysisTools", "getPlotDatasetTypeNames"]
+__all__ = ("reconstructAnalysisTools", "getPlotDatasetTypeNames")
 
 from typing import TYPE_CHECKING, Any, Callable, Iterable
 

python/lsst/analysis/tools/tasks/refCatObjectAnalysis.py

@@ -20,6 +20,8 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
 
+__all__ = ("RefCatObjectAnalysisConfig", "RefCatObjectAnalysisTask")
+
 from lsst.pipe.base import connectionTypes as ct
 
 from ..analysisPlots.analysisPlots import (

python/lsst/analysis/tools/tasks/refCatSourceAnalysis.py

@@ -20,6 +20,8 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
 
+__all__ = ("RefCatSourceAnalysisConfig", "RefCatSourceAnalysisTask")
+
 from lsst.pipe.base import connectionTypes as ct
 
 from ..analysisPlots.analysisPlots import (

python/lsst/analysis/tools/tasks/sourceTableVisitAnalysis.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+__all__ = ("SourceTableVisitAnalysisConfig", "SourceTableVisitAnalysisTask")
+
 from lsst.pipe.base import connectionTypes as ct
 
 from .base import AnalysisBaseConfig, AnalysisBaseConnections, AnalysisPipelineTask