Skip to main content
Version: Canary 🚧

DateRangeParameter

The class for defining and interacting with date range parameters.

Can be found in the classpath squirrels.parameters.DateRangeParameter or squirrels.DateRangeParameter.

Static / Class Methods​

In addition to the static methods specified on this page, see the Parameter page for details on the CreateWithOptions and CreateFromSource factory methods.

For DateRangeParameter in particular:

  • The all_options argument of the CreateWithOptions factory method must be a sequence of DateRangeParameterOption instances
  • The data_source argument of the CreateFromSource factory method must be a DateRangeDataSource

CreateSimple​

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'

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_date" method on it.

if sqrl.param_exists("my_dr_param"):
    my_dr_param: sr.DateRangeParameter = prms["my_dr_param"]
    my_date: str = my_dr_param.get_selected_start_date()
    ...

get_selected_start_date​

Gets selected start date as string.

Optional Keyword Argument

Returns: A string for the date.

get_selected_start_date_quoted​

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​

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 date.

get_selected_end_date_quoted​

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.