PySbs batchtools module

The PySbs batchtools module allows you to call the different command line tools like ordinary python commands.

batchtools module batchtools api reference.

The batchtools module wraps subprocess.Popen and makes it possible to use different command options as native arguments in python. The common structure of a batchtool is:

{toolName}_{toolCommand}(an_input_file, bool_flag=True, string_flag="a value", int_flag=1, list_flag=["a value", "other value"], ...)

# I.E
# a batchtool commandline conversion:
# sbsbaker ambient-occlusion-from-mesh /a/path/to/a/mesh/foo_low.fbx --output-size 8,8 --highdef-mesh a/path/to/a/mesh/foo_hi.fbx --output-name baked_name
# PySBS version :
proc = sbsbaker_ambient_occlusion_from_mesh("/a/path/to/a/mesh/foo_low.fbx", output_size=(8, 8),
                                            highdef_mesh="/a/path/to/a/mesh/foo_hi.fbx", output_name="baked_name")
proc.wait() # wait the end of the process

It is important to call .wait() on the returned process handle before using any output data from the command.

ref-to-demobatchtools Examples which demonstrates an automated pipeline using a mesh with udims.

batchtool’s OutputHandlers

For some batchtools it can be an advantage to retrieve information from the output of the process. As instance batchtools.sbsbaker_info output is very useful to retrieve mesh information like udims or color id but the process management and the information parsing may become painful. That’s why SAT introduced some OutputHandlers to handle this for you. An OutputHandler become the result of a bachtools call instead of a Popen object. The OutputHandler digests the process and its output to give an usable object depend of the batchtool.


# call a sbsbaker_info with the kwarg output_handler=True to get an OutputHandler instead of Popen
# the OutputHandler will stop the interpreter during the batchtool process exactly like Popen.wait()
out = batchtools.sbsbaker_info('foo.fbx', output_handler=True)
# <pysbs.batchtools.output_handlers.SbsBakerInfoOutputHandler object at 0x7f8808fe1c50>
# to get the result use get_results, an OutputHandler's common method
results = out.get_results()
# [<pysbs.batchtools.sbsbaker_info_handlers.SbsBakerInfoEntityStruct object at 0x7f7757881c10>, <pysbs.batchtools.sbsbaker_info_handlers.SbsBakerInfoEntityStruct object at 0x7f7757881e10>]
# SbsBakerInfoOutputHandler.get_results() return a list of SbsBakerInfoEntityStruct. Follow the doc to get more details of SbsBakerInfoEntityStruct
# as mush as possible each member type is converted in a python type.
for entity in results:
    # some examples of its different members
    for mesh in entity.meshes:
        for uv in mesh.uvs:
        for subpart in mesh.submeshes:
# it become easy to retrieve all the udims or uv tiles:
all_udims = set([udim for entity in results for mesh in entity.meshes for uv in mesh.uvs for udim in uv.udim_tiles])

# an other OutputHandler common method is dump() to write the output in a stream IO (file)
with open("dumped_file.ext", 'w') as f:

More details on the different OutputHandlers and it’s associated objects :

SbsRenderOutputHandler output_handlers module

SbsRenderGraphStruct sbsrender_render_handlers module

SbsBakerInfoOutputHandler output_handlers module

SbsBakerInfoEntityStruct sbsbaker_info_handlers module

render animation sequence

As part of batchtools there is also sbsrender_render_animate function that allows you to render an image sequence. sbsrender_render_animate renders an image sequence from an sbsar input using sbsrender. It takes a start frame, an end frame and frames per second. The sbsrender command line tool will be called once for each frame.

By default the $time parameter will be generated for each frame based on start, end and fps. It is also possible to set pass in other sbsrender parameters globally.

To animate other parameters than $time sbsrender_render_animate has the animated_parameters argument . This argument allow to pass a list of pairs of parameter names and functions taking frame and fps as parameters allowing you to generate them over the image sequence.

More details about the different arguments on the api reference page batchtools module


                                        ("input", lambda frame, fps: frame / fps)],

This example renders 51 frames with a frame rate of 24. Note that the output_name value has a sequence padding looking like ### to specify the frame name in the filename. In this example the animated_parameters is used to tweak the input parameter over time using a lambda function taking the two arguments frame and fps

command_only option

Sometimes it could be great to only query the command line without execute it. As instance all the batchtools commands could be “starting” on the user local machine but not executed instead all the commands are written in a file that will be executed later by a renderfarm. Simple example:

from pysbs import batchtools
cmds = []
cmds.append(batchtools.sbscooker("", output_path="/output", command_only=True))
cmds.append(batchtools.sbsrender_render("/output/foo.sbsar", output_path="/output", command_only=True))
with open("/output/batchcommands.txt", "w") as f:

Generate thumbnails

Generate thumbnails with SAT Thumbnail creation with SAT