`spinedb_api.filters.alternative_filter`

Provides functions to apply filtering based on alternatives to parameter value subqueries.

Module Contents

`apply_alternative_filter_to_parameter_value_sq`(db_map, ...)	Replaces parameter value subquery properties in `db_map` such that they return only values of given alternatives.
`alternative_filter_config`(alternatives)	Creates a config dict for alternative filter.
`alternative_filter_from_dict`(db_map, config)	Applies alternative filter to given database map.
`alternative_filter_config_to_shorthand`(config)	Makes a shorthand string from alternative filter configuration.
`alternative_names_from_dict`(config)	Returns alternatives' names from filter config.
`alternative_filter_shorthand_to_config`(shorthand)	Makes configuration dictionary out of a shorthand string.

spinedb_api.filters.alternative_filter.apply_alternative_filter_to_parameter_value_sq(db_map, alternatives)[source]

Replaces parameter value subquery properties in db_map such that they return only values of given alternatives.

Parameters:

db_map (DatabaseMapping) – a database map to alter
alternatives (Iterable of str or int, optional) – alternative names or ids;

spinedb_api.filters.alternative_filter.alternative_filter_config(alternatives)[source]

Creates a config dict for alternative filter.

spinedb_api.filters.alternative_filter.alternative_filter_from_dict(db_map, config)[source]

Applies alternative filter to given database map.

Parameters:

spinedb_api.filters.alternative_filter.alternative_filter_config_to_shorthand(config)[source]

Makes a shorthand string from alternative filter configuration.

spinedb_api.filters.alternative_filter.alternative_names_from_dict(config)[source]

Returns alternatives’ names from filter config.

Parameters:: config (dict) – alternative filter configuration
Returns:: list of alternative names or None if config is not a valid alternative filter configuration
Return type:: list

spinedb_api.filters.alternative_filter.alternative_filter_shorthand_to_config(shorthand)[source]

Makes configuration dictionary out of a shorthand string.