From 37a4a36dc739798309e82c49eb1261b30e3ddfaf Mon Sep 17 00:00:00 2001 From: Matt Seddon Date: Mon, 9 Oct 2023 19:27:29 +1100 Subject: [PATCH] exp save: use -m for --message short option --- dvc/commands/experiments/exec_run.py | 2 +- dvc/commands/experiments/save.py | 2 +- tests/unit/command/test_experiments.py | 18 ++++++++++++++++++ 3 files changed, 20 insertions(+), 2 deletions(-) diff --git a/dvc/commands/experiments/exec_run.py b/dvc/commands/experiments/exec_run.py index 9131ea374..cbb111fc1 100644 --- a/dvc/commands/experiments/exec_run.py +++ b/dvc/commands/experiments/exec_run.py @@ -49,7 +49,7 @@ def add_parser(experiments_subparsers, parent_parser): ), ) exec_run_parser.add_argument( - "-M", + "-m", "--message", type=str, default=None, diff --git a/dvc/commands/experiments/save.py b/dvc/commands/experiments/save.py index d81f1579b..36e00f4a9 100644 --- a/dvc/commands/experiments/save.py +++ b/dvc/commands/experiments/save.py @@ -72,7 +72,7 @@ def add_parser(experiments_subparsers, parent_parser): metavar="", ) save_parser.add_argument( - "-M", + "-m", "--message", type=str, default=None, diff --git a/tests/unit/command/test_experiments.py b/tests/unit/command/test_experiments.py index 1fb1d52c1..d862b8dc9 100644 --- a/tests/unit/command/test_experiments.py +++ b/tests/unit/command/test_experiments.py @@ -479,6 +479,24 @@ 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"]) + assert cli_args.func == CmdExperimentsSave + + cmd = cli_args.func(cli_args) + m = mocker.patch("dvc.repo.experiments.save.save", return_value="acabb") + + assert cmd.run() == 0 + + m.assert_called_once_with( + cmd.repo, + name=None, + force=False, + include_untracked=[], + message="custom commit message", + ) + + def test_experiments_clean(dvc, scm, mocker): cli_args = parse_args(["experiments", "clean"]) assert cli_args.func == CmdExperimentsClean