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

Deprecate Datamodel.read Datamodel.write #424

Merged
merged 4 commits into from
Feb 26, 2025

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Feb 26, 2025

This PR deprecates the unused Datamodel.read and Datamodel.write.

read is a little odd. It needs to be called using a Datamodel instance (not the class) which I suspect is not the intent. However it's unused, untested and being removed so that bug will be "fixed" when it's removed.

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

Tasks

  • update or add relevant tests
  • update relevant docstrings and / or docs/ page
  • Does this PR change any API used downstream? (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)
    • run jwst regression tests with this branch installed ("git+https://github.com/<fork>/stdatamodels@<branch>")
news fragment change types...
  • changes/<PR#>.feature.rst: new feature
  • changes/<PR#>.bugfix.rst: fixes an issue
  • changes/<PR#>.doc.rst: documentation change
  • changes/<PR#>.removal.rst: deprecation or removal of public API
  • changes/<PR#>.misc.rst: infrastructure or miscellaneous change

@braingram braingram changed the title Deprecate Datamodel.read Dwrite Deprecate Datamodel.read Datamodel.write Feb 26, 2025
Copy link

codecov bot commented Feb 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.37%. Comparing base (4e83608) to head (a3f6f2d).
Report is 13 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #424      +/-   ##
==========================================
+ Coverage   78.16%   78.37%   +0.21%     
==========================================
  Files         115      110       -5     
  Lines        5144     5111      -33     
==========================================
- Hits         4021     4006      -15     
+ Misses       1123     1105      -18     

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

@braingram braingram marked this pull request as ready for review February 26, 2025 21:46
@braingram braingram requested a review from a team as a code owner February 26, 2025 21:46
Copy link
Contributor

@emolter emolter left a comment

Choose a reason for hiding this comment

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

LGTM pending passing regression tests

@braingram
Copy link
Collaborator Author

Thanks! Regtests all passed.

@braingram braingram merged commit 864e054 into spacetelescope:main Feb 26, 2025
19 checks passed
@braingram braingram deleted the deprecate_read_write branch February 26, 2025 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants