Skip to main content
Version: 0.5.x

DateRangeParameter (class)

DateRangeParameter objects can be used to interact with real-time selections for date range parameters. It also contains factory methods as static / class methods for creating date range parameters. This is a subclass of Parameter.

The class can be imported from the squirrels.parameters or squirrels module.

Static / Class Methods​

CreateSimple, CreateWithOptions and CreateFromSource are factory methods for creating date range widget parameters in the Squirrels application.

CreateSimple​

@classmethod
def CreateSimple(
    cls, name: str, label: str, default_start_date: str | datetime.date, default_end_date: str | datetime.date, 
    *, description: str = "", min_date: str | datetime.date | None = None, 
    max_date: str | datetime.date | None = None, date_format: str = '%Y-%m-%d'
) -> None:

Creates the configurations for a date range parameter by specifying the default dates directly without specifying any DateRangeParameterOption instances. The parameter configurations get added to a pool of parameter configurations that datasets can pick from.

Unlike the CreateWithOptions factory method, this factory method assumes only one parameter option is needed with no arguments for "user_attribute" and "parent_name".

Required Arguments:

  • name: A string for the name of the parameter
  • label: A string for human-friendly display name for this parameter
  • default_start_date: A string or date (from datetime package). This is the default selected start date
  • default_end_date: A string or date (from datetime package). This is the default selected end date
    • Must be a date after "default_start_date"

Optional Keyword Arguments:

  • description: A string for the explanation / purpose of the parameter. Default is empty string
  • date_format: A string for the format of the "default_date" argument. Uses datetime's format codes. Default is '%Y-%m-%d'
  • min_date: A string, datetime.date, or None. This is the minimum date that can be selected for this parameter. If None, there is no minimum date
  • max_date: A string, datetime.date, or None. This is the maximum date that can be selected for this parameter. If None, there is no maximum date

Returns: None

CreateWithOptions​

@classmethod
def CreateWithOptions(
    cls, name: str, label: str, all_options: typing.Sequence[squirrels.DateRangeParameterOption | dict], *, 
    description: str = "", user_attribute: str | None = None, parent_name: str | None = None
) -> None:

Creates the configurations for a date range parameter by providing a list of the parameter option objects, and adds it to a pool of parameter configurations that datasets can pick from.

Required Arguments:

  • name: A string for the name of the parameter
  • label: A string for human-friendly display name for this parameter
  • all_options: A sequence of DateRangeParameterOption objects (or serialization of the objects as dictionaries) for all parameter options associated to this parameter

Optional Keyword Arguments:

  • description: A string for the explanation / purpose of the parameter. Default is empty string
  • user_attribute: An optional string for the user attribute that may affect the bounds and default dates for this parameter. If None, then the authorized user has no effect on the bounds and default dates. Default is None
  • parent_name: An optional string for the name of the parent parameter that may affect the bounds and default dates for this parameter. If None, then other parameters have no effect on the bounds and default dates. Default is None

Returns: None

CreateFromSource​

@classmethod
def CreateFromSource(
    cls, name: str, label: str, data_source: squirrels.DateRangeDataSource | dict, *, 
    description: str = "", user_attribute: str | None = None, parent_name: str | None = None
) -> None:

Creates the configurations for a date range parameter by providing a lookup table to query from, and adds it to a pool of parameter configurations that datasets can pick from.

Required Arguments:

  • name: A string for the name of the parameter
  • label: A string for human-friendly display name for this parameter
  • data_source: A DateRangeDataSource object (or serialization of the object as a dictionary) which contains details of the lookup table from the external database

Optional Keyword Arguments:

Same optional arguments as the CreateWithOptions static method described above.

Returns: None

Non-Static Methods​

In the context.py file or data model, the methods below can be invoked on a DateRangeParameter object to retrieve details for the selected parameter option at runtime. For example, the following code demonstrates getting the DateRangeParameter object in context.py, and calling the "get_selected_start_date" method on it.

if sqrl.param_exists("my_dr_param"):
    my_dr_param = prms["my_dr_param"]
    assert isinstance(my_dr_param, p.DateRangeParameter)
    my_date: str = my_dr_param.get_selected_start_date()
    ...

get_selected_start_date​

def get_selected_start_date(self, *, date_format: str | None = None) -> str:

Gets selected start date as string.

Optional Keyword Argument

Returns: A string for the date.

get_selected_start_date_quoted​

def get_selected_start_date_quoted(self, *, date_format: str | None = None) -> str:

Gets selected start date as string surrounded by single quotes.

Optional Keyword Argument

  • date_format: See "date_format" argument for the "get_selected_start_date" method above

Returns: A string for the quoted date.

get_selected_end_date​

def get_selected_end_date(self, *, date_format: str | None = None) -> str:

Gets selected end date as string.

Optional Keyword Argument

  • date_format: See "date_format" argument for the "get_selected_start_date" method above

Returns: A string for the date.

get_selected_end_date_quoted​

def get_selected_end_date_quoted(self, *, date_format: str | None = None) -> str:

Gets selected end date as string surrounded by single quotes.

Optional Keyword Argument

  • date_format: See "date_format" argument for the "get_selected_start_date" method above

Returns: A string for the quoted date.