Skip to content

FunctionalTableTransformer

Bases: TableTransformer

Wraps a callable so that it conforms to the TableTransformer interface.

Parameters:

Name Type Description Default
transformer Callable[[Table], Table]

A callable that receives a table and returns a table.

 required

Methods:

Name Description
fit

Note: For FunctionalTableTransformer this is a no-OP.
fit_and_transform

Note: For the FunctionalTableTransformer this is the same as transform().
transform

Apply the callable to a table.

Attributes:

Name Type Description
is_fitted bool

FunctionalTableTransformer is always considered to be fitted.
Source code in src/safeds/data/tabular/transformation/_functional_table_transformer.py 
 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
 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
111
112
class FunctionalTableTransformer(TableTransformer):
    """
    Wraps a callable so that it conforms to the TableTransformer interface.

    Parameters
    ----------
    transformer:
        A callable that receives a table and returns a table.
    """

    # ------------------------------------------------------------------------------------------------------------------
    # Dunder methods
    # ------------------------------------------------------------------------------------------------------------------

    def __init__(
        self,
        transformer: Callable[[Table], Table],
    ) -> None:
        super().__init__(None)
        self._transformer = transformer

    def __hash__(self) -> int:
        return _structural_hash(
            super().__hash__(),
            self._transformer,
        )

    # ------------------------------------------------------------------------------------------------------------------
    # Properties
    # ------------------------------------------------------------------------------------------------------------------

    @property
    def is_fitted(self) -> bool:
        """FunctionalTableTransformer is always considered to be fitted."""
        return True

    # ------------------------------------------------------------------------------------------------------------------
    # Learning and transformation
    # ------------------------------------------------------------------------------------------------------------------

    def fit(self, table: Table) -> FunctionalTableTransformer:  # noqa: ARG002
        """
        **Note:** For FunctionalTableTransformer this is a no-OP.

        Parameters
        ----------
        table:
            Required only to be consistent with other transformers.

        Returns
        -------
        fitted_transformer:
            Returns self, because this transformer is always fitted.
        """
        return self

    def transform(self, table: Table) -> Table:
        """
        Apply the callable to a table.

        **Note:** The given table is not modified.

        Parameters
        ----------
        table:
            The table on which the callable is executed.

        Returns
        -------
        transformed_table:
            The transformed table.

        Raises
        ------
        Exception:
            Raised when the wrapped callable encounters an error.
        """
        return self._transformer(table)

    def fit_and_transform(self, table: Table) -> tuple[FunctionalTableTransformer, Table]:
        """
        **Note:** For the FunctionalTableTransformer this is the same as transform().

        Parameters
        ----------
        table:
            The table on which the callable is to be executed.

        Returns
        -------
        fitted_transformer:
            Return self because the transformer is always fitted.
        transformed_table:
            The transformed table.
        """
        fitted_transformer = self
        transformed_table = self.transform(table)
        return fitted_transformer, transformed_table

is_fitted

FunctionalTableTransformer is always considered to be fitted.

fit

Note: For FunctionalTableTransformer this is a no-OP.

Parameters:

Name Type Description Default
table Table

Required only to be consistent with other transformers.

 required

Returns:

Name Type Description
fitted_transformer FunctionalTableTransformer

Returns self, because this transformer is always fitted.
Source code in src/safeds/data/tabular/transformation/_functional_table_transformer.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def fit(self, table: Table) -> FunctionalTableTransformer:  # noqa: ARG002
    """
    **Note:** For FunctionalTableTransformer this is a no-OP.

    Parameters
    ----------
    table:
        Required only to be consistent with other transformers.

    Returns
    -------
    fitted_transformer:
        Returns self, because this transformer is always fitted.
    """
    return self

fit_and_transform

Note: For the FunctionalTableTransformer this is the same as transform().

Parameters:

Name Type Description Default
table Table

The table on which the callable is to be executed.

 required

Returns:

Name Type Description
fitted_transformer FunctionalTableTransformer

Return self because the transformer is always fitted.
transformed_table Table

The transformed table.
Source code in src/safeds/data/tabular/transformation/_functional_table_transformer.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
def fit_and_transform(self, table: Table) -> tuple[FunctionalTableTransformer, Table]:
    """
    **Note:** For the FunctionalTableTransformer this is the same as transform().

    Parameters
    ----------
    table:
        The table on which the callable is to be executed.

    Returns
    -------
    fitted_transformer:
        Return self because the transformer is always fitted.
    transformed_table:
        The transformed table.
    """
    fitted_transformer = self
    transformed_table = self.transform(table)
    return fitted_transformer, transformed_table

transform

Apply the callable to a table.

Note: The given table is not modified.

Parameters:

Name Type Description Default
table Table

The table on which the callable is executed.

 required

Returns:

Name Type Description
transformed_table Table

The transformed table.

Raises:

Type Description
Exception:

Raised when the wrapped callable encounters an error.
Source code in src/safeds/data/tabular/transformation/_functional_table_transformer.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def transform(self, table: Table) -> Table:
    """
    Apply the callable to a table.

    **Note:** The given table is not modified.

    Parameters
    ----------
    table:
        The table on which the callable is executed.

    Returns
    -------
    transformed_table:
        The transformed table.

    Raises
    ------
    Exception:
        Raised when the wrapped callable encounters an error.
    """
    return self._transformer(table)