Skip to main content
Version: Canary 🚧

NumberParameter

The class for defining and interacting with number parameters.

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

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 NumberParameter in particular:

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

CreateSimple​

Creates the configurations for a number parameter by specifying the bounds directly without specifying any NumberParameterOption 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
  • min_value: A string, int, or Decimal (from decimal package). This is the minimum selectable value for this number parameter
  • max_value: A string, int, or Decimal (from decimal package). This is the maximum selectable value for this number parameter
    • Must be greater than "min_value"

Optional Keyword Arguments:

  • description: A string for the explanation / purpose of the parameter. Default is empty string
  • increment: A string, int, or Decimal (from decimal package). This is the increment of selectable values. Default is 1
    • Must fit evenly between "min_value" and "max_value"
  • default_value: A string, int, Decimal (from decimal package), or None. This is the default selected value. When None, the "min_value" is used. Default is None
    • Must be selectable based on "min_value", "max_value", and "increment"

Returns: None

Non-Static Methods​

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

if sqrl.param_exists("my_num_param"):
    my_num_param: sr.NumberParameter = prms["my_num_param"]
    my_num: str = my_num_param.get_selected_value()
    ...

get_selected_value​

Gets selected number as string. This method takes no arguments.

Returns: A string that's parsable into a decimal number.