From 49c6c0f2ec8fd7808c667600f70330b155bd55b7 Mon Sep 17 00:00:00 2001 From: Bob Swift Date: Fri, 7 Jan 2022 08:56:45 -0700 Subject: [PATCH] Remove underscore from clean_multi for consistency with other functions --- picard/script/functions.py | 6 +++--- test/test_script.py | 24 ++++++++++++------------ 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/picard/script/functions.py b/picard/script/functions.py index 93c3a4d10..94b1ad2af 100644 --- a/picard/script/functions.py +++ b/picard/script/functions.py @@ -1497,20 +1497,20 @@ def func_is_multi(parser, multi): @script_function(eval_args=True, documentation=N_( - """`$clean_multi(name)` + """`$cleanmulti(name)` Removes all empty string elements from the multi-value variable. Example: $$setmulti(test,one; ; two; three) - $clean_multi(%test%) + $cleanmulti(%test%) Result: Sets the value of 'test' to ["one", "two", "three"]. _Since Picard 2.8_""" )) -def func_clean_multi(parser, multi): +def func_cleanmulti(parser, multi): name = normalize_tagname(multi) values = [str(value) for value in parser.context.getall(name) if value or value == 0] parser.context[multi] = values diff --git a/test/test_script.py b/test/test_script.py index f72714360..6d9719d88 100644 --- a/test/test_script.py +++ b/test/test_script.py @@ -1786,7 +1786,7 @@ class ScriptParserTest(PicardTestCase): with self.assertRaisesRegex(ScriptError, areg): self.parser.eval("$is_multi(a,)") - def test_cmd_clean_multi(self): + def test_cmd_cleanmulti(self): context = Metadata() context["foo"] = ["", "one", "two"] context["bar"] = ["one", "", "two"] @@ -1797,9 +1797,9 @@ class ScriptParserTest(PicardTestCase): self.assertScriptResultEquals("%bar%", "one; ; two", context) self.assertScriptResultEquals("%baz%", "one; two; ", context) # Test cleaned values - self.assertScriptResultEquals("$clean_multi(foo)%foo%", "one; two", context) - self.assertScriptResultEquals("$clean_multi(bar)%bar%", "one; two", context) - self.assertScriptResultEquals("$clean_multi(baz)%baz%", "one; two", context) + self.assertScriptResultEquals("$cleanmulti(foo)%foo%", "one; two", context) + self.assertScriptResultEquals("$cleanmulti(bar)%bar%", "one; two", context) + self.assertScriptResultEquals("$cleanmulti(baz)%baz%", "one; two", context) # Text clean with only empty string elements context["foo"] = ["", "", ""] @@ -1807,7 +1807,7 @@ class ScriptParserTest(PicardTestCase): # Confirm initial values self.assertScriptResultEquals("%foo%", "; ; ", context) # Test cleaned values - self.assertScriptResultEquals("$clean_multi(foo)%foo%", "", context) + self.assertScriptResultEquals("$cleanmulti(foo)%foo%", "", context) # Test clean with indirect argument context["foo"] = ["", "one", "two"] @@ -1816,7 +1816,7 @@ class ScriptParserTest(PicardTestCase): # Confirm initial values self.assertScriptResultEquals("%foo%", "; one; two", context) # Test cleaned values - self.assertScriptResultEquals("$clean_multi(%bar%)%foo%", "one; two", context) + self.assertScriptResultEquals("$cleanmulti(%bar%)%foo%", "one; two", context) # Test clean with non-multi argument context["foo"] = "one" @@ -1828,13 +1828,13 @@ class ScriptParserTest(PicardTestCase): self.assertScriptResultEquals("%bar%", "one; ; two", context) self.assertScriptResultEquals("%baz%", "", context) # Test cleaned values - self.assertScriptResultEquals("$clean_multi(foo)%foo%", "one", context) - self.assertScriptResultEquals("$clean_multi(bar)%bar%", "one; ; two", context) - self.assertScriptResultEquals("$clean_multi(baz)%baz%", "", context) + self.assertScriptResultEquals("$cleanmulti(foo)%foo%", "one", context) + self.assertScriptResultEquals("$cleanmulti(bar)%bar%", "one; ; two", context) + self.assertScriptResultEquals("$cleanmulti(baz)%baz%", "", context) # Tests with invalid number of arguments - areg = r"^\d+:\d+:\$clean_multi: Wrong number of arguments for \$clean_multi: Expected exactly 1, " + areg = r"^\d+:\d+:\$cleanmulti: Wrong number of arguments for \$cleanmulti: Expected exactly 1, " with self.assertRaisesRegex(ScriptError, areg): - self.parser.eval("$clean_multi()") + self.parser.eval("$cleanmulti()") with self.assertRaisesRegex(ScriptError, areg): - self.parser.eval("$clean_multi(foo,)") + self.parser.eval("$cleanmulti(foo,)")