Add scenario_recipes module to help building scenarios#612
Merged
Conversation
The module provides a few functions that make it easier to create new scenarios with scenario alternatives or modify existing ones. Re spine-tools/Spine-Toolbox#1480
These lists were a workaround to prevent API documentation of functions that perhaps are not that useful for users. It is better to add ':meta private:' to docstrings to achieve the same effect as __all__ actually affects how imports are treated. For example, my IDE was complaining that code outside of spinedb_api was importing stuff that was not listed in __all__ although those functions are part of spinedb_api's public API.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #612 +/- ##
==========================================
+ Coverage 85.98% 86.03% +0.05%
==========================================
Files 82 83 +1
Lines 11171 11204 +33
Branches 1621 1627 +6
==========================================
+ Hits 9605 9639 +34
+ Misses 1211 1210 -1
Partials 355 355 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds an experimental
scenario_recipesmodule that contains some utility functions that may be useful for scenario generation in scripts. The module is the result of my exploration on what kind of functionality might be needed to implement more useful scenario recipes for Spine Toolbox.Re spine-tools/Spine-Toolbox#1480
Checklist before merging