feat: add mypy plugin #384
Merged
+1,118
−586
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
hiro-o918
force-pushed
the
feature/mypy-plugin
branch
2 times, most recently
from
eb899cb
to
289286a
Compare
hiro-o918
commented
Jul 19, 2024
| redis_port = luigi.OptionalParameter(default=None, description='Task lock check is deactivated, when None.', significant=False) | ||
| redis_timeout = luigi.IntParameter(default=180, description='Redis lock will be released after `redis_timeout` seconds', significant=False) | ||
| redis_host: Optional[str] = luigi.OptionalParameter(default=None, description='Task lock check is deactivated, when None.', significant=False) | ||
| redis_port: Optional[int] = luigi.OptionalIntParameter( |
There was a problem hiding this comment.
redis_port should be int
hiro-o918
commented
Jul 19, 2024
| @@ -81,7 +81,8 @@ def _test_run_with_empty_data_frame(cmdline_args: List[str], test_run_params: te | |||
|
|
|||
| def try_to_run_test_for_empty_data_frame(cmdline_args: List[str]): | |||
| with CmdlineParser.global_instance(cmdline_args): | |||
| test_run_params = test_run() | |||
| # NOTE: parameters passed by command line cannot be linted by mypy. | |||
| test_run_params = test_run() # type: ignore | |||
There was a problem hiding this comment.
mypy-plugin cannot pass this case even though the parameters passed from cmdlin_args
hiro-o918
force-pushed
the
feature/mypy-plugin
branch
3 times, most recently
from
2b8ca03
to
40eed14
Compare
In order to mypy lint effectively
hiro-o918
force-pushed
the
feature/mypy-plugin
branch
from
40eed14
to
f5bf4e4
Compare
hiro-o918
commented
Jul 19, 2024
| @@ -0,0 +1,369 @@ | |||
| """Plugin that provides support for gokart.TaskOnKart. | |||
|
|
|||
| This Code reuses the code from mypy.plugins.dataclasses | |||
There was a problem hiding this comment.
This code quotes from mypy.plugins.dataclasses
| if 'gokart.task.luigi.Task' in fullname: | ||
| # gather attibutes from gokart.TaskOnKart | ||
| # the transformation does not affect because the class has `__init__` method | ||
| return self._task_on_kart_class_maker_callback |
There was a problem hiding this comment.
This is an entrypoint to transform a class to have a __init__ method with luigi. Parameters while type-checking for gokart.TaskOnKart class
|
|
||
| sym = self.lookup_fully_qualified(fullname) | ||
| if sym and isinstance(sym.node, TypeInfo): | ||
| if any(base.fullname == 'gokart.task.TaskOnKart' for base in sym.node.mro): |
There was a problem hiding this comment.
This is also an entrypoint for inheritance of gokart.TaskOnKart
| # then the object default __init__ with an empty signature will be present anyway. | ||
| if ('__init__' not in info.names or info.names['__init__'].plugin_generated) and attributes: | ||
| args = [attr.to_argument(info, of='__init__') for attr in attributes] | ||
| add_method_to_class(self._api, self._cls, '__init__', args=args, return_type=NoneType()) |
There was a problem hiding this comment.
This is a point which create a method __init__ to a class while type checking
hiro-o918
commented
Jul 19, 2024
test/test_mypy.py
Outdated
| test_file.write(test_code.encode('utf-8')) | ||
| test_file.flush() | ||
| result = api.run(['--config-file', str(PYPROJECT_TOML), test_file.name]) | ||
| self.assertIn('error: Missing named argument "bar" for "MyTask" [call-arg]', result[0]) |
There was a problem hiding this comment.
These are error messages for invalid arguments
hirosassa
approved these changes
Jul 20, 2024
| @@ -64,6 +64,7 @@ quote-style = "single" | |||
|
|
|||
| [tool.mypy] | |||
| ignore_missing_imports = true | |||
| plugins = ["gokart.mypy:plugin"] | |||
|
👍 |
kitagry
requested changes
Jul 20, 2024
kitagry
requested changes
Jul 21, 2024
hiro-o918
force-pushed
the
feature/mypy-plugin
branch
4 times, most recently
from
ded0be5
to
ec0013c
Compare
hiro-o918
force-pushed
the
feature/mypy-plugin
branch
from
ec0013c
to
08e2b74
Compare
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.
What
gokart.TaskOnKart