diff --git a/dvc/commands/experiments/run.py b/dvc/commands/experiments/run.py index 090cae313..0b10660c3 100644 --- a/dvc/commands/experiments/run.py +++ b/dvc/commands/experiments/run.py @@ -106,3 +106,8 @@ def _add_run_common(parser): default=None, help="Custom commit message to use when committing the experiment.", ) + parser.add_argument( + "-M", # obsolete + dest="message", + help=argparse.SUPPRESS, + ) diff --git a/dvc/commands/experiments/save.py b/dvc/commands/experiments/save.py index 36e00f4a9..4769ef207 100644 --- a/dvc/commands/experiments/save.py +++ b/dvc/commands/experiments/save.py @@ -78,4 +78,9 @@ def add_parser(experiments_subparsers, parent_parser): default=None, help="Custom commit message to use when committing the experiment.", ) + save_parser.add_argument( + "-M", # obsolete + dest="message", + help=argparse.SUPPRESS, + ) save_parser.set_defaults(func=CmdExperimentsSave) diff --git a/tests/unit/command/test_experiments.py b/tests/unit/command/test_experiments.py index d862b8dc9..d9a6eeb6b 100644 --- a/tests/unit/command/test_experiments.py +++ b/tests/unit/command/test_experiments.py @@ -150,6 +150,27 @@ def test_experiments_run(dvc, scm, mocker): cmd.repo.experiments.run.assert_called_with(**default_arguments) +@pytest.mark.parametrize("flag", ["-m", "-M", "--message"]) +def test_experiments_run_message(dvc, scm, mocker, flag): + default_arguments = { + "params": [], + "name": None, + "queue": False, + "run_all": False, + "jobs": 1, + "tmp_dir": False, + "copy_paths": [], + "message": "mymessage", + } + default_arguments.update(repro_arguments) + + cmd = CmdExperimentsRun(parse_args(["exp", "run", flag, "mymessage"])) + mocker.patch.object(cmd.repo, "reproduce") + mocker.patch.object(cmd.repo.experiments, "run") + cmd.run() + cmd.repo.experiments.run.assert_called_with(**default_arguments) + + def test_experiments_branch(dvc, scm, mocker): m = mocker.patch("dvc.repo.experiments.branch.branch", return_value={}) @@ -479,8 +500,9 @@ def test_experiments_save(dvc, scm, mocker): ) -def test_experiments_save_message(dvc, scm, mocker): - cli_args = parse_args(["exp", "save", "-m", "custom commit message"]) +@pytest.mark.parametrize("flag", ["-m", "-M", "--message"]) +def test_experiments_save_message(dvc, scm, mocker, flag): + cli_args = parse_args(["exp", "save", flag, "custom commit message"]) assert cli_args.func == CmdExperimentsSave cmd = cli_args.func(cli_args)