refactor: move routine outside of FortranObj class

Author: gnikit

fortls/helper_functions.py

@@ -586,6 +586,43 @@ def get_var_stack(line: str) -> list[str]:
         return None
 
 
+def get_placeholders(arg_list: list[str]) -> tuple[str, str]:
+    """
+    Function used to generate placeholders for snippets
+
+    Parameters
+    ----------
+    arg_list : list[str]
+        Method arguments list
+
+    Returns
+    -------
+    Tuple[str, str]
+        Tuple of arguments as a string and snippet string
+
+    Examples
+    --------
+    >>> get_placeholders(['x', 'y'])
+    ('(x, y)', '(${1:x}, ${2:y})')
+
+    >>> get_placeholders(['x=1', 'y=2'])
+    ('(x=1, y=2)', '(x=${1:1}, y=${2:2})')
+
+    >>> get_placeholders(['x', 'y=2', 'z'])
+    ('(x, y=2, z)', '(${1:x}, y=${2:2}, ${3:z})')
+    """
+    place_holders = []
+    for i, arg in enumerate(arg_list):
+        opt_split = arg.split("=")
+        if len(opt_split) > 1:
+            place_holders.append(f"{opt_split[0]}=${{{i+1}:{opt_split[1]}}}")
+        else:
+            place_holders.append(f"${{{i+1}:{arg}}}")
+    arg_str = f"({', '.join(arg_list)})"
+    arg_snip = f"({', '.join(place_holders)})"
+    return arg_str, arg_snip
+
+
 def fortran_md(code: str, docs: str | None):
     """Convert Fortran code to markdown
 

fortls/intrinsics.py

@@ -5,7 +5,7 @@
 import os
 import pathlib
 
-from fortls.helper_functions import fortran_md, map_keywords
+from fortls.helper_functions import fortran_md, get_placeholders, map_keywords
 from fortls.objects import (
     FortranAST,
     FortranObj,
@@ -67,7 +67,7 @@ def get_snippet(self, name_replace=None, drop_arg=-1):
             arg_snip = None
         else:
             arg_list = self.args.split(",")
-            arg_str, arg_snip = self.get_placeholders(arg_list)
+            arg_str, arg_snip = get_placeholders(arg_list)
         name = name_replace if name_replace is not None else self.name
         snippet = name + arg_snip if arg_snip is not None else None
         return name + arg_str, snippet

fortls/objects.py

@@ -32,6 +32,7 @@
     fortran_md,
     get_keywords,
     get_paren_substring,
+    get_placeholders,
     get_var_stack,
 )
 from fortls.json_templates import diagnostic_json, location_json, range_json
@@ -497,19 +498,6 @@ def get_desc(self):
     def get_snippet(self, name_replace=None, drop_arg=-1):
         return None, None
 
-    @staticmethod
-    def get_placeholders(arg_list: list[str]):
-        place_holders = []
-        for i, arg in enumerate(arg_list):
-            opt_split = arg.split("=")
-            if len(opt_split) > 1:
-                place_holders.append(f"{opt_split[0]}=${{{i+1}:{opt_split[1]}}}")
-            else:
-                place_holders.append(f"${{{i+1}:{arg}}}")
-        arg_str = f"({', '.join(arg_list)})"
-        arg_snip = f"({', '.join(place_holders)})"
-        return arg_str, arg_snip
-
     def get_documentation(self):
         return self.doc_str
 
@@ -1017,7 +1005,7 @@ def get_snippet(self, name_replace=None, drop_arg=-1):
             del arg_list[drop_arg]
         arg_snip = None
         if len(arg_list) > 0:
-            arg_str, arg_snip = self.get_placeholders(arg_list)
+            arg_str, arg_snip = get_placeholders(arg_list)
         else:
             arg_str = "()"
         name = name_replace if name_replace is not None else self.name