conductor.clarisse.scripted_class.conductor_job module

class conductor.clarisse.scripted_class.conductor_job.ConductorJob

Bases: sphinx.ext.autodoc.importer._MockObject

declare_actions(s_class)

Attributes concerned with submission.

Currently only buttons.

declare_attributes(s_class)

All attributes and actions are declatred here.

We don’t use CID to declare these, despite it being reccommended, because we need better control over placement in the attribute editor.

declare_dev_attributes(s_class)

declare_environment_attributes(s_class)

Set up any extra environment.

Vars set here will be merged with the package environments.

declare_frames_attributes(s_class)

All attributes concerned with the frame range to render.

declare_general_attributes(s_class)

Most commonly accessed attributes.

declare_machines_attributes(s_class)

Attributes related to setting the instance type.

declare_notification_attributes(s_class)

Set email addresses to be notified on job completion.

declare_packages_attributes(s_class)

Read only attribute to store package names.

All editing of the packages list happens in the popped out UI.

declare_task_attributes(s_class)

This is the task command template.

It will usually contain variables that will be replaced while generating tasks.

declare_upload_attributes(s_class)

Specify options for dependency scanning.

Set to no-scan: use only cached uploads. Glob-scan: If filenames contain “##” or <UDIM>. They will be globbed. Smart-scan If filenames contain “##” the hashes will be replaced with frame numbers that are being used.

on_action(action, obj, data)

Handle any button press in the UI.

We need to wrap everything in a try because Clarisse crashes if an exception is thrown from a scripted class. See https://www.isotropix.com/user/bugtracker/363 .

on_attribute_change(obj, attr, *_)

Handle attributes changing value.

See on_action() docstring regarding exceptions.

static refresh(_, **kw)

Respond to do_setup button click.

Update UI for projects and instances from the data block. kwargs may contain the force keyword, which will invalidate the datablock and fetch fresh from Conductor. We may as well update all ConductorJob nodes.

static set_doc_strings(s_class)

Document all the attributes here.