Skip to content

[pycue] Improve dependency query API #2270

@DiegoTavares

Description

@DiegoTavares

Request from one of the API users:

I would like the Depend object to return the job/layer/frame id as well as name. The existing Depend.id() returns its own unique object id and that's great. I would like the id of the underlining job/layer/frame to be as easily accessible as well. Having the name is certainly very useful though it can leave some room for inaccuracy if there are multiple jobs with the same name. Using opencue.api.getJobs() will return us a list of jobs but there does not appear to be a way to use the data provided by Depend object to tell which job it is referring to. That can happen quite a bit at least in the case of compositing workflow because users will frequently iterate over the same version and create multiple jobs with the same name. Having direct access to the undernlining dependent job/layer/frame id would provide high confidence to developers to access the underlining Layer/Frame object. Thank you!

layer_id = '1111aaaa-4148-4c63-b396-859b07f01fb8'
layer = opencue.api.getLayer(layer_id)
depObjs = layer.getWhatThisDependsOn()
for depObj in depObjs:
  # maybe something like this?
  depFrameId = depObj.dependOnFrameId()
  depLayerId = depObj.dependOnLayerId()
  depJobId = depObj.dependOnJobId()

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions