squirrels 0.2.2__py3-none-any.whl → 0.3.1__py3-none-any.whl

squirrels/data_sources.py

@@ -15,17 +15,19 @@ class DataSource(metaclass=ABCMeta):
     """
     _table_or_query: str
     _id_col: Optional[str]
+    _from_seeds: bool
     _user_group_col: Optional[str] # = field(default=None, kw_only=True)
     _parent_id_col: Optional[str] # = field(default=None, kw_only=True)
     _connection_name: Optional[str] # = field(default=None, kw_only=True)
 
     @abstractmethod
     def __init__(
-        self, table_or_query: str, *, id_col: Optional[str] = None, user_group_col: Optional[str] = None, 
+        self, table_or_query: str, *, id_col: Optional[str] = None, from_seeds: bool = False, user_group_col: Optional[str] = None, 
         parent_id_col: Optional[str] = None, connection_name: Optional[str] = None, **kwargs
     ) -> None:
         self._table_or_query = table_or_query
         self._id_col = id_col
+        self._from_seeds = from_seeds
         self._user_group_col = user_group_col
         self._parent_id_col = parent_id_col
         self._connection_name = connection_name
@@ -85,6 +87,9 @@ class DataSource(metaclass=ABCMeta):
     def _get_key_from_record_as_list(self, key: Optional[str], record: dict[str, Any]) -> Iterable[str]:
         value = self._get_key_from_record(key, record, list())
         return [str(x) for x in value]
+    
+    def is_from_seed(self) -> bool:
+        return self._from_seeds
 
 
 @dataclass
@@ -100,11 +105,14 @@ class _SelectionDataSource(DataSource):
     @abstractmethod
     def __init__(
         self, table_or_query: str, id_col: str, options_col: str, *, order_by_col: Optional[str] = None, 
-        is_default_col: Optional[str] = None, custom_cols: dict[str, str] = {}, user_group_col: Optional[str] = None, 
-        parent_id_col: Optional[str] = None, connection_name: Optional[str] = None, **kwargs
+        is_default_col: Optional[str] = None, custom_cols: dict[str, str] = {}, from_seeds: bool = False, 
+        user_group_col: Optional[str] = None, parent_id_col: Optional[str] = None, connection_name: Optional[str] = None, 
+        **kwargs
     ) -> None:
-        super().__init__(table_or_query, id_col=id_col, user_group_col=user_group_col, parent_id_col=parent_id_col, 
-                         connection_name=connection_name)
+        super().__init__(
+            table_or_query, id_col=id_col, from_seeds=from_seeds, user_group_col=user_group_col, parent_id_col=parent_id_col, 
+            connection_name=connection_name
+        )
         self._options_col = options_col
         self._order_by_col = order_by_col
         self._is_default_col = is_default_col
@@ -139,9 +147,9 @@ class _SelectionDataSource(DataSource):
 
 
 @dataclass
-class SingleSelectDataSource(_SelectionDataSource):
+class SelectDataSource(_SelectionDataSource):
     """
-    Lookup table for single select parameter options
+    Lookup table for select parameter options
 
     Attributes:
         table_or_query: Either the name of the table to use, or a query to run
@@ -150,21 +158,71 @@ class SingleSelectDataSource(_SelectionDataSource):
         order_by_col: The column name to order the options by. Orders by the id_col instead if this is None
         is_default_col: The column name that indicates which options are the default
         custom_cols: Dictionary of attribute to column name for custom fields for the SelectParameterOption
+        from_seeds: Boolean for whether this datasource is created from seeds
         user_group_col: The column name of the user group that the user is in for this option to be valid
         parent_id_col: The column name of the parent option id that must be selected for this option to be valid
         connection_name: Name of the connection to use defined in connections.py
     """
 
+    def __init__(
+            self, table_or_query: str, id_col: str, options_col: str, *, order_by_col: Optional[str] = None, 
+            is_default_col: Optional[str] = None, custom_cols: dict[str, str] = {}, from_seeds: bool = False, 
+            user_group_col: Optional[str] = None, parent_id_col: Optional[str] = None, connection_name: Optional[str] = None, 
+            **kwargs
+        ) -> None:
+        """
+        Constructor for SelectDataSource
+
+        Parameters:
+            ...see Attributes of SelectDataSource
+        """
+        super().__init__(
+            table_or_query, id_col, options_col, order_by_col=order_by_col, is_default_col=is_default_col, custom_cols=custom_cols,
+            from_seeds=from_seeds, user_group_col=user_group_col, parent_id_col=parent_id_col, connection_name=connection_name
+        )
+
+    def _convert(self, ds_param: pc.DataSourceParameterConfig, df: pd.DataFrame) -> pc.SelectionParameterConfig:
+        """
+        Method to convert the associated DataSourceParameter into a SingleSelectParameterConfig or MultiSelectParameterConfig
+
+        Parameters:
+            ds_param: The parameter to convert
+            df: The dataframe containing the parameter options data
+
+        Returns:
+            The converted parameter
+        """
+        all_options = self._get_all_options(df)
+        if ds_param.parameter_type == pc.SingleSelectParameterConfig:
+            return pc.SingleSelectParameterConfig(
+                ds_param.name, ds_param.label, all_options, description=ds_param.description, 
+                user_attribute=ds_param.user_attribute, parent_name=ds_param.parent_name
+            )
+        elif ds_param.parameter_type == pc.MultiSelectParameterConfig:
+            return pc.MultiSelectParameterConfig(
+                ds_param.name, ds_param.label, all_options, description=ds_param.description, 
+                user_attribute=ds_param.user_attribute, parent_name=ds_param.parent_name, **ds_param.extra_args
+            )
+        else:
+            raise u.ConfigurationError(f'Invalid widget type "{ds_param.parameter_type}" for SelectDataSource')
+
+
+@dataclass
+class SingleSelectDataSource(_SelectionDataSource):
+    """
+    DEPRECATED. Use "SelectDataSource" instead.
+    """
+
     def __init__(
             self, table_or_query: str, id_col: str, options_col: str, *, order_by_col: Optional[str] = None, 
             is_default_col: Optional[str] = None, custom_cols: dict[str, str] = {}, user_group_col: Optional[str] = None, 
             parent_id_col: Optional[str] = None, connection_name: Optional[str] = None, **kwargs
         ) -> None:
         """
-        Constructor for SingleSelectDataSource
+        Constructor for SelectDataSource
 
         Parameters:
-            ...see Attributes of SingleSelectDataSource
+            ...see Attributes of SelectDataSource
         """
         super().__init__(table_or_query, id_col, options_col, order_by_col=order_by_col, is_default_col=is_default_col,
                          custom_cols=custom_cols, user_group_col=user_group_col, parent_id_col=parent_id_col, 
@@ -183,27 +241,13 @@ class SingleSelectDataSource(_SelectionDataSource):
         """
         self._validate_parameter_type(ds_param, pc.SingleSelectParameterConfig)
         all_options = self._get_all_options(df)
-        return pc.SingleSelectParameterConfig(ds_param.name, ds_param.label, all_options, is_hidden=ds_param.is_hidden, 
+        return pc.SingleSelectParameterConfig(ds_param.name, ds_param.label, all_options, description=ds_param.description, 
                                               user_attribute=ds_param.user_attribute, parent_name=ds_param.parent_name)
 
-
 @dataclass
 class MultiSelectDataSource(_SelectionDataSource):
     """
-    Lookup table for single select parameter options
-
-    Attributes:
-        table_or_query: Either the name of the table to use, or a query to run
-        id_col: The column name of the id
-        options_col: The column name of the options
-        order_by_col: The column name to order the options by. Orders by the id_col instead if this is None
-        is_default_col: The column name that indicates which options are the default
-        custom_cols: Dictionary of attribute to column name for custom fields for the SelectParameterOption
-        include_all: Whether applying no selection is equivalent to selecting all. Default is True
-        order_matters: Whether the ordering of the selection matters. Default is False 
-        user_group_col: The column name of the user group that the user is in for this option to be valid
-        parent_id_col: The column name of the parent option id that must be selected for this option to be valid
-        connection_name: Name of the connection to use defined in connections.py
+    DEPRECATED. Use "SelectDataSource" instead.
     """
     _show_select_all: bool # = field(default=True, kw_only=True)
     _is_dropdown: bool # = field(default=True, kw_only=True)
@@ -245,7 +289,7 @@ class MultiSelectDataSource(_SelectionDataSource):
         all_options = self._get_all_options(df)
         return pc.MultiSelectParameterConfig(
             ds_param.name, ds_param.label, all_options, show_select_all=self._show_select_all, is_dropdown=self._is_dropdown,
-            order_matters=self._order_matters, none_is_all=self._none_is_all, is_hidden=ds_param.is_hidden, 
+            order_matters=self._order_matters, none_is_all=self._none_is_all, description=ds_param.description, 
             user_attribute=ds_param.user_attribute, parent_name=ds_param.parent_name
         )
 
@@ -257,9 +301,10 @@ class DateDataSource(DataSource):
 
     Attributes:
         table_or_query: Either the name of the table to use, or a query to run
-        id_col: The column name of the id
         default_date_col: The column name of the default date
         date_format: The format of the default date(s). Defaults to '%Y-%m-%d'
+        id_col: The column name of the id
+        from_seeds: Boolean for whether this datasource is created from seeds
         user_group_col: The column name of the user group that the user is in for this option to be valid
         parent_id_col: The column name of the parent option id that the default date belongs to
         connection_name: Name of the connection to use defined in connections.py
@@ -269,7 +314,8 @@ class DateDataSource(DataSource):
 
     def __init__(
         self, table_or_query: str, default_date_col: str, *, date_format: str = '%Y-%m-%d', id_col: Optional[str] = None, 
-        user_group_col: Optional[str] = None, parent_id_col: Optional[str] = None, connection_name: Optional[str] = None, **kwargs
+        from_seeds: bool = False, user_group_col: Optional[str] = None, parent_id_col: Optional[str] = None, 
+        connection_name: Optional[str] = None, **kwargs
     ) -> None:
         """
         Constructor for DateDataSource
@@ -277,8 +323,10 @@ class DateDataSource(DataSource):
         Parameters:
             ...see Attributes of DateDataSource
         """
-        super().__init__(table_or_query, id_col=id_col, user_group_col=user_group_col, parent_id_col=parent_id_col, 
-                         connection_name=connection_name)
+        super().__init__(
+            table_or_query, id_col=id_col, from_seeds=from_seeds, user_group_col=user_group_col, parent_id_col=parent_id_col, 
+            connection_name=connection_name
+        )
         self._default_date_col = default_date_col
         self._date_format = date_format
 
@@ -305,7 +353,7 @@ class DateDataSource(DataSource):
                                    parent_option_ids=self._get_key_from_record_as_list(self._parent_id_col, record))
             for _, record in records.items()
         )
-        return pc.DateParameterConfig(ds_param.name, ds_param.label, options, is_hidden=ds_param.is_hidden, 
+        return pc.DateParameterConfig(ds_param.name, ds_param.label, options, description=ds_param.description, 
                                       user_attribute=ds_param.user_attribute, parent_name=ds_param.parent_name)
 
 
@@ -316,10 +364,11 @@ class DateRangeDataSource(DataSource):
 
     Attributes:
         table_or_query: Either the name of the table to use, or a query to run
-        id_col: The column name of the id
         default_start_date_col: The column name of the default start date
         default_end_date_col: The column name of the default end date
         date_format: The format of the default date(s). Defaults to '%Y-%m-%d'
+        id_col: The column name of the id
+        from_seeds: Boolean for whether this datasource is created from seeds
         user_group_col: The column name of the user group that the user is in for this option to be valid
         parent_id_col: The column name of the parent option id that the default date belongs to
         connection_name: Name of the connection to use defined in connections.py
@@ -330,8 +379,8 @@ class DateRangeDataSource(DataSource):
 
     def __init__(
         self, table_or_query: str, default_start_date_col: str, default_end_date_col: str, *, date_format: str = '%Y-%m-%d',
-        id_col: Optional[str] = None, user_group_col: Optional[str] = None, parent_id_col: Optional[str] = None, 
-        connection_name: Optional[str] = None, **kwargs
+        id_col: Optional[str] = None, from_seeds: bool = False, user_group_col: Optional[str] = None, 
+        parent_id_col: Optional[str] = None, connection_name: Optional[str] = None, **kwargs
     ) -> None:
         """
         Constructor for DateRangeDataSource
@@ -339,8 +388,10 @@ class DateRangeDataSource(DataSource):
         Parameters:
             ...see Attributes of DateRangeDataSource
         """
-        super().__init__(table_or_query, id_col=id_col, user_group_col=user_group_col, parent_id_col=parent_id_col, 
-                         connection_name=connection_name)
+        super().__init__(
+            table_or_query, id_col=id_col, from_seeds=from_seeds, user_group_col=user_group_col, parent_id_col=parent_id_col, 
+            connection_name=connection_name
+        )
         self._default_start_date_col = default_start_date_col
         self._default_end_date_col = default_end_date_col
         self._date_format = date_format
@@ -369,7 +420,7 @@ class DateRangeDataSource(DataSource):
                                         parent_option_ids=self._get_key_from_record_as_list(self._parent_id_col, record))
             for _, record in records.items()
         )
-        return pc.DateRangeParameterConfig(ds_param.name, ds_param.label, options, is_hidden=ds_param.is_hidden, 
+        return pc.DateRangeParameterConfig(ds_param.name, ds_param.label, options, description=ds_param.description, 
                                            user_attribute=ds_param.user_attribute, parent_name=ds_param.parent_name)
 
 
@@ -385,10 +436,13 @@ class _NumericDataSource(DataSource):
     @abstractmethod
     def __init__(
         self, table_or_query: str, min_value_col: str, max_value_col: str, *, increment_col: Optional[str] = None, 
-        id_col: Optional[str] = None, user_group_col: Optional[str] = None, parent_id_col: Optional[str] = None, 
-        connection_name: Optional[str] = None, **kwargs
+        id_col: Optional[str] = None, from_seeds: bool = False, user_group_col: Optional[str] = None, 
+        parent_id_col: Optional[str] = None, connection_name: Optional[str] = None, **kwargs
     ) -> None:
-        super().__init__(table_or_query, id_col=id_col, user_group_col=user_group_col, parent_id_col=parent_id_col, connection_name=connection_name)
+        super().__init__(
+            table_or_query, id_col=id_col, from_seeds=from_seeds, user_group_col=user_group_col, parent_id_col=parent_id_col, 
+            connection_name=connection_name
+        )
         self._min_value_col = min_value_col
         self._max_value_col = max_value_col
         self._increment_col = increment_col
@@ -401,11 +455,12 @@ class NumberDataSource(_NumericDataSource):
 
     Attributes:
         table_or_query: Either the name of the table to use, or a query to run
-        id_col: The column name of the id
         min_value_col: The column name of the minimum value
         max_value_col: The column name of the maximum value
         increment_col: The column name of the increment value. Defaults to column of 1's if None
         default_value_col: The column name of the default value. Defaults to min_value_col if None
+        id_col: The column name of the id
+        from_seeds: Boolean for whether this datasource is created from seeds
         user_group_col: The column name of the user group that the user is in for this option to be valid
         parent_id_col: The column name of the parent option id that the default value belongs to
         connection_name: Name of the connection to use defined in connections.py
@@ -414,8 +469,8 @@ class NumberDataSource(_NumericDataSource):
 
     def __init__(
         self, table_or_query: str, min_value_col: str, max_value_col: str, *, increment_col: Optional[str] = None,
-        default_value_col: Optional[str] = None, id_col: Optional[str] = None, user_group_col: Optional[str] = None, 
-        parent_id_col: Optional[str] = None, connection_name: Optional[str] = None, **kwargs
+        default_value_col: Optional[str] = None, id_col: Optional[str] = None, from_seeds: bool = False, 
+        user_group_col: Optional[str] = None, parent_id_col: Optional[str] = None, connection_name: Optional[str] = None, **kwargs
     ) -> None:
         """
         Constructor for NumberDataSource
@@ -423,8 +478,10 @@ class NumberDataSource(_NumericDataSource):
         Parameters:
             ...see Attributes of NumberDataSource
         """
-        super().__init__(table_or_query, min_value_col, max_value_col, increment_col=increment_col, id_col=id_col, 
-                         user_group_col=user_group_col, parent_id_col=parent_id_col, connection_name=connection_name)
+        super().__init__(
+            table_or_query, min_value_col, max_value_col, increment_col=increment_col, id_col=id_col, from_seeds=from_seeds,
+            user_group_col=user_group_col, parent_id_col=parent_id_col, connection_name=connection_name
+        )
         self._default_value_col = default_value_col
 
     def _convert(self, ds_param: pc.DataSourceParameterConfig, df: pd.DataFrame) -> pc.NumberParameterConfig:
@@ -452,7 +509,7 @@ class NumberDataSource(_NumericDataSource):
                                      parent_option_ids=self._get_key_from_record_as_list(self._parent_id_col, record))
             for _, record in records.items()
         )
-        return pc.NumberParameterConfig(ds_param.name, ds_param.label, options, is_hidden=ds_param.is_hidden,
+        return pc.NumberParameterConfig(ds_param.name, ds_param.label, options, description=ds_param.description,
                                         user_attribute=ds_param.user_attribute, parent_name=ds_param.parent_name)
 
 
@@ -463,12 +520,13 @@ class NumberRangeDataSource(_NumericDataSource):
 
     Attributes:
         table_or_query: Either the name of the table to use, or a query to 
-        id_col: The column name of the id
         min_value_col: The column name of the minimum value
         max_value_col: The column name of the maximum value
         increment_col: The column name of the increment value. Defaults to column of 1's if None
         default_lower_value_col: The column name of the default lower value. Defaults to min_value_col if None
         default_upper_value_col: The column name of the default upper value. Defaults to max_value_col if None
+        id_col: The column name of the id
+        from_seeds: Boolean for whether this datasource is created from seeds
         user_group_col: The column name of the user group that the user is in for this option to be valid
         parent_id_col: The column name of the parent option id that the default value belongs to
         connection_name: Name of the connection to use defined in connections.py
@@ -479,7 +537,8 @@ class NumberRangeDataSource(_NumericDataSource):
     def __init__(
         self, table_or_query: str, min_value_col: str, max_value_col: str, *, increment_col: Optional[str] = None,
         default_lower_value_col: Optional[str] = None, default_upper_value_col: Optional[str] = None, id_col: Optional[str] = None, 
-        user_group_col: Optional[str] = None, parent_id_col: Optional[str] = None, connection_name: Optional[str] = None, **kwargs
+        from_seeds: bool = False, user_group_col: Optional[str] = None, parent_id_col: Optional[str] = None, 
+        connection_name: Optional[str] = None, **kwargs
     ) -> None:
         """
         Constructor for NumRangeDataSource
@@ -487,8 +546,10 @@ class NumberRangeDataSource(_NumericDataSource):
         Parameters:
             ...see Attributes of NumRangeDataSource
         """
-        super().__init__(table_or_query, min_value_col, max_value_col, increment_col=increment_col, id_col=id_col, 
-                         user_group_col=user_group_col, parent_id_col=parent_id_col, connection_name=connection_name)
+        super().__init__(
+            table_or_query, min_value_col, max_value_col, increment_col=increment_col, id_col=id_col, from_seeds=from_seeds, 
+            user_group_col=user_group_col, parent_id_col=parent_id_col, connection_name=connection_name
+        )
         self._default_lower_value_col = default_lower_value_col
         self._default_upper_value_col = default_upper_value_col
 
@@ -518,5 +579,65 @@ class NumberRangeDataSource(_NumericDataSource):
                                        parent_option_ids=self._get_key_from_record_as_list(self._parent_id_col, record))
             for _, record in records.items()
         )
-        return pc.NumberRangeParameterConfig(ds_param.name, ds_param.label, options, is_hidden=ds_param.is_hidden,
+        return pc.NumberRangeParameterConfig(ds_param.name, ds_param.label, options, description=ds_param.description,
                                           user_attribute=ds_param.user_attribute, parent_name=ds_param.parent_name)
+
+
+@dataclass
+class TextDataSource(DataSource):
+    """
+    Lookup table for text parameter default options
+
+    Attributes:
+        table_or_query: Either the name of the table to use, or a query to run
+        default_text_col: The column name of the default text
+        id_col: The column name of the id
+        from_seeds: Boolean for whether this datasource is created from seeds
+        user_group_col: The column name of the user group that the user is in for this option to be valid
+        parent_id_col: The column name of the parent option id that the default date belongs to
+        connection_name: Name of the connection to use defined in connections.py
+    """
+    _default_text_col: str
+
+    def __init__(
+        self, table_or_query: str, default_text_col: str, *, id_col: Optional[str] = None, from_seeds: bool = False, 
+        user_group_col: Optional[str] = None, parent_id_col: Optional[str] = None, connection_name: Optional[str] = None,
+        **kwargs
+    ) -> None:
+        """
+        Constructor for DateDataSource
+
+        Parameters:
+            ...see Attributes of DateDataSource
+        """
+        super().__init__(
+            table_or_query, id_col=id_col, from_seeds=from_seeds, user_group_col=user_group_col, parent_id_col=parent_id_col, 
+            connection_name=connection_name
+        )
+        self._default_text_col = default_text_col
+
+    def _convert(self, ds_param: pc.DataSourceParameterConfig, df: pd.DataFrame) -> pc.TextParameterConfig:
+        """
+        Method to convert the associated DataSourceParameter into a TextParameterConfig
+
+        Parameters:
+            ds_param: The parameter to convert
+            df: The dataframe containing the parameter options data
+
+        Returns:
+            The converted parameter
+        """
+        self._validate_parameter_type(ds_param, pc.TextParameterConfig)
+
+        columns = [self._default_text_col]
+        df_agg = self._get_aggregated_df(df, columns)
+
+        records: dict[str, dict[str, Any]] = df_agg.to_dict("index")
+        options = tuple(
+            po.TextParameterOption(default_text=str(record[self._default_text_col]), 
+                                   user_groups=self._get_key_from_record_as_list(self._user_group_col, record), 
+                                   parent_option_ids=self._get_key_from_record_as_list(self._parent_id_col, record))
+            for _, record in records.items()
+        )
+        return pc.TextParameterConfig(ds_param.name, ds_param.label, options, description=ds_param.description, 
+                                      user_attribute=ds_param.user_attribute, parent_name=ds_param.parent_name)

squirrels/dateutils.py

@@ -289,7 +289,7 @@ class DateModPipeline(DateModifier):
         incremented by a DateModifier step.
 
         If the step is positive and start date is less than end date, then it'll return an increasing list of
-        dates starting from the start date. If the step is positive and start date is less than end date, 
+        dates starting from the start date. If the step is negative and start date is greater than end date, 
         then it'll return a decreasing list of dates starting from the start date. Otherwise, an empty list
         is returned.
 
@@ -379,7 +379,7 @@ class DateStringModifier(_DateRepresentationModifier):
         to the modified date, incremented by a DateModifier step.
 
         If the step is positive and start date is less than end date, then it'll return an increasing list of
-        dates starting from the start date. If the step is positive and start date is less than end date, 
+        dates starting from the start date. If the step is negative and start date is greater than end date, 
         then it'll return a decreasing list of dates starting from the start date. Otherwise, an empty list
         is returned.
 
@@ -443,7 +443,7 @@ class TimestampModifier(_DateRepresentationModifier):
         to the modified date, incremented by a DateModifier step.
 
         If the step is positive and start date is less than end date, then it'll return an increasing list of
-        dates starting from the start date. If the step is positive and start date is less than end date, 
+        dates starting from the start date. If the step is negative and start date is greater than end date, 
         then it'll return a decreasing list of dates starting from the start date. Otherwise, an empty list
         is returned.