import os import re import sys import avalon.api as avalon import hiero import pyblish.api import avalon.io from avalon.vendor.Qt import (QtWidgets, QtGui) import pype.api as pype from pype.api import Logger, Anatomy log = Logger().get_logger(__name__, "hiero") cached_process = None self = sys.modules[__name__] self._has_been_setup = False self._has_menu = False self._registered_gui = None AVALON_CONFIG = os.getenv("AVALON_CONFIG", "pype") def set_workfiles(): ''' Wrapping function for workfiles launcher ''' from avalon.tools import workfiles workdir = os.environ["AVALON_WORKDIR"] # show workfile gui workfiles.show(workdir) def sync_avalon_data_to_workfile(): # import session to get project dir project_name = avalon.Session["AVALON_PROJECT"] anatomy = Anatomy(project_name) work_template = anatomy.templates["work"]["path"] work_root = anatomy.root_value_for_template(work_template) active_project_root = ( os.path.join(work_root, project_name) ).replace("\\", "/") # getting project project = hiero.core.projects()[-1] if "Tag Presets" in project.name(): return log.debug("Synchronizing Pype metadata to project: {}".format( project.name())) # set project root with backward compatibility try: project.setProjectDirectory(active_project_root) except Exception: # old way of seting it project.setProjectRoot(active_project_root) # get project data from avalon db project_doc = avalon.io.find_one({"type": "project"}) project_data = project_doc["data"] log.debug("project_data: {}".format(project_data)) # get format and fps property from avalon db on project width = project_data["resolutionWidth"] height = project_data["resolutionHeight"] pixel_aspect = project_data["pixelAspect"] fps = project_data['fps'] format_name = project_data['code'] # create new format in hiero project format = hiero.core.Format(width, height, pixel_aspect, format_name) project.setOutputFormat(format) # set fps to hiero project project.setFramerate(fps) # TODO: add auto colorspace set from project drop log.info("Project property has been synchronised with Avalon db") def launch_workfiles_app(event): """ Event for launching workfiles after hiero start Args: event (obj): required but unused """ set_workfiles() def reload_config(): """Attempt to reload pipeline at run-time. CAUTION: This is primarily for development and debugging purposes. """ import importlib for module in ( "avalon", "avalon.lib", "avalon.pipeline", "pyblish", "pyblish_lite", "pypeapp", "{}.api".format(AVALON_CONFIG), "{}.templates".format(AVALON_CONFIG), "{}.hosts.hiero.lib".format(AVALON_CONFIG), "{}.hosts.hiero.menu".format(AVALON_CONFIG), "{}.hosts.hiero.tags".format(AVALON_CONFIG) ): log.info("Reloading module: {}...".format(module)) try: module = importlib.import_module(module) reload(module) except Exception as e: log.warning("Cannot reload module: {}".format(e)) importlib.reload(module) def setup(console=False, port=None, menu=True): """Setup integration Registers Pyblish for Hiero plug-ins and appends an item to the File-menu Arguments: console (bool): Display console with GUI port (int, optional): Port from which to start looking for an available port to connect with Pyblish QML, default provided by Pyblish Integration. menu (bool, optional): Display file menu in Hiero. """ if self._has_been_setup: teardown() add_submission() if menu: add_to_filemenu() self._has_menu = True self._has_been_setup = True print("pyblish: Loaded successfully.") def show(): """Try showing the most desirable GUI This function cycles through the currently registered graphical user interfaces, if any, and presents it to the user. """ return (_discover_gui() or _show_no_gui)() def _discover_gui(): """Return the most desirable of the currently registered GUIs""" # Prefer last registered guis = reversed(pyblish.api.registered_guis()) for gui in list(guis) + ["pyblish_lite"]: try: gui = __import__(gui).show except (ImportError, AttributeError): continue else: return gui def teardown(): """Remove integration""" if not self._has_been_setup: return if self._has_menu: remove_from_filemenu() self._has_menu = False self._has_been_setup = False print("pyblish: Integration torn down successfully") def remove_from_filemenu(): raise NotImplementedError("Implement me please.") def add_to_filemenu(): PublishAction() class PyblishSubmission(hiero.exporters.FnSubmission.Submission): def __init__(self): hiero.exporters.FnSubmission.Submission.__init__(self) def addToQueue(self): # Add submission to Hiero module for retrieval in plugins. hiero.submission = self show() def add_submission(): registry = hiero.core.taskRegistry registry.addSubmission("Pyblish", PyblishSubmission) class PublishAction(QtWidgets.QAction): """ Action with is showing as menu item """ def __init__(self): QtWidgets.QAction.__init__(self, "Publish", None) self.triggered.connect(self.publish) for interest in ["kShowContextMenu/kTimeline", "kShowContextMenukBin", "kShowContextMenu/kSpreadsheet"]: hiero.core.events.registerInterest(interest, self.eventHandler) self.setShortcut("Ctrl+Alt+P") def publish(self): # Removing "submission" attribute from hiero module, to prevent tasks # from getting picked up when not using the "Export" dialog. if hasattr(hiero, "submission"): del hiero.submission show() def eventHandler(self, event): # Add the Menu to the right-click menu event.menu.addAction(self) def _show_no_gui(): """ Popup with information about how to register a new GUI In the event of no GUI being registered or available, this information dialog will appear to guide the user through how to get set up with one. """ messagebox = QtWidgets.QMessageBox() messagebox.setIcon(messagebox.Warning) messagebox.setWindowIcon(QtGui.QIcon(os.path.join( os.path.dirname(pyblish.__file__), "icons", "logo-32x32.svg")) ) spacer = QtWidgets.QWidget() spacer.setMinimumSize(400, 0) spacer.setSizePolicy(QtWidgets.QSizePolicy.Minimum, QtWidgets.QSizePolicy.Expanding) layout = messagebox.layout() layout.addWidget(spacer, layout.rowCount(), 0, 1, layout.columnCount()) messagebox.setWindowTitle("Uh oh") messagebox.setText("No registered GUI found.") if not pyblish.api.registered_guis(): messagebox.setInformativeText( "In order to show you a GUI, one must first be registered. " "Press \"Show details...\" below for information on how to " "do that.") messagebox.setDetailedText( "Pyblish supports one or more graphical user interfaces " "to be registered at once, the next acting as a fallback to " "the previous." "\n" "\n" "For example, to use Pyblish Lite, first install it:" "\n" "\n" "$ pip install pyblish-lite" "\n" "\n" "Then register it, like so:" "\n" "\n" ">>> import pyblish.api\n" ">>> pyblish.api.register_gui(\"pyblish_lite\")" "\n" "\n" "The next time you try running this, Lite will appear." "\n" "See http://api.pyblish.com/register_gui.html for " "more information.") else: messagebox.setInformativeText( "None of the registered graphical user interfaces " "could be found." "\n" "\n" "Press \"Show details\" for more information.") messagebox.setDetailedText( "These interfaces are currently registered." "\n" "%s" % "\n".join(pyblish.api.registered_guis())) messagebox.setStandardButtons(messagebox.Ok) messagebox.exec_() def CreateNukeWorkfile(nodes=None, nodes_effects=None, to_timeline=False, **kwargs): ''' Creating nuke workfile with particular version with given nodes Also it is creating timeline track items as precomps. Arguments: nodes(list of dict): each key in dict is knob order is important to_timeline(type): will build trackItem with metadata Returns: bool: True if done Raises: Exception: with traceback ''' import hiero.core from pype.hosts.nuke import ( lib as nklib ) # check if the file exists if does then Raise "File exists!" if os.path.exists(filepath): raise FileExistsError("File already exists: `{}`".format(filepath)) # if no representations matching then # Raise "no representations to be build" if len(representations) == 0: raise AttributeError("Missing list of `representations`") # check nodes input if len(nodes) == 0: log.warning("Missing list of `nodes`") # create temp nk file nuke_script = hiero.core.nuke.ScriptWriter() # create root node and save all metadata root_node = hiero.core.nuke.RootNode() anatomy = Anatomy(os.environ["AVALON_PROJECT"]) work_template = anatomy.templates["work"]["path"] root_path = anatomy.root_value_for_template(work_template) nuke_script.addNode(root_node) # here to call pype.hosts.nuke.lib.BuildWorkfile script_builder = nklib.BuildWorkfile( root_node=root_node, root_path=root_path, nodes=nuke_script.getNodes(), **kwargs ) class ClipLoader: active_bin = None def __init__(self, plugin_cls, context, sequence=None, track=None, **kwargs): """ Initialize object Arguments: plugin_cls (api.Loader): plugin object context (dict): loader plugin context sequnce (hiero.core.Sequence): sequence object track (hiero.core.Track): track object kwargs (dict)[optional]: possible keys: projectBinPath: "path/to/binItem" hieroWorkfileName: "name_of_hiero_project_file_no_extension" """ self.cls = plugin_cls self.context = context self.kwargs = kwargs self.active_project = self._get_active_project() self.project_bin = self.active_project.clipsBin() self.data = dict() assert self._set_data(), str("Cannot Load selected data, look into " "database or call your supervisor") # inject asset data to representation dict self._get_asset_data() log.debug("__init__ self.data: `{}`".format(self.data)) # add active components to class self.active_sequence = self._get_active_sequence(sequence) self.active_track = self._get_active_track(track) def _set_data(self): """ Gets context and convert it to self.data data structure: { "name": "assetName_subsetName_representationName" "path": "path/to/file/created/by/get_repr..", "binPath": "projectBinPath", } """ # create name repr = self.context["representation"] repr_cntx = repr["context"] asset = str(repr_cntx["asset"]) subset = str(repr_cntx["subset"]) representation = str(repr_cntx["representation"]) self.data["clip_name"] = "_".join([asset, subset, representation]) self.data["track_name"] = "_".join([subset, representation]) # gets file path file = self.cls.fname if not file: repr_id = repr["_id"] log.warning( "Representation id `{}` is failing to load".format(repr_id)) return None self.data["path"] = file.replace("\\", "/") # convert to hashed path if repr_cntx.get("frame"): self._fix_path_hashes() # solve project bin structure path hierarchy = str("/".join(( "Loader", repr_cntx["hierarchy"].replace("\\", "/"), asset ))) self.data["binPath"] = self.kwargs.get( "projectBinPath", hierarchy ) return True def _fix_path_hashes(self): """ Convert file path where it is needed padding with hashes """ file = self.data["path"] if "#" not in file: frame = self.context["representation"]["context"].get("frame") padding = len(frame) file = file.replace(frame, "#" * padding) self.data["path"] = file def _get_active_project(self): """ Get hiero active project object """ fname = self.kwargs.get("hieroWorkfileName", "") return next((p for p in hiero.core.projects() if fname in p.name()), hiero.core.projects()[-1]) def _get_asset_data(self): """ Get all available asset data joint `data` key with asset.data dict into the representaion """ asset_name = self.context["representation"]["context"]["asset"] self.data["assetData"] = pype.get_asset(asset_name)["data"] def _make_project_bin(self, hierarchy): """ Creare bins by given hierarchy path It will also make sure no duplicit bins will be created Arguments: hierarchy (str): path devided by slashes "bin0/bin1/bin2" Returns: bin (hiero.core.BinItem): with the bin to be used for mediaItem """ if self.active_bin: return self.active_bin assert hierarchy != "", "Please add hierarchy!" log.debug("__ hierarchy1: `{}`".format(hierarchy)) if '/' in hierarchy: hierarchy = hierarchy.split('/') else: hierarchy = [hierarchy] parent_bin = None for i, name in enumerate(hierarchy): # if first index and list is more then one long if i == 0: bin = next((bin for bin in self.project_bin.bins() if name in bin.name()), None) if not bin: bin = hiero.core.Bin(name) self.project_bin.addItem(bin) log.debug("__ bin.name: `{}`".format(bin.name())) parent_bin = bin # if second to prelast elif (i >= 1) and (i <= (len(hierarchy) - 1)): bin = next((bin for bin in parent_bin.bins() if name in bin.name()), None) if not bin: bin = hiero.core.Bin(name) parent_bin.addItem(bin) parent_bin = bin return parent_bin def _make_track_item(self): """ Create track item with """ pass def _set_clip_color(self, last_version=True): """ Sets color of clip on clip/track item Arguments: last_version (bool): True = green | False = red """ pass def _set_container_tag(self, item, metadata): """ Sets container tag to given clip/track item Arguments: item (hiero.core.BinItem or hiero.core.TrackItem) metadata (dict): data to be added to tag """ pass def _get_active_sequence(self, sequence): if not sequence: return hiero.ui.activeSequence() else: return sequence def _get_active_track(self, track): if not track: track_name = self.data["track_name"] else: track_name = track.name() track_pass = next( (t for t in self.active_sequence.videoTracks() if t.name() in track_name), None ) if not track_pass: track_pass = hiero.core.VideoTrack(track_name) self.active_sequence.addTrack(track_pass) return track_pass def load(self): log.debug("__ active_project: `{}`".format(self.active_project)) log.debug("__ active_sequence: `{}`".format(self.active_sequence)) # create project bin for the media to be imported into self.active_bin = self._make_project_bin(self.data["binPath"]) log.debug("__ active_bin: `{}`".format(self.active_bin)) log.debug("__ version.data: `{}`".format( self.context["version"]["data"])) # create mediaItem in active project bin # create clip media media = hiero.core.MediaSource(self.data["path"]) media_duration = int(media.duration()) handle_start = int(self.data["assetData"]["handleStart"]) handle_end = int(self.data["assetData"]["handleEnd"]) clip_in = int(self.data["assetData"]["clipIn"]) clip_out = int(self.data["assetData"]["clipOut"]) log.debug("__ media_duration: `{}`".format(media_duration)) log.debug("__ handle_start: `{}`".format(handle_start)) log.debug("__ handle_end: `{}`".format(handle_end)) log.debug("__ clip_in: `{}`".format(clip_in)) log.debug("__ clip_out: `{}`".format(clip_out)) # check if slate is included # either in version data families or by calculating frame diff slate_on = next( (f for f in self.context["version"]["data"]["families"] if "slate" in f), None) or bool((( clip_out - clip_in + 1) + handle_start + handle_end ) - media_duration) log.debug("__ slate_on: `{}`".format(slate_on)) # calculate slate differences if slate_on: media_duration -= 1 handle_start += 1 fps = self.data["assetData"]["fps"] # create Clip from Media _clip = hiero.core.Clip(media) _clip.setName(self.data["clip_name"]) # add Clip to bin if not there yet if self.data["clip_name"] not in [ b.name() for b in self.active_bin.items()]: binItem = hiero.core.BinItem(_clip) self.active_bin.addItem(binItem) _source = next((item for item in self.active_bin.items() if self.data["clip_name"] in item.name()), None) if not _source: log.warning("Problem with created Source clip: `{}`".format( self.data["clip_name"])) version = next((s for s in _source.items()), None) clip = version.item() # add to track as clip item track_item = hiero.core.TrackItem( self.data["clip_name"], hiero.core.TrackItem.kVideo) track_item.setSource(clip) track_item.setSourceIn(handle_start) track_item.setTimelineIn(clip_in) track_item.setSourceOut(media_duration - handle_end) track_item.setTimelineOut(clip_out) track_item.setPlaybackSpeed(1) self.active_track.addTrackItem(track_item) log.info("Loading clips: `{}`".format(self.data["clip_name"])) def create_nk_workfile_clips(nk_workfiles, seq=None): ''' nk_workfile is list of dictionaries like: [{ 'path': 'P:/Jakub_testy_pipeline/test_v01.nk', 'name': 'test', 'handleStart': 15, # added asymetrically to handles 'handleEnd': 10, # added asymetrically to handles "clipIn": 16, "frameStart": 991, "frameEnd": 1023, 'task': 'Comp-tracking', 'work_dir': 'VFX_PR', 'shot': '00010' }] ''' proj = hiero.core.projects()[-1] root = proj.clipsBin() if not seq: seq = hiero.core.Sequence('NewSequences') root.addItem(hiero.core.BinItem(seq)) # todo will ned to define this better # track = seq[1] # lazy example to get a destination# track clips_lst = [] for nk in nk_workfiles: task_path = '/'.join([nk['work_dir'], nk['shot'], nk['task']]) bin = create_bin_in_project(task_path, proj) if nk['task'] not in seq.videoTracks(): track = hiero.core.VideoTrack(nk['task']) seq.addTrack(track) else: track = seq.tracks(nk['task']) # create clip media media = hiero.core.MediaSource(nk['path']) media_in = int(media.startTime() or 0) media_duration = int(media.duration() or 0) handle_start = nk.get("handleStart") handle_end = nk.get("handleEnd") if media_in: source_in = media_in + handle_start else: source_in = nk["frameStart"] + handle_start if media_duration: source_out = (media_in + media_duration - 1) - handle_end else: source_out = nk["frameEnd"] - handle_end source = hiero.core.Clip(media) name = os.path.basename(os.path.splitext(nk['path'])[0]) split_name = split_by_client_version(name)[0] or name # add to bin as clip item items_in_bin = [b.name() for b in bin.items()] if split_name not in items_in_bin: binItem = hiero.core.BinItem(source) bin.addItem(binItem) new_source = [ item for item in bin.items() if split_name in item.name() ][0].items()[0].item() # add to track as clip item trackItem = hiero.core.TrackItem( split_name, hiero.core.TrackItem.kVideo) trackItem.setSource(new_source) trackItem.setSourceIn(source_in) trackItem.setSourceOut(source_out) trackItem.setTimelineIn(nk["clipIn"]) trackItem.setTimelineOut(nk["clipIn"] + (source_out - source_in)) track.addTrackItem(trackItem) clips_lst.append(trackItem) return clips_lst def create_bin_in_project(bin_name='', project=''): ''' create bin in project and if the bin_name is "bin1/bin2/bin3" it will create whole depth ''' if not project: # get the first loaded project project = hiero.core.projects()[-1] if not bin_name: return None if '/' in bin_name: bin_name = bin_name.split('/') else: bin_name = [bin_name] clipsBin = project.clipsBin() done_bin_lst = [] for i, b in enumerate(bin_name): if i == 0 and len(bin_name) > 1: if b in [bin.name() for bin in clipsBin.bins()]: bin = [bin for bin in clipsBin.bins() if b in bin.name()][0] done_bin_lst.append(bin) else: create_bin = hiero.core.Bin(b) clipsBin.addItem(create_bin) done_bin_lst.append(create_bin) elif i >= 1 and i < len(bin_name) - 1: if b in [bin.name() for bin in done_bin_lst[i - 1].bins()]: bin = [ bin for bin in done_bin_lst[i - 1].bins() if b in bin.name() ][0] done_bin_lst.append(bin) else: create_bin = hiero.core.Bin(b) done_bin_lst[i - 1].addItem(create_bin) done_bin_lst.append(create_bin) elif i == len(bin_name) - 1: if b in [bin.name() for bin in done_bin_lst[i - 1].bins()]: bin = [ bin for bin in done_bin_lst[i - 1].bins() if b in bin.name() ][0] done_bin_lst.append(bin) else: create_bin = hiero.core.Bin(b) done_bin_lst[i - 1].addItem(create_bin) done_bin_lst.append(create_bin) # print [bin.name() for bin in clipsBin.bins()] return done_bin_lst[-1] def split_by_client_version(string): regex = r"[/_.]v\d+" try: matches = re.findall(regex, string, re.IGNORECASE) return string.split(matches[0]) except Exception as e: print(e) return None # nk_workfiles = [{ # 'path': 'C:/Users/hubert/_PYPE_testing/projects/D001_projectx/episodes/ep120/ep120sq01/120sh020/publish/plates/platesMain/v023/prjx_120sh020_platesMain_v023.nk', # 'name': '120sh020_platesMain', # 'handles': 10, # 'handleStart': 10, # 'handleEnd': 10, # "clipIn": 16, # "frameStart": 991, # "frameEnd": 1023, # 'task': 'platesMain', # 'work_dir': 'shots', # 'shot': '120sh020' # }]