Class Hierarchy

• SocketServer.BaseRequestHandler: Base class for request handler classes.
  • qb.backend.pythonChildHandler.PFXRequestHandler
  • SocketServer.StreamRequestHandler: Define self.rfile and self.wfile for stream sockets.
    • qb.remoteMessaging.RemoteMessagingStreamRequestHandler: Handler for a streaming logging request.
• SocketServer.BaseServer: Base class for server classes.
  • SocketServer.TCPServer: Base class for various socket-based server classes.
    • qb.backend.pythonChildHandler.PFXSimpleSocketServer: Listens for output from PFXSimpleClient on the same host, usually running in another python interpreter inside a 3rd-party application such as Maya.
    • SocketServer.ThreadingTCPServer
      • qb.remoteMessaging.RemoteMessagingReceiver: A simple TCP socket-based logging receiver.
• SocketServer.ThreadingMixIn: Mix-in class to handle each request in a new thread.
  • SocketServer.ThreadingTCPServer
    • qb.remoteMessaging.RemoteMessagingReceiver: A simple TCP socket-based logging receiver.
• object: The most base type
  • exceptions.BaseException: Common base class for all exceptions
    • exceptions.Exception: Common base class for all non-exit exceptions.
      • qb.backend.QubeBackEndError: An exception class used to indicate an error condition specfic to a Qube jobtype backend
        • qb.backend.appDefaultPaths.AppVersionNotFoundError
      • qb.frontend.QubeJobError: Base class for all exceptions raised by any of the Qube job frontends
      • qb.utils.exceptions.QubeUtilityGeneralError: An exception class used to indicate an error condition not handled by the qb.utils package.
      • qb.remoteMessaging.RemoteMessagingError
  • commandHandlers.CommandHandler: Some applications have different ways to start or be called, depending on either OS or application version; this base class defines the default behavior.
    • commandHandlers.Cinema4DCommandHandler: On Windows, ensure that the slashes face the right way, and escape any ctrl-characters
    • commandHandlers.MayaBatchCommandHandler: On OS X, source the MayaEnv.sh, otherwise do nothing.
    • commandHandlers.SketchUpCommandHandler: On
  • logging.Filterer: A base class for loggers and handlers which allows them to share common code.
    • logging.Handler: Handler instances dispatch logging events to specific destinations.
      • logging.handlers.SocketHandler: A handler class which writes logging records, in pickle format, to a streaming socket.
        • qb.remoteMessaging.RemoteMessagingSocketHandler
    • logging.Logger: Instances of the Logger class represent a single logging channel.
      • qb.remoteMessaging.RemoteMessagingSender: Create a logging object which will send messages over a socket to a logger running on a remote host.
  • qb.backend.logParser.LogParser: The base class for log parsers in Qube, it provides all the functionality needed with the exception of calculating in-frame progress.
    • qb.backend.afterEffectsLogParser.AERenderLogParser: This LogParser class is for AfterEffects sequence renders.
    • qb.backend.logParser.CmdRangeChunkLogParser: This LogParser class is expected to be used for jobs whose agenda contains frame chunks or partitions.
    • qb.backend.logParser.ProgressPercentageLogParser: This LogParser class on of calcProgress() is for the most trivial case:
  • qb.backend.pythonChildHandler.PFXSimpleClient
  • qb.backend.utils.PFXSimpleTimer: A convenience class containing some simple timer-type methods
  • qb.backend.pythonChildHandler.PyCmdDispatcher: The PyCmdDispatcher class is used by qube python jobtypes to execute commands through an abstracted application or shell.
  • qb.backend.pythonChildHandler.PyCmdExecutor: The PyCmdExecutor class is used by qube loadOnce python jobtypes.
  • qb.backend.pythonBackEnd.PythonQubeBackEnd: The base class for PipelineFX's python back-end modules.
    • qb.backend.commandBackEnd.CommandBackEnd: A base class for command-line and command range jobtypes written in Python.
      • pyCmdline.cmdlineBackEnd.CmdLineBackEnd: A backend for a python-based cmdline jobtype which allows for extensible log parsing.
      • pyCmdrange.cmdrangeBackEnd.CmdRangeBackEnd: A backend for a python-based cmdrange jobtype which allows for extensible log parsing.
      • modoCmdrangeBackEnd.ModoCmdRangeBackEnd: A backend for a Modo using the cmdrange approach, starts Modo for every agenda item
      • workCmdlineBackEnd.WorkCmdlineBackEnd: A backend for a python-based cmdrange jobtype which allows for extensible log parsing.
    • qb.backend.pythonChildBackEnd.PythonChildBackEnd: A python-based Qube backend that has a PyCmdDispatcher.
      • houdiniBackEnd.HoudiniBackEnd: A backend for a jobtype that runs an instance of Houdini in a child process.
      • mayaBackEnd.MayaBackEnd: A backend for a jobtype that runs an instance of Nuke in a child process.
      • nukeBackEnd.NukeBackEnd: A backend for a jobtype that runs an instance of Nuke in a child process.
      • VRED_backEnd.VRED_BackEnd: A backend for a jobtype that runs an instance of VRED in a child process.
  • qb.remoteMessaging.RemoteMessagingServer: Create and manage a logger running in a thread.
  • qb.utils.files.WorkerConfigFile: A class to read and write the qbwrk.conf file on the supervisor; this file contains blocks herein referred to as "stanzas" for each template or host definition.
  • dict: dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list.
    • qb.QBObject: Baseclass for Qube python objects.
      • qb.Job: Container for Qube's job properties.
        • qb.backend.pythonChildJob.PythonChildJob
    • qb.frontend.QubeJob: A base class for the frontend of any Qube job whose backend jobtype uses the qube qb.backend.pythonBackEnd modules
      • pyCmdrange.cmdrangeFrontEnd.CmdRangeJob
      • qb.frontend.pythonFrontEnd.PythonChildJob
        • houdiniFrontEnd.HoudiniPythonJob: A base class for all Houdini dynamic allocation jobs
          • houdiniFrontEnd.HoudiniHipBaseJob: A virtual class for all Houdini hip file jobs
            • houdiniFrontEnd.HoudiniRenderRopJob: A class for Houdini jobs that process one or more ROP nodes
        • mayaFrontEnd.MayaPythonJob
          • mayaFrontEnd.MayaRenderJob
        • nukeFrontEnd.NukePythonJob
          • nukeFrontEnd.NukeRenderJob
        • VRED_frontEnd.VRED_PythonJob: The base class for a Load-Once VRED job.
          • VRED_frontEnd.VRED_SequencerRenderJob: Run one or more VRED sequences, optionally across a frame range
          • VRED_frontEnd.VRED_ViewpointRenderJob: Render a one or more VRED Viewpoints
      • workCmdlineFrontEnd.WorkCmdlineJob