-
Notifications
You must be signed in to change notification settings - Fork 10
/
__init__.py
209 lines (170 loc) · 6.5 KB
/
__init__.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
from __future__ import annotations
from typing import TYPE_CHECKING
from django.db import transaction
from django.utils import timezone
from dandiapi.api.asset_paths import add_asset_paths, delete_asset_paths, get_conflicting_paths
from dandiapi.api.models.asset import Asset, AssetBlob
from dandiapi.api.models.dandiset import Dandiset
from dandiapi.api.models.version import Version
from dandiapi.api.services import audit
from dandiapi.api.services.asset.exceptions import (
AssetAlreadyExistsError,
AssetPathConflictError,
DandisetOwnerRequiredError,
DraftDandisetNotModifiableError,
ZarrArchiveBelongsToDifferentDandisetError,
)
from dandiapi.api.tasks import remove_asset_blob_embargoed_tag_task
if TYPE_CHECKING:
from dandiapi.zarr.models import ZarrArchive
def _create_asset(
*,
path: str,
asset_blob: AssetBlob | None = None,
zarr_archive: ZarrArchive | None = None,
metadata: dict,
):
metadata = Asset.strip_metadata(metadata)
asset = Asset(
path=path,
blob=asset_blob,
zarr=zarr_archive,
metadata=metadata,
status=Asset.Status.PENDING,
)
asset.full_clean(validate_constraints=False)
asset.save()
return asset
def _add_asset_to_version(
*,
version: Version,
asset_blob: AssetBlob | None,
zarr_archive: ZarrArchive | None,
metadata: dict,
) -> Asset:
path = metadata['path']
asset = _create_asset(
path=path, asset_blob=asset_blob, zarr_archive=zarr_archive, metadata=metadata
)
version.assets.add(asset)
add_asset_paths(asset, version)
# Trigger a version metadata validation, as saving the version might change the metadata
Version.objects.filter(id=version.id).update(
status=Version.Status.PENDING, modified=timezone.now()
)
return asset
def _remove_asset_from_version(*, asset: Asset, version: Version):
# Remove asset paths and asset itself from version
delete_asset_paths(asset, version)
version.assets.remove(asset)
# Trigger a version metadata validation, as saving the version might change the metadata
Version.objects.filter(id=version.id).update(
status=Version.Status.PENDING, modified=timezone.now()
)
def change_asset( # noqa: PLR0913
*,
user,
asset: Asset,
version: Version,
new_asset_blob: AssetBlob | None = None,
new_zarr_archive: ZarrArchive | None = None,
new_metadata: dict,
) -> tuple[Asset, bool]:
"""
Change the blob/zarr/metadata of an asset if necessary.
Returns a tuple of the asset, and whether or not it was changed. When changing an asset, a new
asset is created automatically.
"""
if not new_asset_blob and not new_zarr_archive:
raise ValueError('One of new_zarr_archive or new_asset_blob must be given')
if 'path' not in new_metadata:
raise ValueError('Path must be present in new_metadata')
if not user.has_perm('owner', version.dandiset):
raise DandisetOwnerRequiredError
if version.version != 'draft':
raise DraftDandisetNotModifiableError
path = new_metadata['path']
new_metadata_stripped = Asset.strip_metadata(new_metadata)
if not asset.is_different_from(
asset_blob=new_asset_blob,
zarr_archive=new_zarr_archive,
metadata=new_metadata_stripped,
path=path,
):
return asset, False
# Verify we aren't changing path to the same value as an existing asset
if version.assets.filter(path=path).exclude(asset_id=asset.asset_id).exists():
raise AssetAlreadyExistsError
with transaction.atomic():
_remove_asset_from_version(asset=asset, version=version)
new_asset = _add_asset_to_version(
version=version,
asset_blob=new_asset_blob,
zarr_archive=new_zarr_archive,
metadata=new_metadata,
)
# Set previous asset and save
new_asset.previous = asset
new_asset.save()
audit.update_asset(dandiset=version.dandiset, user=user, asset=new_asset)
return new_asset, True
def add_asset_to_version(
*,
user,
version: Version,
asset_blob: AssetBlob | None = None,
zarr_archive: ZarrArchive | None = None,
metadata: dict,
) -> Asset:
"""Create an asset, adding it to a version."""
if not asset_blob and not zarr_archive:
raise RuntimeError(
'One of zarr_archive or asset_blob must be given to add_asset_to_version'
)
if 'path' not in metadata:
raise RuntimeError('Path must be present in metadata')
if not user.has_perm('owner', version.dandiset):
raise DandisetOwnerRequiredError
if version.version != 'draft':
raise DraftDandisetNotModifiableError
# Check if there are already any assets with the same path
path = metadata['path']
if version.assets.filter(path=path).exists():
raise AssetAlreadyExistsError
# Check if there are any assets that conflict with this path
conflicts = get_conflicting_paths(path, version)
if conflicts:
raise AssetPathConflictError(new_path=path, existing_paths=conflicts)
# Ensure zarr archive doesn't already belong to a dandiset
if zarr_archive and zarr_archive.dandiset != version.dandiset:
raise ZarrArchiveBelongsToDifferentDandisetError
with transaction.atomic():
# Creating an asset in an OPEN dandiset that points to an embargoed blob results in that
# blob being unembargoed
if (
asset_blob is not None
and asset_blob.embargoed
and version.dandiset.embargo_status == Dandiset.EmbargoStatus.OPEN
):
asset_blob.embargoed = False
asset_blob.save()
transaction.on_commit(
lambda: remove_asset_blob_embargoed_tag_task.delay(blob_id=asset_blob.blob_id)
)
asset = _add_asset_to_version(
version=version,
asset_blob=asset_blob,
zarr_archive=zarr_archive,
metadata=metadata,
)
audit.add_asset(dandiset=version.dandiset, user=user, asset=asset)
return asset
def remove_asset_from_version(*, user, asset: Asset, version: Version) -> Version:
if not user.has_perm('owner', version.dandiset):
raise DandisetOwnerRequiredError
if version.version != 'draft':
raise DraftDandisetNotModifiableError
with transaction.atomic():
_remove_asset_from_version(asset=asset, version=version)
audit.remove_asset(dandiset=version.dandiset, user=user, asset=asset)
return version