Add scenario_recipes module to help building scenarios

CHANGELOG.md

@@ -17,6 +17,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   Note, that the semantics of metadata imports have changed, see the Changed section below.
 - Added missing `export_metadata()`, `export_entity_metadata()` and `export_parameter_value_metadata()` functions
   to `export_functions` module.
+- A new experimental module `spinedb_api.scenario_recipes` contains functions to support complex scenario generation
+  from sets of alternatives.
 
 ### Changed
 

spinedb_api/filters/alternative_filter.py

@@ -21,8 +21,6 @@
 from ..exception import SpineDBAPIError
 from .query_utils import filter_by_active_elements
 
-__all__ = ("alternative_filter_config",)
-
 ALTERNATIVE_FILTER_TYPE = "alternative_filter"
 ALTERNATIVE_FILTER_SHORTHAND_TAG = "alternatives"
 
@@ -31,6 +29,8 @@ def apply_alternative_filter_to_parameter_value_sq(db_map, alternatives):
     """
     Replaces parameter value subquery properties in ``db_map`` such that they return only values of given alternatives.
 
+    :meta private:
+
     Args:
         db_map (DatabaseMapping): a database map to alter
         alternatives (Iterable of str or int, optional): alternative names or ids;
@@ -69,6 +69,8 @@ def alternative_filter_from_dict(db_map, config):
     """
     Applies alternative filter to given database map.
 
+    :meta private:
+
     Args:
         db_map (DatabaseMapping): target database map
         config (dict): alternative filter configuration
@@ -80,6 +82,8 @@ def alternative_filter_config_to_shorthand(config):
     """
     Makes a shorthand string from alternative filter configuration.
 
+    :meta private:
+
     Args:
         config (dict): alternative filter configuration
 
@@ -96,6 +100,8 @@ def alternative_names_from_dict(config):
     """
     Returns alternatives' names from filter config.
 
+    :meta private:
+
     Args:
         config (dict): alternative filter configuration
 
@@ -111,6 +117,8 @@ def alternative_filter_shorthand_to_config(shorthand):
     """
     Makes configuration dictionary out of a shorthand string.
 
+    :meta private:
+
     Args:
         shorthand (str): a shorthand string
 

spinedb_api/filters/renamer.py

@@ -17,8 +17,6 @@
 from functools import partial
 from sqlalchemy import case
 
-__all__ = ("entity_class_renamer_config", "parameter_renamer_config")
-
 ENTITY_CLASS_RENAMER_TYPE = "entity_class_renamer"
 ENTITY_CLASS_RENAMER_SHORTHAND_TAG = "entity_class_rename"
 PARAMETER_RENAMER_TYPE = "parameter_renamer"
@@ -29,6 +27,8 @@ def apply_renaming_to_entity_class_sq(db_map, name_map):
     """
     Applies renaming to entity class subquery.
 
+    :meta private:
+
     Args:
         db_map (DatabaseMapping): a database map
         name_map (dict): a map from old name to new name
@@ -55,6 +55,8 @@ def entity_class_renamer_from_dict(db_map, config):
     """
     Applies entity class renamer manipulator to given database map.
 
+    :meta private:
+
     Args:
         db_map (DatabaseMapping): target database map
         config (dict): renamer configuration
@@ -66,6 +68,8 @@ def entity_class_renamer_config_to_shorthand(config):
     """
     Makes a shorthand string from renamer configuration.
 
+    :meta private:
+
     Args:
         config (dict): renamer configuration
 
@@ -82,6 +86,8 @@ def entity_class_renamer_shorthand_to_config(shorthand):
     """
     Makes configuration dictionary out of a shorthand string.
 
+    :meta private:
+
     Args:
         shorthand (str): a shorthand string
 
@@ -99,6 +105,8 @@ def apply_renaming_to_parameter_definition_sq(db_map, name_map):
     """
     Applies renaming to parameter definition subquery.
 
+    :meta private:
+
     Args:
         db_map (DatabaseMapping): a database map
         name_map (dict): a map from old name to new name
@@ -124,6 +132,8 @@ def parameter_renamer_from_dict(db_map, config):
     """
     Applies parameter renamer manipulator to given database map.
 
+    :meta private:
+
     Args:
         db_map (DatabaseMapping): target database map
         config (dict): renamer configuration
@@ -135,6 +145,8 @@ def parameter_renamer_config_to_shorthand(config):
     """
     Makes a shorthand string from renamer configuration.
 
+    :meta private:
+
     Args:
         config (dict): renamer configuration
 
@@ -152,6 +164,8 @@ def parameter_renamer_shorthand_to_config(shorthand):
     """
     Makes configuration dictionary out of a shorthand string.
 
+    :meta private:
+
     Args:
         shorthand (str): a shorthand string
 

spinedb_api/filters/scenario_filter.py

@@ -9,16 +9,14 @@
 # Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
 # this program. If not, see <http://www.gnu.org/licenses/>.
 ######################################################################################################################
-""" This module provides the scenario filter. """
+"""This module provides the scenario filter."""
 
 from functools import partial
 from sqlalchemy import and_, case, desc, func, or_
 from sqlalchemy.sql.expression import label
 from ..exception import SpineDBAPIError
 from .query_utils import filter_by_active_elements
 
-__all__ = ("scenario_filter_config",)
-
 SCENARIO_FILTER_TYPE = "scenario_filter"
 SCENARIO_SHORTHAND_TAG = "scenario"
 
@@ -27,6 +25,8 @@ def apply_scenario_filter_to_subqueries(db_map, scenario):
     """
     Replaces affected subqueries in ``db_map`` such that they return only values of given scenario.
 
+    :meta private:
+
     Args:
         db_map (DatabaseMapping): a database map to alter
         scenario (str or int): scenario name or id
@@ -65,6 +65,8 @@ def scenario_filter_from_dict(db_map, config):
     """
     Applies scenario filter to given database map.
 
+    :meta private:
+
     Args:
         db_map (DatabaseMapping): target database map
         config (dict): scenario filter configuration
@@ -76,6 +78,8 @@ def scenario_name_from_dict(config):
     """
     Returns scenario's name from filter config.
 
+    :meta private:
+
     Args:
         config (dict): scenario filter configuration
 
@@ -91,6 +95,8 @@ def scenario_filter_config_to_shorthand(config):
     """
     Makes a shorthand string from scenario filter configuration.
 
+    :meta private:
+
     Args:
         config (dict): scenario filter configuration
 
@@ -104,6 +110,8 @@ def scenario_filter_shorthand_to_config(shorthand):
     """
     Makes configuration dictionary out of a shorthand string.
 
+    :meta private:
+
     Args:
         shorthand (str): a shorthand string
 

spinedb_api/filters/value_transformer.py

@@ -31,13 +31,13 @@
 VALUE_TRANSFORMER_TYPE = "value_transformer"
 VALUE_TRANSFORMER_SHORTHAND_TAG = "value_transform"
 
-__all__ = ("value_transformer_config",)
-
 
 def apply_value_transform_to_parameter_value_sq(db_map, instructions):
     """
     Applies renaming to parameter definition subquery.
 
+    :meta private:
+
     Args:
         db_map (DatabaseMapping): a database map
         instructions (dict): mapping from entity class name to mapping from parameter name to list of
@@ -73,6 +73,8 @@ def value_transformer_from_dict(db_map, config):
     """
     Applies value transformer manipulator to given database map.
 
+    :meta private:
+
     Args:
         db_map (DatabaseMapping): target database map
         config (dict): transformer configuration
@@ -84,6 +86,8 @@ def value_transformer_config_to_shorthand(config):
     """
     Makes a shorthand string from transformer configuration.
 
+    :meta private:
+
     Args:
         config (dict): transformer configuration
 
@@ -113,6 +117,8 @@ def value_transformer_shorthand_to_config(shorthand):
     Args:
         shorthand (str): a shorthand string
 
+    :meta private:
+
     Returns:
         dict: value transformer configuration
     """