sbsarmanager module

class sbsarchive.sbsarmanager.SBSARManager(aArchive)

Bases: object

Class SBSARManager to manipulate sbsar file. Must be used with the with statement.

Parameters:

aArchive – an sbsarchive.SBSArchive or absolute file path

addAllPresets(self, aGraphIdentifier, aPresetFilePath)

add all presets of a sbsprs file to a given graph

Parameters:

  • aGraphIdentifier – graph’s identifier

  • aPresetFilePath – file path of the sbsprs file

:return

addIcon(aGraphIdentifier, aIconPath, replaceIfExists=False)

Add an icon file to the sbsar for the given graph identifier

Parameters:

  • aGraphIdentifier – the graph identifier to which attach the icon

  • aIconPath – icon file path

  • replaceIfExists – if True the already existing icon will be replaced otherwise error will be raised

Returns:

applyExternalPreset(self, aGraphIdentifier, aPresetFilePath, aPresetName)

apply a new preset to a given graph from a sbsprs file

Parameters:

  • aGraphIdentifier – graph’s identifier

  • aPresetFilePath – file path of the sbsprs file

  • aPresetName – preset’s name

:return

applyInternalPreset(self, aGraphIdentifier, aPresetName)

apply an embedded preset of a given graph

Parameters:

  • aGraphIdentifier – graph’s identifier

  • aPresetName – preset’s name

Returns:

changeInputValueFromName(self, aGraphIdentifier, aInputIndentifier, aType, aValue)

change the value of input by using its identifier

Parameters:

  • aGraphIdentifier – graph’s identifier

  • aInputIdentifier – input’s identifier

  • aType – sbsarenum.SBSARTypeEnum

  • aValue – value of the new input

Returns:

deleteAllPresets(self, aGraphIdentifier)

delete all presets of a given graph

Parameters:

aGraphIdentifier – graph’s identifier

:return

deleteIcon(self, aGraphIdentifier)

delete the icon of a given graph

Parameters:

aGraphIdentifier – graph’s identifier

Returns:

exportAllPresets(self, aGraphIdentifier, aPresetFilePath)

export all presets of a given graph in a sbsprs file

Parameters:

  • aGraphIdentifier – graph’s identifier

  • aPresetFilePath – file path of the sbsprs file

Returns:

save()

Save the sbsar modification

Returns:

saveAllIcons(aOutputDir)

saveIcon(aGraphIdentifier, aOutputDir) extract icons of all graphes to the given output directory

Parameters:

aOutputDir – output directory path

Returns:

saveAs(aArchiveFilePath)

Save as the sbsar modification

Parameters:

aArchiveFilePath – a valid file path

Returns:

saveIcon(aGraphIdentifier, aOutputDir)

extract the graph’s icon to the given output directory

Parameters:

  • aGraphIdentifier – graph’s identifier

  • aOutputDir – output directory path

Returns:

class sbsarchive.sbsarmanager.SBSArchive

Bases: object