chore: add private _run_task_without_session_env function to the Session class #281
Conversation
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
godobyte
commented
Nov 5, 2025
src/openjd/sessions/_session.py
Outdated
Comment on lines
1142
to
1145
| if apply_existing_env: | ||
| for identifier in self._environments_entered: | ||
| if identifier in self._created_env_vars: | ||
| self._created_env_vars[identifier].apply_to_environment(result) |
Contributor
Author
There was a problem hiding this comment.
Alternatively, which is hack-y, but can potentially unblock.
Suggested change
| if apply_existing_env: | |
| for identifier in self._environments_entered: | |
| if identifier in self._created_env_vars: | |
| self._created_env_vars[identifier].apply_to_environment(result) | |
| if extra_env_vars.get("APPLY_EXISTING_ENV", "true").lower() != "false": | |
| for identifier in self._environments_entered: | |
| if identifier in self._created_env_vars: | |
| self._created_env_vars[identifier].apply_to_environment(result) |
Signed-off-by: Godot Bian <13778003+godobyte@users.noreply.github.com>
Signed-off-by: Godot Bian <13778003+godobyte@users.noreply.github.com>
godobyte
changed the title
leongdl
reviewed
Nov 6, 2025
src/openjd/sessions/_session.py
Outdated
| step_script: StepScriptModel, | ||
| task_parameter_values: TaskParameterSet, | ||
| os_env_vars: Optional[dict[str, str]] = None, | ||
| use_session_env_vars: Optional[bool] = True, |
Contributor
There was a problem hiding this comment.
Nit: Can we not have this variable and always have the code be true?
We don't want anyone else to consume this for any other reason. We want to directly jump to the better API and migrate.
Contributor
Author
There was a problem hiding this comment.
Sure, updated in a new commit.
leongdl
reviewed
Nov 6, 2025
src/openjd/sessions/_session.py
Outdated
| use_session_env_vars: Optional[bool] = True, | ||
| log_task_banner: bool = True, | ||
| ) -> None: | ||
| """Run a Task within the Session. |
Contributor
There was a problem hiding this comment.
nit - maybe just say private API since it is private and very short lived.
leongdl
reviewed
Nov 6, 2025
src/openjd/sessions/_session.py
Outdated
| if use_session_env_vars: | ||
| action_env_vars = self._evaluate_current_session_env_vars(os_env_vars) | ||
| else: | ||
| action_env_vars = dict[str, Optional[str]](self._process_env) # Make a copy |
Contributor
There was a problem hiding this comment.
Take away the if-else and always use line 898?
Contributor
Author
There was a problem hiding this comment.
You meant only after L899?
leongdl
reviewed
Nov 6, 2025
src/openjd/sessions/_session.py
Outdated
| # than after -- run() itself may end up setting the action state to FAILED. | ||
| self._runner.run() | ||
|
|
||
| def _run_task_with_optional_session_env( |
Contributor
There was a problem hiding this comment.
Checked that this is a copy-paste of https://github.com/OpenJobDescription/openjd-sessions-for-python/blob/mainline/src/openjd/sessions/_session.py#L779, with the new if-else.
godobyte
changed the title
Signed-off-by: Godot Bian <13778003+godobyte@users.noreply.github.com>
|
godobyte
changed the title
leongdl
approved these changes
Nov 6, 2025
mwiebe
approved these changes
Nov 6, 2025
lucaseck
added a commit
to lucaseck/openjd-sessions-for-python
that referenced
this pull request
Nov 7, 2025
…the Session class (OpenJobDescription#281)" This reverts commit bc7ac1a.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What was the problem/requirement? (What/Why)
The Session class needed a new method to run tasks with more granular control over environment variable handling. The existing
run_taskmethod always applies all entered environment variables, but there was a requirement to optionally exclude session environment variables while still allowing custom OS environment variables to be passed in.What was the solution? (How)
Added a new
_run_task_without_session_envmethod to the Session class that provides:run_taskbut with different environment variable controlThe implementation follows the same pattern as the existing
run_taskmethod but not applying env var from env enter.What is the impact of this change?
This change provides support for tasks need custom environment variables without session-level environment.
How was this change tested?
See DEVELOPMENT.md for information on running tests.
Was this change documented?
Is this a breaking change?
No
Does this change impact security?
No
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.