Skip to content

TableWithDescriptions

A Table with descriptions for its columns.

Parameters:

Name Type Description Default
table Table

The table.

 required
column_descriptions dict[str, str]

A dictionary mapping column names to their descriptions.

 required

Raises:

Type Description
ColumnNotFoundError

If a column name in descriptions does not exist in table.
Source code in src/safeds_datasets/tabular/containers/_table_with_descriptions.py 
 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
class TableWithDescriptions:
    """
    A `Table` with descriptions for its columns.

    Parameters
    ----------
    table:
        The table.
    column_descriptions:
        A dictionary mapping column names to their descriptions.

    Raises
    ------
    ColumnNotFoundError
        If a column name in `descriptions` does not exist in `table`.
    """

    def __init__(self, table: Table, column_descriptions: dict[str, str]) -> None:
        # Check that all column names in `descriptions` exist in `table`
        _check_columns_exist(table, list(column_descriptions.keys()))

        self._data = table
        self._descriptions = column_descriptions

    @property
    def data(self) -> Table:
        """The data."""
        return self._data

    @property
    def column_descriptions(self) -> Table:
        """
        Return a `Table` contain the name of a column and its description.

        The name is stored in a column called `"Name"` and the description in a column called `"Description"`.
        """
        return Table(
            {
                "Name": self._data.column_names,
                "Description": [self.get_column_description(column_name) for column_name in self._data.column_names],
            },
        )

    def get_column_description(self, column_name: str) -> str:
        """
        Get the description of a column. If no description exists, an empty string is returned.

        Parameters
        ----------
        column_name:
            The name of the column.

        Returns
        -------
        column_description:
            The description of the column.

        Raises
        ------
        ColumnNotFoundError
            If no column with the given name exists.
        """
        _check_columns_exist(self._data, [column_name])

        return self._descriptions.get(column_name, "")

column_descriptions: Table property

Return a Table contain the name of a column and its description.

The name is stored in a column called "Name" and the description in a column called "Description".

data: Table property

The data.

__init__(table, column_descriptions)

Source code in src/safeds_datasets/tabular/containers/_table_with_descriptions.py 
22
23
24
25
26
27
def __init__(self, table: Table, column_descriptions: dict[str, str]) -> None:
    # Check that all column names in `descriptions` exist in `table`
    _check_columns_exist(table, list(column_descriptions.keys()))

    self._data = table
    self._descriptions = column_descriptions

get_column_description(column_name)

Get the description of a column. If no description exists, an empty string is returned.

Parameters:

Name Type Description Default
column_name str

The name of the column.

 required

Returns:

Name Type Description
column_description str

The description of the column.

Raises:

Type Description
ColumnNotFoundError

If no column with the given name exists.
Source code in src/safeds_datasets/tabular/containers/_table_with_descriptions.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def get_column_description(self, column_name: str) -> str:
    """
    Get the description of a column. If no description exists, an empty string is returned.

    Parameters
    ----------
    column_name:
        The name of the column.

    Returns
    -------
    column_description:
        The description of the column.

    Raises
    ------
    ColumnNotFoundError
        If no column with the given name exists.
    """
    _check_columns_exist(self._data, [column_name])

    return self._descriptions.get(column_name, "")