Repository navigation
Allow per distribution mypy strictness options - #5169
Conversation
| # [mypy-tests] | ||
| # [mypy-tests.yaml] | ||
| # module_name = "yaml" | ||
| # [mypy-tests.yaml.values] |
There was a problem hiding this comment.
This needs to have module_name = "yaml.values", right?
There was a problem hiding this comment.
I don't believe so. You have the mypy-tests.yaml section and underneath it the module_name value and the values section.
| return | ||
|
|
||
| assert isinstance(mypy_tests_conf, dict), "mypy-tests should be a section" | ||
| for section_name, mypy_section in mypy_tests_conf.items(): |
There was a problem hiding this comment.
The section_name isn't actually used except in error messages. Could we use it instead of the module_name?
There was a problem hiding this comment.
The reason I put module_name in is because the module you use it for might not be a straight forward module or you might want to use a wildcard if you wanted the configuration to apply for several modules.
For example for protobuf, you can't put the section name as google.protobuf because the TOML heirarchy is dot based.
| "--config-file", config_file_name, | ||
| "--strict-optional", | ||
| "--no-site-packages", | ||
| "--show-traceback", |
There was a problem hiding this comment.
We could instead put all of these options in the config file too, because (unless I'm misremembering) options passed at the command line trump those in a config file. But it's also useful to pass them here, so that we have a minimum set of strictness options that all packages have to obey.
My vote is to leave this as is for now, and revisit it if we see a need for less strict options in some particular package.
| mypy_main("", sys.stdout, sys.stderr) | ||
| except SystemExit as err: | ||
| code = max(code, err.code) | ||
| finally: |
There was a problem hiding this comment.
Why not put all the code in the with NamedTemporaryFile block so you don't need to explicitly delete the file?
There was a problem hiding this comment.
Out of the tempfile python docs:
Whether the name can be used to open the file a second time, while the named temporary file is still open, varies across platforms (it can be so used on Unix; it cannot on Windows NT or later).
So the mypy process basically gets an empty file if you try to use it.
Good thing I develop on windows, or I'd never have guessed.
There was a problem hiding this comment.
I just stumbled onto https://bugs.python.org/issue14243 too, sounds painful.
JelleZijlstra
left a comment
JelleZijlstra
left a comment
There was a problem hiding this comment.
Thanks for the explanations!
2 participants
As requested by #1526.
This addition takes mypy configuration from each distribution metadata file and constructs a single mypy.ini to run with. It assumes there is no mypy.ini but in case we ever need one, it would be simple to add these on top of an existing configuration file.
Might be relevant for #2852
As the issue did not really specify how the configuration would look, I added the following:
You may add a mypy-tests section to the metadata file.
It looks like this:
[mypy-tests]
[mypy-tests.yaml]
module_name = "yaml"
[mypy-tests.yaml.values]
disallow_incomplete_defs = true
disallow_untyped_defs = true
module_name can be of the form "a.*" like in mypy.ini.
You can add several module sections for complex distributions with several modules.
I added the '--warn-incomplete-stub' option since it is made specifically for typeshed runs. See docs.