Added CLI support for Mypy Plugins #18104
Conversation
Signed-off-by: Dibri Nsofor <[email protected]>
Signed-off-by: Dibri Nsofor <[email protected]>
Signed-off-by: Dibri Nsofor <[email protected]>
Signed-off-by: Dibri Nsofor <[email protected]>
for more information, see https://pre-commit.ci
mypy/main.py
Outdated
| @@ -1008,6 +1008,12 @@ def add_invertible_flag( | |||
| title="Advanced options", description="Debug and customize mypy internals." | |||
| ) | |||
| internals_group.add_argument("--pdb", action="store_true", help="Invoke pdb on fatal error") | |||
| internals_group.add_argument( | |||
| "--plugins", | |||
| nargs="*", | |||
There was a problem hiding this comment.
Using nargs="*" might be problematic, since this swallows all of the following positional arguments. For example, the invocation
mypy --plugins my_plugin src/foo.pywill interpret both my_plugin and src/foo.py as arguments to plugins, and will error due to no targets being given.
Maybe a repeatable argument or a string argument with the same syntax as the config file would work better?
This comment has been minimized.
This comment has been minimized.
docs/source/command_line.rst
Outdated
| @@ -888,6 +888,11 @@ in developing or debugging mypy internals. | |||
| This flag will invoke the Python debugger when mypy encounters | |||
| a fatal error. | |||
|
|
|||
| .. option:: --plugins {MODULE|PLUGIN_FILE} ... | |||
There was a problem hiding this comment.
Consider matching this with argument's metavar so that the output of mypy --help looks the same.
Also, plugins is listed before pdb in the config file documentation, so it may be worth using the same order here for symmetry.
There was a problem hiding this comment.
The ordering seems to be consistent already
There was a problem hiding this comment.
Hmm, maybe I'm looking at a different page. The page I'm looking at is this one: https://mypy.readthedocs.io/en/stable/config_file.html#confval-plugins, which has plugins before pdb
There was a problem hiding this comment.
@brianschubert you're right, shouldn't the ordering from command_line.rst be preserved?
Signed-off-by: Dibri Nsofor <[email protected]>
…into plugins-from-cli
Signed-off-by: Dibri Nsofor <[email protected]>
for more information, see https://pre-commit.ci
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
Fixes #11667
(Explain how this PR changes mypy.)
Includes a command line argument (
--plugins), as a supplementary approach to supplying Mypy plugins.Not sure how to add tests for this, but have tested locally and extended the docs to highlight this change.