Skip to content

onconova.research.controllers.dataset

DatasetsController

Bases: ControllerBase

create_dataset(payload)

Source code in onconova/research/controllers/dataset.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
@route.post(
    path="",
    response={201: ModifiedResourceSchema, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageDatasets],
    operation_id="createDataset",
)
def create_dataset(self, payload: scm.DatasetCreate):
    # Check that requesting user is a member of the project
    project = get_object_or_404(orm.Project, id=payload.projectId)  
    if (
        not project.is_member(self.context.request.user)  # type: ignore
        and self.context.request.user.access_level < 3  # type: ignore
    ):
        raise HttpError(403, "User is not a member of the project")
    return 201, payload.model_dump_django()

delete_dataset(datasetId)

Source code in onconova/research/controllers/dataset.py 
60
61
62
63
64
65
66
67
68
@route.delete(
    path="/{datasetId}",
    response={204: None, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanDeleteDatasets],
    operation_id="deleteDatasetById",
)
def delete_dataset(self, datasetId: str):
    get_object_or_404(orm.Dataset, id=datasetId).delete()
    return 204, None

get_all_dataset_history_events(datasetId)

Source code in onconova/research/controllers/dataset.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
@route.get(
    path="/{datasetId}/history/events",
    response={
        200: Paginated[HistoryEvent.bind_schema(scm.DatasetCreate)],
        404: None,
        **COMMON_HTTP_ERRORS,
    },
    permissions=[perms.CanViewCases],
    operation_id="getAllDatasetHistoryEvents",
)
@paginate()
@ordering()
def get_all_dataset_history_events(self, datasetId: str):
    instance = get_object_or_404(orm.Dataset, id=datasetId)
    return pghistory.models.Events.objects.tracks(instance).all()  # type: ignore

get_all_datasets_matching_the_query(query)

Source code in onconova/research/controllers/dataset.py 
23
24
25
26
27
28
29
30
31
32
33
@route.get(
    path="",
    response={200: Paginated[scm.Dataset], **COMMON_HTTP_ERRORS},
    permissions=[perms.CanViewDatasets],
    operation_id="getDatasets",
)
@paginate()
@ordering()
def get_all_datasets_matching_the_query(self, query: Query[scm.DatasetFilters]):  # type: ignore
    queryset = orm.Dataset.objects.all().order_by("-created_at")
    return query.filter(queryset)  # type: ignore

get_dataset_by_id(datasetId)

Source code in onconova/research/controllers/dataset.py 
51
52
53
54
55
56
57
58
@route.get(
    path="/{datasetId}",
    response={200: scm.Dataset, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanViewDatasets],
    operation_id="getDatasetById",
)
def get_dataset_by_id(self, datasetId: str):
    return get_object_or_404(orm.Dataset, id=datasetId)

get_dataset_history_event_by_id(datasetId, eventId)

Source code in onconova/research/controllers/dataset.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
@route.get(
    path="/{datasetId}/history/events/{eventId}",
    response={
        200: HistoryEvent.bind_schema(scm.DatasetCreate),
        404: None,
        **COMMON_HTTP_ERRORS,
    },
    permissions=[perms.CanViewCases],
    operation_id="getDatasetHistoryEventById",
)
def get_dataset_history_event_by_id(self, datasetId: str, eventId: str):
    instance = get_object_or_404(orm.Dataset, id=datasetId)
    return get_object_or_404(
        pghistory.models.Events.objects.tracks(instance), pgh_id=eventId  # type: ignore
    )

revert_dataset_to_history_event(datasetId, eventId)

Source code in onconova/research/controllers/dataset.py 
113
114
115
116
117
118
119
120
121
@route.put(
    path="/{datasetId}/history/events/{eventId}/reversion",
    response={201: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="revertDatasetToHistoryEvent",
)
def revert_dataset_to_history_event(self, datasetId: str, eventId: str):
    instance = get_object_or_404(orm.Dataset, id=datasetId)
    return 201, get_object_or_404(instance.events, pgh_id=eventId).revert()

update_dataset(datasetId, payload)

Source code in onconova/research/controllers/dataset.py 
70
71
72
73
74
75
76
77
78
79
@route.put(
    path="/{datasetId}",
    response={200: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageDatasets],
    operation_id="updateDataset",
)
def update_dataset(self, datasetId: str, payload: scm.DatasetCreate):  # type: ignore
    return payload.model_dump_django(
        instance=self.get_object_or_exception(orm.Dataset, id=datasetId)
    )
runner