fcsxml.FCSBaseObject

class fcsxml.FCSBaseObject[source]

FCSBaseObject is the Transmogrifier root object upon which all other classes extent. It provides basic error logging capabilities.

entityPath()[source]

This function will output the Final Cut Server absolute path for the loaded object.

Returns:(( str)) – the entity path (i.e. /asset/12).
Raises :fcsxml.FCSObjectLoadError
lastError()[source]

Returns last logged error.

Returns:(dict) – Log dict with keys: logMSG and logLevel
logger(logMSG, logLevel='normal', printClassInLog=None)[source]

Provides a basic Logging Function. Prints our message to standard out based upon our configured log level.

Parameters:
  • logMSG (str) – The log message
  • logLevel (str) – The logging level of the parameter (‘normal’,’debug’,’error’)
  • printClassInLog (bool) – Flag for whether we will print the class name in our logging output
Returns:

bool - Always returns True

Note

At some point we should probably migrate to msg module

logs(logLevel='')[source]

Returns a list of stored log entries.

Parameters:logLevel (str) – Limit returned log entries to those matching this log level.
Returns:((list)) – List of log entries, each entry is a dictionary with keys: logMSG and logLevel
printLogs(logLevel='all')

Prints all stored log entries.

Parameters:logLevel (str) – Specify a log level to limit output.

Previous topic

fcsxml

Next topic

fcsxml.FCSXMLField

This Page