kumoai 2.13.0.dev202511211730__py3-none-any.whl → 2.15.0.dev202601131732__py3-none-any.whl

kumoai/experimental/rfm/base/table.py

@@ -0,0 +1,722 @@
+from abc import ABC, abstractmethod
+from collections.abc import Sequence
+from functools import cached_property
+
+import numpy as np
+import pandas as pd
+from kumoapi.model_plan import MissingType
+from kumoapi.source_table import UnavailableSourceTable
+from kumoapi.table import Column as ColumnDefinition
+from kumoapi.table import TableDefinition
+from kumoapi.typing import Dtype, Stype
+from typing_extensions import Self
+
+from kumoai.experimental.rfm.base import (
+    Column,
+    ColumnSpec,
+    ColumnSpecType,
+    DataBackend,
+    SourceColumn,
+    SourceForeignKey,
+)
+from kumoai.experimental.rfm.base.utils import to_datetime
+from kumoai.experimental.rfm.infer import (
+    infer_dtype,
+    infer_primary_key,
+    infer_stype,
+    infer_time_column,
+)
+from kumoai.utils import display, quote_ident
+
+
+class Table(ABC):
+    r"""A :class:`Table` fully specifies the relevant metadata of a single
+    table, *i.e.* its selected columns, data types, semantic types, primary
+    keys and time columns.
+
+    Args:
+        name: The name of this table.
+        source_name: The source name of this table. If set to ``None``,
+            ``name`` is being used.
+        columns: The selected columns of this table.
+        primary_key: The name of the primary key of this table, if it exists.
+        time_column: The name of the time column of this table, if it exists.
+        end_time_column: The name of the end time column of this table, if it
+            exists.
+    """
+    _NUM_SAMPLE_ROWS = 1_000
+
+    def __init__(
+        self,
+        name: str,
+        source_name: str | None = None,
+        columns: Sequence[ColumnSpecType] | None = None,
+        primary_key: MissingType | str | None = MissingType.VALUE,
+        time_column: str | None = None,
+        end_time_column: str | None = None,
+    ) -> None:
+
+        self._name = name
+        self._source_name = source_name or name
+        self._column_dict: dict[str, Column] = {}
+        self._primary_key: str | None = None
+        self._time_column: str | None = None
+        self._end_time_column: str | None = None
+        self._expr_sample_df = pd.DataFrame(index=range(self._NUM_SAMPLE_ROWS))
+
+        if columns is None:
+            columns = list(self._source_column_dict.keys())
+
+        self.add_columns(columns)
+
+        if isinstance(primary_key, MissingType):
+            # Infer primary key from source metadata, but only set it in case
+            # it is already part of the column set (don't magically add it):
+            if any(column.is_source for column in self.columns):
+                primary_key = self._source_primary_key
+                if (primary_key is not None and primary_key in self
+                        and self[primary_key].is_source):
+                    self.primary_key = primary_key
+        elif primary_key is not None:
+            if primary_key not in self:
+                self.add_column(primary_key)
+            self.primary_key = primary_key
+
+        if time_column is not None:
+            if time_column not in self:
+                self.add_column(time_column)
+            self.time_column = time_column
+
+        if end_time_column is not None:
+            if end_time_column not in self:
+                self.add_column(end_time_column)
+            self.end_time_column = end_time_column
+
+    @property
+    def name(self) -> str:
+        r"""The name of this table."""
+        return self._name
+
+    @property
+    def source_name(self) -> str:
+        r"""The source name of this table."""
+        return self._source_name
+
+    @property
+    def _quoted_source_name(self) -> str:
+        return quote_ident(self._source_name)
+
+    # Column ##################################################################
+
+    def has_column(self, name: str) -> bool:
+        r"""Returns ``True`` if this table holds a column with name ``name``;
+        ``False`` otherwise.
+        """
+        return name in self._column_dict
+
+    def column(self, name: str) -> Column:
+        r"""Returns the data column named with name ``name`` in this table.
+
+        Args:
+            name: The name of the column.
+
+        Raises:
+            KeyError: If ``name`` is not present in this table.
+        """
+        if not self.has_column(name):
+            raise KeyError(f"Column '{name}' not found in table '{self.name}'")
+        return self._column_dict[name]
+
+    @property
+    def columns(self) -> list[Column]:
+        r"""Returns a list of :class:`Column` objects that represent the
+        columns in this table.
+        """
+        return list(self._column_dict.values())
+
+    def add_columns(self, columns: Sequence[ColumnSpecType]) -> None:
+        r"""Adds a set of columns to this table.
+
+        Args:
+            columns: The columns to add.
+
+        Raises:
+            KeyError: If any of the column names already exist in this table.
+        """
+        if len(columns) == 0:
+            return
+
+        column_specs = [ColumnSpec.coerce(column) for column in columns]
+
+        # Obtain a batch-wise sample for all column expressions:
+        expr_specs = [spec for spec in column_specs if not spec.is_source]
+        if len(expr_specs) > 0:
+            dfs = [
+                self._expr_sample_df,
+                self._get_expr_sample_df(expr_specs).reset_index(drop=True),
+            ]
+            size = min(map(len, dfs))
+            df = pd.concat([dfs[0].iloc[:size], dfs[1].iloc[:size]], axis=1)
+            df = df.loc[:, ~df.columns.duplicated(keep='last')]
+            self._expr_sample_df = df
+
+        for column_spec in column_specs:
+            if column_spec.name in self:
+                raise KeyError(f"Column '{column_spec.name}' already exists "
+                               f"in table '{self.name}'")
+
+            dtype = column_spec.dtype
+            stype = column_spec.stype
+
+            if column_spec.is_source:
+                if column_spec.name not in self._source_column_dict:
+                    raise ValueError(
+                        f"Column '{column_spec.name}' does not exist in the "
+                        f"underlying source table")
+
+                if dtype is None:
+                    dtype = self._source_column_dict[column_spec.name].dtype
+
+                if dtype == Dtype.unsupported:
+                    raise ValueError(
+                        f"Encountered unsupported data type for column "
+                        f"'{column_spec.name}' in table '{self.name}'. Please "
+                        f"either change the column's data type or remove the "
+                        f"column from this table.")
+
+            if dtype is None:
+                if column_spec.is_source:
+                    ser = self._source_sample_df[column_spec.name]
+                else:
+                    ser = self._expr_sample_df[column_spec.name]
+                try:
+                    dtype = infer_dtype(ser)
+                except Exception as e:
+                    raise RuntimeError(
+                        f"Encountered unsupported data type '{ser.dtype}' for "
+                        f"column '{column_spec.name}' in table '{self.name}'. "
+                        f"Please either manually override the columns's data "
+                        f"type or remove the column from this table.") from e
+
+            if stype is None:
+                if column_spec.is_source:
+                    ser = self._source_sample_df[column_spec.name]
+                else:
+                    ser = self._expr_sample_df[column_spec.name]
+                try:
+                    stype = infer_stype(ser, column_spec.name, dtype)
+                except Exception as e:
+                    raise RuntimeError(
+                        f"Could not determine semantic type for column "
+                        f"'{column_spec.name}' with data type '{dtype}' in "
+                        f"table '{self.name}'. Please either change the "
+                        f"column's data type or remove the column from this "
+                        f"table.") from e
+
+            self._column_dict[column_spec.name] = Column(
+                name=column_spec.name,
+                expr=column_spec.expr,
+                dtype=dtype,
+                stype=stype,
+            )
+
+    def add_column(self, column: ColumnSpecType) -> Column:
+        r"""Adds a column to this table.
+
+        Args:
+            column: The column to add.
+
+        Raises:
+            KeyError: If the column name already exists in this table.
+        """
+        column_spec = ColumnSpec.coerce(column)
+        self.add_columns([column_spec])
+        return self[column_spec.name]
+
+    def remove_column(self, name: str) -> Self:
+        r"""Removes a column from this table.
+
+        Args:
+            name: The name of the column.
+
+        Raises:
+            KeyError: If ``name`` is not present in this table.
+        """
+        if name not in self:
+            raise KeyError(f"Column '{name}' not found in table '{self.name}'")
+
+        if self._primary_key == name:
+            self.primary_key = None
+        if self._time_column == name:
+            self.time_column = None
+        if self._end_time_column == name:
+            self.end_time_column = None
+        del self._column_dict[name]
+
+        return self
+
+    # Primary key #############################################################
+
+    def has_primary_key(self) -> bool:
+        r"""Returns ``True``` if this table has a primary key; ``False``
+        otherwise.
+        """
+        return self._primary_key is not None
+
+    @property
+    def primary_key(self) -> Column | None:
+        r"""The primary key column of this table.
+
+        The getter returns the primary key column of this table, or ``None`` if
+        no such primary key is present.
+
+        The setter sets a column as a primary key on this table, and raises a
+        :class:`ValueError` if the primary key has a non-ID compatible data
+        type or if the column name does not match a column in the data frame.
+        """
+        if self._primary_key is None:
+            return None
+        return self[self._primary_key]
+
+    @primary_key.setter
+    def primary_key(self, name: str | None) -> None:
+        if name is not None and name == self._time_column:
+            raise ValueError(f"Cannot specify column '{name}' as a primary "
+                             f"key since it is already defined to be a time "
+                             f"column")
+        if name is not None and name == self._end_time_column:
+            raise ValueError(f"Cannot specify column '{name}' as a primary "
+                             f"key since it is already defined to be an end "
+                             f"time column")
+
+        if self.primary_key is not None:
+            self.primary_key._is_primary_key = False
+
+        if name is None:
+            self._primary_key = None
+            return
+
+        self[name].stype = Stype.ID
+        self[name]._is_primary_key = True
+        self._primary_key = name
+
+    # Time column #############################################################
+
+    def has_time_column(self) -> bool:
+        r"""Returns ``True`` if this table has a time column; ``False``
+        otherwise.
+        """
+        return self._time_column is not None
+
+    @property
+    def time_column(self) -> Column | None:
+        r"""The time column of this table.
+
+        The getter returns the time column of this table, or ``None`` if no
+        such time column is present.
+
+        The setter sets a column as a time column on this table, and raises a
+        :class:`ValueError` if the time column has a non-timestamp compatible
+        data type or if the column name does not match a column in the data
+        frame.
+        """
+        if self._time_column is None:
+            return None
+        return self[self._time_column]
+
+    @time_column.setter
+    def time_column(self, name: str | None) -> None:
+        if name is not None and name == self._primary_key:
+            raise ValueError(f"Cannot specify column '{name}' as a time "
+                             f"column since it is already defined to be a "
+                             f"primary key")
+        if name is not None and name == self._end_time_column:
+            raise ValueError(f"Cannot specify column '{name}' as a time "
+                             f"column since it is already defined to be an "
+                             f"end time column")
+
+        if self.time_column is not None:
+            self.time_column._is_time_column = False
+
+        if name is None:
+            self._time_column = None
+            return
+
+        self[name].stype = Stype.timestamp
+        self[name]._is_time_column = True
+        self._time_column = name
+
+    # End Time column #########################################################
+
+    def has_end_time_column(self) -> bool:
+        r"""Returns ``True`` if this table has an end time column; ``False``
+        otherwise.
+        """
+        return self._end_time_column is not None
+
+    @property
+    def end_time_column(self) -> Column | None:
+        r"""The end time column of this table.
+
+        The getter returns the end time column of this table, or ``None`` if no
+        such end time column is present.
+
+        The setter sets a column as an end time column on this table, and
+        raises a :class:`ValueError` if the end time column has a non-timestamp
+        compatible data type or if the column name does not match a column in
+        the data frame.
+        """
+        if self._end_time_column is None:
+            return None
+        return self[self._end_time_column]
+
+    @end_time_column.setter
+    def end_time_column(self, name: str | None) -> None:
+        if name is not None and name == self._primary_key:
+            raise ValueError(f"Cannot specify column '{name}' as an end time "
+                             f"column since it is already defined to be a "
+                             f"primary key")
+        if name is not None and name == self._time_column:
+            raise ValueError(f"Cannot specify column '{name}' as an end time "
+                             f"column since it is already defined to be a "
+                             f"time column")
+
+        if self.end_time_column is not None:
+            self.end_time_column._is_end_time_column = False
+
+        if name is None:
+            self._end_time_column = None
+            return
+
+        self[name].stype = Stype.timestamp
+        self[name]._is_end_time_column = True
+        self._end_time_column = name
+
+    # Metadata ################################################################
+
+    @property
+    def metadata(self) -> pd.DataFrame:
+        r"""Returns a :class:`pandas.DataFrame` object containing metadata
+        information about the columns in this table.
+
+        The returned dataframe has columns ``"Name"``, ``"Data Type"``,
+        ``"Semantic Type"``, ``"Primary Key"``, ``"Time Column"`` and
+        ``"End Time Column"``, which provide an aggregated view of the
+        properties of the columns of this table.
+
+        Example:
+            >>> # doctest: +SKIP
+            >>> import kumoai.experimental.rfm as rfm
+            >>> table = rfm.LocalTable(df=..., name=...).infer_metadata()
+            >>> table.metadata
+                Name        Data Type  Semantic Type  Primary Key  Time Column  End Time Column
+            0   CustomerID  float64    ID             True         False        False
+        """  # noqa: E501
+        cols = self.columns
+
+        return pd.DataFrame({
+            'Name':
+            pd.Series(dtype=str, data=[c.name for c in cols]),
+            'Data Type':
+            pd.Series(dtype=str, data=[c.dtype for c in cols]),
+            'Semantic Type':
+            pd.Series(dtype=str, data=[c.stype for c in cols]),
+            'Primary Key':
+            pd.Series(
+                dtype=bool,
+                data=[self._primary_key == c.name for c in cols],
+            ),
+            'Time Column':
+            pd.Series(
+                dtype=bool,
+                data=[self._time_column == c.name for c in cols],
+            ),
+            'End Time Column':
+            pd.Series(
+                dtype=bool,
+                data=[self._end_time_column == c.name for c in cols],
+            ),
+        })
+
+    def print_metadata(self) -> None:
+        r"""Prints the :meth:`~metadata` of this table."""
+        msg = f"🏷️ Metadata of Table `{self.name}`"
+        if num := self._num_rows:
+            msg += " (1 row)" if num == 1 else f" ({num:,} rows)"
+
+        display.title(msg)
+        display.dataframe(self.metadata)
+
+    def infer_primary_key(self, verbose: bool = True) -> Self:
+        r"""Infers the primary key in this table.
+
+        Args:
+            verbose: Whether to print verbose output.
+        """
+        if self.has_primary_key():
+            return self
+
+        def _set_primary_key(primary_key: str) -> None:
+            self.primary_key = primary_key
+            if verbose:
+                display.message(f"Inferred primary key `{primary_key}` for "
+                                f"table `{self.name}`")
+
+        # Inference from source column metadata:
+        if any(column.is_source for column in self.columns):
+            primary_key = self._source_primary_key
+            if (primary_key is not None and primary_key in self
+                    and self[primary_key].is_source):
+                _set_primary_key(primary_key)
+                return self
+
+            unique_keys = [
+                column.name for column in self._source_column_dict.values()
+                if column.is_unique_key
+            ]
+            if (len(unique_keys) == 1  # NOTE No composite keys yet.
+                    and unique_keys[0] in self
+                    and self[unique_keys[0]].is_source):
+                _set_primary_key(unique_keys[0])
+                return self
+
+        # Heuristic-based inference:
+        candidates = [
+            column.name for column in self.columns if column.stype == Stype.ID
+        ]
+        if len(candidates) == 0:
+            for column in self.columns:
+                if self.name.lower() == column.name.lower():
+                    candidates.append(column.name)
+                elif (self.name.lower().endswith('s')
+                      and self.name.lower()[:-1] == column.name.lower()):
+                    candidates.append(column.name)
+
+        if primary_key := infer_primary_key(
+                table_name=self.name,
+                df=self._get_sample_df(),
+                candidates=candidates,
+        ):
+            _set_primary_key(primary_key)
+            return self
+
+        return self
+
+    def infer_time_column(self, verbose: bool = True) -> Self:
+        r"""Infers the time column in this table.
+
+        Args:
+            verbose: Whether to print verbose output.
+        """
+        if self.has_time_column():
+            return self
+
+        # Heuristic-based inference:
+        candidates = [
+            column.name for column in self.columns
+            if column.stype == Stype.timestamp
+            and column.name != self._end_time_column
+        ]
+
+        if time_column := infer_time_column(
+                df=self._get_sample_df(),
+                candidates=candidates,
+        ):
+            self.time_column = time_column
+
+            if verbose:
+                display.message(f"Inferred time column `{time_column}` for "
+                                f"table `{self.name}`")
+
+        return self
+
+    def infer_metadata(self, verbose: bool = True) -> Self:
+        r"""Infers metadata, *i.e.*, primary keys and time columns, in this
+        table.
+
+        Args:
+            verbose: Whether to print verbose output.
+        """
+        logs = []
+
+        if not self.has_primary_key():
+            self.infer_primary_key(verbose=False)
+            if self.has_primary_key():
+                logs.append(f"primary key `{self._primary_key}`")
+
+        if not self.has_time_column():
+            self.infer_time_column(verbose=False)
+            if self.has_time_column():
+                logs.append(f"time column `{self._time_column}`")
+
+        if verbose and len(logs) > 0:
+            display.message(f"Inferred {' and '.join(logs)} for table "
+                            f"`{self.name}`")
+
+        return self
+
+    # Helpers #################################################################
+
+    def _to_api_table_definition(self) -> TableDefinition:
+        return TableDefinition(
+            cols=[
+                ColumnDefinition(col.name, col.stype, col.dtype)
+                for col in self.columns
+            ],
+            source_table=UnavailableSourceTable(table=self.name),
+            pkey=self._primary_key,
+            time_col=self._time_column,
+            end_time_col=self._end_time_column,
+        )
+
+    @cached_property
+    def _source_column_dict(self) -> dict[str, SourceColumn]:
+        source_columns = self._get_source_columns()
+        if len(source_columns) == 0:
+            raise ValueError(f"Table '{self.name}' has no columns")
+        return {column.name: column for column in source_columns}
+
+    @cached_property
+    def _source_primary_key(self) -> str | None:
+        primary_keys = [
+            column.name for column in self._source_column_dict.values()
+            if column.is_primary_key
+        ]
+        # NOTE No composite keys yet.
+        return primary_keys[0] if len(primary_keys) == 1 else None
+
+    @cached_property
+    def _source_foreign_key_dict(self) -> dict[str, SourceForeignKey]:
+        return {key.name: key for key in self._get_source_foreign_keys()}
+
+    @cached_property
+    def _source_sample_df(self) -> pd.DataFrame:
+        return self._get_source_sample_df().reset_index(drop=True)
+
+    @cached_property
+    def _num_rows(self) -> int | None:
+        return self._get_num_rows()
+
+    def _get_sample_df(self) -> pd.DataFrame:
+        dfs: list[pd.DataFrame] = []
+        if any(column.is_source for column in self.columns):
+            dfs.append(self._source_sample_df)
+        if any(not column.is_source for column in self.columns):
+            dfs.append(self._expr_sample_df)
+
+        if len(dfs) == 0:
+            return pd.DataFrame(index=range(1000))
+        if len(dfs) == 1:
+            return dfs[0]
+
+        size = min(map(len, dfs))
+        df = pd.concat([dfs[0].iloc[:size], dfs[1].iloc[:size]], axis=1)
+        df = df.loc[:, ~df.columns.duplicated(keep='last')]
+        return df
+
+    @staticmethod
+    def _sanitize(
+        df: pd.DataFrame,
+        dtype_dict: dict[str, Dtype | None] | None = None,
+        stype_dict: dict[str, Stype | None] | None = None,
+    ) -> pd.DataFrame:
+        r"""Sanitzes a :class:`pandas.DataFrame` in-place such that its data
+        types match table data and semantic type specification.
+        """
+        def _to_list(ser: pd.Series, dtype: Dtype | None) -> pd.Series:
+            if (pd.api.types.is_string_dtype(ser)
+                    and dtype in {Dtype.intlist, Dtype.floatlist}):
+                try:
+                    ser = ser.map(lambda row: np.fromstring(
+                        row.strip('[]'),
+                        sep=',',
+                        dtype=int if dtype == Dtype.intlist else np.float32,
+                    ) if row is not None else None)
+                except Exception:
+                    pass
+
+            if pd.api.types.is_string_dtype(ser):
+                try:
+                    import orjson as json
+                except ImportError:
+                    import json
+                try:
+                    ser = ser.map(lambda row: json.loads(row)
+                                  if row is not None else None)
+                except Exception:
+                    pass
+
+            return ser
+
+        for column_name in df.columns:
+            dtype = (dtype_dict or {}).get(column_name)
+            stype = (stype_dict or {}).get(column_name)
+
+            if dtype == Dtype.time:
+                df[column_name] = to_datetime(df[column_name])
+            elif stype == Stype.timestamp:
+                df[column_name] = to_datetime(df[column_name])
+            elif dtype is not None and dtype.is_list():
+                df[column_name] = _to_list(df[column_name], dtype)
+            elif stype == Stype.sequence:
+                df[column_name] = _to_list(df[column_name], Dtype.floatlist)
+
+        return df
+
+    # Python builtins #########################################################
+
+    def __hash__(self) -> int:
+        special_columns = [
+            self.primary_key,
+            self.time_column,
+            self.end_time_column,
+        ]
+        return hash(tuple(self.columns + special_columns))
+
+    def __contains__(self, name: str) -> bool:
+        return self.has_column(name)
+
+    def __getitem__(self, name: str) -> Column:
+        return self.column(name)
+
+    def __delitem__(self, name: str) -> None:
+        self.remove_column(name)
+
+    def __repr__(self) -> str:
+        return (f'{self.__class__.__name__}(\n'
+                f'  name={self.name},\n'
+                f'  num_columns={len(self.columns)},\n'
+                f'  primary_key={self._primary_key},\n'
+                f'  time_column={self._time_column},\n'
+                f'  end_time_column={self._end_time_column},\n'
+                f')')
+
+    # Abstract Methods ########################################################
+
+    @property
+    @abstractmethod
+    def backend(self) -> DataBackend:
+        r"""The data backend of this table."""
+
+    @abstractmethod
+    def _get_source_columns(self) -> list[SourceColumn]:
+        pass
+
+    @abstractmethod
+    def _get_source_foreign_keys(self) -> list[SourceForeignKey]:
+        pass
+
+    @abstractmethod
+    def _get_source_sample_df(self) -> pd.DataFrame:
+        pass
+
+    @abstractmethod
+    def _get_expr_sample_df(
+        self,
+        columns: Sequence[ColumnSpec],
+    ) -> pd.DataFrame:
+        pass
+
+    @abstractmethod
+    def _get_num_rows(self) -> int | None:
+        pass