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 asdf.asdf and AsdfFile.resolve_and_inline and minor cleanup #1690

Merged
merged 7 commits into from
Dec 5, 2023

Conversation

braingram
Copy link
Contributor

@braingram braingram commented Nov 16, 2023

Description

This PR is work towards cleaning up the asdf api focusing on asdf.asdf.

This PR deprecates asdf.asdf. The two public portions of this module AsdfFile and open_asdf are already exposed at the more convenient top level asdf (as AsdfFile and open) so this PR moves asdf.asdf to asdf._asdf and adds a deprecation warning on import or use of asdf.asdf.

Additionally, this PR deprecates AsdfFile.resolve_and_inline (which can be replaced with AsdfFile.resolve_references and providing all_array_storage='inline' to write_to/update).

Finally, this PR adds a prefix to asdf.asdf.get_asdf_library_info to make it more explicit that this is a private method.

A few warnings can be seen in the weldx downstream job as this PR adds an AsdfDeprecationWarning for the asdf.asdf.SerializationContext move in #1573.

Checklist:

  • pre-commit checks ran successfully
  • tests ran successfully
  • for a public change, a changelog entry was added
  • for a public change, documentation was updated
  • for any new features, unit tests were added

@braingram braingram changed the title Deprecate asdf.asdf and slight cleanup Deprecate asdf.asdf and minor cleanup Nov 16, 2023
@braingram braingram marked this pull request as ready for review November 16, 2023 21:55
@braingram braingram requested a review from a team as a code owner November 16, 2023 21:55
@braingram braingram changed the title Deprecate asdf.asdf and minor cleanup Deprecate asdf.asdf and AsdfFile.resolve_and_inline and minor cleanup Nov 20, 2023
Copy link
Contributor

@eslavich eslavich left a comment

Choose a reason for hiding this comment

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

🚀

@braingram braingram merged commit 8d342d3 into asdf-format:main Dec 5, 2023
@braingram braingram deleted the cleanup_asdf branch December 5, 2023 23:46
@braingram braingram mentioned this pull request Dec 6, 2023
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