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

Replace logging with warnings #3396

Merged
merged 1 commit into from
Jan 22, 2025
Merged

Conversation

pllim
Copy link
Contributor

@pllim pllim commented Jan 16, 2025

Description

In trying to figure out why deprecating warning is thrown when I do specviz = Specviz(), I found out that it is from logging. The use of logging in Jdaviz does not quite make sense because we do not have a custom logger to begin with. Looks like all we use logging for is to emit deprecation warning and unit warning. I think this is better done by just using warnings directly, which we then can control directly either from Python proper or pytest.

While I am at it, also did some isort because I cannot help myself.

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. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)? 🐱

@pllim pllim added the no-changelog-entry-needed changelog bot directive label Jan 16, 2025
@pllim pllim added this to the 4.2 milestone Jan 16, 2025
@github-actions github-actions bot added cubeviz plugin Label for plugins common to multiple configurations rampviz labels Jan 16, 2025
@pllim pllim force-pushed the replace-logging branch 2 times, most recently from d425c46 to c75a78f Compare January 17, 2025 02:32
@pllim pllim added the Extra CI Run cron jobs in PR label Jan 17, 2025
@pllim
Copy link
Contributor Author

pllim commented Jan 17, 2025

devdeps failures are unrelated

@pllim pllim marked this pull request as ready for review January 17, 2025 03:28
@pllim
Copy link
Contributor Author

pllim commented Jan 17, 2025

Hmm the SOURCE_ID isn't a problem here... Why is it flaky? Nvm it is there after all.

Copy link
Member

@kecnry kecnry left a comment

Choose a reason for hiding this comment

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

LGTM - thanks for the cleanup!

@kecnry
Copy link
Member

kecnry commented Jan 21, 2025

(is any of this worth backporting?)

@pllim
Copy link
Contributor Author

pllim commented Jan 21, 2025

Re: backport -- You didn't deprecate any plugin thingy in v4.1.x, did you? Even if you did, I don't think the stuff is showing up in the notebook anyway because your API refactor stuff isn't backported, right? So, no, I don't think this needs backporting.

@pllim
Copy link
Contributor Author

pllim commented Jan 21, 2025

Gah looks like I have to rebase after #3400 is merged.

Also update tests and sort some imports.

Replaced a couple of accidental deprecated usage internally.

Handle those warnings everywhere else.
@pllim pllim enabled auto-merge January 22, 2025 03:40
@pllim pllim merged commit a334d2e into spacetelescope:main Jan 22, 2025
17 of 19 checks passed
Copy link

codecov bot commented Jan 22, 2025

Codecov Report

Attention: Patch coverage is 75.00000% with 8 lines in your changes missing coverage. Please review.

Project coverage is 87.62%. Comparing base (ed09c31) to head (ab5f6b0).
Report is 5 commits behind head on main.

Files with missing lines Patch % Lines
jdaviz/core/user_api.py 40.00% 3 Missing ⚠️
jdaviz/configs/cubeviz/plugins/parsers.py 0.00% 2 Missing ⚠️
jdaviz/configs/rampviz/plugins/parsers.py 33.33% 2 Missing ⚠️
jdaviz/core/template_mixin.py 93.75% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3396   +/-   ##
=======================================
  Coverage   87.62%   87.62%           
=======================================
  Files         128      128           
  Lines       19844    19844           
=======================================
  Hits        17388    17388           
  Misses       2456     2456           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pllim pllim deleted the replace-logging branch January 22, 2025 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cubeviz Extra CI Run cron jobs in PR no-changelog-entry-needed changelog bot directive plugin Label for plugins common to multiple configurations rampviz
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants