updating client to not have option to export to file, no longer supported by Singularity (tar stream/pipe only supported option)

Author: vsoch

docs/cli/run_singularity/README.md

@@ -136,13 +136,13 @@ Execute assumes that you want the output, and by default returns it.
 
 ## Export
 
-Here you can export an image. The default export_type="tar", pipe=False, and output_file = None. Not specifying an output file will produce file in a temporary directory:
+Here you can export an image. The default export_type="tar", and it must be a pipe.
 
 ```python
-tmptar = S.export(image_path=image)
+S.export(image_path=image)
 ```
 
-You might want an in memory tar to work with, and if this is the case, you want a function from the [reproduce.py](../../singularity/reproduce.py) module:
+This is going to pipe the image into your stdout, which you probably don't want to do. Instead, you might want an in memory tar to work with, and if this is the case, you want a function from the [reproduce.py](../../singularity/reproduce.py) module:
 
 ```python
 from singularity.reproduce import get_memory_tar

docs/cli/run_singularity/singularity_client.py

@@ -39,7 +39,7 @@
 S.help(command="exec")
 
 # export an image as a byte array
-byte_array = S.export(image,pipe=True)
+byte_array = S.export(image)
 
 # Get an in memory tar
 from singularity.reproduce import get_memory_tar

singularity/cli.py

@@ -172,11 +172,9 @@ def execute(self,image_path,command,writable=False,contain=False):
 
 
 
-    def export(self,image_path,pipe=False,output_file=None,export_format="tar"):
+    def export(self,image_path,export_format="tar"):
         '''export will export an image, sudo must be used.
         :param image_path: full path to image
-        :param pipe: export to pipe and not file (default, False)
-        :param output_file: if pipe=False, export tar to this file. If not specified, 
         will generate temporary directory.
         :param export_format: the export format (only tar currently supported)
         '''
@@ -186,31 +184,8 @@ def export(self,image_path,pipe=False,output_file=None,export_format="tar"):
             print("Currently only supported export format is tar.")
             return None
 
-        # If the user has specified export to pipe, we don't need a file
-        if pipe == True:
-            cmd.append(image_path)
-        else:
-            _,tmptar = tempfile.mkstemp(suffix=".%s" %export_format)
-            os.remove(tmptar)
-            cmd = cmd + ['-f',tmptar,image_path]
-            self.run_command(cmd,sudo=False)
-
-            # Was there an error?            
-            if not os.path.exists(tmptar):
-                print('Error generating image tar')
-                return None
-
-            # if user has specified output file, move it there, return path
-            if output_file is not None:
-                shutil.copyfile(tmptar,output_file)
-                return output_file
-            else:
-                return tmptar
-
-        # Otherwise, return output of pipe    
+        cmd.append(image_path)
         output = self.run_command(cmd,sudo=False)
-        if pipe is False:
-            self.println(output)        
         return output
 
 

singularity/reproduce.py

@@ -510,7 +510,7 @@ def get_memory_tar(image_path):
     cli = Singularity()
     if "pancakes" in os.environ:
         del os.environ['pancakes']
-    byte_array = cli.export(image_path,pipe=True)
+    byte_array = cli.export(image_path)
     file_object = io.BytesIO(byte_array)
     tar = tarfile.open(mode="r|*", fileobj=file_object)
     return (file_object,tar)