feat: SDK - pipeline run parameters - dynamic choices (HEXA-1620)#385
Merged
Conversation
…-dynamic-choices Conflicts: openhexa/sdk/pipelines/parameter/__init__.py openhexa/sdk/pipelines/parameter/decorator.py
yolanfery
approved these changes
May 13, 2026
yolanfery
left a comment
yolanfery
left a comment
Contributor
There was a problem hiding this comment.
Very very tricky one, but it looks good to me, well done
Cool tests as well 👌
No comment, just a comment related to the backend : I feel like the SDK shouldn't parse the file format but should delegate that to the backend based on extension and/or content. This would simplify interfaces
Comment on lines
+126
to
+132
| def test_decorator_with_string_shorthand(self): | ||
| @parameter(code="district", type=str, choices="districts.csv") | ||
| def my_pipeline(district): | ||
| pass | ||
|
|
||
| params = my_pipeline.get_all_parameters() | ||
| assert isinstance(params[0].choices, ChoicesFromFile) |
mrivar
changed the title
mrivar
changed the title
mrivar
commented
May 14, 2026
| dependencies = [ | ||
| "urllib3<3", | ||
| "multiprocess~=0.70.15", | ||
| "requests>=2.31,<2.34", |
Contributor
Author
There was a problem hiding this comment.
Changed because we were getting an error on conda build:
https://github.com/BLSQ/openhexa-sdk-python/actions/runs/25662804662/job/75327513034
conda-forge recently published requests 2.34.1, which didn't exist when the previous pin was written
Conflicts: openhexa/sdk/pipelines/parameter/__init__.py openhexa/sdk/pipelines/parameter/decorator.py pyproject.toml
Merged
bramj
added a commit
that referenced
this pull request
Jun 12, 2026
This is a bug in the SDK's CLI upload path. Root cause The server's GraphQL ParameterInput type expects the field name choicesFromFile (camelCase). The SDK was sending choices_from_file (snake_case), so the server rejected it — exactly what the error said: "Field 'choices_from_file' is not defined by type 'ParameterInput'. Did you mean 'choicesFromFile'?" Why it only broke now: upload_pipeline (in openhexa/cli/api.py) passes Parameter.to_dict() straight through as the GraphQL input. Every previous parameter field was a single word (code, type, name, required, multiple, directory…), so snake_case and camelCase happened to be identical. choices_from_file, added in the recent dynamic-choices feature (#385), is the first multi-word field — so it's the first mismatch. Fix I added a small boundary serializer that renames the key only when sending to GraphQL, in openhexa/cli/api.py. I deliberately left Parameter.to_dict() untouched — it keeps snake_case as its internal spec convention (the AST-construction code and ~22 tests in tests/test_choices.py rely on that), so the camelCase concern lives only where it belongs: the GraphQL call. Verification - Executed the helper: ChoicesFromFile("regions.csv", column="code") now serializes to {"choicesFromFile": {"format": None, "path": "regions.csv", "column": "code"}}, snake key gone, nested values intact. Parameters without dynamic choices don't get the key. - to_dict() still returns snake_case (internal convention preserved). - tests/test_choices.py → 22 passed; tests/test_cli.py (upload/pipeline/parameter) → 18 passed; ruff check clean. One side note: the SDK's bundled schema (openhexa/graphql/schema.generated.graphql) doesn't yet contain the choicesFromFile field at all — it lags the server. That doesn't block the push (validation is server-side), but it's worth refreshing the bundled schema in a follow-up so the SDK's breaking-change detection stays accurate. Re-run openhexa pipelines push and it should import cleanly now.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Related PRs:
Lets pipeline parameters load their valid choices from a file at runtime, rather than requiring a hardcoded list.
Changes
ChoicesFromFile("path/to/file.csv")descriptor — supports CSV, JSON, YAMLchoices="districts.csv"is equivalent to the explicit form@parameterdecorator and are parsed correctly from pipeline source files (AST round-trip)parameter.pyinto aparameter/package (types, decorator, widgets, choices — each in their own file)How/what to test
@parameter("district", type=str, choices="districts.csv")and check that the platform renders a dynamic dropdown populated from that filechoices=["UG", "KE"]) still work as beforepytest tests/test_choices.py