User Guide Cancel

output_handlers | Substance 3D Automation ToolKit

output_handlers

class batchtools.output_handlers.OutputProcessHandler(process, print_stdout=True, print_stderr=True)
class batchtools.output_handlers.OutputProcessHandler(process, print_stdout=True, print_stderr=True)
 class batchtools.output_handlers.OutputProcessHandler(process, print_stdout=True, print_stderr=True)  

Bases: object

Base class used by the different batchtool’s OutputHandler object. It wrapped a Popen process and handle the output stream. It stop python interpreter during the time it takes for the process to finish, in same way that Popen.wait() function. the OutputProcessHandler but manage the Popen process itself (return of batchtool command).

Parameters:
  • process (subprocess.Popen) – a Popen process, usually come from a batchtool call
  • print_stdout (bool) – print the stdout stream
  • print_stderr (bool) – print the stderr stream
dump(iostream)
dump(iostream)
 dump(iostream)  

Dump the output in an iostream

Parameters:iostream
Returns:
get_results()
get_results()
 get_results()  
output
output
 output  

return a list from the raw output data

Returns:dict
print_stderr()
print_stderr()
 print_stderr()  
print_stdout()
print_stdout()
 print_stdout()  
stderr
stderr
 stderr  
stdout
stdout
 stdout  
wait()
wait()
 wait()  

only here for future retro compatibility, if we move OutputHandler as default return result and avoid error. :return:

exception batchtools.output_handlers.OutputProcessHandlerPipeError(msg)
exception batchtools.output_handlers.OutputProcessHandlerPipeError(msg)
 exception batchtools.output_handlers.OutputProcessHandlerPipeError(msg)  

Bases: Exception

args
args
 args  
with_traceback()
with_traceback()
 with_traceback()  

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class batchtools.output_handlers.SbsBakerInfoOutputHandler(*args, **kwargs)
class batchtools.output_handlers.SbsBakerInfoOutputHandler(*args, **kwargs)
 class batchtools.output_handlers.SbsBakerInfoOutputHandler(*args, **kwargs)  

Bases: batchtools.output_handlers.OutputProcessHandler

SbsRenderOutputHandler handle the batchtools.sbsrender_render output. It can retrieve the different output data like a data formed list or a dedicated list for each graph data: SbsBakerInfoEntityStruct

Parameters:
  • args
  • kwargs
dump(iostream)
dump(iostream)
 dump(iostream)  

Dump the output in an iostream

Parameters:iostream
Returns:
get_results()
get_results()
 get_results()  

Parse output data and return a correspondent objects list

Returns:list<SbsBakerInfoEntityStruct>
output
output
 output  

return a list from the raw output data

Returns:dict
print_stderr()
print_stderr()
 print_stderr()  
print_stdout()
print_stdout()
 print_stdout()  
stderr
stderr
 stderr  
stdout
stdout
 stdout  
wait()
wait()
 wait()  

only here for future retro compatibility, if we move OutputHandler as default return result and avoid error. :return:

class batchtools.output_handlers.SbsRenderOutputHandler(*args, **kwargs)
class batchtools.output_handlers.SbsRenderOutputHandler(*args, **kwargs)
 class batchtools.output_handlers.SbsRenderOutputHandler(*args, **kwargs)  

Bases: batchtools.output_handlers.OutputProcessHandler

SbsRenderOutputHandler handle the batchtools.sbsrender_render output. It can retrieve the different output data like a data formed list or a dedicated list for each graph data: SbsRenderOutputHandlerGraphStruct

Parameters:
  • args
  • kwargs
dump(iostream)
dump(iostream)
 dump(iostream)  

Dump the output in an iostream

Parameters:iostream
Returns:
get_results()
get_results()
 get_results()  

Parse output data and return a correspondent objects list

Returns:list<SbsRenderOutputHandlerGraphStruct >
get_results_as_dict()
get_results_as_dict()
 get_results_as_dict()  

Parse output data and return a list of dict

Returns:list
output
output
 output  

return a list from the raw output data

Returns:dict
print_stderr()
print_stderr()
 print_stderr()  
print_stdout()
print_stdout()
 print_stdout()  
stderr
stderr
 stderr  
stdout
stdout
 stdout  
wait()
wait()
 wait()  

only here for future retro compatibility, if we move OutputHandler as default return result and avoid error. :return:

class batchtools.output_handlers.SpotColorInfoOutputHandler(*args, **kwargs)
class batchtools.output_handlers.SpotColorInfoOutputHandler(*args, **kwargs)
 class batchtools.output_handlers.SpotColorInfoOutputHandler(*args, **kwargs)  

Bases: batchtools.output_handlers.OutputProcessHandler

SbsRenderOutputHandler handle the batchtools.sbsrender_render output. It can retrieve the different output data like a data formed list or a dedicated list for each graph data: SbsRenderOutputHandlerGraphStruct

Parameters:
  • args
  • kwargs
dump(iostream)
dump(iostream)
 dump(iostream)  

Dump the output in an iostream

Parameters:iostream
Returns:
get_results()
get_results()
 get_results()  

Parse output data and return a correspondent objects list

Returns:list<SbsRenderOutputHandlerGraphStruct >
get_results_as_dict()
get_results_as_dict()
 get_results_as_dict()  

Parse output data and return a list of dict

Returns:list
output
output
 output  

return a list from the raw output data

Returns:dict
print_stderr()
print_stderr()
 print_stderr()  
print_stdout()
print_stdout()
 print_stdout()  
stderr
stderr
 stderr  
stdout
stdout
 stdout  
wait()
wait()
 wait()  

only here for future retro compatibility, if we move OutputHandler as default return result and avoid error. :return:

Get help faster and easier

New user?