Details
-
Type:
Story
-
Status: To Do
-
Resolution: Unresolved
-
Fix Version/s: None
-
Component/s: None
-
Labels:None
-
Templates:customfield_11800 175220
-
Team:SQuaRE
Description
meas_base plugins are registered using makeSingleFramePlugin (or makeForcedPlugin). Those functions create “throwaway” classes SingleFrameFromGenericPlugin and ForcedFromGenericPlugin, of which the resulting plugins are then instances.
In other words, we end up with (e.g.) a measurement plugin called SingleFrameInputCountPlugin which has class lsst.meas.base.wrappers.GenericPlugin.makeSingleFramePlugin.<locals>.SingleFrameFromGenericPlugin. As the locals implies, there's no way to instantiated that class directly.
Unfortunately, this upsets Sphinx/automodapi. There seem to be two alternatives, both of which generate warnings. Simply using automodapi generates warnings of the form:
meas_base/doc/meas_base/index.rst:57: WARNING: Could not import class or module 'lsst.meas.base.wrappers.SingleFrameFromGenericPlugin' specified for inheritance diagram
|
An attempt to work around this by telling automodapi to skip these classes generates warnings like:
/meas_base/doc/meas_base/index.rst:41: WARNING: Tried to skip objects {'SingleFrameFromGenericPlugin', 'ForcedFromGenericPlugin'} in module lsst.meas.base, but they were not present. Ignoring.
|
Neither of these warnings are fatal, but neither are they very satisfying.