Skip to content

Disallow abbreviated command-line options #5469

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

Merged
merged 1 commit into from
Jun 25, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions changelog/1149.removal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Pytest no longer accepts prefixes of command-line arguments, for example
typing ``pytest --doctest-mod`` inplace of ``--doctest-modules``.
This was previously allowed where the ``ArgumentParser`` thought it was unambiguous,
but this could be incorrect due to delayed parsing of options for plugins.
See for example issues `#1149 <https://github.com/pytest-dev/pytest/issues/1149>`__,
`#3413 <https://github.com/pytest-dev/pytest/issues/3413>`__, and
`#4009 <https://github.com/pytest-dev/pytest/issues/4009>`__.
2 changes: 1 addition & 1 deletion extra/get_issues.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ def report(issues):
if __name__ == "__main__":
import argparse

parser = argparse.ArgumentParser("process bitbucket issues")
parser = argparse.ArgumentParser("process bitbucket issues", allow_abbrev=False)
parser.add_argument(
"--refresh", action="store_true", help="invalidate cache, refresh issues"
)
Expand Down
2 changes: 1 addition & 1 deletion scripts/release.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def changelog(version, write_out=False):

def main():
init(autoreset=True)
parser = argparse.ArgumentParser()
parser = argparse.ArgumentParser(allow_abbrev=False)
parser.add_argument("version", help="Release version")
options = parser.parse_args()
pre_release(options.version)
Expand Down
39 changes: 39 additions & 0 deletions src/_pytest/config/argparsing.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import argparse
import sys
import warnings
from gettext import gettext

import py

Expand Down Expand Up @@ -328,6 +330,7 @@ def __init__(self, parser, extra_info=None, prog=None):
usage=parser._usage,
add_help=False,
formatter_class=DropShorterLongHelpFormatter,
allow_abbrev=False,
)
# extra_info is a dict of (param -> value) to display if there's
# an usage error to provide more contextual information to the user
Expand Down Expand Up @@ -355,6 +358,42 @@ def parse_args(self, args=None, namespace=None):
getattr(args, FILE_OR_DIR).extend(argv)
return args

if sys.version_info[:2] < (3, 8): # pragma: no cover
# Backport of https://github.com/python/cpython/pull/14316 so we can
# disable long --argument abbreviations without breaking short flags.
def _parse_optional(self, arg_string):
if not arg_string:
return None
if not arg_string[0] in self.prefix_chars:
return None
if arg_string in self._option_string_actions:
action = self._option_string_actions[arg_string]
return action, arg_string, None
if len(arg_string) == 1:
return None
if "=" in arg_string:
option_string, explicit_arg = arg_string.split("=", 1)
if option_string in self._option_string_actions:
action = self._option_string_actions[option_string]
return action, option_string, explicit_arg
if self.allow_abbrev or not arg_string.startswith("--"):
option_tuples = self._get_option_tuples(arg_string)
if len(option_tuples) > 1:
msg = gettext(
"ambiguous option: %(option)s could match %(matches)s"
)
options = ", ".join(option for _, option, _ in option_tuples)
self.error(msg % {"option": arg_string, "matches": options})
elif len(option_tuples) == 1:
option_tuple, = option_tuples
return option_tuple
if self._negative_number_matcher.match(arg_string):
if not self._has_negative_number_optionals:
return None
if " " in arg_string:
return None
return None, arg_string, None


class DropShorterLongHelpFormatter(argparse.HelpFormatter):
"""shorten help for long options that differ only in extra hyphens
Expand Down
2 changes: 1 addition & 1 deletion testing/acceptance_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -984,7 +984,7 @@ def test_zipimport_hook(testdir, tmpdir):
"app/foo.py": """
import pytest
def main():
pytest.main(['--pyarg', 'foo'])
pytest.main(['--pyargs', 'foo'])
"""
}
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
HERE = pathlib.Path(__file__).parent
TEST_CONTENT = (HERE / "template_test.py").read_bytes()

parser = argparse.ArgumentParser()
parser = argparse.ArgumentParser(allow_abbrev=False)
parser.add_argument("numbers", nargs="*", type=int)


Expand Down
2 changes: 1 addition & 1 deletion testing/test_capture.py
Original file line number Diff line number Diff line change
Expand Up @@ -735,7 +735,7 @@ def test_func():
assert 0
"""
)
result = testdir.runpytest("--cap=fd")
result = testdir.runpytest("--capture=fd")
result.stdout.fnmatch_lines(
"""
*def test_func*
Expand Down
8 changes: 3 additions & 5 deletions testing/test_parseopt.py
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ def defaultget(option):

def test_drop_short_helper(self):
parser = argparse.ArgumentParser(
formatter_class=parseopt.DropShorterLongHelpFormatter
formatter_class=parseopt.DropShorterLongHelpFormatter, allow_abbrev=False
)
parser.add_argument(
"-t", "--twoword", "--duo", "--two-word", "--two", help="foo"
Expand Down Expand Up @@ -239,10 +239,8 @@ def test_drop_short_0(self, parser):
parser.addoption("--funcarg", "--func-arg", action="store_true")
parser.addoption("--abc-def", "--abc-def", action="store_true")
parser.addoption("--klm-hij", action="store_true")
args = parser.parse(["--funcarg", "--k"])
assert args.funcarg is True
assert args.abc_def is False
assert args.klm_hij is True
with pytest.raises(UsageError):
parser.parse(["--funcarg", "--k"])

def test_drop_short_2(self, parser):
parser.addoption("--func-arg", "--doit", action="store_true")
Expand Down
2 changes: 1 addition & 1 deletion testing/test_pastebin.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def test_skip():
pytest.skip("")
"""
)
reprec = testdir.inline_run(testpath, "--paste=failed")
reprec = testdir.inline_run(testpath, "--pastebin=failed")
assert len(pastebinlist) == 1
s = pastebinlist[0]
assert s.find("def test_fail") != -1
Expand Down