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

add type annotations to ts_salobj

    XMLWordPrintable

    Details

    • Story Points:
      3
    • Epic Link:
    • Sprint:
      TSSW Sprint - Jun 21 - Jul 05
    • Team:
      Telescope and Site
    • Urgent?:
      No

      Description

      Add type annotations to ts_salobj and test them with mypy.
      Configure pytest to run mypy on ts_salobj and also on ts_tcpip (which already has type annotations).

        Attachments

          Activity

          No builds found.
          rowen Russell Owen created issue -
          rowen Russell Owen made changes -
          Field Original Value New Value
          Sprint TSSW Sprint - Jun 21 - Jul 05 [ 1104 ]
          rowen Russell Owen made changes -
          Status To Do [ 10001 ] In Progress [ 3 ]
          Hide
          rowen Russell Owen added a comment - - edited

          Note: mypy cannot handle the topic attributes added to Controller, Remote, BaseCsc, etc. (e.g. evt_summaryState, cmd_enable, tel_whatever). So I chose not to annotate the ts_salobj unit test files that tested the Controller, Remote and CSC classes because I would have to to disable checking of too many lines, making the code hard to read.

          Pull request:

          Show
          rowen Russell Owen added a comment - - edited Note: mypy cannot handle the topic attributes added to Controller, Remote, BaseCsc, etc. (e.g. evt_summaryState, cmd_enable, tel_whatever). So I chose not to annotate the ts_salobj unit test files that tested the Controller, Remote and CSC classes because I would have to to disable checking of too many lines, making the code hard to read. Pull request: https://github.com/lsst-ts/ts_salobj/pull/199 https://github.com/lsst-ts/ts_tcpip/pull/6
          rowen Russell Owen made changes -
          Reviewers Eric Coughlin [ ecoughlin ]
          Status In Progress [ 3 ] In Review [ 10004 ]
          rowen Russell Owen made changes -
          Summary add type annotations to ts_salobj and ts_tcpip add type annotations to ts_salobj
          rowen Russell Owen made changes -
          Description Add type annotations to ts_salobj and test them with mypy Add type annotations to ts_salobj and test them with mypy.
          Configure pytest to run mypy on ts_salobj and also on ts_tcpip (which already has type annotations).
          Hide
          rowen Russell Owen added a comment - - edited

          Reviewed on github.

          Released ts_salobj v6.5.0 and ts_tcpip v0.3.1

          Show
          rowen Russell Owen added a comment - - edited Reviewed on github. Released ts_salobj v6.5.0 and ts_tcpip v0.3.1
          rowen Russell Owen made changes -
          Status In Review [ 10004 ] Reviewed [ 10101 ]
          rowen Russell Owen made changes -
          Resolution Done [ 10000 ]
          Status Reviewed [ 10101 ] Done [ 10002 ]
          rowen Russell Owen made changes -
          Comment [ Reviewed on github ]

            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.