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

          is blocked by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-9786 Investigate pybind11 build size

          • Done
          mentioned in

          Page Loading...

            Activity

            Hide
            Permalink
            swinbank John Swinbank added a comment -

            It seems unlikely that we'll ever find effort to go through and audit all of the wrappers for this, much as I'd like to. I suggest closing this ticket as “Won't Fix”, and addressing individual problems as we come across them.

            Show
            swinbank John Swinbank added a comment - It seems unlikely that we'll ever find effort to go through and audit all of the wrappers for this, much as I'd like to. I suggest closing this ticket as “Won't Fix”, and addressing individual problems as we come across them.

              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.