Return parameter values from the orderly.parameters call.
#49
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
Previously we would inject parameter values as global variables before the script starts executing. While this follows the behaviour of orderly2, it confuses a lot of Python tooling, including linters and type checkers. It also did not support executing orderly scripts outside of a packet context (eg. interactively). The `orderly.parameters` function now returns the parameter values as a dictionary, which we can get from the global context. When running outside of a packet context, it returns the parameters' default values.
plietar
force-pushed
the
mrc-5255-return-parameters
branch
from
fd63e8c
to
927fafa
Compare
richfitz
reviewed
May 7, 2024
| with open("result.txt", "w") as f: | ||
| f.write(f"a: {a}\nb: {b}\n") # type: ignore | ||
| f.write(f"a: {parameters['a']}\nb: {parameters['b']}\n") |
There was a problem hiding this comment.
Add some sugar to allow parameters.a perhaps?
That (or anything slightly more sophisticated than just using a dict for the storage) would also allow nicer error messages on near miss parameter usage, so that parameters['whatever'] or parameters.whatever might return an error that lists known parameters
There was a problem hiding this comment.
I've replaced it with a SimpleNamespace subclass, which has .foo lookup. The subclass is empty for now (other than the inherited init/eq/repr methods), but we can extend it in the future.
richfitz
approved these changes
May 10, 2024
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.
Previously we would inject parameter values as global variables before the script starts executing. While this follows the behaviour of orderly2, it confuses a lot of Python tooling, including linters and type checkers. It also did not support executing orderly scripts outside of a packet context (eg. interactively).
The
orderly.parametersfunction now returns the parameter values as a dictionary, which we can get from the global context. When running outside of a packet context, it returns the parameters' default values.