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

Pythonic type names in pybind11 docstrings

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Won't Fix
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
    • Story Points:
      4
    • Epic Link:
    • Team:
      Data Release Production
    • Urgent?:
      No

      Description

      While wrapping pipe_tasks for pybind11, I found a cosmetic bug in which a method's docstring reported some parameter types in C++ style and others in python style:

      1. (self: lsst.meas.base._sdssCentroid.SdssCentroidTransform, inputCatalog: lsst.afw.table._source.SourceCatalog, outputCatalog: lsst.afw.table._base.BaseCatalog, wcs: lsst::afw::image::Wcs, calib: lsst::afw::image::Calib) -> None

      The problem was fixed by importing Wcs and Calib before importing the pybind11 wrapper, but I've since seen the same problem in other methods. We should audit the pybind11 wrappers to ensure that their types are always reported in python terms.

        Attachments

          Issue Links

            Activity

            krzys Krzysztof Findeisen created issue -
            krzys Krzysztof Findeisen made changes -
            Field Original Value New Value
            Epic Link DM-7717 [ 26925 ]
            krzys Krzysztof Findeisen made changes -
            Link This issue blocks DM-9099 [ DM-9099 ]
            swinbank John Swinbank made changes -
            Labels pybind11 SciencePipelines pybind11
            jbosch Jim Bosch made changes -
            Link This issue blocks DM-9099 [ DM-9099 ]
            jbosch Jim Bosch made changes -
            Link This issue blocks DM-9100 [ DM-9100 ]
            swinbank John Swinbank made changes -
            Epic Link DM-7717 [ 26925 ] DM-9155 [ 29718 ]
            swinbank John Swinbank made changes -
            Link This issue blocks DM-9100 [ DM-9100 ]
            krzys Krzysztof Findeisen made changes -
            Link This issue is blocked by DM-9786 [ DM-9786 ]
            gcomoretto Gabriele Comoretto [X] (Inactive) made changes -
            Remote Link This issue links to "Page (Confluence)" [ 25899 ]
            swinbank John Swinbank made changes -
            Team Data Release Production [ 10301 ]
            Urgent? off
            Labels SciencePipelines pybind11 pybind11
            swinbank John Swinbank made changes -
            Resolution Done [ 10000 ]
            Status To Do [ 10001 ] Won't Fix [ 10405 ]

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              krzys Krzysztof Findeisen
              Watchers:
              John Swinbank, Krzysztof Findeisen
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.