Optional parameter #2295
Merged
Optional parameter #2295
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
4a14a7e to
60f85ca
Compare
This allows a parameter to be a string or None. None is serialized as an empty string, and empty strings parse as None. This is useful for luigi.Config classes where we want a None value for some parameters and don't want warnings about the type being wrong.
This will reduce warnings in the scheduler. It should be safe unless there are cases where the empty string needs to be distinguished from None. That doesn't seem to be the case anywhere here.
60f85ca to
f9aef13
Compare
dlstadther
approved these changes
Dec 10, 2017
|
Forgot to update this, but I've been using this in production about 2 weeks now and it works fine. |
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.
Description
Create an OptionalParameter class that serializes None as the empty string and use this class whenever we have a parameter with default None. Empty string gets parsed to None.
Motivation and Context
I get a long series of type warnings from default None values in the Luigi codebase whenever I run my pipeline. This gets rid of those, and should be safe as long as no one needs to differentiate between the empty string and None.
Have you tested this? If so, how?
I added some unit tests for the OptionalParameter class. I haven't tried running a pipeline with it yet, but I will soon.