Documentation for Substance Automation Toolkit is now included in the SAT package. You can access the documentation by opening html-doc.zip inside your downloaded SAT package.
output_handlers
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: |
|
|---|
dump(iostream)
Dump the output in an iostream
| Parameters: | iostream – |
|---|---|
| Returns: |
get_results()
output
return a list from the raw output data
| Returns: | dict |
|---|
print_stderr()
print_stdout()
stderr
stdout
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)
Bases: Exception
args
with_traceback()
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
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
| Parameters: |
|
|---|
dump(iostream)
Dump the output in an iostream
| Parameters: | iostream – |
|---|---|
| Returns: |
get_results()
Parse output data and return a correspondent objects list
| Returns: | list<SbsBakerInfoEntityStruct> |
|---|
output
return a list from the raw output data
| Returns: | dict |
|---|
print_stderr()
print_stdout()
stderr
stdout
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)
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
| Parameters: |
|
|---|
dump(iostream)
Dump the output in an iostream
| Parameters: | iostream – |
|---|---|
| Returns: |
get_results()
Parse output data and return a correspondent objects list
| Returns: | list<SbsRenderOutputHandlerGraphStruct > |
|---|
get_results_as_dict()
Parse output data and return a list of dict
| Returns: | list |
|---|
output
return a list from the raw output data
| Returns: | dict |
|---|
print_stderr()
print_stdout()
stderr
stdout
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)
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
| Parameters: |
|
|---|
dump(iostream)
Dump the output in an iostream
| Parameters: | iostream – |
|---|---|
| Returns: |
get_results()
Parse output data and return a correspondent objects list
| Returns: | list<SbsRenderOutputHandlerGraphStruct > |
|---|
get_results_as_dict()
Parse output data and return a list of dict
| Returns: | list |
|---|
output
return a list from the raw output data
| Returns: | dict |
|---|
print_stderr()
print_stdout()
stderr
stdout
wait()
only here for future retro compatibility, if we move OutputHandler as default return result and avoid error. :return:
