Add dump load dumps and loads to top level asdf#1930
Merged
Conversation
zacharyburnett
approved these changes
Jun 10, 2025
zacharyburnett
left a comment
Member
There was a problem hiding this comment.
was going to suggest pretty-printing options, but then I realized that we aren't minifying ASDF so it's ALWAYS pretty-printed 😅
Contributor
Author
"mASDF" :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a few functions to
asdfto mimic the interface used for other serialization libraries (json,pickle,yaml...):asdf.dump: Write the provided tree to the provided file path (or file-like object)asdf.load: Load the ASDF tree from the provided file path (or file-like object)asdf.dumps: Dump to a stringasdf.loads: Load from a stringI did some minor test reorganization to make testing these new functions a bit easier by moving the
treefixture out oftest_generic_ioand adding arecursive_treefixture (this expanded a few tests intest_generic_io).One plan for these new functions is to use them during an upcoming test reorganization.
These functions should feel familiar to anyone who uses the python
json,pickleand/oryamllibraries and should also be useful for some downstream libraries to simplify some asdf uses. For example, roman_datamodels contains the following code:This can be simplified to:
Closes #1873
The docstrings are largely copies of
AsdfFile.__init__asdf.openandAsdfFile.write_tooptions with some LLM peppered suggestions (which used those docstrings as context).Tasks
pre-commiton your machinepyteston your machineno-changelog-entry-needed)changes/:echo "changed something" > changes/<PR#>.<changetype>.rst(see below for change types)docs/pagenews fragment change types...
changes/<PR#>.feature.rst: new featurechanges/<PR#>.bugfix.rst: bug fixchanges/<PR#>.doc.rst: documentation changechanges/<PR#>.removal.rst: deprecation or removal of public APIchanges/<PR#>.general.rst: infrastructure or miscellaneous change