[Bugfix] Scope deprecated CLI argument warnings to the parser that defines them (#59917)
Signed-off-by: Tyler Ma <158780265+TylerMa-debugg@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -4,6 +4,7 @@
|
||||
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
from argparse import BooleanOptionalAction
|
||||
|
||||
import pytest
|
||||
@@ -252,6 +253,28 @@ def test_duplicate_dict_args(caplog_vllm, parser):
|
||||
assert "--optimization-level" in caplog_vllm.text
|
||||
|
||||
|
||||
@pytest.mark.skipif(
|
||||
sys.version_info >= (3, 13), reason="argparse handles deprecated natively"
|
||||
)
|
||||
def test_deprecated_arg_scoped_to_subcommand(caplog_vllm, disable_log_dedup):
|
||||
"""A deprecated arg of one subcommand must not warn for a sibling
|
||||
subcommand that defines a non-deprecated arg with the same dest."""
|
||||
parser = FlexibleArgumentParser()
|
||||
subparsers = parser.add_subparsers(dest="subcommand")
|
||||
run_batch = subparsers.add_parser("run-batch")
|
||||
run_batch.add_argument_group("Frontend").add_argument(
|
||||
"--url", default="0.0.0.0", deprecated=True
|
||||
)
|
||||
chat = subparsers.add_parser("chat")
|
||||
chat.add_argument("--url", default="http://localhost:8000/v1")
|
||||
|
||||
parser.parse_args(["chat", "--url", "http://localhost:9000/v1"])
|
||||
assert "is deprecated" not in caplog_vllm.text
|
||||
|
||||
parser.parse_args(["run-batch", "--url", "1.2.3.4"])
|
||||
assert caplog_vllm.text.count("argument 'url' is deprecated") == 1
|
||||
|
||||
|
||||
def test_model_specification(
|
||||
parser_with_config, cli_config_file, cli_config_file_with_model
|
||||
):
|
||||
|
||||
@@ -119,7 +119,6 @@ class SortedHelpFormatter(ArgumentDefaultsHelpFormatter, RawDescriptionHelpForma
|
||||
class FlexibleArgumentParser(ArgumentParser):
|
||||
"""ArgumentParser that allows both underscore and dash in names."""
|
||||
|
||||
_deprecated: set[Action] = set()
|
||||
_json_tip: str = (
|
||||
"When passing JSON CLI arguments, the following sets of arguments "
|
||||
"are equivalent:\n"
|
||||
@@ -132,6 +131,8 @@ class FlexibleArgumentParser(ArgumentParser):
|
||||
_search_keyword: str | None = None
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
# Must exist before super().__init__(), which already adds arguments.
|
||||
self._deprecated: set[Action] = set()
|
||||
# Set the default "formatter_class" to SortedHelpFormatter
|
||||
if "formatter_class" not in kwargs:
|
||||
kwargs["formatter_class"] = SortedHelpFormatter
|
||||
@@ -160,7 +161,7 @@ class FlexibleArgumentParser(ArgumentParser):
|
||||
|
||||
def parse_known_args(self, args=None, namespace=None):
|
||||
namespace, args = super().parse_known_args(args, namespace)
|
||||
for action in FlexibleArgumentParser._deprecated:
|
||||
for action in self._deprecated:
|
||||
if (
|
||||
hasattr(namespace, dest := action.dest)
|
||||
and getattr(namespace, dest) != action.default
|
||||
@@ -172,15 +173,19 @@ class FlexibleArgumentParser(ArgumentParser):
|
||||
deprecated = kwargs.pop("deprecated", False)
|
||||
action = super().add_argument(*args, **kwargs)
|
||||
if deprecated:
|
||||
FlexibleArgumentParser._deprecated.add(action)
|
||||
self._deprecated.add(action)
|
||||
return action
|
||||
|
||||
class _FlexibleArgumentGroup(_ArgumentGroup):
|
||||
def __init__(self, container, *args, **kwargs):
|
||||
super().__init__(container, *args, **kwargs)
|
||||
self._deprecated: set[Action] = container._deprecated
|
||||
|
||||
def add_argument(self, *args, **kwargs):
|
||||
deprecated = kwargs.pop("deprecated", False)
|
||||
action = super().add_argument(*args, **kwargs)
|
||||
if deprecated:
|
||||
FlexibleArgumentParser._deprecated.add(action)
|
||||
self._deprecated.add(action)
|
||||
return action
|
||||
|
||||
def add_argument_group(self, *args, **kwargs):
|
||||
|
||||
Reference in New Issue
Block a user