Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-15758

Help strings for subconfigurables

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: pex_config
    • Labels:
      None
    • Templates:
    • Team:
      Architecture

      Description

      Alex Drlica-Wagner reports:

      I've been trying to access the configurable options for a "nested" config like ProcessCcdConfig (i.e., a config that contains other ConfigurableInstance objects). I would have thought that something like this would work to give me the help string for an IsrTaskConfig object, but instead I get the help for a ConfigurableInstance

      from lsst.pipe.tasks.processCcd import ProcessCcdConfig
      config = ProcessCcdConfig()
      help(config.isr)
      

      and the output:

      Help on ConfigurableInstance in module lsst.pex.config.configurableField object:
       
      class ConfigurableInstance(builtins.object)
       |  Methods defined here:
      ...
      

      This is continuing off of a Slack conversation with Jonathan Sick Merlin Fisher-Levine Paul Price.


      Merlin Fisher-Levine then responded:
      I think that the root of this is also what causes help(config.<int_field>)
      to return the help for an int, rather than the docstring and options
      for that int-field in the config. If it's somehow not, that's something
      to fix too...

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                ktl Kian-Tat Lim
                Reporter:
                ktl Kian-Tat Lim
                Reviewers:
                Merlin Fisher-Levine
                Watchers:
                Kian-Tat Lim, Merlin Fisher-Levine
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel