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

remove logging manipulation during create_gridded_psf_model #1503

Merged
merged 2 commits into from
Nov 12, 2024

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Nov 7, 2024

#1494 uncovered a bug where building a psf messes up logging.

The call to restart_logging:

restart_logging(verbose=False)

in create_gridded_psf_model

results in (if the comment is to be believed) webbpsf clearing all log handlers for the root logger:
https://github.com/spacetelescope/webbpsf/blob/3043186b5e420a87b6891bdac1380aec866068b6/webbpsf/utils.py#L54

This PR removes the call to restart_logging and the logging_level argument to create_gridded_psf_model (since I believe the logging infrastructure for webbpsf is by default unconfigured).

Regression tests: https://github.com/spacetelescope/RegressionTests/actions/runs/11730160143

show only the 1 unrelated failure on main.

Tasks

  • request a review from someone specific, to avoid making the maintainers review every PR
  • add a build milestone, i.e. 24Q4_B15 (use the latest build if not sure)
  • Does this PR change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types)
    • update or add relevant tests
    • update relevant docstrings and / or docs/ page
    • start a regression test and include a link to the running job (click here for instructions)
      • Do truth files need to be updated ("okified")?
        • after the reviewer has approved these changes, run okify_regtests to update the truth files
  • if a JIRA ticket exists, make sure it is resolved properly
news fragment change types...
  • changes/<PR#>.general.rst: infrastructure or miscellaneous change
  • changes/<PR#>.docs.rst
  • changes/<PR#>.stpipe.rst
  • changes/<PR#>.associations.rst
  • changes/<PR#>.scripts.rst
  • changes/<PR#>.mosaic_pipeline.rst
  • changes/<PR#>.patch_match.rst

steps

  • changes/<PR#>.dq_init.rst
  • changes/<PR#>.saturation.rst
  • changes/<PR#>.refpix.rst
  • changes/<PR#>.linearity.rst
  • changes/<PR#>.dark_current.rst
  • changes/<PR#>.jump_detection.rst
  • changes/<PR#>.ramp_fitting.rst
  • changes/<PR#>.assign_wcs.rst
  • changes/<PR#>.flatfield.rst
  • changes/<PR#>.photom.rst
  • changes/<PR#>.flux.rst
  • changes/<PR#>.source_detection.rst
  • changes/<PR#>.tweakreg.rst
  • changes/<PR#>.skymatch.rst
  • changes/<PR#>.outlier_detection.rst
  • changes/<PR#>.resample.rst
  • changes/<PR#>.source_catalog.rst

@braingram braingram changed the title removing logging manipulation during create_gridded_psf removing logging manipulation during create_gridded_psf_model Nov 7, 2024
@braingram braingram changed the title removing logging manipulation during create_gridded_psf_model remove logging manipulation during create_gridded_psf_model Nov 7, 2024
@braingram braingram marked this pull request as ready for review November 7, 2024 20:29
@braingram braingram requested a review from a team as a code owner November 7, 2024 20:29
Copy link

codecov bot commented Nov 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.21%. Comparing base (088212b) to head (1a88241).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1503   +/-   ##
=======================================
  Coverage   76.21%   76.21%           
=======================================
  Files         115      115           
  Lines        7631     7627    -4     
=======================================
- Hits         5816     5813    -3     
+ Misses       1815     1814    -1     

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

Copy link
Collaborator

@schlafly schlafly left a comment

Choose a reason for hiding this comment

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

Awesome, thanks Brett. Do you see this as our misusing this code, or is this a bug that should get fed back to WebbPSF?

@braingram
Copy link
Collaborator Author

Awesome, thanks Brett. Do you see this as our misusing this code, or is this a bug that should get fed back to WebbPSF?

I think misuse of their code. It seems reasonable that a 'restart_logging' function might do something like remove registered logging handlers.

@braingram braingram merged commit 8a04f5a into spacetelescope:main Nov 12, 2024
25 of 27 checks passed
@braingram braingram deleted the webbpsf_logging branch November 12, 2024 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants