Merge pull request #1308 from linsword13/expander

Add expander support for string methods

Author: douglasjacobsen

lib/ramble/docs/workspace_config.rst

@@ -184,8 +184,6 @@ Supported functions are:
 * ``randint`` (from `random.randint`)
 * ``join_str(iterable, sep=",")`` (concatenate iterable into ``sep``-separated string)
 * ``re_search(regex, str)`` (determine if ``str`` contains pattern ``regex``, based on ``re.search``)
-* ``upper_str(str)`` (convert ``str`` to uppercase)
-* ``lower_str(str)`` (convert ``str`` to lowercase)
 * ``maybe(var_name, default="")`` (returns the expanded ``var_name`` if it is defined, otherwise returns ``default``)
 
 Besides the above listed, any functions from the ``math`` module can be used in Ramble by referencing ``math_<function_name>``.
@@ -195,6 +193,9 @@ String slicing is supported:
 
 * ``str[start:end:step]`` (string slicing)
 
+In addition to the listed, any string methods can be used by referencing ``str_<method_name>``.
+For example, ``str_upper(<str>)`` invokes the ``<str>.upper()`` method.
+
 Dictionary references are supported:
 
 * ``dict_name["key"]`` (dictionary subscript)

lib/ramble/ramble/expander.py

@@ -38,14 +38,6 @@ def _join_str(seq, sep=","):
     return sep.join(str(i) for i in seq)
 
 
-def _upper_str(in_str):
-    return in_str.upper()
-
-
-def _lower_str(in_str):
-    return in_str.lower()
-
-
 def _re_search(regex, s):
     return re.search(regex, s) is not None
 
@@ -128,8 +120,6 @@ def _maybe(expander, var_name, default=""):
     "simplify_str": spack.util.naming.simplify_name,
     "join_str": _join_str,
     "re_search": _re_search,
-    "upper_str": _upper_str,
-    "lower_str": _lower_str,
 }
 
 # Format Spec Regex:
@@ -976,7 +966,13 @@ def _eval_function_call(self, node):
             parts = node.func.id.split("_", 1)
             if len(parts) == 2:
                 module_name, func_name = parts
-                if module_name in supported_modules:
+                # Special handling for function calls prefixed with `str_`
+                if module_name == "str" and len(args) > 0:
+                    s = str(args[0])
+                    if hasattr(s, func_name) and callable(getattr(s, func_name)):
+                        s_method = getattr(s, func_name)
+                        return s_method(*args[1:], **kwargs)
+                elif module_name in supported_modules:
                     module = supported_modules[module_name]
                     if hasattr(module, func_name):
                         func = getattr(module, func_name)

lib/ramble/ramble/test/expander.py

@@ -146,8 +146,12 @@ def build_variant_set():
         ("math_sqrt(64)", "8.0", set(), 1),
         ("math_log(9, 3)", "2.0", set(), 1),
         ("math_not_exist(1)", "math_not_exist(1)", set(), 1),
-        ("upper_str('foo')", "FOO", set(), 1),
-        ("lower_str('FOO')", "foo", set(), 1),
+        ("str_upper('foo')", "FOO", set(), 1),
+        ("str_lower('FOO')", "foo", set(), 1),
+        ("str_capitalize('foo')", "Foo", set(), 1),
+        ("str_lstrip('AAAbbb', 'A')", "bbb", set(), 1),
+        ("str_join('.', str_split('a b c 1'))", "a.b.c.1", set(), 1),
+        ("str_no_such_method('a')", "str_no_such_method('a')", set(), 1),
     ],
 )
 def test_expansions(input, output, no_expand_vars, passes):