Put all gen3 formatters in a formatters subdir

obs_base is going to start accruing more formatters so it makes sense to put them all in one place. Leave the FitsRawFormatterBase in the root directory but it now is exported by default and so is renamed to use an _
lsst · Jun 12, 2020 · 1882fc9 · 1882fc9
1 parent 6ad37be
commit 1882fc9
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 13 deletions.
diff --git a/doc/lsst.obs.base/index.rst b/doc/lsst.obs.base/index.rst
@@ -38,11 +38,8 @@ Python API reference
 .. automodapi:: lsst.obs.base
    :no-main-docstr:
 
-.. automodapi:: lsst.obs.base.fitsExposureFormatter
+.. automodapi:: lsst.obs.base.formatters.fitsExposure
    :no-main-docstr:
 
-.. automodapi:: lsst.obs.base.fitsGenericFormatter
-   :no-main-docstr:
-
-.. automodapi:: lsst.obs.base.fitsRawFormatterBase
+.. automodapi:: lsst.obs.base.formatters.fitsGeneric
    :no-main-docstr:
diff --git a/python/lsst/obs/base/__init__.py b/python/lsst/obs/base/__init__.py
@@ -28,7 +28,7 @@
 from .exposureIdInfo import *
 from .makeRawVisitInfo import *
 from .makeRawVisitInfoViaObsInfo import *
-from .fitsRawFormatterBase import *
+from ._fitsRawFormatterBase import *
 from .utils import *
 from .ingest import *
 from .defineVisits import *
diff --git a/python/lsst/obs/base/fitsRawFormatterBase.py → ...on/lsst/obs/base/_fitsRawFormatterBase.py b/python/lsst/obs/base/fitsRawFormatterBase.py → ...on/lsst/obs/base/_fitsRawFormatterBase.py
@@ -31,7 +31,7 @@
 from lsst.daf.butler import FileDescriptor
 import lsst.log
 
-from .fitsExposureFormatter import FitsExposureFormatter
+from .formatters.fitsExposure import FitsExposureFormatter
 from .makeRawVisitInfoViaObsInfo import MakeRawVisitInfoViaObsInfo
 from .utils import createInitialSkyWcs, InitialSkyWcsError
 

diff --git a/python/lsst/obs/base/formatters/__init__.py b/python/lsst/obs/base/formatters/__init__.py
diff --git a/...on/lsst/obs/base/fitsExposureFormatter.py → .../lsst/obs/base/formatters/fitsExposure.py b/...on/lsst/obs/base/fitsExposureFormatter.py → .../lsst/obs/base/formatters/fitsExposure.py
diff --git a/python/lsst/obs/base/fitsGenericFormatter.py → ...n/lsst/obs/base/formatters/fitsGeneric.py b/python/lsst/obs/base/fitsGenericFormatter.py → ...n/lsst/obs/base/formatters/fitsGeneric.py
@@ -23,7 +23,7 @@
 
 import os.path
 
-from lsst.daf.butler.formatters.fileFormatter import FileFormatter
+from lsst.daf.butler.formatters.file import FileFormatter
 
 
 class FitsGenericFormatter(FileFormatter):

diff --git a/python/lsst/obs/base/ingest.py b/python/lsst/obs/base/ingest.py
@@ -43,7 +43,7 @@
 from lsst.pipe.base import Task
 
 from ._instrument import Instrument, makeExposureRecordFromObsInfo
-from .fitsRawFormatterBase import FitsRawFormatterBase
+from ._fitsRawFormatterBase import FitsRawFormatterBase
 
 
 @dataclass

diff --git a/tests/test_butlerFits.py b/tests/test_butlerFits.py
@@ -55,17 +55,17 @@
   # Want to check disassembly so can't use InMemory
   cls: lsst.daf.butler.datastores.posixDatastore.PosixDatastore
   formatters:
-    ExposureCompositeF: lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter
+    ExposureCompositeF: lsst.obs.base.formatters.fitsExposure.FitsExposureFormatter
     lossless:
-      formatter: lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter
+      formatter: lsst.obs.base.formatters.fitsExposure.FitsExposureFormatter
       parameters:
         recipe: lossless
     uncompressed:
-      formatter: lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter
+      formatter: lsst.obs.base.formatters.fitsExposure.FitsExposureFormatter
       parameters:
         recipe: noCompression
     lossy:
-      formatter: lsst.obs.base.fitsExposureFormatter.FitsExposureFormatter
+      formatter: lsst.obs.base.formatters.fitsExposure.FitsExposureFormatter
       parameters:
         recipe: lossyBasic
   composites: