Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

user-APIs: forbid setting non-existing attribute #2577

Merged
merged 2 commits into from
Nov 28, 2023

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Nov 27, 2023

Description

This pull request prevents setting attributes on user-APIs (currently plugin APIs, but eventually perhaps viewer APIs as well via #2563). This prevents user-confusion caused by typos, etc.

imviz.plugins['Plot Options'].mistyped_or_nonexisting_attribute = 5  # now raises an error

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

@kecnry kecnry added this to the 3.8 milestone Nov 27, 2023
@pllim pllim added the api API change label Nov 27, 2023
Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be less confusing if we wanna be strict about the public API and stuff. Thanks!

@kecnry kecnry force-pushed the user-api-restrict-setattr branch 2 times, most recently from 40bdd62 to 17758cc Compare November 27, 2023 19:00
@kecnry kecnry added the trivial Only needs one approval instead of two label Nov 27, 2023
@kecnry kecnry closed this Nov 28, 2023
@kecnry kecnry reopened this Nov 28, 2023
@kecnry kecnry force-pushed the user-api-restrict-setattr branch 3 times, most recently from 41366f0 to 7aee6ec Compare November 28, 2023 14:03
@kecnry kecnry marked this pull request as ready for review November 28, 2023 14:13
@kecnry kecnry force-pushed the user-api-restrict-setattr branch from 7aee6ec to 1155a80 Compare November 28, 2023 14:34
@kecnry kecnry force-pushed the user-api-restrict-setattr branch from 1155a80 to dacfc14 Compare November 28, 2023 14:48
@kecnry kecnry merged commit ffb585b into spacetelescope:main Nov 28, 2023
11 of 12 checks passed
@kecnry kecnry deleted the user-api-restrict-setattr branch November 28, 2023 15:09
rosteen pushed a commit to rosteen/jdaviz that referenced this pull request Nov 29, 2023
* user-APIs: forbid setting non-existing attribute
* fix broken tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api API change trivial Only needs one approval instead of two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants