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 new API design doc #447

Merged
merged 16 commits into from
Apr 25, 2022
Merged

Add new API design doc #447

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
ee800d4
Add new API design doc
jwodder Mar 3, 2021
1702bb2
Add get_raw_metadata()
jwodder Mar 4, 2021
6340c9b
Update for first round of comments
jwodder Mar 5, 2021
ffd6ac1
Remove the "_all" from "get_all_*" methods
jwodder Mar 8, 2021
9e2d414
Change `DandiMeta` to `DandisetMeta`
jwodder Mar 11, 2021
58500c1
Specify `get_metadata` default for `download()`
jwodder Mar 11, 2021
6d731db
Make `set_metadata()` modify objects in-place
jwodder Mar 11, 2021
6661c28
RemoteAsset.uuid → identifier
jwodder Mar 11, 2021
20cc7dc
Replace Asset.sha256 with `get_digest()`
jwodder Mar 11, 2021
3f62f3d
Add an implementation note
jwodder Mar 12, 2021
21f361a
Adjust progress dict fields
jwodder Mar 12, 2021
7d3266f
Add some methods
jwodder Apr 6, 2021
201b081
Updates
jwodder Jun 4, 2021
af512df
Remove "created" attribute from Asset classes
jwodder Jun 7, 2021
6f84091
Update User name fields
jwodder Jun 7, 2021
2b32d56
Don't do that.
jwodder Jun 7, 2021
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
Prev Previous commit
Next Next commit
Make set_metadata() modify objects in-place
  • Loading branch information
@jwodder
jwodder committed Jun 4, 2021
commit 6d731db36ec5bde31c5df1171fa4127c86677af0
4 changes: 2 additions & 2 deletions doc/design/python-api-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Designs for an improved Python API
* TO DO: Add an argument for controlling whether to create a directory under `target_dir` with the same name as the Dandiset ID?

* Methods of the `DraftDandiset` class (a subclass of `RemoteDandiset` used only for mutable draft versions):
* `set_metadata(metadata: DandisetMeta) -> DraftDandiset` — returns the new, modified object
* `set_metadata(metadata: DandisetMeta) -> None` — modifies instance in-place
* Methods for uploading an individual asset:
* `upload_file(filepath: Union[str, Path], metadata: BareAssetMeta, show_progress=True, existing="refesh", validation="require") -> RemoteAsset`
Copy link
Member

Choose a reason for hiding this comment

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

metadata should not be provided but extracted as part of the *upload_file*

Copy link
Member Author

Choose a reason for hiding this comment

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

The idea of this method is to support generic file uploads where the user crafts the metadata themselves. If we only want to support upload of files that can be represented with LocalAsset instances, we can get rid of it.

* `iter_upload_file(filepath: Union[str, Path], metadata: BareAssetMeta, existing="refesh", validation="require") -> Iterator[UploadProgressDict]`
Expand Down Expand Up @@ -105,7 +105,7 @@ Designs for an improved Python API
* `version_id: str`
Copy link
Member

Choose a reason for hiding this comment

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

like dandiset version? also would not bother... may be if we are to establish relationship to a specific dandiset, could be via .dandiset: RemoteDandiset

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, Dandiset version. Same response as above.

* `get_metadata() -> RemoteAssetMeta`
* `get_raw_metadata() -> dict` — useful when the metadata is invalid
* `set_metadata(metadata: BareAssetMeta) -> RemoteAsset` — returns the new, modified object
* `set_metadata(metadata: BareAssetMeta) -> None` — Assuming assets keep their identifier on metadata change, this modifies the instance in-place; otherwise, it should return the new, modified instance
* `delete() -> None`
* `download(filepath: str, show_progress=True, chunk_size=...) -> ???`
* `iter_download(filepath: str, chunk_size=...) -> Iterator[DownloadProgressDict]`
Expand Down