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

Apply code style rules to pipelines #9144

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

emolter
Copy link
Collaborator

@emolter emolter commented Feb 5, 2025

Partially Resolves JP-3860

This PR applies code style and documentation fixes to the pipeline/ submodule.

Tasks

  • request a review from someone specific, to avoid making the maintainers review every PR
  • add a build milestone, i.e. Build 11.3 (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#>.datamodels.rst
  • changes/<PR#>.scripts.rst
  • changes/<PR#>.set_telescope_pointing.rst
  • changes/<PR#>.pipeline.rst

stage 1

  • changes/<PR#>.group_scale.rst
  • changes/<PR#>.dq_init.rst
  • changes/<PR#>.emicorr.rst
  • changes/<PR#>.saturation.rst
  • changes/<PR#>.ipc.rst
  • changes/<PR#>.firstframe.rst
  • changes/<PR#>.lastframe.rst
  • changes/<PR#>.reset.rst
  • changes/<PR#>.superbias.rst
  • changes/<PR#>.refpix.rst
  • changes/<PR#>.linearity.rst
  • changes/<PR#>.rscd.rst
  • changes/<PR#>.persistence.rst
  • changes/<PR#>.dark_current.rst
  • changes/<PR#>.charge_migration.rst
  • changes/<PR#>.jump.rst
  • changes/<PR#>.clean_flicker_noise.rst
  • changes/<PR#>.ramp_fitting.rst
  • changes/<PR#>.gain_scale.rst

stage 2

  • changes/<PR#>.assign_wcs.rst
  • changes/<PR#>.badpix_selfcal.rst
  • changes/<PR#>.msaflagopen.rst
  • changes/<PR#>.nsclean.rst
  • changes/<PR#>.imprint.rst
  • changes/<PR#>.background.rst
  • changes/<PR#>.extract_2d.rst
  • changes/<PR#>.master_background.rst
  • changes/<PR#>.wavecorr.rst
  • changes/<PR#>.srctype.rst
  • changes/<PR#>.straylight.rst
  • changes/<PR#>.wfss_contam.rst
  • changes/<PR#>.flatfield.rst
  • changes/<PR#>.fringe.rst
  • changes/<PR#>.pathloss.rst
  • changes/<PR#>.barshadow.rst
  • changes/<PR#>.photom.rst
  • changes/<PR#>.pixel_replace.rst
  • changes/<PR#>.resample_spec.rst
  • changes/<PR#>.residual_fringe.rst
  • changes/<PR#>.cube_build.rst
  • changes/<PR#>.extract_1d.rst
  • changes/<PR#>.resample.rst

stage 3

  • changes/<PR#>.assign_mtwcs.rst
  • changes/<PR#>.mrs_imatch.rst
  • changes/<PR#>.tweakreg.rst
  • changes/<PR#>.skymatch.rst
  • changes/<PR#>.exp_to_source.rst
  • changes/<PR#>.outlier_detection.rst
  • changes/<PR#>.tso_photometry.rst
  • changes/<PR#>.stack_refs.rst
  • changes/<PR#>.align_refs.rst
  • changes/<PR#>.klip.rst
  • changes/<PR#>.spectral_leak.rst
  • changes/<PR#>.source_catalog.rst
  • changes/<PR#>.combine_1d.rst
  • changes/<PR#>.ami.rst

other

  • changes/<PR#>.wfs_combine.rst
  • changes/<PR#>.white_light.rst
  • changes/<PR#>.cube_skymatch.rst
  • changes/<PR#>.engdb_tools.rst
  • changes/<PR#>.guider_cds.rst

@emolter
Copy link
Collaborator Author

emolter commented Feb 5, 2025

regression tests started here https://github.com/spacetelescope/RegressionTests/actions/runs/13163158711

edit: all passing except the ones also failing on main

Copy link

codecov bot commented Feb 5, 2025

Codecov Report

Attention: Patch coverage is 33.95225% with 249 lines in your changes missing coverage. Please review.

Project coverage is 73.77%. Comparing base (a86a74e) to head (c114eb9).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
jwst/pipeline/calwebb_detector1.py 7.84% 47 Missing ⚠️
jwst/pipeline/calwebb_spec2.py 54.00% 46 Missing ⚠️
jwst/pipeline/calwebb_spec3.py 13.95% 37 Missing ⚠️
jwst/pipeline/calwebb_ami3.py 14.28% 24 Missing ⚠️
jwst/pipeline/calwebb_coron3.py 7.69% 24 Missing ⚠️
jwst/pipeline/calwebb_dark.py 11.11% 24 Missing ⚠️
jwst/pipeline/calwebb_tso3.py 20.83% 19 Missing ⚠️
jwst/pipeline/calwebb_guider.py 23.07% 10 Missing ⚠️
jwst/pipeline/calwebb_image3.py 61.90% 8 Missing ⚠️
jwst/pipeline/calwebb_image2.py 81.57% 7 Missing ⚠️
... and 1 more
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9144      +/-   ##
==========================================
- Coverage   73.77%   73.77%   -0.01%     
==========================================
  Files         372      372              
  Lines       37273    37267       -6     
==========================================
- Hits        27498    27492       -6     
  Misses       9775     9775              

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

@emolter emolter marked this pull request as ready for review February 5, 2025 23:56
@emolter emolter requested review from a team as code owners February 5, 2025 23:56
Copy link
Collaborator

@melanieclarke melanieclarke left a comment

Choose a reason for hiding this comment

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

Looks good, just a couple minor requests.

jwst/pipeline/calwebb_coron3.py Outdated Show resolved Hide resolved
jwst/pipeline/calwebb_image2.py Outdated Show resolved Hide resolved
jwst/pipeline/calwebb_spec2.py Outdated Show resolved Hide resolved
jwst/pipeline/calwebb_spec2.py Outdated Show resolved Hide resolved
@emolter
Copy link
Collaborator Author

emolter commented Feb 6, 2025

All suggested fixes are in 0f47e5f

restarted the regression tests just in case the hasattr change messed something up (though I doubt it)

https://github.com/spacetelescope/RegressionTests/actions/runs/13163158711

@melanieclarke
Copy link
Collaborator

Looks good, thanks! I'll leave this one open for a bit in case anyone else wants to review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants