`spinedb_api.filters.scenario_filter`

Provides functions to apply filtering based on scenarios to subqueries.

Module Contents

`apply_scenario_filter_to_subqueries`(db_map, scenario)	Replaces affected subqueries in `db_map` such that they return only values of given scenario.
`scenario_filter_config`(scenario)	Creates a config dict for scenario filter.
`scenario_filter_from_dict`(db_map, config)	Applies scenario filter to given database map.
`scenario_name_from_dict`(config)	Returns scenario's name from filter config.
`scenario_filter_config_to_shorthand`(config)	Makes a shorthand string from scenario filter configuration.
`scenario_filter_shorthand_to_config`(shorthand)	Makes configuration dictionary out of a shorthand string.

spinedb_api.filters.scenario_filter.apply_scenario_filter_to_subqueries(db_map, scenario)[source]

Replaces affected subqueries in db_map such that they return only values of given scenario.

Parameters:

spinedb_api.filters.scenario_filter.scenario_filter_config(scenario)[source]

Creates a config dict for scenario filter.

spinedb_api.filters.scenario_filter.scenario_filter_from_dict(db_map, config)[source]

Applies scenario filter to given database map.

Parameters:

spinedb_api.filters.scenario_filter.scenario_name_from_dict(config)[source]

Returns scenario’s name from filter config.

Parameters:: config (dict) – scenario filter configuration
Returns:: scenario name or None if config is not a valid scenario filter configuration
Return type:: str

spinedb_api.filters.scenario_filter.scenario_filter_config_to_shorthand(config)[source]

Makes a shorthand string from scenario filter configuration.

spinedb_api.filters.scenario_filter.scenario_filter_shorthand_to_config(shorthand)[source]

Makes configuration dictionary out of a shorthand string.