Skip to content

CRUD

create_run(**kwargs)

Create a new object instance.

Parameters:

Name Type Description Default
**kwargs dict

Keyword arguments.

 {}

Returns:

Type Description
Run

Object instance.
Source code in digitalhub_core/entities/runs/crud.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def create_run(**kwargs) -> Run:
    """
    Create a new object instance.

    Parameters
    ----------
    **kwargs : dict
        Keyword arguments.

    Returns
    -------
    Run
        Object instance.
    """
    return run_from_parameters(**kwargs)

create_run_from_dict(obj)

Create a new Run instance from a dictionary.

Parameters:

Name Type Description Default
obj dict

Dictionary to create object from.

 required

Returns:

Type Description
Run

Run object.
Source code in digitalhub_core/entities/runs/crud.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def create_run_from_dict(obj: dict) -> Run:
    """
    Create a new Run instance from a dictionary.

    Parameters
    ----------
    obj : dict
        Dictionary to create object from.

    Returns
    -------
    Run
        Run object.
    """
    check_context(obj.get("project"))
    return run_from_dict(obj)

delete_run(identifier, project=None, entity_id=None, delete_all_versions=False, cascade=True, **kwargs)

Delete object from backend.

Parameters:

Name Type Description Default
identifier str

Entity key or name.

 required
project str

Project name.

 None
entity_id str

Entity ID.

 None
delete_all_versions bool

Delete all versions of the named entity. Use entity name instead of entity key as identifier.

 False
cascade bool

Cascade delete.

 True
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
dict

Response from backend.
Source code in digitalhub_core/entities/runs/crud.py 
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
def delete_run(
    identifier: str,
    project: str | None = None,
    entity_id: str | None = None,
    delete_all_versions: bool = False,
    cascade: bool = True,
    **kwargs,
) -> dict:
    """
    Delete object from backend.

    Parameters
    ----------
    identifier : str
        Entity key or name.
    project : str
        Project name.
    entity_id : str
        Entity ID.
    delete_all_versions : bool
        Delete all versions of the named entity.
        Use entity name instead of entity key as identifier.
    cascade : bool
        Cascade delete.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    dict
        Response from backend.
    """
    if not identifier.startswith("store://"):
        raise EntityError("Run has no name. Use key instead.")
    return delete_entity_api_ctx(
        identifier=identifier,
        entity_type=ENTITY_TYPE,
        project=project,
        entity_id=entity_id,
        delete_all_versions=delete_all_versions,
        cascade=cascade,
        **kwargs,
    )

get_run(identifier, project=None, entity_id=None, **kwargs)

Get object from backend.

Parameters:

Name Type Description Default
identifier str

Entity key or name.

 required
project str

Project name.

 None
entity_id str

Entity ID.

 None
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
Run

Object instance.
Source code in digitalhub_core/entities/runs/crud.py 
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
def get_run(
    identifier: str,
    project: str | None = None,
    entity_id: str | None = None,
    **kwargs,
) -> Run:
    """
    Get object from backend.

    Parameters
    ----------
    identifier : str
        Entity key or name.
    project : str
        Project name.
    entity_id : str
        Entity ID.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    Run
        Object instance.
    """
    if not identifier.startswith("store://"):
        raise EntityError("Run has no name. Use key instead.")
    obj = read_entity_api_ctx(
        identifier,
        ENTITY_TYPE,
        project=project,
        entity_id=entity_id,
        **kwargs,
    )
    return run_from_dict(obj)

import_run(file)

Get object from file.

Parameters:

Name Type Description Default
file str

Path to the file.

 required

Returns:

Type Description
Run

Object instance.
Source code in digitalhub_core/entities/runs/crud.py 
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
def import_run(file: str) -> Run:
    """
    Get object from file.

    Parameters
    ----------
    file : str
        Path to the file.

    Returns
    -------
    Run
        Object instance.
    """
    obj: dict = read_yaml(file)
    return create_run_from_dict(obj)

list_runs(project, **kwargs)

List all objects from backend.

Parameters:

Name Type Description Default
project str

Project name.

 required
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
list[Run]

List of runs.
Source code in digitalhub_core/entities/runs/crud.py 
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
def list_runs(project: str, **kwargs) -> list[Run]:
    """
    List all objects from backend.

    Parameters
    ----------
    project : str
        Project name.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    list[Run]
        List of runs.
    """
    objs = list_entity_api_ctx(
        project=project,
        entity_type=ENTITY_TYPE,
        **kwargs,
    )
    return [run_from_dict(obj) for obj in objs]

new_run(project, task, kind, uuid=None, git_source=None, labels=None, local_execution=False, **kwargs)

Create run.

Parameters:

Name Type Description Default
project str

Project name.

 required
task str

Name of the task associated with the run.

 required
kind str

Kind the object.

 required
uuid str

ID of the object (UUID4).

 None
git_source str

Remote git source for object.

 None
labels list[str]

List of labels.

 None
local_execution bool

Flag to determine if object has local execution.

 False
**kwargs dict

Spec keyword arguments.

 {}

Returns:

Type Description
Run

Run object.
Source code in digitalhub_core/entities/runs/crud.py 
 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
def new_run(
    project: str,
    task: str,
    kind: str,
    uuid: str | None = None,
    git_source: str | None = None,
    labels: list[str] | None = None,
    local_execution: bool = False,
    **kwargs,
) -> Run:
    """
    Create run.

    Parameters
    ----------
    project : str
        Project name.
    task : str
        Name of the task associated with the run.
    kind : str
        Kind the object.
    uuid : str
        ID of the object (UUID4).
    git_source : str
        Remote git source for object.
    labels : list[str]
        List of labels.
    local_execution : bool
        Flag to determine if object has local execution.
    **kwargs : dict
        Spec keyword arguments.

    Returns
    -------
    Run
        Run object.
    """
    obj = create_run(
        project=project,
        task=task,
        kind=kind,
        uuid=uuid,
        git_source=git_source,
        labels=labels,
        local_execution=local_execution,
        **kwargs,
    )
    obj.save()
    return obj

update_run(entity, **kwargs)

Update object in backend.

Parameters:

Name Type Description Default
entity Run

The object to update.

 required
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
Run

Entity updated.
Source code in digitalhub_core/entities/runs/crud.py 
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
def update_run(entity: Run, **kwargs) -> Run:
    """
    Update object in backend.

    Parameters
    ----------
    entity : Run
        The object to update.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    Run
        Entity updated.
    """
    obj = update_entity_api_ctx(
        project=entity.project,
        entity_type=ENTITY_TYPE,
        entity_id=entity.id,
        entity_dict=entity.to_dict(include_all_non_private=True),
        **kwargs,
    )
    return run_from_dict(obj)