Making hub and spoke dict callback a function of the model module instead of a separate module #499
Conversation
This file contains 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
bknueven
reviewed
Mar 27, 2025
| @@ -367,10 +363,10 @@ def _do_decomp(module, cfg, scenario_creator, scenario_creator_kwargs, scenario_ | |||
| list_of_spoke_dict.append(reduced_costs_spoke) | |||
|
|
|||
| # if the user dares, let them mess with the hubdict prior to solve | |||
| if cfg.hub_and_spoke_dict_callback is not None: | |||
| module = sputils.module_name_to_module(cfg.hub_and_spoke_dict_callback) | |||
| if hasattr(module,'hub_and_spoke_dict_callback'): | |||
| module.hub_and_spoke_dict_callback(hub_dict, list_of_spoke_dict) | |||
There was a problem hiding this comment.
Related to this PR: should this callback also have cfg explicitly passed into it? E.g.,
Suggested change
| module.hub_and_spoke_dict_callback(hub_dict, list_of_spoke_dict) | |
| module.hub_and_spoke_dict_callback(hub_dict, list_of_spoke_dict, cfg) |
I guess with your comment there's a different way to get the config object from this function?
There was a problem hiding this comment.
I think passing it keeps it more general and perhaps easy to use, so I'm in favor of adding it :)
I use a class inside my model module, so when the class gets initialized I save what I need from cfg to self.some_attribute. Since my function is a method of that class, I am accessing what I need from cfg through that attribute. But having it explicitly passed is more flexible for non-class-oriented modules, so adding it makes sense to me.
bknueven
reviewed
Apr 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I think having the callback that does hub and spoke dict manipulation in
generic_cylinders.pyas a function within the model module is more convenient because that manipulation can be dependent on the value of the config optionscfg. The same could be achieved by just also passingcfgto the callback the way it is written now but in the case where the user defines a class within their model module, having the callback be a method of the class makescfg-dependent implementation straightforward.