introduce environment_variable_groups to Step class #160
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
akx
requested changes
Feb 18, 2025
| @@ -38,6 +38,7 @@ def __init__( | |||
| outputs: Iterable[Any] = (), | |||
| mounts: Iterable[Mount] = (), | |||
| environment_variables: Iterable[EnvironmentVariable] = (), | |||
| environment_variable_groups: List[str] = [], | |||
There was a problem hiding this comment.
Suggested change
| environment_variable_groups: List[str] = [], | |
| environment_variable_groups: Iterable[str] = (), |
Having a list as the type is too restrictive, and especially having a list as the default argument leads to unintuitive behavior.
| @@ -68,6 +69,7 @@ def __init__( | |||
| EnvironmentVariable, | |||
| "name", | |||
| ) | |||
| self.environment_variable_groups = environment_variable_groups | |||
There was a problem hiding this comment.
Suggested change
| self.environment_variable_groups = environment_variable_groups | |
| self.environment_variable_groups = list(environment_variable_groups) |
The argument can be listified here. Calling list() ensures we take a copy of a list, or iterate an iterable into a new list.
Otherwise, doing
foo = []
s1 = Step(..., environment_variable_groups=foo)
s2 = Step(..., environment_variable_groups=foo)
foo.append("bar")would end up the EVGs for both steps being modified.
That said, we could do better still:
Suggested change
| self.environment_variable_groups = environment_variable_groups | |
| self.environment_variable_groups = [str(evg) for evg in environment_variable_groups if evg] |
This would implicitly filter out falsy values, and ensure everything else actually is str.
| @@ -85,6 +87,7 @@ def parse(cls, data: SerializedDict) -> "Step": | |||
| kwargs["stop_condition"] = kwargs.pop("stop-condition", None) | |||
| kwargs["upload_store"] = kwargs.pop("upload-store", None) | |||
| kwargs["resources"] = WorkloadResources.parse(kwargs.pop("resources", {})) | |||
| kwargs["environment_variable_groups"] = kwargs.pop("environment-variable-groups", None) | |||
There was a problem hiding this comment.
As currently is, None would not be a valid argument for Step(). An empty tuple would be.
Suggested change
| kwargs["environment_variable_groups"] = kwargs.pop("environment-variable-groups", None) | |
| kwargs["environment_variable_groups"] = kwargs.pop("environment-variable-groups", ()) |
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 want to make the environment_variable_groups setting accessible from the CLI and from the valohai yaml.
To achieve this, I have created a PR in valohai-cli as well (valohai-cli#323).
I could test my changes on valohai-cli and the local linting here on valohai-yaml, however, the API endpoint seems to validate with an older valohai-yaml version as well, causing an API validation error.