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.

Sign up for GitHub

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

Add notes to docs about get_metadata() vs. get_raw_metadata() #1398

Merged
merged 2 commits into from
Feb 1, 2024
Merged

Add notes to docs about get_metadata() vs. get_raw_metadata() #1398

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db6f4cf
Add notes to error messages & docs about `get_metadata()` vs. `get_ra…
jwodder Jan 31, 2024
9e521e3
Remove note from error messages
jwodder Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions dandi/dandiapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -971,6 +971,12 @@ def get_metadata(self) -> models.Dandiset:
"""
Fetch the metadata for this version of the Dandiset as a
`dandischema.models.Dandiset` instance

.. note::

Only published Dandiset versions can be expected to have valid
metadata. Consider using `get_raw_metadata()` instead in order to
fetch unstructured, possibly-invalid metadata.
"""
return models.Dandiset.parse_obj(self.get_raw_metadata())

Expand Down Expand Up @@ -1347,6 +1353,12 @@ def get_metadata(self) -> models.Asset:
"""
Fetch the metadata for the asset as a `dandischema.models.Asset`
instance

.. note::

Only assets in published Dandiset versions can be expected to have
valid metadata. Consider using `get_raw_metadata()` instead in
order to fetch unstructured, possibly-invalid metadata.
"""
return models.Asset.parse_obj(self.get_raw_metadata())

Expand Down
Loading