spacetelescope / stdatamodels

https://stdatamodels.readthedocs.io
Other
5 stars 25 forks source link

deprecate schema_editor #352

Closed braingram closed 3 weeks ago

braingram commented 4 weeks ago

This PR adds a UserWarning if the schema_editor submodule is imported.

https://github.com/spacetelescope/jwst/pull/8909 removed its use in jwst

before merging this PR I'll make an issue to track the removal of schema_editor. I'm not sure if this qualifies as "public API" (since it's undocumented and untested in this package) so I'm ok removing it in the next minor version (so it's not picked up by current jwst releases).

Regression tests running at: https://github.com/spacetelescope/RegressionTests/actions/runs/11632063641

Tasks

news fragment change types... - ``changes/.feature.rst``: new feature - ``changes/.bugfix.rst``: fixes an issue - ``changes/.doc.rst``: documentation change - ``changes/.removal.rst``: deprecation or removal of public API - ``changes/.misc.rst``: infrastructure or miscellaneous change
codecov[bot] commented 4 weeks ago

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 67.51%. Comparing base (fd6be8d) to head (0d9f0b4). Report is 9 commits behind head on main.

Files with missing lines Patch % Lines
src/stdatamodels/jwst/datamodels/schema_editor.py 0.00% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #352 +/- ## ========================================== + Coverage 66.55% 67.51% +0.96% ========================================== Files 102 114 +12 Lines 5456 5913 +457 ========================================== + Hits 3631 3992 +361 - Misses 1825 1921 +96 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.