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 testing statement to ignore import failure #8977

Merged
merged 6 commits into from
Nov 26, 2024

Conversation

tapastro
Copy link
Contributor

This PR addresses CI failures with py312-xdist caused by a tox testing method of ignoring the tests if an import fails. The import of pysiaf should work as expected with its inclusion in the test dependencies, so we can safely delete the failure catch.

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#>.fits_generator.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

@braingram
Copy link
Collaborator

I don't know why setuptools is no longer being installed but romancal had a similar error to the python 3.12 one on main in jwst.

spacetelescope/romancal#1537 added setuptools as a dependency for python > 3.12 since pysiaf uses pkg_resources. This PR might benefit from a similar addition.

@tapastro tapastro marked this pull request as draft November 25, 2024 17:16
@tapastro
Copy link
Contributor Author

Ah, I may have misunderstood the error trace from CI - I thought pkg_resources was deprecated in 3.12+ and it was only being called because of the import ignore statement. If pysiaf requires it, there won't be much benefit in this change. I'll wait for CI to fail again on the PR then add setuptools to the requirements.

Copy link

codecov bot commented Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.53%. Comparing base (3401d49) to head (e9475f1).
Report is 12 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8977   +/-   ##
=======================================
  Coverage   64.53%   64.53%           
=======================================
  Files         375      375           
  Lines       38745    38729   -16     
=======================================
- Hits        25003    24994    -9     
+ Misses      13742    13735    -7     

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


🚨 Try these New Features:

@tapastro
Copy link
Contributor Author

@tapastro tapastro marked this pull request as ready for review November 26, 2024 15:53
Copy link
Collaborator

@braingram braingram left a comment

Choose a reason for hiding this comment

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

LGTM!

@tapastro
Copy link
Contributor Author

Do you know why the environment wouldn't pull setuptools as a dependency of pysiaf in the first place, @braingram ?

@braingram
Copy link
Collaborator

Do you know why the environment wouldn't pull setuptools as a dependency of pysiaf in the first place, @braingram ?

It's not a dependency for pysaif. The latest release https://github.com/spacetelescope/pysiaf/releases/tag/v0.24.0 now removes the pkg_resources usage (so should fix the issue for the newest version).

@braingram
Copy link
Collaborator

braingram commented Nov 26, 2024

Here is a relevant description: https://docs.python.org/3.12/whatsnew/3.12.html#removed
The key bit being:

gh-95299: Do not pre-install setuptools in virtual environments created with venv. This means that distutils, setuptools, pkg_resources, and easy_install will no longer available by default; to access these run pip install setuptools in the activated virtual environment.

@tapastro
Copy link
Contributor Author

After a new release of pysiaf yesterday, CI on jwst/main shows no failure: https://github.com/spacetelescope/jwst/actions/runs/12034980168

I'll remove the dependency update and make this a simple removal of the import catch.

@tapastro tapastro merged commit 6ea327f into spacetelescope:main Nov 26, 2024
27 checks passed
@tapastro tapastro deleted the remove-pkg-resources-call branch November 26, 2024 21:28
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.

3 participants