Mergin

Author: BlankCanvasStudio

README.md

@@ -295,7 +295,7 @@ The file unroll.py can be called from the CLI passing a --file argument to speci
 
 **strip_cmd(nodes)** - Strips all the commands executed from a series of bash nodes in order. No replacement occurs, it simply returns the raw commands.
 
-**advanced_unroll(nodes, var_list={}, fn_dict={}, alias_table={})** - This function strips the commands executed by the series of bash nodes after resolving and command aliasing, function calls, and variable substitutions. 
+**advanced_unroll(nodes, var_list={}, fn_dict={}, alias_table={}, strip_cmds=True)** - This function resolves command aliasing, function calls, and variable substitutions in a series of bash nodes, replacing as it progresses. The strip_cmds boolean can be toggeled to return only the commands executed or the replaced nodes. 
 
 
 

bashparser.egg-info/PKG-INFO

@@ -1,6 +1,10 @@
 Metadata-Version: 2.1
 Name: bashparser
+<<<<<<< HEAD
 Version: 0.7
+=======
+Version: 0.9
+>>>>>>> e84f9a27b9e8926d8a4e1e4ab18e3651161dae4d
 Summary: A framework for manipulating and analysing bash scripts
 Home-page: https://github.com/BlankCanvasStudio/bashparse
 Author: Spencer Stingley

bashparser/ast.py

@@ -20,7 +20,7 @@ def __init__(self, root):
         self.no_children = {'operator', 'reservedword', 'pipe', 'parameter', 'tilde', 'heredoc'}
         self.parts_children = {'list', 'pipeline', 'if', 'for', 'while', 'until', 'command', 'function', 'word', 'assignment'}
         self.command_children = {'commandsubstitution', 'processsubstitution'}
-        self.passable_nodes = {'command', 'list', 'compound', 'for', 'parameter', 'function', 'pipeline', 'if'}
+        self.passable_nodes = {'command', 'list', 'for', 'parameter', 'function', 'pipeline', 'if', 'while'}
         self.list_children = {}
         self.contains_variable_text = {'word', 'assignment'}
 
@@ -38,27 +38,46 @@ def apply_fn(node):
             if node.kind in self.passable_nodes: return CONT
             elif node.kind == 'operator': word = node.op
             elif node.kind == 'pipe': word = node.pipe
+            elif node.kind == 'redirect': 
+                if type(node.input) == bashlex.ast.node:
+                    word += str(NodeVisitor(node.input))
+                elif node.input is not None: 
+                    word += str(node.input)
+                word += str(node.type)
+                if type(node.output) == bashlex.ast.node:
+                    word += str(NodeVisitor(node.output))
+                elif node.output is not None:
+                    word += str(node.output)
+                self._string = self._string + ' ' + word
+                return DONT_DESCEND
+            elif node.kind == 'compound':
+                for part in node.list:
+                    word += ' ' + str(NodeVisitor(part))
+                if hasattr(node, 'redirects'):
+                    for part in node.redirects:
+                        word += ' ' + str(NodeVisitor(part))
+                self._string = self._string + ' ' + word
+                return DONT_DESCEND
             elif node.kind == 'commandsubstitution': 
                 word = '$('
                 cmd = node.command
                 for part in cmd.parts:
                     word += str(NodeVisitor(part)) + ' '
                 word = word[:-1] + ')'
-                self._string = self._string + word + ' '
+                self._string = self._string + ' ' + word
                 return DONT_DESCEND
 
             elif hasattr(node, 'word'): 
                 word = node.word
-                self._string = self._string + word + ' '
+                self._string = self._string + ' ' + word
                 return DONT_DESCEND 
             else: 
-                print('node: ', node.dump())
                 raise ValueError('Error! Unsupported node kind encountered when converting NodeVisitor to string: ', node.kind)
-            self._string = self._string + word + ' '
+            self._string = self._string + ' ' + word
             return CONT
 
         self.apply(apply_fn)
-        return self._string[:-1]     # remove trailing space cause wrong
+        return self._string.strip() # remove surrounding spaces cause wrong
 
 
     def __type__(self):
@@ -235,8 +254,10 @@ def children(self, root = None):
         elif k == 'redirect':
             if isinstance(root.output, bashlex.ast.node):
                 return [ root.output ]
-            if root.heredoc:
+            elif root.heredoc:
                 return [ root.heredoc[child_num] ]
+            else:
+                return []
         elif hasattr(root, 'list'):
             return root.list
         else:

bashparser/generalize.py

@@ -40,9 +40,7 @@ def parameter_tracking_generalization(generalize_nodes, params_used = {}, param_
 
     for node in generalize_nodes:
         if node.kind == 'word':
-            print('here1')
             if node.word not in params_used: 
-                print('here2')
                 params_used[node.word] = str(param_num) 
                 param_num += 1
             node.word = '%' + params_used[node.word]
@@ -58,9 +56,7 @@ def parameter_tracking_generalization(generalize_nodes, params_used = {}, param_
                     node.parts[0].word = "%d=%" + str(params_used[value_assigned])
                 for i in range(1, len(node.parts)):
                     if hasattr(node.parts[i], 'word'):
-                        print('here3')
                         if node.parts[i].word not in params_used: 
-                            print('here4')
                             params_used[node.parts[i].word] = str(param_num) 
                             param_num += 1
                         node.parts[i].word = '%' + str(params_used[node.parts[i].word])

bashparser/test/test_ast.py

@@ -38,9 +38,14 @@ def test_str(self):
 		rebuilt_commands = str(NodeVisitor(nodes[0]))
 		expected_result = "for a in $n do wget that ; cd there ; mv here ; a=b ; done"
 		self.assertTrue(rebuilt_commands == expected_result)
-
 		self.assertTrue(str(NodeVisitor(None)) == '')
-
+		"""
+		node_string = 'history -n >/dev/null 2>&1'
+		node = bashlex.parse(node_string)[0]
+		rebuilt_command = str(NodeVisitor(node))
+		expected_result = 'history -n >/dev/null 2>&1'
+		self.assertTrue(rebuilt_command == expected_result)
+		"""
 
 	def test_apply(self):
 		# Build ast to test apply on

bashparser/test/test_variable.py

@@ -114,7 +114,7 @@ def test_update_variable_list(self):
         self.assertTrue({'a':['3']} == new_var_list)
         node = bashparser.parse('a=4')[0]
         new_var_list = update_variable_list(node, new_var_list)
-        self.assertTrue({'a':['3', '4']} == new_var_list)
+        self.assertTrue({'a':['4']} == new_var_list)
 
 
     def test_update_var_list_with_for_loop(self):

bashparser/unroll.py

@@ -32,7 +32,7 @@ def apply_fn(node, vstr):
 	return unrolled_commands
 
 
-def advanced_unroll(nodes, var_list={}, fn_dict={}, alias_table={}):
+def advanced_unroll(nodes, var_list={}, fn_dict={}, alias_table={}, strip_cmds=True):
 	# The ordering of this function is important. Tread lightly
 
 	nodes = bashparser.build_and_resolve_aliasing(nodes, alias_table)
@@ -41,9 +41,13 @@ def advanced_unroll(nodes, var_list={}, fn_dict={}, alias_table={}):
 
 	nodes = bashparser.substitute_variables(nodes, var_list)
 
-	commands = strip_cmd(nodes)
+	if strip_cmds:
+		ret_val = strip_cmd(nodes)
+	else:
+		ret_val = nodes
+
+	return ret_val
 
-	return commands
 
 def main():
 	import argparse

bashparser/variables.py

@@ -161,7 +161,7 @@ def apply_fn(node, var_list):
         """ We need to treat a variable and for loop seperately because a string in a for loop is actually an array """
         if node.kind == 'assignment':
             name, value = node.word.split('=', maxsplit=1)
-            var_list = add_variable_to_list(var_list, name, value)
+            var_list = add_variable_to_list(var_list, name, value, append=False)
         elif node.kind == 'for':
             var_list = update_var_list_with_for_loop(node, var_list)
         return CONT
@@ -170,7 +170,7 @@ def apply_fn(node, var_list):
     return var_list
 
 
-def add_variable_to_list(var_list, name, values): 
+def add_variable_to_list(var_list, name, values, append=True): 
     """ (variable dict, name, value) Adds the corresponding name and value to dictionary. If name exists in 
         the dictionary, the value is added. Prevents bugs with use of the var_list """
 
@@ -182,7 +182,7 @@ def add_variable_to_list(var_list, name, values):
     for i, val in enumerate(values):
         if type(val) is not str and type(val) is not bashlex.ast.node: values[i] = str(val)    
 
-    if name in var_list:
+    if name in var_list and append:
         for val in values:
             if val not in var_list[name]:
                 var_list[name] += [ val ]

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = bashparser
-version = 0.8
+version = 0.14
 author = Spencer Stingley
 description = A framework for manipulating and analysing bash scripts
 long_description = A framework for manipulating and analysing bash scripts

setup.py

@@ -7,7 +7,7 @@
 
 setuptools.setup(
     name="bashparser",
-    version="0.8",
+    version="0.14",
     author="Spencer Stingley",
     author_email="[email protected]",
     description="A framework for manipulating and analysing bash scripts",