Uploaded image for project: 'Request For Comments'
  1. Request For Comments
  2. RFC-748

Accelerated deprecation of Filter

    XMLWordPrintable

    Details

    • Type: RFC
    • Status: Implemented
    • Resolution: Done
    • Component/s: DM
    • Labels:

      Description

      RFC-730 agreed to the deprecation of afw.image.Filter as part of the process of replacing it with FilterLabel. We later agreed on #dm-naming-things that the final APIs should say "Filter" (e.g., getFilter, which returns a FilterLabel), to prevent future users from having to deal the fact that we changed filter classes. Although this decision implies the deprecation of any methods with names like getFilterLabel, this deprecation was never formally approved.

      I then published a Community post that gave the following sequence of events, not realizing it contradicted the developer guide:

      1. Deprecation of the Filter class and dependent APIs in Science Pipelines release 22 (the earliest possible, unless we create a 21.1 release)
      2. Removal of Filter in release 23 (dev guide requires release 24)
      3. Deprecation of transitional APIs called, e.g., getFilterLabel instead of getFilter in release 23 (blocked on removal of original getFilter, etc.)
      4. Removal of transitional APIs in release 24 (dev guide requires release 26)

      This RFC formally proposes the elements of this transition that were not addressed by RFC-730, namely:

      • the transitional status of components like getFilterLabel, and
      • the deprecation of all components for only one major release rather than the two prescribed by the developer guide.

      While I realize it will cause some trouble for users, an accelerated deprecation timeline will let us remove Filter and its global registry quickly, something I understand is blocking Gen 3 work on multi-instrument repositories.

        Attachments

          Issue Links

            Activity

            krzys Krzysztof Findeisen created issue -
            krzys Krzysztof Findeisen made changes -
            Field Original Value New Value
            Link This issue is triggering DM-27170 [ DM-27170 ]
            krzys Krzysztof Findeisen made changes -
            Link This issue is triggering DM-27177 [ DM-27177 ]
            krzys Krzysztof Findeisen made changes -
            Status Proposed [ 10805 ] Flagged [ 10606 ]
            krzys Krzysztof Findeisen made changes -
            Description RFC-730 agreed to the deprecation of {{afw.image.Filter}} as part of the process of replacing it with {{FilterLabel}}. We later agreed on [#dm-naming-things|https://lsstc.slack.com/archives/CAVQQ6SBX/p1606774726143800] that the final APIs should say "Filter" (e.g., {{getFilter}}, which returns a {{FilterLabel}}), to prevent future users from having to deal the fact that we changed filter classes. Although this decision implies the deprecation of any methods with names like {{getFilterLabel}}, this deprecation was never formally approved.

            I then published a [Community post|https://community.lsst.org/t/4591] that gave the following sequence of events, not realizing it contradicted the [developer guide|https://developer.lsst.io/stack/deprecating-interfaces.html]:
            # Deprecation of the {{Filter}} class and dependent APIs in Science Pipelines release 22 (the earliest possible, unless we create a 21.1 release)
            # Removal of {{Filter}} in release 23 (dev guide requires release 24)
            # Deprecation of transitional APIs called, e.g., {{getFilterLabel}} instead of {{getFilter}} in release 23 (blocked on removal of original {{getFilter}}, etc.)
            # Removal of transitional APIs in release 24 (dev guide requires release 26)

            This RFC covers the aspects of this transition that were not addressed by RFC-730, namely:
            * the transitional status of components like {{getFilterLabel}}, and
            * the deprecation of all components for only one major release rather than the two prescribed by the developer guide.

            While I realize it will cause some trouble for users, an accelerated deprecation timeline will let us remove {{Filter}} and its global registry quickly, something I understand is blocking Gen 3 work on multi-instrument repositories.
            RFC-730 agreed to the deprecation of {{afw.image.Filter}} as part of the process of replacing it with {{FilterLabel}}. We later agreed on [#dm-naming-things|https://lsstc.slack.com/archives/CAVQQ6SBX/p1606774726143800] that the final APIs should say "Filter" (e.g., {{getFilter}}, which returns a {{FilterLabel}}), to prevent future users from having to deal the fact that we changed filter classes. Although this decision implies the deprecation of any methods with names like {{getFilterLabel}}, this deprecation was never formally approved.

            I then published a [Community post|https://community.lsst.org/t/4591] that gave the following sequence of events, not realizing it contradicted the [developer guide|https://developer.lsst.io/stack/deprecating-interfaces.html]:
            # Deprecation of the {{Filter}} class and dependent APIs in Science Pipelines release 22 (the earliest possible, unless we create a 21.1 release)
            # Removal of {{Filter}} in release 23 (dev guide requires release 24)
            # Deprecation of transitional APIs called, e.g., {{getFilterLabel}} instead of {{getFilter}} in release 23 (blocked on removal of original {{getFilter}}, etc.)
            # Removal of transitional APIs in release 24 (dev guide requires release 26)

            This RFC formally proposes the elements of this transition that were not addressed by RFC-730, namely:
            * the transitional status of components like {{getFilterLabel}}, and
            * the deprecation of all components for only one major release rather than the two prescribed by the developer guide.

            While I realize it will cause some trouble for users, an accelerated deprecation timeline will let us remove {{Filter}} and its global registry quickly, something I understand is blocking Gen 3 work on multi-instrument repositories.
            krzys Krzysztof Findeisen made changes -
            Link This issue relates to RFC-730 [ RFC-730 ]
            krzys Krzysztof Findeisen made changes -
            Planned End 08/Jan/21 1:00 AM 09/Jan/21 1:00 AM
            gcomoretto Gabriele Comoretto [X] (Inactive) made changes -
            Remote Link This issue links to "Page (Confluence)" [ 27143 ]
            gcomoretto Gabriele Comoretto [X] (Inactive) made changes -
            Remote Link This issue links to "Page (Confluence)" [ 27221 ]
            tjenness Tim Jenness made changes -
            Status Flagged [ 10606 ] Board Recommended [ 11405 ]
            krzys Krzysztof Findeisen made changes -
            Status Board Recommended [ 11405 ] Adopted [ 10806 ]
            gcomoretto Gabriele Comoretto [X] (Inactive) made changes -
            Remote Link This issue links to "Page (Confluence)" [ 27253 ]
            Parejkoj John Parejko made changes -
            Resolution Done [ 10000 ]
            Status Adopted [ 10806 ] Implemented [ 11105 ]
            Parejkoj John Parejko made changes -
            Link This issue is triggering DM-27177 [ DM-27177 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-27177 [ DM-27177 ]

              People

              Assignee:
              krzys Krzysztof Findeisen
              Reporter:
              krzys Krzysztof Findeisen
              Watchers:
              Ian Sullivan, Jim Bosch, John Parejko, Kian-Tat Lim, Krzysztof Findeisen, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Planned End:

                  Jenkins

                  No builds found.