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

Modernize type annotations in ts_utils and simplify ImageNameServiceClient

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ts_middleware
    • Labels:
    • Story Points:
      1
    • Epic Link:
    • Sprint:
      TSSW Sprint - Jan 02 - Jan 16, TSSW Sprint - Jan 16 - Jan 30
    • Team:
      Telescope and Site
    • Urgent?:
      No

      Description

      Modernize type annotations to use | instead of typing.Optional and typing.Union, etc.

      I also tried modernize the doc build to use documenteer[guide] in ts_utils. This is an experiment to try out the modern documenteer that can generate type information for parameters (but not yet return values) from type annotations. That is on tag "documenteer-guide" but we decided not to include it in this ticket.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-37529 Please install documenteer[guide] in Docker images

          • To Do

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            rowen Russell Owen added a comment - - edited

            The jury is still out on whether to update Jenkinsfile to pip install documenteer[guide] (that depends on the timing of DM-37529). But I can drop that commit if it's not needed. Or leave it in for now and get rid of it later.

            Pull request: https://github.com/lsst-ts/ts_utils/pull/12

            Show
            rowen Russell Owen added a comment - - edited The jury is still out on whether to update Jenkinsfile to pip install documenteer [guide] (that depends on the timing of DM-37529 ). But I can drop that commit if it's not needed. Or leave it in for now and get rid of it later. Pull request: https://github.com/lsst-ts/ts_utils/pull/12
            Hide
            Permalink
            ecoughlin Eric Coughlin added a comment -

            Reviewed on GitHub.

            Show
            ecoughlin Eric Coughlin added a comment - Reviewed on GitHub.
            Hide
            Permalink
            rowen Russell Owen added a comment -

            Tagged v1.2.2 without the update to the doc system.

            Show
            rowen Russell Owen added a comment - Tagged v1.2.2 without the update to the doc system.

              People

              Assignee:
              rowen Russell Owen
              Reporter:
              rowen Russell Owen
              Reviewers:
              Eric Coughlin
              Watchers:
              Eric Coughlin, Russell Owen
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.