Skip to content

feat: add --show-hidden-parameters CLI option for deadline bundle gui-submit#1042

Draft
epmog wants to merge 1 commit intoaws-deadline:mainlinefrom
epmog:show_hidden
Draft

feat: add --show-hidden-parameters CLI option for deadline bundle gui-submit#1042
epmog wants to merge 1 commit intoaws-deadline:mainlinefrom
epmog:show_hidden

Conversation

@epmog
Copy link
Copy Markdown
Contributor

@epmog epmog commented Mar 13, 2026

Note this is in draft until #1073 is merged so that we can add the cli-arg and config option at the same time without having an awful UX experience

What was the problem/requirement? (What/Why)

When crafting job bundles, it can be useful to create hidden job parameters to simplify the gui shown to the user by hiding values that they don't normally need to change. However, when debugging these bundles users need to be able to debug and potentially change these values. They want to see and be able to edit all job parameters without manually modifying the bundle on disk.

Additionally, there was a bug where the float spinner could lose precision from values in the template. QDoubleSpinBox defaults to 2 decimal places and truncates values on setValue() before any signals fire, so setValue(2.718) silently becomes 2.72.

What was the solution? (How)

Add a --show-hidden-paramaters CLI option to quickly allow users to display all the parameters!

deadline bundle gui-submit --show-hidden-parameters /path/to/bundle

We infer the UI control from the parameter type using following table since the paramater ui type is HIDDEN:

Parameter type Has allowedValues? Widget
STRING No LINE_EDIT
INT No SPIN_BOX (integer)
FLOAT No SPIN_BOX (float)
PATH (directory) No CHOOSE_DIRECTORY
PATH (file, input) No CHOOSE_INPUT_FILE
PATH (file, output) No CHOOSE_OUTPUT_FILE
Any type Yes DROPDOWN_LIST

Note: controls that require an explicit userInterface.control hint (like MULTILINE_EDIT or
CHECK_BOX) cannot be inferred. A revealed hidden STRING always becomes LINE_EDIT, not
MULTILINE_EDIT, because the HIDDEN control replaced whatever the author might have intended.

Future change will add a config option to allow usage within DCCs!

What is the impact of this change?

Users can now show previously hidden parameters and modify them in the submission dialog!

How was this change tested?

hatch run test
$ deadline bundle gui-submit --browse test/unit/deadline_client/ui/test_data/job_bundle_with_hidden_params --show-hidden-parameters
image

I also changed the values of the hidden parameters in the gui and confirmed that the submitted job had those updated values.

Was this change documented?

N/A

Does this PR introduce new dependencies?

N/A

Is this a breaking change?

N/A

Does this change impact security?

N/A

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@github-actions github-actions Bot added the waiting-on-maintainers Waiting on the maintainers to review. label Mar 13, 2026
@epmog epmog force-pushed the show_hidden branch 2 times, most recently from 1bc703c to 775f28e Compare March 14, 2026 00:00
Comment thread docs/design/gui-show-hidden-parameters.md Outdated
Comment thread src/deadline/client/ui/widgets/openjd_parameters_widget.py Outdated
@epmog epmog force-pushed the show_hidden branch 4 times, most recently from c31f1df to 8e279c4 Compare March 18, 2026 00:10
@epmog epmog marked this pull request as ready for review March 18, 2026 00:15
@epmog epmog requested a review from a team as a code owner March 18, 2026 00:15
…gui-submit`

Signed-off-by: Morgan Epp <60796713+epmog@users.noreply.github.com>
mwiebe
mwiebe previously approved these changes Mar 18, 2026
@sonarqubecloud
Copy link
Copy Markdown

@epmog epmog marked this pull request as draft March 25, 2026 19:05
@epmog epmog removed the waiting-on-maintainers Waiting on the maintainers to review. label Apr 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants