-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathcontroller.py
More file actions
1694 lines (1544 loc) · 57.8 KB
/
controller.py
File metadata and controls
1694 lines (1544 loc) · 57.8 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
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import io
import logging
import os
from abc import ABCMeta
from pathlib import Path
from typing import Any
from typing import Callable
from typing import Dict
from typing import List
from typing import Literal
from typing import Optional
from typing import Tuple
from typing import Union
import lib.core as constances
from lib.core import ApprovalStatus
from lib.core import usecases
from lib.core.conditions import Condition
from lib.core.conditions import CONDITION_EQ as EQ
from lib.core.entities import AttachmentEntity
from lib.core.entities import BaseItemEntity
from lib.core.entities import ConfigEntity
from lib.core.entities import ContributorEntity
from lib.core.entities import CustomFieldEntity
from lib.core.entities import FolderEntity
from lib.core.entities import ImageEntity
from lib.core.entities import PROJECT_ITEM_ENTITY_MAP
from lib.core.entities import ProjectEntity
from lib.core.entities import SettingEntity
from lib.core.entities import TeamEntity
from lib.core.entities import UserEntity
from lib.core.entities.classes import AnnotationClassEntity
from lib.core.entities.filters import ItemFilters
from lib.core.entities.filters import ProjectFilters
from lib.core.entities.filters import UserFilters
from lib.core.entities.integrations import IntegrationEntity
from lib.core.enums import CustomFieldEntityEnum
from lib.core.enums import CustomFieldType
from lib.core.enums import ProjectType
from lib.core.exceptions import AppException
from lib.core.exceptions import FileChangedError
from lib.core.jsx_conditions import EmptyQuery
from lib.core.jsx_conditions import Filter
from lib.core.jsx_conditions import Join
from lib.core.jsx_conditions import OperatorEnum
from lib.core.jsx_conditions import Query
from lib.core.reporter import Reporter
from lib.core.response import Response
from lib.core.service_types import PROJECT_TYPE_RESPONSE_MAP
from lib.core.usecases import serialize_item_entity
from lib.infrastructure.custom_entities import generate_schema
from lib.infrastructure.helpers import timed_lru_cache
from lib.infrastructure.query_builder import FieldValidationHandler
from lib.infrastructure.query_builder import IncludeHandler
from lib.infrastructure.query_builder import ItemFilterHandler
from lib.infrastructure.query_builder import ProjectFilterHandler
from lib.infrastructure.query_builder import QueryBuilderChain
from lib.infrastructure.query_builder import UserFilterHandler
from lib.infrastructure.repositories import S3Repository
from lib.infrastructure.serviceprovider import ServiceProvider
from lib.infrastructure.services.http_client import HttpClient
from lib.infrastructure.utils import divide_to_chunks
from lib.infrastructure.utils import extract_project_folder
from typing_extensions import Unpack
def build_condition(**kwargs) -> Condition:
condition = Condition.get_empty_condition()
if any(kwargs.values()):
for key, value in ((key, value) for key, value in kwargs.items() if value):
condition = condition & Condition(key, value, EQ)
return condition
def serialize_custom_fields(
service_provider: ServiceProvider, data: List[dict], entity: CustomFieldEntityEnum
) -> List[dict]:
existing_custom_fields = service_provider.list_custom_field_names(entity)
for i in range(len(data)):
if not data[i]:
data[i] = {}
updated_fields = {}
for custom_field_name, field_value in data[i].items():
field_id = int(custom_field_name)
try:
component_id = service_provider.get_custom_field_component_id(
field_id, entity=entity
)
except AppException:
# The component template can be deleted, but not from the entity, so it will be skipped.
continue
if field_value and component_id == CustomFieldType.DATE_PICKER.value:
field_value /= 1000 # Convert timestamp
new_field_name = service_provider.get_custom_field_name(
field_id, entity=entity
)
updated_fields[new_field_name] = field_value
data[i].clear()
data[i].update(updated_fields)
for existing_custom_field in existing_custom_fields:
if existing_custom_field not in data[i]:
data[i][existing_custom_field] = None
return data
class BaseManager:
def __init__(self, service_provider: ServiceProvider):
self.service_provider = service_provider
class WorkManagementManager(BaseManager):
def get_user_metadata(
self, pk: Union[str, int], include: List[Literal["custom_fields"]] = None
):
if isinstance(pk, int):
filters = {"id": pk}
else:
filters = {"email": pk}
users = self.list_users(include=include, **filters)
if not users:
raise AppException("User not found.")
return users[0]
def set_custom_field_value(
self,
entity_id: int,
entity: CustomFieldEntity,
parent_entity: CustomFieldEntityEnum,
field_name: str,
value: Any,
):
_context = {}
if entity == CustomFieldEntityEnum.PROJECT:
_context["project_id"] = entity_id
template_id = self.service_provider.get_custom_field_id(
field_name, entity=entity
)
component_id = self.service_provider.get_custom_field_component_id(
template_id, entity=entity
)
# timestamp: convert seconds to milliseconds
if component_id == CustomFieldType.DATE_PICKER.value and value is not None:
try:
value = value * 1000
except Exception:
raise AppException("Invalid custom field value provided.")
self.service_provider.work_management.set_custom_field_value(
entity_id=entity_id,
entity=entity,
parent_entity=parent_entity,
template_id=template_id,
data=value,
context=_context,
)
def list_users(self, include: List[Literal["custom_fields"]] = None, **filters):
valid_fields = generate_schema(
UserFilters.__annotations__,
self.service_provider.get_custom_fields_templates(
CustomFieldEntityEnum.CONTRIBUTOR
),
)
chain = QueryBuilderChain(
[
FieldValidationHandler(valid_fields.keys()),
UserFilterHandler(
service_provider=self.service_provider,
entity=CustomFieldEntityEnum.CONTRIBUTOR,
),
]
)
query = chain.handle(filters, EmptyQuery())
if include and "custom_fields" in include:
response = self.service_provider.work_management.list_users(
query, include_custom_fields=True
)
if not response.ok:
raise AppException(response.error)
users = response.data
custom_fields_list = [user.custom_fields for user in users]
serialized_fields = serialize_custom_fields(
self.service_provider,
custom_fields_list,
CustomFieldEntityEnum.CONTRIBUTOR,
)
for users, serialized_custom_fields in zip(users, serialized_fields):
users.custom_fields = serialized_custom_fields
return response.data
return self.service_provider.work_management.list_users(query).data
def update_user_activity(
self,
user_email: str,
provided_projects: Union[List[int], List[str], Literal["*"]],
action: Literal["resume", "pause"],
):
if isinstance(provided_projects, list):
if not provided_projects:
raise AppException("Provided projects list cannot be empty.")
body_query = EmptyQuery()
if isinstance(provided_projects[0], int):
body_query &= Filter("id", provided_projects, OperatorEnum.IN)
else:
body_query &= Filter("name", provided_projects, OperatorEnum.IN)
exist_projects = self.service_provider.work_management.search_projects(
body_query
).res_data
# project validation
if len(set(provided_projects)) > len(exist_projects):
raise AppException("Invalid project(s) provided.")
else:
exist_projects = self.service_provider.work_management.search_projects(
EmptyQuery()
).res_data
chunked_projects_ids = divide_to_chunks([i.id for i in exist_projects], 50)
for chunk in chunked_projects_ids:
body_query = EmptyQuery()
body_query &= Filter("projects.id", chunk, OperatorEnum.IN)
body_query &= Filter(
"projects.contributors.email", user_email, OperatorEnum.EQ
)
res = self.service_provider.work_management.update_user_activity(
body_query=body_query, action=action
)
res.raise_for_status()
class ProjectManager(BaseManager):
def __init__(self, service_provider: ServiceProvider, team: TeamEntity):
super().__init__(service_provider)
self._team = team
def get_by_id(self, project_id):
use_case = usecases.GetProjectByIDUseCase(
project_id=project_id, service_provider=self.service_provider
)
response = use_case.execute()
return response
def get_by_name(self, name: str):
use_case = usecases.GetProjectByNameUseCase(
name=name, service_provider=self.service_provider
)
response = use_case.execute()
if response.errors:
raise AppException(response.errors)
return response
def get_metadata(
self,
project: ProjectEntity,
include_annotation_classes: bool = False,
include_settings: bool = False,
include_contributors: bool = False,
include_complete_image_count: bool = False,
include_custom_fields: bool = False,
):
use_case = usecases.GetProjectMetaDataUseCase(
project=project,
service_provider=self.service_provider,
include_annotation_classes=include_annotation_classes,
include_settings=include_settings,
include_contributors=include_contributors,
include_complete_image_count=include_complete_image_count,
include_custom_fields=include_custom_fields,
)
return use_case.execute()
def create(self, entity: ProjectEntity) -> Response:
use_case = usecases.CreateProjectUseCase(
project=entity, service_provider=self.service_provider
)
return use_case.execute()
def list(self, condition: Condition):
use_case = usecases.GetProjectsUseCase(
condition=condition,
service_provider=self.service_provider,
)
return use_case.execute()
def delete(self, name: str):
use_case = usecases.DeleteProjectUseCase(
project_name=name, service_provider=self.service_provider
)
return use_case.execute()
def update(self, entity: ProjectEntity) -> Response:
use_case = usecases.UpdateProjectUseCase(
entity, service_provider=self.service_provider
)
return use_case.execute()
def set_settings(self, project: ProjectEntity, settings: List[SettingEntity]):
use_case = usecases.UpdateSettingsUseCase(
to_update=settings,
service_provider=self.service_provider,
project=project,
)
return use_case.execute()
def list_settings(self, project: ProjectEntity):
use_case = usecases.GetSettingsUseCase(
service_provider=self.service_provider, project=project
)
return use_case.execute()
def list_workflow(self, project: ProjectEntity):
use_case = usecases.GetWorkflowsUseCase(
project=project, service_provider=self.service_provider
)
return use_case.execute()
def set_workflows(self, project: ProjectEntity, steps: List):
use_case = usecases.SetWorkflowUseCase(
service_provider=self.service_provider,
steps=steps,
project=project,
)
return use_case.execute()
def add_contributors(
self,
team: TeamEntity,
project: ProjectEntity,
contributors: List[ContributorEntity],
):
project = self.get_metadata(project).data
for contributor in contributors:
contributor.user_role = self.service_provider.get_role_name(
project, contributor.user_role
)
project = self.get_metadata(project).data
use_case = usecases.AddContributorsToProject(
team=team,
project=project,
contributors=contributors,
service_provider=self.service_provider,
)
return use_case.execute()
def un_share(self, project: ProjectEntity, user_id: str):
use_case = usecases.UnShareProjectUseCase(
service_provider=self.service_provider,
project=project,
user_id=user_id,
)
return use_case.execute()
def assign_items(
self, project: ProjectEntity, folder: FolderEntity, item_names: list, user: str
):
use_case = usecases.AssignItemsUseCase(
project=project,
service_provider=self.service_provider,
folder=folder,
item_names=item_names,
user=user,
)
return use_case.execute()
def un_assign_items(
self, project: ProjectEntity, folder: FolderEntity, item_names: list
):
use_case = usecases.UnAssignItemsUseCase(
project=project,
service_provider=self.service_provider,
folder=folder,
item_names=item_names,
)
return use_case.execute()
def upload_priority_scores(
self, project: ProjectEntity, folder: FolderEntity, scores, project_folder_name
):
use_case = usecases.UploadPriorityScoresUseCase(
reporter=Reporter(),
project=project,
folder=folder,
scores=scores,
service_provider=self.service_provider,
project_folder_name=project_folder_name,
)
return use_case.execute()
def get_editor_template(self, project: ProjectEntity) -> dict:
response = self.service_provider.projects.get_editor_template(
team=self._team, project=project
)
response.raise_for_status()
return response.data
def list_projects(
self,
include: List[str] = None,
**filters: Unpack[ProjectFilters],
) -> List[ProjectEntity]:
valid_fields = generate_schema(
ProjectFilters.__annotations__,
self.service_provider.get_custom_fields_templates(
CustomFieldEntityEnum.PROJECT
),
)
chain = QueryBuilderChain(
[
FieldValidationHandler(valid_fields.keys()),
ProjectFilterHandler(
self.service_provider, entity=CustomFieldEntityEnum.PROJECT
),
]
)
query = chain.handle(filters, EmptyQuery())
include_custom_fields: bool = (
True if include and "custom_fields" in include else False
)
if include_custom_fields:
response = self.service_provider.work_management.list_projects(
body_query=query
)
else:
response = self.service_provider.work_management.search_projects(
body_query=query
)
if response.error:
raise AppException(response.error)
projects = response.data
if include_custom_fields:
custom_fields_list = [project.custom_fields for project in projects]
serialized_fields = serialize_custom_fields(
self.service_provider, custom_fields_list, CustomFieldEntityEnum.PROJECT
)
for project, serialized_custom_fields in zip(projects, serialized_fields):
project.custom_fields = serialized_custom_fields
return projects
class AnnotationClassManager(BaseManager):
@timed_lru_cache(seconds=3600)
def __get_auth_data(self, project: ProjectEntity, folder: FolderEntity):
response = self.service_provider.get_s3_upload_auth_token(project, folder)
if not response.ok:
raise AppException(response.error)
return response.data
def _get_s3_repository(self, project: ProjectEntity, folder: FolderEntity):
auth_data = self.__get_auth_data(project, folder)
return S3Repository(
auth_data["accessKeyId"],
auth_data["secretAccessKey"],
auth_data["sessionToken"],
auth_data["bucket"],
auth_data["region"],
)
def create(self, project: ProjectEntity, annotation_class: AnnotationClassEntity):
use_case = usecases.CreateAnnotationClassUseCase(
annotation_class=annotation_class,
project=project,
service_provider=self.service_provider,
)
return use_case.execute()
def create_multiple(
self, project: ProjectEntity, annotation_classes: List[AnnotationClassEntity]
):
use_case = usecases.CreateAnnotationClassesUseCase(
service_provider=self.service_provider,
annotation_classes=annotation_classes,
project=project,
)
return use_case.execute()
def list(self, condition: Condition):
use_case = usecases.GetAnnotationClassesUseCase(
service_provider=self.service_provider,
condition=condition,
)
return use_case.execute()
def delete(self, project: ProjectEntity, annotation_class: AnnotationClassEntity):
use_case = usecases.DeleteAnnotationClassUseCase(
annotation_class=annotation_class,
project=project,
service_provider=self.service_provider,
)
return use_case.execute()
def copy_multiple(
self,
source_project: ProjectEntity,
source_folder: FolderEntity,
source_item: BaseItemEntity,
destination_project: ProjectEntity,
destination_folder: FolderEntity,
destination_item: BaseItemEntity,
):
use_case = usecases.CopyImageAnnotationClasses(
from_project=source_project,
from_folder=source_folder,
from_image=source_item,
to_project=destination_project,
to_folder=destination_folder,
to_image=destination_item,
service_provider=self.service_provider,
from_project_s3_repo=self._get_s3_repository(source_project, source_folder),
to_project_s3_repo=self._get_s3_repository(
destination_project, destination_folder
),
)
return use_case.execute()
def download(self, project: ProjectEntity, download_path: str):
use_case = usecases.DownloadAnnotationClassesUseCase(
project=project,
download_path=download_path,
service_provider=self.service_provider,
)
return use_case.execute()
class FolderManager(BaseManager):
def create(self, project: ProjectEntity, folder: FolderEntity):
use_case = usecases.CreateFolderUseCase(
project=project,
folder=folder,
service_provider=self.service_provider,
)
return use_case.execute()
def get_by_id(self, folder_id, project_id, team_id):
use_case = usecases.GetFolderByIDUseCase(
folder_id=folder_id,
project_id=project_id,
team_id=team_id,
service_provider=self.service_provider,
)
return use_case.execute()
def list(self, project: ProjectEntity, condition: Condition = None):
use_case = usecases.SearchFoldersUseCase(
project=project, service_provider=self.service_provider, condition=condition
)
return use_case.execute()
def delete_multiple(self, project: ProjectEntity, folders: List[FolderEntity]):
use_case = usecases.DeleteFolderUseCase(
project=project,
folders=folders,
service_provider=self.service_provider,
)
return use_case.execute()
def get_by_name(self, project: ProjectEntity, name: str = None):
name = Controller.get_folder_name(name)
use_case = usecases.GetFolderUseCase(
project=project,
folder_name=name,
service_provider=self.service_provider,
)
return use_case.execute()
def assign_users(
self, project: ProjectEntity, folder: FolderEntity, users: List[str]
):
use_case = usecases.AssignFolderUseCase(
service_provider=self.service_provider,
project=project,
folder=folder,
users=users,
)
return use_case.execute()
class ItemManager(BaseManager):
def get_by_name(
self,
project: ProjectEntity,
folder: FolderEntity,
name: str,
) -> BaseItemEntity:
items = self.list_items(project, folder, name=name)
item = next(iter(items), None)
if not items:
raise AppException("Item not found.")
return item
@staticmethod
def _extract_value_from_mapping(data, extractor=lambda x: x):
if isinstance(data, (list, tuple, set)):
return [extractor(i) for i in data]
return extractor(data)
def _handle_special_fields(self, project: ProjectEntity, keys: List[str], val):
"""
Handle special fields like 'approval_status', 'assignments', 'user_role' and 'annotation_status'.
"""
if keys[0] == "approval_status":
val = (
[ApprovalStatus(i).value for i in val]
if isinstance(val, (list, tuple, set))
else ApprovalStatus(val).value
)
elif keys[0] == "annotation_status":
val = self._extract_value_from_mapping(
val,
lambda x: self.service_provider.get_annotation_status_value(project, x),
)
elif keys[0] == "assignments" and keys[1] == "user_role":
if isinstance(val, list):
val = [self.service_provider.get_role_id(project, i) for i in val]
else:
val = self.service_provider.get_role_id(project, val)
return val
@staticmethod
def _determine_condition_and_key(keys: List[str]) -> Tuple[OperatorEnum, str]:
"""Determine the condition and key from the filters."""
if len(keys) == 1:
return OperatorEnum.EQ, keys[0]
else:
if keys[-1].upper() in OperatorEnum.__members__:
condition = OperatorEnum[keys.pop().upper()]
else:
condition = OperatorEnum.EQ
return condition, ".".join(keys)
def _build_query(
self, project: ProjectEntity, filters: dict, include: List[str]
) -> Query:
"""Build the query object based on filters and include fields."""
filter_annotations = ItemFilters.__annotations__.keys()
query = EmptyQuery()
_include = set(include if include else [])
for key, val in filters.items():
if key in filter_annotations:
_keys = key.split("__")
entity = PROJECT_ITEM_ENTITY_MAP.get(project.type, BaseItemEntity)
if _keys[0] not in entity.__fields__:
_include.add(_keys[0])
val = self._handle_special_fields(project, _keys, val)
condition, _key = self._determine_condition_and_key(_keys)
query &= Filter(_key, val, condition)
for i in _include:
query &= Join(i)
return query
@staticmethod
def process_response(
service_provider,
items: List[BaseItemEntity],
project: ProjectEntity,
folder: FolderEntity,
map_fields: bool = True,
) -> List[BaseItemEntity]:
"""Process the response data and return a list of serialized items."""
data = []
for item in items:
if map_fields:
item = usecases.serialize_item_entity(item, project)
item = usecases.add_item_path(project, folder, item)
else:
item = usecases.serialize_item_entity(item, project, map_fields=False)
item.annotation_status = service_provider.get_annotation_status_name(
project, item.annotation_status
)
for assignment in item.assignments:
_role = "role" if "role" in assignment else "user_role"
user_id = "email" if "email" in assignment else "user_id"
role_name = service_provider.get_role_name(project, assignment[_role])
if role_name == "QA":
item.qa_email = assignment[user_id]
elif role_name == "Annotator":
item.annotator_email = assignment[user_id]
assignment["user_role"] = role_name
assignment.pop("role", None)
assignment.pop("email", None)
data.append(item)
return data
def list_items(
self,
project: ProjectEntity,
folder: FolderEntity,
/,
include: List[str] = None,
**filters: Unpack[ItemFilters],
) -> List[BaseItemEntity]:
entity = PROJECT_ITEM_ENTITY_MAP.get(project.type, BaseItemEntity)
chain = QueryBuilderChain(
[
FieldValidationHandler(ItemFilters.__annotations__.keys()),
ItemFilterHandler(
project=project,
service_provider=self.service_provider,
entity=entity,
),
IncludeHandler(include=include),
]
)
query = chain.handle(filters, EmptyQuery())
data = self.service_provider.item_service.list(project.id, folder.id, query)
return self.process_response(self.service_provider, data, project, folder)
def attach(
self,
project: ProjectEntity,
folder: FolderEntity,
attachments: List[AttachmentEntity],
annotation_status: str = None,
):
annotation_status_value = (
self.service_provider.get_annotation_status_value(
project, annotation_status
)
if annotation_status
else None
)
use_case = usecases.AttachItems(
reporter=Reporter(),
project=project,
folder=folder,
attachments=attachments,
annotation_status_value=annotation_status_value,
service_provider=self.service_provider,
)
return use_case.execute()
def delete(
self,
project: ProjectEntity,
folder: FolderEntity,
item_names: List[str] = None,
):
use_case = usecases.DeleteItemsUseCase(
project=project,
folder=folder,
item_names=item_names,
service_provider=self.service_provider,
)
return use_case.execute()
def copy_multiple(
self,
project: ProjectEntity,
from_folder: FolderEntity,
to_folder: FolderEntity,
duplicate_strategy: Literal["skip", "replace", "replace_annotations_only"],
item_names: List[str] = None,
include_annotations: bool = True,
):
if project.type == ProjectType.PIXEL:
use_case = usecases.CopyItems(
reporter=Reporter(),
project=project,
from_folder=from_folder,
to_folder=to_folder,
item_names=item_names,
service_provider=self.service_provider,
include_annotations=include_annotations,
)
else:
use_case = usecases.CopyMoveItems(
reporter=Reporter(),
project=project,
from_folder=from_folder,
to_folder=to_folder,
item_names=item_names,
service_provider=self.service_provider,
include_annotations=include_annotations,
duplicate_strategy=duplicate_strategy,
operation="copy",
chunk_size=500,
)
return use_case.execute()
def move_multiple(
self,
project: ProjectEntity,
from_folder: FolderEntity,
to_folder: FolderEntity,
duplicate_strategy: Literal["skip", "replace", "replace_annotations_only"],
item_names: List[str] = None,
):
if project.type == ProjectType.PIXEL:
use_case = usecases.MoveItems(
reporter=Reporter(),
project=project,
from_folder=from_folder,
to_folder=to_folder,
item_names=item_names,
service_provider=self.service_provider,
)
else:
use_case = usecases.CopyMoveItems(
reporter=Reporter(),
project=project,
from_folder=from_folder,
to_folder=to_folder,
item_names=item_names,
service_provider=self.service_provider,
duplicate_strategy=duplicate_strategy,
include_annotations=True,
operation="move",
chunk_size=500,
)
return use_case.execute()
def set_annotation_statuses(
self,
project: ProjectEntity,
folder: FolderEntity,
annotation_status: str,
item_names: List[str] = None,
):
use_case = usecases.SetAnnotationStatues(
Reporter(),
project=project,
folder=folder,
annotation_status=self.service_provider.get_annotation_status_value(
project, annotation_status
),
item_names=item_names,
service_provider=self.service_provider,
)
return use_case.execute()
def set_approval_statuses(
self,
project: ProjectEntity,
folder: FolderEntity,
approval_status: str,
item_names: List[str] = None,
):
use_case = usecases.SetApprovalStatues(
Reporter(),
project=project,
folder=folder,
approval_status=approval_status,
item_names=item_names,
service_provider=self.service_provider,
)
return use_case.execute()
def update(self, project: ProjectEntity, item: BaseItemEntity):
item.annotation_status = self.service_provider.get_annotation_status_value(
project, item.annotation_status
)
use_case = usecases.UpdateItemUseCase(
project=project, service_provider=self.service_provider, item=item
)
return use_case.execute()
class AnnotationManager(BaseManager):
def __init__(self, service_provider: ServiceProvider, config: ConfigEntity):
super().__init__(service_provider)
self._config = config
def set_item_annotations(
self,
project: ProjectEntity,
folder: FolderEntity,
item_id: int,
data: dict,
overwrite: bool,
transform_version: str = "llmJsonV2",
etag: str = None,
):
response = self.service_provider.annotations.set_item_annotations(
project, folder, item_id, data, overwrite, transform_version, etag
)
if not response.ok:
if response.status_code == 412 and any(
True for i in response.error if i["code"] == "PRECONDITION_FAILED"
):
raise FileChangedError(
"The file has changed and overwrite is set to False."
)
response.raise_for_status()
return response.data
def get_item_annotations(
self,
project: ProjectEntity,
folder: FolderEntity,
item_id: int,
transform_version: str = "llmJsonV2",
):
response = self.service_provider.annotations.get_item_annotations(
project, folder, item_id, transform_version
)
if not response.ok:
if response.status_code == 404:
return None
response.raise_for_status()
return response
def list(
self,
project: ProjectEntity,
folder: FolderEntity = None,
items: Union[List[str], List[int]] = None,
verbose=True,
transform_version: str = None,
):
use_case = usecases.GetAnnotations(
config=self._config,
reporter=Reporter(log_info=verbose, log_warning=verbose),
project=project,
folder=folder,
items=items,
service_provider=self.service_provider,
transform_version=transform_version,
)
return use_case.execute()
def download(
self,
project: ProjectEntity,
folder: FolderEntity,
destination: str,
recursive: bool,
item_names: Optional[List[str]],
callback: Optional[Callable],
):
use_case = usecases.DownloadAnnotations(
config=self._config,
reporter=Reporter(),
project=project,
folder=folder,
destination=destination,
recursive=recursive,
item_names=item_names,
service_provider=self.service_provider,
callback=callback,
)
return use_case.execute()
def download_image_annotations(
self,
project: ProjectEntity,
folder: FolderEntity,
image_name: str,
destination: str,
):
use_case = usecases.DownloadImageAnnotationsUseCase(
project=project,
folder=folder,
image_name=image_name,
service_provider=self.service_provider,
destination=destination,
)
return use_case.execute()
def delete(
self,
project: ProjectEntity,
folder: FolderEntity,
item_names: Optional[List[str]] = None,
):
use_case = usecases.DeleteAnnotations(
project=project,
folder=folder,
service_provider=self.service_provider,
image_names=item_names,
)
return use_case.execute()
def upload_multiple(
self,
project: ProjectEntity,
folder: FolderEntity,
annotations: List[dict],
keep_status: bool,
user: UserEntity,
output_format: str = None,
):
if project.type == ProjectType.MULTIMODAL and output_format == "multimodal":
use_case = usecases.UploadMultiModalAnnotationsUseCase(
reporter=Reporter(),
project=project,
root_folder=folder,
annotations=annotations,
service_provider=self.service_provider,
keep_status=keep_status,
user=user,
transform_version="llmJsonV2",
)
else:
use_case = usecases.UploadAnnotationsUseCase(