Allow trailing commas for files setting in mypy.ini and setup.ini
#18621
Conversation
|
Diff from mypy_primer, showing the effect of this PR on open source code: imagehash (https://github.com/JohannesBuchner/imagehash): 1.56x faster (39.4s -> 25.2s in a single noisy sample)
|
| @@ -126,7 +126,7 @@ def split_and_match_files(paths: str) -> list[str]: | |||
| Returns a list of file paths | |||
| """ | |||
|
|
|||
| return split_and_match_files_list(paths.split(",")) | |||
| return split_and_match_files_list(split_commas(paths)) | |||
There was a problem hiding this comment.
Maybe do the same for pyproject.toml? (Line 202 uses try_split and is equally prone to trailing comma)
There was a problem hiding this comment.
I tried this test:
[case testCmdlineCfgFilesTrailingComma]
# cmd: mypy
[file pyproject.toml]
\[tool.mypy]
files = [
"a.py",
"b.py",
]
[file a.py]
x: str = 'x' # ok
[file b.py]
y: int = 'y' # E: Incompatible types in assignment (expression has type "str", variable has type "int")
[file c.py]
# This should not trigger any errors, because it is not included:
z: int = 'z'
[out]and it passed on main. So, I don't think that this change is required.
There was a problem hiding this comment.
Nah, not exactly. This is perverse style, but...
[case testCmdlineCfgFilesTrailingComma]
# cmd: mypy
[file pyproject.toml]
\[tool.mypy]
files = """
a.py,
b.py,
"""
[file a.py]
x: str = 'x' # ok
[file b.py]
y: int = 'y' # E: Incompatible types in assignment (expression has type "str", variable has type "int")
[file c.py]
# This should not trigger any errors, because it is not included:
z: int = 'z'
[out]
(remove the trailing comma to make it pass)
There was a problem hiding this comment.
When lists are toml lists, commas are handled much earlier by the parser itself. But mypy seems to support ini-style comma-delimited lists as single strings as well. I don't know how useful that is, but let's keep commas treatment consistent?
There was a problem hiding this comment.
Ok, here's the thing. pyproject.toml uses try_split function which is regex based.
Looks like there are multiple settings that are affected.
Let's do it this way: since I cannot really change just one handler, I will merge this PR and create the next one with many tests based on try_split.
…i` (python#18621) Now ```ini files = a.py, b.py ``` and ```ini files = a.py, b.py, ``` will be the same thing. Previously, adding a traling comma would add `''` to `paths`, which resulted in a strange error like: ``` a.py: error: Duplicate module named "a" (also at "a.py") (diff) a.py: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#mapping-file-paths-to-modules for more info (diff) a.py: note: Common resolutions include: a) using `--exclude` to avoid checking one of them, b) adding `__init__.py` somewhere, c) using `--explicit-package-bases` or adjusting MYPYPATH (diff) ``` Refs python#14240 Refs python/cpython#129708
…roject.toml` (python#18624) Refs python#18621 Closes python#18623 With a lot more tests.
Now
files = a.py, b.pyand
files = a.py, b.py,will be the same thing.
Previously, adding a traling comma would add
''topaths, which resulted in a strange error like:Refs #14240
Refs python/cpython#129708