-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy path_purge.py
More file actions
762 lines (686 loc) · 31.7 KB
/
_purge.py
File metadata and controls
762 lines (686 loc) · 31.7 KB
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
import uuid
from abc import ABC, abstractmethod
from collections.abc import Callable, Iterable, Sequence
from dataclasses import dataclass
from functools import partial
from typing import Any, Literal, cast
import questionary
from cognite.client.data_classes import DataSetUpdate
from cognite.client.data_classes.data_modeling import Edge
from cognite.client.data_classes.data_modeling.statistics import SpaceStatistics
from cognite.client.exceptions import CogniteAPIError
from pydantic import JsonValue
from rich import print
from rich.console import Console
from rich.panel import Panel
from cognite_toolkit._cdf_tk.client import ToolkitClient
from cognite_toolkit._cdf_tk.client._resource_base import RequestItem
from cognite_toolkit._cdf_tk.client.http_client import (
HTTPClient,
ItemsRequest,
ItemsSuccessResponse,
)
from cognite_toolkit._cdf_tk.client.identifiers import (
InstanceDefinitionId,
InstanceId,
InternalId,
)
from cognite_toolkit._cdf_tk.client.resource_classes.data_modeling import NodeId, NodeResponse, SpaceId
from cognite_toolkit._cdf_tk.cruds import (
AssetCRUD,
ContainerCRUD,
DataModelCRUD,
EdgeCRUD,
EventCRUD,
ExtractionPipelineCRUD,
FileMetadataCRUD,
LabelCRUD,
NodeCRUD,
RelationshipCRUD,
ResourceCRUD,
SequenceCRUD,
SpaceCRUD,
ThreeDModelCRUD,
TimeSeriesCRUD,
TransformationCRUD,
ViewCRUD,
WorkflowCRUD,
)
from cognite_toolkit._cdf_tk.data_classes import DeployResults, ResourceDeployResult
from cognite_toolkit._cdf_tk.exceptions import (
AuthorizationError,
ToolkitMissingResourceError,
)
from cognite_toolkit._cdf_tk.protocols import ResourceResponseProtocol
from cognite_toolkit._cdf_tk.storageio import InstanceIO
from cognite_toolkit._cdf_tk.storageio.selectors import InstanceSelector
from cognite_toolkit._cdf_tk.tk_warnings import (
HighSeverityWarning,
LimitedAccessWarning,
)
from cognite_toolkit._cdf_tk.utils import humanize_collection
from cognite_toolkit._cdf_tk.utils.aggregators import (
AssetAggregator,
EventAggregator,
FileAggregator,
LabelCountAggregator,
RelationshipAggregator,
SequenceAggregator,
TimeSeriesAggregator,
)
from cognite_toolkit._cdf_tk.utils.producer_worker import ProducerWorkerExecutor
from cognite_toolkit._cdf_tk.utils.useful_types import JsonVal
from cognite_toolkit._cdf_tk.utils.validate_access import ValidateAccess
from ._base import ToolkitCommand
@dataclass
class DeleteResults:
deleted: int = 0
failed: int = 0
class DeleteItem(RequestItem):
item: JsonValue
as_id_fun: Callable[[JsonValue], str]
def dump(self, camel_case: bool = True, exclude_extra: bool = False) -> dict[str, Any]:
return self.item # type: ignore[return-value]
def __str__(self) -> str:
return self.as_id_fun(self.item)
@dataclass
class ToDelete(ABC):
crud: ResourceCRUD
total: int
delete_url: str
@property
def display_name(self) -> str:
return self.crud.display_name
@abstractmethod
def get_process_function(
self, client: ToolkitClient, console: Console, verbose: bool, process_results: ResourceDeployResult
) -> Callable[[list[ResourceResponseProtocol]], list[JsonVal]]:
raise NotImplementedError()
def get_extra_fields(self) -> dict[str, JsonVal]:
return {}
@dataclass
class DataModelingToDelete(ToDelete):
def get_process_function(
self, client: ToolkitClient, console: Console, verbose: bool, process_results: ResourceDeployResult
) -> Callable[[list[ResourceResponseProtocol]], list[JsonVal]]:
def as_id(chunk: list[ResourceResponseProtocol]) -> list[JsonVal]:
# We know that all data modeling resources implement as_id
return [item.as_id().dump() for item in chunk] # type: ignore[attr-defined]
return as_id
@dataclass
class EdgeToDelete(ToDelete):
def get_process_function(
self, client: ToolkitClient, console: Console, verbose: bool, process_results: ResourceDeployResult
) -> Callable[[list[ResourceResponseProtocol]], list[JsonVal]]:
def as_id(chunk: list[ResourceResponseProtocol]) -> list[JsonVal]:
return [
{"space": item.space, "externalId": item.external_id, "instanceType": "edge"}
for item in cast(list[Edge], chunk)
]
return as_id
@dataclass
class NodesToDelete(ToDelete):
delete_datapoints: bool
delete_file_content: bool
def get_process_function(
self, client: ToolkitClient, console: Console, verbose: bool, process_results: ResourceDeployResult
) -> Callable[[list[ResourceResponseProtocol]], list[JsonVal]]:
def check_for_data(chunk: list[NodeResponse]) -> list[JsonVal]:
instance_ids = [InstanceId(instance_id=item.as_id()) for item in chunk]
found_ids: set[NodeId] = set()
if not self.delete_datapoints:
timeseries = client.tool.timeseries.retrieve(instance_ids, ignore_unknown_ids=True)
found_ids |= {ts.instance_id for ts in timeseries if ts.instance_id is not None}
if not self.delete_file_content:
files = client.tool.filemetadata.retrieve(instance_ids, ignore_unknown_ids=True)
found_ids |= {f.instance_id for f in files if f.instance_id is not None}
if found_ids and verbose:
console.print(f"Skipping {found_ids} nodes as they have datapoints or file content")
process_results.unchanged += len(found_ids)
result: list[JsonVal] = []
for node_id in (n.instance_id for n in instance_ids if n.instance_id not in found_ids):
dumped = node_id.dump(include_instance_type=True)
result.append(dumped)
return result
return check_for_data # type: ignore[return-value]
@dataclass
class IdResourceToDelete(ToDelete):
def get_process_function(
self, client: ToolkitClient, console: Console, verbose: bool, process_results: ResourceDeployResult
) -> Callable[[list[ResourceResponseProtocol]], list[JsonVal]]:
def as_id(chunk: list[ResourceResponseProtocol]) -> list[JsonVal]:
# We know that all id resources have an id attribute
return [{"id": item.id} for item in chunk] # type: ignore[attr-defined]
return as_id
@dataclass
class ExternalIdToDelete(ToDelete):
def get_process_function(
self, client: ToolkitClient, console: Console, verbose: bool, process_results: ResourceDeployResult
) -> Callable[[list[ResourceResponseProtocol]], list[JsonVal]]:
def as_external_id(chunk: list[ResourceResponseProtocol]) -> list[JsonVal]:
# We know that all external id resources have an external_id attribute
return [{"externalId": item.external_id} for item in chunk] # type: ignore[attr-defined]
return as_external_id
@dataclass
class AssetToDelete(IdResourceToDelete):
recursive: bool
def get_extra_fields(self) -> dict[str, JsonVal]:
return {"recursive": self.recursive}
class PurgeCommand(ToolkitCommand):
BATCH_SIZE_DM = 1000
def space(
self,
client: ToolkitClient,
selected_space: str,
include_space: bool = False,
delete_datapoints: bool = False,
delete_file_content: bool = False,
dry_run: bool = False,
auto_yes: bool = False,
verbose: bool = False,
) -> DeployResults:
# Warning Messages
if not dry_run:
self._print_panel("space", selected_space)
if not dry_run and not auto_yes:
confirm = questionary.confirm(
f"Are you really sure you want to purge the {selected_space!r} space?", default=False
).ask()
if not confirm:
return DeployResults([], "purge", dry_run=dry_run)
stats = client.data_modeling.statistics.spaces.retrieve(selected_space)
if stats is None:
raise ToolkitMissingResourceError(f"Space {selected_space!r} does not exist")
# ValidateAuth
validator = ValidateAccess(client, "purge")
if include_space or (stats.containers + stats.views + stats.data_models) > 0:
# We check for write even in dry-run mode. This is because dry-run is expected to fail
# if the user cannot perform the purge.
validator.data_model(["read", "write"], spaces={selected_space})
if (stats.nodes + stats.edges) > 0:
validator.instances(["read", "write"], spaces={selected_space})
to_delete = self._create_to_delete_list_purge_space(client, delete_datapoints, delete_file_content, stats)
if dry_run:
results = DeployResults([], "purge", dry_run=True)
for item in to_delete:
results[item.display_name] = ResourceDeployResult(item.display_name, deleted=item.total)
if include_space:
space_loader = SpaceCRUD.create_loader(client)
results[space_loader.display_name] = ResourceDeployResult(space_loader.display_name, deleted=1)
else:
results = self._delete_resources(to_delete, client, verbose, selected_space, None)
if include_space:
self._delete_space(client, selected_space, results)
print(results.counts_table(exclude_columns={"Created", "Changed", "Total"}))
return results
@staticmethod
def _create_to_delete_list_purge_space(
client: ToolkitClient, delete_datapoints: bool, delete_file_content: bool, stats: SpaceStatistics
) -> list[ToDelete]:
config = client.config
to_delete = [
EdgeToDelete(
EdgeCRUD.create_loader(client), stats.edges, config.create_api_url("/models/instances/delete")
),
NodesToDelete(
NodeCRUD.create_loader(client),
stats.nodes,
config.create_api_url(
"/models/instances/delete",
),
delete_datapoints=delete_datapoints,
delete_file_content=delete_file_content,
),
DataModelingToDelete(
DataModelCRUD.create_loader(client),
stats.data_models,
config.create_api_url("/models/datamodels/delete"),
),
DataModelingToDelete(
ViewCRUD.create_loader(client), stats.views, config.create_api_url("/models/views/delete")
),
DataModelingToDelete(
ContainerCRUD.create_loader(client),
stats.containers,
config.create_api_url("/models/containers/delete"),
),
]
return to_delete
def _delete_space(self, client: ToolkitClient, selected_space: str, results: DeployResults) -> None:
space_loader = SpaceCRUD.create_loader(client)
try:
space_loader.delete([SpaceId(space=selected_space)])
print(f"Space {selected_space} deleted")
except CogniteAPIError as e:
self.warn(HighSeverityWarning(f"Failed to delete space {selected_space!r}: {e}"))
else:
results[space_loader.display_name] = ResourceDeployResult(space_loader.display_name, deleted=1)
def _delete_resources(
self,
to_delete: list[ToDelete],
client: ToolkitClient,
verbose: bool,
space: str | None,
data_set_external_id: str | None,
) -> DeployResults:
results = DeployResults([], "purge", dry_run=False)
console = Console()
with HTTPClient(client.config, max_retries=10) as delete_client:
for item in to_delete:
if item.total == 0:
results[item.display_name] = ResourceDeployResult(item.display_name, deleted=0)
continue
# Two results objects since they are updated concurrently
process_results = ResourceDeployResult(item.display_name)
write_results = ResourceDeployResult(item.display_name)
executor = ProducerWorkerExecutor[list[ResourceResponseProtocol], list[JsonVal]](
download_iterable=self._iterate_batch(
item.crud, space, data_set_external_id, batch_size=self.BATCH_SIZE_DM
),
process=item.get_process_function(client, console, verbose, process_results),
write=self._purge_batch(item, item.delete_url, delete_client, write_results),
max_queue_size=10,
total_item_count=item.total,
download_description=f"Downloading {item.display_name}",
process_description=f"Preparing {item.display_name} for deletion",
write_description=f"Deleting {item.display_name}",
console=console,
)
executor.run()
write_results += process_results
results[item.display_name] = write_results
if executor.error_occurred:
if verbose and executor.error_traceback:
executor.print_traceback()
self.warn(
HighSeverityWarning(f"Failed to delete all {item.display_name}. {executor.error_message}")
)
return results
@staticmethod
def _iterate_batch(
crud: ResourceCRUD, selected_space: str | None, data_set_external_id: str | None, batch_size: int
) -> Iterable[list[ResourceResponseProtocol]]:
batch: list[ResourceResponseProtocol] = []
for resource in crud.iterate(space=selected_space, data_set_external_id=data_set_external_id):
batch.append(resource)
if len(batch) >= batch_size:
yield batch
batch = []
if batch:
yield batch
@staticmethod
def _purge_batch(
delete_item: ToDelete, delete_url: str, delete_client: HTTPClient, result: ResourceDeployResult
) -> Callable[[list[JsonVal]], None]:
crud = delete_item.crud
def as_id(item: JsonVal) -> str:
try:
return str(crud.get_id(item))
except KeyError:
# Fallback to internal ID
return str(crud.get_internal_id(item))
def process(items: list[JsonVal]) -> None:
responses = delete_client.request_items_retries(
ItemsRequest(
endpoint_url=delete_url,
method="POST",
items=[DeleteItem(item=item, as_id_fun=as_id) for item in items],
extra_body_fields=delete_item.get_extra_fields(),
)
)
for response in responses:
if isinstance(response, ItemsSuccessResponse):
result.deleted += len(response.ids)
else:
result.unchanged += len(response.ids)
return process
def dataset(
self,
client: ToolkitClient,
selected_data_set_external_id: str,
archive_dataset: bool = False,
include_data: bool = True,
include_configurations: bool = False,
asset_recursive: bool = False,
dry_run: bool = False,
auto_yes: bool = False,
verbose: bool = False,
) -> DeployResults:
"""Purge a dataset and all its content
Args:
client: The ToolkitClient to use
selected_data_set_external_id: The external ID of the dataset to purge
archive_dataset: Whether to archive the dataset itself after the purge
include_data: Whether to include data (assets, events, time series, files, sequences, 3D models, relationships, labels) in the purge
include_configurations: Whether to include configurations (workflows, transformations, extraction pipelines) in the purge
asset_recursive: Whether to recursively delete assets.
dry_run: Whether to perform a dry run
auto_yes: Whether to automatically confirm the purge
verbose: Whether to print verbose output
Returns:
DeployResults: The results of the purge operation
"""
# Warning Messages
if not dry_run:
self._print_panel("dataSet", selected_data_set_external_id)
if not dry_run and not auto_yes:
confirm = questionary.confirm(
f"Are you really sure you want to purge the {selected_data_set_external_id!r} dataSet?", default=False
).ask()
if not confirm:
return DeployResults([], "purge", dry_run=dry_run)
# Validate Auth
validator = ValidateAccess(client, "purge")
data_set_id = client.lookup.data_sets.id(selected_data_set_external_id)
if data_set_id is None:
raise ToolkitMissingResourceError(f"DataSet {selected_data_set_external_id!r} does not exist")
action = cast(Sequence[Literal["read", "write"]], ["read"] if dry_run else ["read", "write"])
if include_data:
# Check asset, events, time series, files, and sequences access, relationships, labels, 3D access.
validator.dataset_data(action, dataset_ids={data_set_id})
if include_configurations:
# Check workflow, transformations, extraction pipeline access
validator.dataset_configurations(action, dataset_ids={data_set_id})
to_delete: list[ToDelete] = self._create_to_delete_list_purge_dataset(
client,
include_data,
include_configurations,
selected_data_set_external_id,
asset_recursive,
)
if dry_run:
results = DeployResults([], "purge", dry_run=True)
for item in to_delete:
results[item.display_name] = ResourceDeployResult(item.display_name, deleted=item.total)
else:
results = self._delete_resources(to_delete, client, verbose, None, selected_data_set_external_id)
print(results.counts_table(exclude_columns={"Created", "Changed", "Total"}))
if archive_dataset and not dry_run:
self._archive_dataset(client, selected_data_set_external_id)
return results
@staticmethod
def _archive_dataset(client: ToolkitClient, data_set: str) -> None:
archived = (
DataSetUpdate(external_id=data_set)
.external_id.set(str(uuid.uuid4()))
.metadata.add({"archived": "true"})
.write_protected.set(True)
)
client.data_sets.update(archived)
print(f"DataSet {data_set} archived")
@staticmethod
def _create_to_delete_list_purge_dataset(
client: ToolkitClient,
include_data: bool,
include_configurations: bool,
data_set_external_id: str,
asset_recursive: bool,
) -> list[ToDelete]:
config = client.config
to_delete: list[ToDelete] = []
if include_data:
three_d_crud = ThreeDModelCRUD.create_loader(client)
to_delete.extend(
[
ExternalIdToDelete(
RelationshipCRUD.create_loader(client),
RelationshipAggregator(client).count(data_set_external_id=data_set_external_id),
config.create_api_url("/relationships/delete"),
),
IdResourceToDelete(
EventCRUD.create_loader(client),
EventAggregator(client).count(data_set_external_id=data_set_external_id),
config.create_api_url("/events/delete"),
),
IdResourceToDelete(
FileMetadataCRUD.create_loader(client),
FileAggregator(client).count(data_set_external_id=data_set_external_id),
config.create_api_url("/files/delete"),
),
IdResourceToDelete(
TimeSeriesCRUD.create_loader(client),
TimeSeriesAggregator(client).count(data_set_external_id=data_set_external_id),
config.create_api_url("/timeseries/delete"),
),
IdResourceToDelete(
SequenceCRUD.create_loader(client),
SequenceAggregator(client).count(data_set_external_id=data_set_external_id),
config.create_api_url("/sequences/delete"),
),
IdResourceToDelete(
three_d_crud,
sum(1 for _ in three_d_crud.iterate(data_set_external_id=data_set_external_id)),
config.create_api_url("/3d/models/delete"),
),
AssetToDelete(
AssetCRUD.create_loader(client),
AssetAggregator(client).count(data_set_external_id=data_set_external_id),
config.create_api_url("/assets/delete"),
recursive=asset_recursive,
),
ExternalIdToDelete(
LabelCRUD.create_loader(client),
LabelCountAggregator(client).count(data_set_external_id=data_set_external_id),
config.create_api_url("/labels/delete"),
),
]
)
if include_configurations:
transformation_crud = TransformationCRUD.create_loader(client)
workflow_crud = WorkflowCRUD.create_loader(client)
extraction_pipeline_crud = ExtractionPipelineCRUD.create_loader(client)
to_delete.extend(
[
IdResourceToDelete(
transformation_crud,
sum(1 for _ in transformation_crud.iterate(data_set_external_id=data_set_external_id)),
config.create_api_url("/transformations/delete"),
),
ExternalIdToDelete(
workflow_crud,
sum(1 for _ in workflow_crud.iterate(data_set_external_id=data_set_external_id)),
config.create_api_url("/workflows/delete"),
),
IdResourceToDelete(
extraction_pipeline_crud,
sum(1 for _ in extraction_pipeline_crud.iterate(data_set_external_id=data_set_external_id)),
config.create_api_url("/extpipes/delete"),
),
]
)
return to_delete
@staticmethod
def _print_panel(resource_type: str, resource: str) -> None:
print(
Panel(
f"[red]WARNING:[/red] This operation [bold]cannot be undone[/bold]! "
f"Resources in {resource!r} are permanently deleted",
style="bold",
title=f"Purge {resource_type}",
title_align="left",
border_style="red",
expand=False,
)
)
def instances(
self,
client: ToolkitClient,
selector: InstanceSelector,
dry_run: bool = False,
auto_yes: bool = False,
unlink: bool = True,
verbose: bool = False,
) -> DeleteResults:
"""Purge instances"""
io = InstanceIO(client)
console = Console()
validator = ValidateAccess(client, default_operation="purge")
self.validate_instance_access(validator, selector.get_instance_spaces())
if unlink:
self.validate_timeseries_access(validator)
self.validate_file_access(validator)
total = io.count(selector)
if total is None or total == 0:
print("No instances found.")
return DeleteResults()
if not dry_run:
self._print_panel("instances", str(selector))
if not auto_yes:
confirm = questionary.confirm(
f"Are you really sure you want to purge all {total:,} instances in {selector!s}?",
default=False,
).ask()
if not confirm:
return DeleteResults()
process: Callable[[Sequence[InstanceDefinitionId]], list[dict[str, JsonVal]]] = self._prepare
if unlink:
process = partial(self._unlink_prepare, client=client, dry_run=dry_run, console=console, verbose=verbose)
with HTTPClient(config=client.config) as delete_client:
process_str = "Would be unlinking" if dry_run else "Unlinking"
write_str = "Would be deleting" if dry_run else "Deleting"
results = DeleteResults()
executor = ProducerWorkerExecutor[Sequence[InstanceDefinitionId], list[dict[str, JsonVal]]](
download_iterable=io.download_ids(selector),
process=process,
write=partial(self._delete_instance_ids, dry_run=dry_run, delete_client=delete_client, results=results),
total_item_count=total,
max_queue_size=10,
download_description=f"Retrieving instances from {selector!s}",
process_description=f"{process_str} instances from files/timeseries" if unlink else "",
write_description=f"{write_str} instances",
console=console,
)
executor.run()
executor.raise_on_error()
prefix = "Would have purged" if dry_run else "Purged"
if results.failed == 0:
console.print(f"{prefix} {results.deleted:,} instances in {selector!s}")
else:
console.print(
f"{prefix} {results.deleted:,} instances in {selector!s}, but failed to purge {results.failed:,} instances"
)
return results
def validate_instance_access(self, validator: ValidateAccess, instance_spaces: list[str] | None) -> None:
space_ids = validator.instances(
["read", "write"], spaces=set(instance_spaces) if instance_spaces else None, operation="purge"
)
if space_ids is None:
# Full access
return
self.warn(
LimitedAccessWarning(
f"You can only purge instances in the following instance spaces: {humanize_collection(space_ids)}."
)
)
return
def validate_model_access(self, validator: ValidateAccess, view: list[str] | None) -> None:
space = view[0] if isinstance(view, list) and view and isinstance(view[0], str) else None
if space_ids := validator.data_model(["read"], spaces={space} if space else None):
self.warn(
LimitedAccessWarning(
f"You can only select views in the {len(space_ids)} spaces you have access to: {humanize_collection(space_ids)}."
)
)
def validate_timeseries_access(self, validator: ValidateAccess) -> None:
try:
ids_by_scope = validator.timeseries(["read", "write"], operation="unlink")
except AuthorizationError as e:
self.warn(HighSeverityWarning(f"You cannot unlink time series. You need read and write access: {e!s}"))
return
if ids_by_scope is None:
return
scope_str = humanize_collection(
[f"{scope_name} ({humanize_collection(ids)})" for scope_name, ids in ids_by_scope.items()],
bind_word="and",
)
self.warn(LimitedAccessWarning(f"You can only unlink time series in the following scopes: {scope_str}."))
def validate_file_access(self, validator: ValidateAccess) -> None:
try:
ids_by_scope = validator.files(["read", "write"], operation="unlink")
except AuthorizationError as e:
self.warn(HighSeverityWarning(f"You cannot unlink files. You need read and write access: {e!s}"))
return
if ids_by_scope is None:
return
scope_str = humanize_collection(
[f"{scope_name} ({humanize_collection(ids)})" for scope_name, ids in ids_by_scope.items()],
bind_word="and",
)
self.warn(LimitedAccessWarning(f"You can only unlink files in the following scopes: {scope_str}."))
@staticmethod
def _prepare(instance_ids: Sequence[InstanceDefinitionId]) -> list[dict[str, JsonVal]]:
output: list[dict[str, JsonVal]] = []
for instance_id in instance_ids:
dumped = instance_id.dump(include_instance_type=True)
output.append(dumped)
return output
def _unlink_prepare(
self,
instance_ids: Sequence[InstanceDefinitionId],
client: ToolkitClient,
dry_run: bool,
console: Console,
verbose: bool = False,
) -> list[dict[str, JsonVal]]:
self._unlink_timeseries(instance_ids, client, dry_run, console, verbose)
self._unlink_files(instance_ids, client, dry_run, console, verbose)
return self._prepare(instance_ids)
@staticmethod
def _delete_instance_ids(
items: list[dict[str, JsonVal]], dry_run: bool, delete_client: HTTPClient, results: DeleteResults
) -> None:
if dry_run:
results.deleted += len(items)
return
responses = delete_client.request_items_retries(
ItemsRequest(
endpoint_url=delete_client.config.create_api_url("/models/instances/delete"),
method="POST",
items=[InstanceDefinitionId._load(item) for item in items],
)
)
for response in responses:
if isinstance(response, ItemsSuccessResponse):
results.deleted += len(response.ids)
else:
results.failed += len(response.ids)
@staticmethod
def _unlink_timeseries(
instances: Sequence[InstanceDefinitionId], client: ToolkitClient, dry_run: bool, console: Console, verbose: bool
) -> list[InstanceDefinitionId]:
node_ids = [instance for instance in instances if isinstance(instance, NodeId)]
if node_ids:
timeseries = client.tool.timeseries.retrieve(
[InstanceId(instance_id=NodeId(space=node.space, external_id=node.external_id)) for node in node_ids],
ignore_unknown_ids=True,
)
migrated_timeseries_ids = [
InternalId(id=ts.id) for ts in timeseries if ts.instance_id and ts.pending_instance_id
]
if not dry_run and timeseries:
client.tool.timeseries.unlink_instance_ids(migrated_timeseries_ids)
if verbose:
console.print(f"Unlinked {len(migrated_timeseries_ids)} timeseries from datapoints.")
elif verbose and migrated_timeseries_ids:
console.print(f"Would have unlinked {len(timeseries)} timeseries from datapoints.")
return list(instances)
@staticmethod
def _unlink_files(
instances: Sequence[InstanceDefinitionId], client: ToolkitClient, dry_run: bool, console: Console, verbose: bool
) -> list[InstanceDefinitionId]:
file_ids = [instance for instance in instances if isinstance(instance, NodeId)]
if file_ids:
files = client.tool.filemetadata.retrieve(
[InstanceId(instance_id=NodeId(space=node.space, external_id=node.external_id)) for node in file_ids],
ignore_unknown_ids=True,
)
migrated_file_ids = [
InternalId(id=file.id) for file in files if file.instance_id and file.pending_instance_id
]
if not dry_run and files:
client.tool.filemetadata.unlink_instance_ids(migrated_file_ids)
if verbose:
console.print(f"Unlinked {len(migrated_file_ids)} files from nodes.")
elif verbose and files:
console.print(f"Would have unlinked {len(migrated_file_ids)} files from their blob content.")
return list(instances)