[bug fix] Flow decorator click option names fix #1775
Merged
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
valayDave
commented
Mar 27, 2024
metaflow/decorators.py
Outdated
| @@ -518,7 +518,7 @@ def _init_flow_decorators( | |||
| else: | |||
| # Each "non-multiple" flow decorator is only allowed to have one set of options | |||
| deco_flow_init_options = { | |||
| option: deco_options[option] for option in deco.options | |||
| option: deco_options[option.replace("-", "_")] for option in deco.options | |||
There was a problem hiding this comment.
- When we expose flow decorator options with a
-in the name, the code crashes at settingdeco_flow_init_optionswith a KeyError ondeco_options. Thedeco_optionsas passed down from Click which converts anyoptionwith-to_. - translating the
-to_ensures theoptioncan match the value indeco_optionsand doesn't result in KeyError. This is only the case when options contain- - Already present flow decorators will have no issues anyways since this only effects flow deco options that have a
-in the name (which currently none of them do). - This doesn't handle the case where option names have
_. But opens up creation of options with-'s.
- When we expose flow decorator options with a `-` in the name, the code crashes at setting `deco_flow_init_options` with a KeyError on `deco_options`. The `deco_options` as passed down from Click which converts any `option` with `-` to `_`. - translating the `-` to `_` ensures the `option` can match the value in `deco_options` and doesn't result in KeyError. This is only the case **when options contain `-`** - Already present flow decorators will have no issues anyways since this only effects flow deco options that have a `-` in the name (which currently none of them do). - This doesn't handle the case where option names have `_`. But opens up creation of options with `-`'s.
valayDave
force-pushed
the
valay/fix-deco-attr
branch
from
b964221 to
0229de8
Compare
valayDave
added a commit
to valayDave/metaflow
that referenced
this pull request
Mar 27, 2024
Linked to upstream : [Netflix#1775] - When we expose flow decorator options with a `-` in the name, the code crashes at setting `deco_flow_init_options` with a KeyError on `deco_options`. The `deco_options` as passed down from Click which converts any `option` with `-` to `_`. - translating the `-` to `_` ensures the `option` can match the value in `deco_options` and doesn't result in KeyError. This is only the case **when options contain `-`** - Already present flow decorators will have no issues anyways since this only effects flow deco options that have a `-` in the name (which currently none of them do). - This doesn't handle the case where option names have `_`. But opens up creation of options with `-`'s.
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.
-in the name, the code crashes at settingdeco_flow_init_optionswith a KeyError ondeco_options. Thedeco_optionsas passed down from Click which converts anyoptionwith-to_.-to_ensures theoptioncan match the value indeco_optionsand doesn't result in KeyError. This is only the case when options contain--in the name (which currently none of them do)._. But opens up creation of options with-'s.