Skip to content

Status

DataitemStatus

Bases: Status

Status class for dataitem entities.

Source code in digitalhub_data/entities/dataitems/status.py 
 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
class DataitemStatus(Status):
    """
    Status class for dataitem entities.
    """

    def __init__(
        self,
        state: str,
        message: str | None = None,
        files: list[dict] | None = None,
        preview: dict | None = None,
        **kwargs,
    ) -> None:
        """
        Constructor.

        Parameters
        ----------
        preview : dict
            Preview of the data.
        """
        super().__init__(state, message)
        self.files = files
        self.preview = preview

    def add_file(self, file: dict) -> None:
        """
        Add a file to the status.

        Parameters
        ----------
        file : dict
            File to add.

        Returns
        -------
        None
        """

        # Add the file to the list
        if self.files is None:
            self.files = []

        # Remove the file info if it already exists
        self.files = [f for f in self.files if f["path"] != file["path"]]

        # Add the new file
        self.files.append(file)

__init__(state, message=None, files=None, preview=None, **kwargs)

Constructor.

Parameters:

Name Type Description Default
preview dict

Preview of the data.

 None
Source code in digitalhub_data/entities/dataitems/status.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def __init__(
    self,
    state: str,
    message: str | None = None,
    files: list[dict] | None = None,
    preview: dict | None = None,
    **kwargs,
) -> None:
    """
    Constructor.

    Parameters
    ----------
    preview : dict
        Preview of the data.
    """
    super().__init__(state, message)
    self.files = files
    self.preview = preview

add_file(file)

Add a file to the status.

Parameters:

Name Type Description Default
file dict

File to add.

 required

Returns:

Type Description
None
Source code in digitalhub_data/entities/dataitems/status.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def add_file(self, file: dict) -> None:
    """
    Add a file to the status.

    Parameters
    ----------
    file : dict
        File to add.

    Returns
    -------
    None
    """

    # Add the file to the list
    if self.files is None:
        self.files = []

    # Remove the file info if it already exists
    self.files = [f for f in self.files if f["path"] != file["path"]]

    # Add the new file
    self.files.append(file)

DataitemStatusDataitem

Bases: DataitemStatus

Status class for dataitem dataitem entities.

Source code in digitalhub_data/entities/dataitems/status.py 
56
57
58
59
class DataitemStatusDataitem(DataitemStatus):
    """
    Status class for dataitem dataitem entities.
    """

DataitemStatusIceberg

Bases: DataitemStatus

Status class for dataitem iceberg entities.

Source code in digitalhub_data/entities/dataitems/status.py 
68
69
70
71
class DataitemStatusIceberg(DataitemStatus):
    """
    Status class for dataitem iceberg entities.
    """

DataitemStatusTable

Bases: DataitemStatus

Status class for dataitem table entities.

Source code in digitalhub_data/entities/dataitems/status.py 
62
63
64
65
class DataitemStatusTable(DataitemStatus):
    """
    Status class for dataitem table entities.
    """