feat: add mypy plugin options to handle missing paramters for a task #428
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
hiro-o918
force-pushed
the
feature/missing-parameters
branch
from
6042033 to
b8d0720
Compare
hiro-o918
requested review from
hirosassa,
yokomotod,
Hi-king,
ikyasam18,
kitagry and
ujiuji1259
kitagry
requested changes
Feb 12, 2025
| module = ["pandas.*", "apscheduler.*", "dill.*", "boto3.*", "testfixtures.*", "luigi.*"] | ||
|
|
||
| [tool.gokart-mypy] | ||
| error_on_missing_parameters = true |
There was a problem hiding this comment.
I think this name is a little long. And the name of mypy is something like disallow- or ignore-. Therefore, I think disallow_missing_parameters is preferable. What do you think?
There was a problem hiding this comment.
updated the param name
gokart/mypy.py
Outdated
| config = cls._parse_toml(config_file) | ||
| gokart_plugin_config = config.get('tool', {}).get('gokart-mypy', {}) | ||
|
|
||
| error_on_missing_parameters = gokart_plugin_config.get('error_on_missing_parameters', False) |
There was a problem hiding this comment.
I think parameter name should be FINAL variable.
There was a problem hiding this comment.
I introduce Enum for parameters
hiro-o918
force-pushed
the
feature/missing-parameters
branch
4 times, most recently
from
857b40d to
f8432e7
Compare
kitagry
approved these changes
Mar 27, 2025
There was a problem hiding this comment.
@hiro-o918 Sorry for the late review. Could you add documentation?
hiro-o918
force-pushed
the
feature/missing-parameters
branch
from
9af5f47 to
ddf8e6a
Compare
|
Sorry for late response, I added docs |
hiro-o918
force-pushed
the
feature/missing-parameters
branch
from
ddf8e6a to
d89dcb3
Compare
|
Thank you!! |
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.
Background
In this discussion, I initially omitted handling errors for missing parameters in the task constructor because luigi.Config allows implicit parameters, making it difficult to validate them on linting
However, I occasionally forget to pass required parameters to tasks, leading to runtime errors when executing the pipeline.
What
This PR introduces an option for gokart mypy to raise an error when a task constructor is called without all required parameters.
Users can configure mypy to allow implicit parameter passing if needed in their project.