RunSettings Set Method #166
Merged
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
Closed
3 tasks
Spartee
suggested changes
Mar 8, 2022
Merge remote-tracking branch 'upstream/develop' into rs-set-arg
Spartee
suggested changes
Mar 8, 2022
smartsim/settings/base.py
Outdated
| rs = RunSettings("python") | ||
| rs.set("an-arg", "a-val") | ||
| rs.set("a-flag") | ||
| rs.run_args["an-arg"] # returns "a-val" |
There was a problem hiding this comment.
Ideally users shouldn't know that run_args exist now and solely use .set() if you want to show the arguments in the docstring then lets call a user facing method like RunSettings.format_run_args
There was a problem hiding this comment.
Does this mean that we should be moving run_args -> _run_args or is that considered out of scope for this PR?
There was a problem hiding this comment.
Leaving as is for now, fixed docstr in 4a10a76
smartsim/settings/base.py
Outdated
| """allows users to set individual run arguments. Does | ||
| basic formating such as stripping leading dashes. | ||
|
|
||
| This method also ensures that the argument being set |
There was a problem hiding this comment.
So we don't actually check that it IS valid. Lets just state that condition can be used to write scripts that will adapt under variables that can be changed at runtime. like, for example, the hostname one.
Spartee
approved these changes
Mar 10, 2022
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.
This PR implements a
RunSettings.setwhich is able to programmatically set run arguments:run_argsdictionary.RunSettingsare able to further restrict arguments that may conflict with SmartSim's process by providing their own restricted arguments.Looking for feedback and/or additional arguments that should be restricted in the subclasses.