forked from python/mypy
-
Notifications
You must be signed in to change notification settings - Fork 0
Fix: Handle Trailing Commas and Empty Strings in File Paths #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
arvi18
wants to merge
3
commits into
master
Choose a base branch
from
clone-dev-11171
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -109,6 +109,9 @@ def split_and_match_files_list(paths: Sequence[str]) -> list[str]: | |
expanded_paths = [] | ||
|
||
for path in paths: | ||
if not path: | ||
continue | ||
|
||
path = expand_path(path.strip()) | ||
globbed_files = fileglob.glob(path, recursive=True) | ||
if globbed_files: | ||
|
@@ -318,6 +321,23 @@ def parse_config_file( | |
print(f"{file_read}: No [mypy] section in config file", file=stderr) | ||
else: | ||
section = parser["mypy"] | ||
|
||
if "files" in section: | ||
raw_files = section["files"].strip() | ||
files_split = [file.strip() for file in raw_files.split(",")] | ||
|
||
# Remove trailing empty entry if present | ||
if files_split and files_split[-1] == "": | ||
files_split.pop() | ||
|
||
# Raise an error if there are any remaining empty strings | ||
if "" in files_split: | ||
raise ValueError( | ||
"Invalid config: Empty filenames are not allowed except for trailing commas." | ||
) | ||
Comment on lines
+335
to
+337
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The error message could be more informative. Consider including details about why empty filenames are invalid, or suggesting how to correct the configuration (e.g., removing the extra commas). raise ValueError(
"Invalid config: Empty filenames are not allowed. Please ensure all file entries are valid."
) |
||
|
||
options.files = files_split | ||
|
||
prefix = f"{file_read}: [mypy]: " | ||
updates, report_dirs = parse_section( | ||
prefix, options, set_strict_flags, section, config_types, stderr | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,168 @@ | ||
import os | ||
import tempfile | ||
from unittest import TestCase, main | ||
|
||
from mypy.config_parser import parse_config_file | ||
from mypy.options import Options | ||
|
||
|
||
class TestConfigParser(TestCase): | ||
def test_parse_config_file_with_single_file(self) -> None: | ||
"""A single file should be correctly parsed.""" | ||
with tempfile.TemporaryDirectory() as tmpdirname: | ||
config_path = os.path.join(tmpdirname, "test_config.ini") | ||
|
||
with open(config_path, "w") as f: | ||
f.write( | ||
""" | ||
[mypy] | ||
files = file1.py | ||
""" | ||
) | ||
|
||
options = Options() | ||
|
||
parse_config_file(options, lambda: None, config_path, stdout=None, stderr=None) | ||
|
||
self.assertEqual(options.files, ["file1.py"]) | ||
|
||
def test_parse_config_file_with_no_spaces(self) -> None: | ||
"""Files listed without spaces should be correctly parsed.""" | ||
with tempfile.TemporaryDirectory() as tmpdirname: | ||
config_path = os.path.join(tmpdirname, "test_config.ini") | ||
|
||
with open(config_path, "w") as f: | ||
f.write( | ||
""" | ||
[mypy] | ||
files =file1.py,file2.py,file3.py | ||
""" | ||
) | ||
|
||
options = Options() | ||
|
||
parse_config_file(options, lambda: None, config_path, stdout=None, stderr=None) | ||
|
||
self.assertEqual(options.files, ["file1.py", "file2.py", "file3.py"]) | ||
|
||
def test_parse_config_file_with_extra_spaces(self) -> None: | ||
"""Files with extra spaces should be correctly parsed.""" | ||
with tempfile.TemporaryDirectory() as tmpdirname: | ||
config_path = os.path.join(tmpdirname, "test_config.ini") | ||
|
||
with open(config_path, "w") as f: | ||
f.write( | ||
""" | ||
[mypy] | ||
files = file1.py , file2.py , file3.py | ||
""" | ||
) | ||
|
||
options = Options() | ||
|
||
parse_config_file(options, lambda: None, config_path, stdout=None, stderr=None) | ||
|
||
self.assertEqual(options.files, ["file1.py", "file2.py", "file3.py"]) | ||
|
||
def test_parse_config_file_with_empty_files_key(self) -> None: | ||
"""An empty files key should result in an empty list.""" | ||
with tempfile.TemporaryDirectory() as tmpdirname: | ||
config_path = os.path.join(tmpdirname, "test_config.ini") | ||
|
||
with open(config_path, "w") as f: | ||
f.write( | ||
""" | ||
[mypy] | ||
files = | ||
""" | ||
) | ||
|
||
options = Options() | ||
|
||
parse_config_file(options, lambda: None, config_path, stdout=None, stderr=None) | ||
|
||
self.assertEqual(options.files, []) | ||
|
||
def test_parse_config_file_with_only_comma(self) -> None: | ||
"""A files key with only a comma should raise an error.""" | ||
with tempfile.TemporaryDirectory() as tmpdirname: | ||
config_path = os.path.join(tmpdirname, "test_config.ini") | ||
|
||
with open(config_path, "w") as f: | ||
f.write( | ||
""" | ||
[mypy] | ||
files = , | ||
""" | ||
) | ||
|
||
options = Options() | ||
|
||
with self.assertRaises(ValueError) as cm: | ||
parse_config_file(options, lambda: None, config_path, stdout=None, stderr=None) | ||
|
||
self.assertIn("Invalid config", str(cm.exception)) | ||
|
||
def test_parse_config_file_with_only_whitespace(self) -> None: | ||
"""A files key with only whitespace should result in an empty list.""" | ||
with tempfile.TemporaryDirectory() as tmpdirname: | ||
config_path = os.path.join(tmpdirname, "test_config.ini") | ||
|
||
with open(config_path, "w") as f: | ||
f.write( | ||
""" | ||
[mypy] | ||
files = | ||
""" | ||
) | ||
|
||
options = Options() | ||
|
||
parse_config_file(options, lambda: None, config_path, stdout=None, stderr=None) | ||
|
||
self.assertEqual(options.files, []) | ||
|
||
def test_parse_config_file_with_mixed_valid_and_invalid_entries(self) -> None: | ||
"""Mix of valid and invalid filenames should raise an error.""" | ||
with tempfile.TemporaryDirectory() as tmpdirname: | ||
config_path = os.path.join(tmpdirname, "test_config.ini") | ||
|
||
with open(config_path, "w") as f: | ||
f.write( | ||
""" | ||
[mypy] | ||
files = file1.py, , , file2.py | ||
""" | ||
) | ||
|
||
options = Options() | ||
|
||
with self.assertRaises(ValueError) as cm: | ||
parse_config_file(options, lambda: None, config_path, stdout=None, stderr=None) | ||
|
||
self.assertIn("Invalid config", str(cm.exception)) | ||
|
||
def test_parse_config_file_with_newlines_between_files(self) -> None: | ||
"""Newlines between file entries should be correctly handled.""" | ||
with tempfile.TemporaryDirectory() as tmpdirname: | ||
config_path = os.path.join(tmpdirname, "test_config.ini") | ||
|
||
with open(config_path, "w") as f: | ||
f.write( | ||
""" | ||
[mypy] | ||
files = file1.py, | ||
file2.py, | ||
file3.py | ||
""" | ||
) | ||
|
||
options = Options() | ||
|
||
parse_config_file(options, lambda: None, config_path, stdout=None, stderr=None) | ||
|
||
self.assertEqual(options.files, ["file1.py", "file2.py", "file3.py"]) | ||
|
||
|
||
if __name__ == "__main__": | ||
main() |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This check removes the trailing empty string, but the subsequent check on line 334 raises an error if any empty strings are present. Consider simplifying this logic to directly raise an error if any empty strings are present after stripping whitespace, as trailing commas are now explicitly allowed.