Skip to content

CRUD

create_function(**kwargs)

Create a new object instance.

Parameters:

Name Type Description Default
**kwargs dict

Keyword arguments.

 {}

Returns:

Type Description
Function

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

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

    Returns
    -------
    Function
        Object instance.
    """
    return function_from_parameters(**kwargs)

create_function_from_dict(obj)

Create a new Function instance from a dictionary.

Parameters:

Name Type Description Default
obj dict

Dictionary to create the Function from.

 required

Returns:

Type Description
Function

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

    Parameters
    ----------
    obj : dict
        Dictionary to create the Function from.

    Returns
    -------
    Function
        Function object.
    """
    check_context(obj.get("project"))
    return function_from_dict(obj)

delete_function(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/functions/crud.py 
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
def delete_function(
    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.
    """
    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_function(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
Function

Object instance.
Source code in digitalhub_core/entities/functions/crud.py 
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
def get_function(
    identifier: str,
    project: str | None = None,
    entity_id: str | None = None,
    **kwargs,
) -> Function:
    """
    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
    -------
    Function
        Object instance.
    """
    obj = read_entity_api_ctx(
        identifier,
        ENTITY_TYPE,
        project=project,
        entity_id=entity_id,
        **kwargs,
    )
    return function_from_dict(obj)

get_function_versions(identifier, project=None, **kwargs)

Get object versions from backend.

Parameters:

Name Type Description Default
identifier str

Entity key or name.

 required
project str

Project name.

 None
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
list[Function]

List of object instances.
Source code in digitalhub_core/entities/functions/crud.py 
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
def get_function_versions(
    identifier: str,
    project: str | None = None,
    **kwargs,
) -> list[Function]:
    """
    Get object versions from backend.

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

    Returns
    -------
    list[Function]
        List of object instances.
    """
    obj = read_entity_api_ctx_versions(
        identifier,
        entity_type=ENTITY_TYPE,
        project=project,
        **kwargs,
    )
    return [function_from_dict(o) for o in obj]

import_function(file)

Get object from file.

Parameters:

Name Type Description Default
file str

Path to the file.

 required

Returns:

Type Description
Function

Object instance.
Source code in digitalhub_core/entities/functions/crud.py 
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
def import_function(file: str) -> Function:
    """
    Get object from file.

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

    Returns
    -------
    Function
        Object instance.
    """
    obj = read_yaml(file)
    if isinstance(obj, list):
        func_dict = obj[0]
        task_dicts = obj[1:]
    else:
        func_dict = obj
        task_dicts = []
    check_context(func_dict.get("project"))
    func = create_function_from_dict(func_dict)
    func.import_tasks(task_dicts)
    return func

list_functions(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[Function]

List of functions.
Source code in digitalhub_core/entities/functions/crud.py 
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
def list_functions(project: str, **kwargs) -> list[Function]:
    """
    List all objects from backend.

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

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

new_function(project, name, kind, uuid=None, description=None, git_source=None, labels=None, embedded=True, **kwargs)

Create a Function instance with the given parameters.

Parameters:

Name Type Description Default
project str

Project name.

 required
name str

Object name.

 required
kind str

Kind the object.

 required
uuid str

ID of the object (UUID4).

 None
description str

Description of the object (human readable).

 None
git_source str

Remote git source for object.

 None
labels list[str]

List of labels.

 None
embedded bool

Flag to determine if object must be embedded in project.

 True
**kwargs dict

Spec keyword arguments.

 {}

Returns:

Type Description
Function

Object instance.
Source code in digitalhub_core/entities/functions/crud.py 
 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
def new_function(
    project: str,
    name: str,
    kind: str,
    uuid: str | None = None,
    description: str | None = None,
    git_source: str | None = None,
    labels: list[str] | None = None,
    embedded: bool = True,
    **kwargs,
) -> Function:
    """
    Create a Function instance with the given parameters.

    Parameters
    ----------
    project : str
        Project name.
    name : str
        Object name.
    kind : str
        Kind the object.
    uuid : str
        ID of the object (UUID4).
    description : str
        Description of the object (human readable).
    git_source : str
        Remote git source for object.
    labels : list[str]
        List of labels.
    embedded : bool
        Flag to determine if object must be embedded in project.
    **kwargs : dict
        Spec keyword arguments.

    Returns
    -------
    Function
        Object instance.
    """
    obj = create_function(
        project=project,
        name=name,
        kind=kind,
        uuid=uuid,
        description=description,
        git_source=git_source,
        labels=labels,
        embedded=embedded,
        **kwargs,
    )
    obj.save()
    return obj

update_function(entity, **kwargs)

Update object in backend.

Parameters:

Name Type Description Default
entity Function

The object to update.

 required
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
Function

Entity updated.
Source code in digitalhub_core/entities/functions/crud.py 
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
def update_function(entity: Function, **kwargs) -> Function:
    """
    Update object in backend.

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

    Returns
    -------
    Function
        Entity updated.
    """
    obj = update_entity_api_ctx(
        project=entity.project,
        entity_type=ENTITY_TYPE,
        entity_id=entity.id,
        entity_dict=entity.to_dict(),
        **kwargs,
    )
    return function_from_dict(obj)