mirror of
https://github.com/ynput/ayon-core.git
synced 2026-01-01 16:34:53 +01:00
692 lines
21 KiB
Python
692 lines
21 KiB
Python
import os
|
|
import sys
|
|
import types
|
|
import inspect
|
|
import copy
|
|
import tempfile
|
|
import xml.etree.ElementTree
|
|
|
|
import six
|
|
import pyblish.plugin
|
|
import pyblish.api
|
|
|
|
from openpype.lib import (
|
|
Logger,
|
|
import_filepath,
|
|
filter_profiles
|
|
)
|
|
from openpype.settings import (
|
|
get_project_settings,
|
|
get_system_settings,
|
|
)
|
|
from openpype.pipeline import (
|
|
tempdir
|
|
)
|
|
from openpype.pipeline.plugin_discover import DiscoverResult
|
|
|
|
from .contants import (
|
|
DEFAULT_PUBLISH_TEMPLATE,
|
|
DEFAULT_HERO_PUBLISH_TEMPLATE,
|
|
)
|
|
|
|
|
|
def get_template_name_profiles(
|
|
project_name, project_settings=None, logger=None
|
|
):
|
|
"""Receive profiles for publish template keys.
|
|
|
|
At least one of arguments must be passed.
|
|
|
|
Args:
|
|
project_name (str): Name of project where to look for templates.
|
|
project_settings(Dic[str, Any]): Prepared project settings.
|
|
|
|
Returns:
|
|
List[Dict[str, Any]]: Publish template profiles.
|
|
"""
|
|
|
|
if not project_name and not project_settings:
|
|
raise ValueError((
|
|
"Both project name and project settings are missing."
|
|
" At least one must be entered."
|
|
))
|
|
|
|
if not project_settings:
|
|
project_settings = get_project_settings(project_name)
|
|
|
|
profiles = (
|
|
project_settings
|
|
["global"]
|
|
["tools"]
|
|
["publish"]
|
|
["template_name_profiles"]
|
|
)
|
|
if profiles:
|
|
return copy.deepcopy(profiles)
|
|
|
|
# Use legacy approach for cases new settings are not filled yet for the
|
|
# project
|
|
legacy_profiles = (
|
|
project_settings
|
|
["global"]
|
|
["publish"]
|
|
["IntegrateAssetNew"]
|
|
["template_name_profiles"]
|
|
)
|
|
if legacy_profiles:
|
|
if not logger:
|
|
logger = Logger.get_logger("get_template_name_profiles")
|
|
|
|
logger.warning((
|
|
"Project \"{}\" is using legacy access to publish template."
|
|
" It is recommended to move settings to new location"
|
|
" 'project_settings/global/tools/publish/template_name_profiles'."
|
|
).format(project_name))
|
|
|
|
# Replace "tasks" key with "task_names"
|
|
profiles = []
|
|
for profile in copy.deepcopy(legacy_profiles):
|
|
profile["task_names"] = profile.pop("tasks", [])
|
|
profiles.append(profile)
|
|
return profiles
|
|
|
|
|
|
def get_hero_template_name_profiles(
|
|
project_name, project_settings=None, logger=None
|
|
):
|
|
"""Receive profiles for hero publish template keys.
|
|
|
|
At least one of arguments must be passed.
|
|
|
|
Args:
|
|
project_name (str): Name of project where to look for templates.
|
|
project_settings(Dic[str, Any]): Prepared project settings.
|
|
|
|
Returns:
|
|
List[Dict[str, Any]]: Publish template profiles.
|
|
"""
|
|
|
|
if not project_name and not project_settings:
|
|
raise ValueError((
|
|
"Both project name and project settings are missing."
|
|
" At least one must be entered."
|
|
))
|
|
|
|
if not project_settings:
|
|
project_settings = get_project_settings(project_name)
|
|
|
|
profiles = (
|
|
project_settings
|
|
["global"]
|
|
["tools"]
|
|
["publish"]
|
|
["hero_template_name_profiles"]
|
|
)
|
|
if profiles:
|
|
return copy.deepcopy(profiles)
|
|
|
|
# Use legacy approach for cases new settings are not filled yet for the
|
|
# project
|
|
legacy_profiles = copy.deepcopy(
|
|
project_settings
|
|
["global"]
|
|
["publish"]
|
|
["IntegrateHeroVersion"]
|
|
["template_name_profiles"]
|
|
)
|
|
if legacy_profiles:
|
|
if not logger:
|
|
logger = Logger.get_logger("get_hero_template_name_profiles")
|
|
|
|
logger.warning((
|
|
"Project \"{}\" is using legacy access to hero publish template."
|
|
" It is recommended to move settings to new location"
|
|
" 'project_settings/global/tools/publish/"
|
|
"hero_template_name_profiles'."
|
|
).format(project_name))
|
|
return legacy_profiles
|
|
|
|
|
|
def get_publish_template_name(
|
|
project_name,
|
|
host_name,
|
|
family,
|
|
task_name,
|
|
task_type,
|
|
project_settings=None,
|
|
hero=False,
|
|
logger=None
|
|
):
|
|
"""Get template name which should be used for passed context.
|
|
|
|
Publish templates are filtered by host name, family, task name and
|
|
task type.
|
|
|
|
Default template which is used at if profiles are not available or profile
|
|
has empty value is defined by 'DEFAULT_PUBLISH_TEMPLATE' constant.
|
|
|
|
Args:
|
|
project_name (str): Name of project where to look for settings.
|
|
host_name (str): Name of host integration.
|
|
family (str): Family for which should be found template.
|
|
task_name (str): Task name on which is intance working.
|
|
task_type (str): Task type on which is intance working.
|
|
project_setting (Dict[str, Any]): Prepared project settings.
|
|
logger (logging.Logger): Custom logger used for 'filter_profiles'
|
|
function.
|
|
|
|
Returns:
|
|
str: Template name which should be used for integration.
|
|
"""
|
|
|
|
template = None
|
|
filter_criteria = {
|
|
"hosts": host_name,
|
|
"families": family,
|
|
"task_names": task_name,
|
|
"task_types": task_type,
|
|
}
|
|
if hero:
|
|
default_template = DEFAULT_HERO_PUBLISH_TEMPLATE
|
|
profiles = get_hero_template_name_profiles(
|
|
project_name, project_settings, logger
|
|
)
|
|
|
|
else:
|
|
profiles = get_template_name_profiles(
|
|
project_name, project_settings, logger
|
|
)
|
|
default_template = DEFAULT_PUBLISH_TEMPLATE
|
|
|
|
profile = filter_profiles(profiles, filter_criteria, logger=logger)
|
|
if profile:
|
|
template = profile["template_name"]
|
|
return template or default_template
|
|
|
|
|
|
class HelpContent:
|
|
def __init__(self, title, description, detail=None):
|
|
self.title = title
|
|
self.description = description
|
|
self.detail = detail
|
|
|
|
|
|
def load_help_content_from_filepath(filepath):
|
|
"""Load help content from xml file.
|
|
Xml file may containt errors and warnings.
|
|
"""
|
|
errors = {}
|
|
warnings = {}
|
|
output = {
|
|
"errors": errors,
|
|
"warnings": warnings
|
|
}
|
|
if not os.path.exists(filepath):
|
|
return output
|
|
tree = xml.etree.ElementTree.parse(filepath)
|
|
root = tree.getroot()
|
|
for child in root:
|
|
child_id = child.attrib.get("id")
|
|
if child_id is None:
|
|
continue
|
|
|
|
# Make sure ID is string
|
|
child_id = str(child_id)
|
|
|
|
title = child.find("title").text
|
|
description = child.find("description").text
|
|
detail_node = child.find("detail")
|
|
detail = None
|
|
if detail_node is not None:
|
|
detail = detail_node.text
|
|
if child.tag == "error":
|
|
errors[child_id] = HelpContent(title, description, detail)
|
|
elif child.tag == "warning":
|
|
warnings[child_id] = HelpContent(title, description, detail)
|
|
return output
|
|
|
|
|
|
def load_help_content_from_plugin(plugin):
|
|
cls = plugin
|
|
if not inspect.isclass(plugin):
|
|
cls = plugin.__class__
|
|
plugin_filepath = inspect.getfile(cls)
|
|
plugin_dir = os.path.dirname(plugin_filepath)
|
|
basename = os.path.splitext(os.path.basename(plugin_filepath))[0]
|
|
filename = basename + ".xml"
|
|
filepath = os.path.join(plugin_dir, "help", filename)
|
|
return load_help_content_from_filepath(filepath)
|
|
|
|
|
|
def publish_plugins_discover(paths=None):
|
|
"""Find and return available pyblish plug-ins
|
|
|
|
Overridden function from `pyblish` module to be able collect crashed files
|
|
and reason of their crash.
|
|
|
|
Arguments:
|
|
paths (list, optional): Paths to discover plug-ins from.
|
|
If no paths are provided, all paths are searched.
|
|
|
|
"""
|
|
|
|
# The only difference with `pyblish.api.discover`
|
|
result = DiscoverResult(pyblish.api.Plugin)
|
|
|
|
plugins = dict()
|
|
plugin_names = []
|
|
|
|
allow_duplicates = pyblish.plugin.ALLOW_DUPLICATES
|
|
log = pyblish.plugin.log
|
|
|
|
# Include plug-ins from registered paths
|
|
if not paths:
|
|
paths = pyblish.plugin.plugin_paths()
|
|
|
|
for path in paths:
|
|
path = os.path.normpath(path)
|
|
if not os.path.isdir(path):
|
|
continue
|
|
|
|
for fname in os.listdir(path):
|
|
if fname.startswith("_"):
|
|
continue
|
|
|
|
abspath = os.path.join(path, fname)
|
|
|
|
if not os.path.isfile(abspath):
|
|
continue
|
|
|
|
mod_name, mod_ext = os.path.splitext(fname)
|
|
|
|
if not mod_ext == ".py":
|
|
continue
|
|
|
|
try:
|
|
module = import_filepath(abspath, mod_name)
|
|
|
|
# Store reference to original module, to avoid
|
|
# garbage collection from collecting it's global
|
|
# imports, such as `import os`.
|
|
sys.modules[abspath] = module
|
|
|
|
except Exception as err:
|
|
result.crashed_file_paths[abspath] = sys.exc_info()
|
|
|
|
log.debug("Skipped: \"%s\" (%s)", mod_name, err)
|
|
continue
|
|
|
|
for plugin in pyblish.plugin.plugins_from_module(module):
|
|
if not allow_duplicates and plugin.__name__ in plugin_names:
|
|
result.duplicated_plugins.append(plugin)
|
|
log.debug("Duplicate plug-in found: %s", plugin)
|
|
continue
|
|
|
|
plugin_names.append(plugin.__name__)
|
|
|
|
plugin.__module__ = module.__file__
|
|
key = "{0}.{1}".format(plugin.__module__, plugin.__name__)
|
|
plugins[key] = plugin
|
|
|
|
# Include plug-ins from registration.
|
|
# Directly registered plug-ins take precedence.
|
|
for plugin in pyblish.plugin.registered_plugins():
|
|
if not allow_duplicates and plugin.__name__ in plugin_names:
|
|
result.duplicated_plugins.append(plugin)
|
|
log.debug("Duplicate plug-in found: %s", plugin)
|
|
continue
|
|
|
|
plugin_names.append(plugin.__name__)
|
|
|
|
plugins[plugin.__name__] = plugin
|
|
|
|
plugins = list(plugins.values())
|
|
pyblish.plugin.sort(plugins) # In-place
|
|
|
|
# In-place user-defined filter
|
|
for filter_ in pyblish.plugin._registered_plugin_filters:
|
|
filter_(plugins)
|
|
|
|
result.plugins = plugins
|
|
|
|
return result
|
|
|
|
|
|
def filter_pyblish_plugins(plugins):
|
|
"""Pyblish plugin filter which applies OpenPype settings.
|
|
|
|
Apply OpenPype settings on discovered plugins. On plugin with implemented
|
|
class method 'def apply_settings(cls, project_settings, system_settings)'
|
|
is called the method. Default behavior looks for plugin name and current
|
|
host name to look for
|
|
|
|
Args:
|
|
plugins (List[pyblish.plugin.Plugin]): Discovered plugins on which
|
|
are applied settings.
|
|
"""
|
|
|
|
log = Logger.get_logger("filter_pyblish_plugins")
|
|
|
|
# TODO: Don't use host from 'pyblish.api' but from defined host by us.
|
|
# - kept becau on farm is probably used host 'shell' which propably
|
|
# affect how settings are applied there
|
|
host = pyblish.api.current_host()
|
|
project_name = os.environ.get("AVALON_PROJECT")
|
|
|
|
project_setting = get_project_settings(project_name)
|
|
system_settings = get_system_settings()
|
|
|
|
# iterate over plugins
|
|
for plugin in plugins[:]:
|
|
if hasattr(plugin, "apply_settings"):
|
|
try:
|
|
# Use classmethod 'apply_settings'
|
|
# - can be used to target settings from custom settings place
|
|
# - skip default behavior when successful
|
|
plugin.apply_settings(project_setting, system_settings)
|
|
continue
|
|
|
|
except Exception:
|
|
log.warning(
|
|
(
|
|
"Failed to apply settings on plugin {}"
|
|
).format(plugin.__name__),
|
|
exc_info=True
|
|
)
|
|
|
|
try:
|
|
config_data = (
|
|
project_setting
|
|
[host]
|
|
["publish"]
|
|
[plugin.__name__]
|
|
)
|
|
except KeyError:
|
|
# host determined from path
|
|
file = os.path.normpath(inspect.getsourcefile(plugin))
|
|
file = os.path.normpath(file)
|
|
|
|
split_path = file.split(os.path.sep)
|
|
if len(split_path) < 4:
|
|
log.warning(
|
|
'plugin path too short to extract host {}'.format(file)
|
|
)
|
|
continue
|
|
|
|
host_from_file = split_path[-4]
|
|
plugin_kind = split_path[-2]
|
|
|
|
# TODO: change after all plugins are moved one level up
|
|
if host_from_file == "openpype":
|
|
host_from_file = "global"
|
|
|
|
try:
|
|
config_data = (
|
|
project_setting
|
|
[host_from_file]
|
|
[plugin_kind]
|
|
[plugin.__name__]
|
|
)
|
|
except KeyError:
|
|
continue
|
|
|
|
for option, value in config_data.items():
|
|
if option == "enabled" and value is False:
|
|
log.info('removing plugin {}'.format(plugin.__name__))
|
|
plugins.remove(plugin)
|
|
else:
|
|
log.info('setting {}:{} on plugin {}'.format(
|
|
option, value, plugin.__name__))
|
|
|
|
setattr(plugin, option, value)
|
|
|
|
|
|
def find_close_plugin(close_plugin_name, log):
|
|
if close_plugin_name:
|
|
plugins = pyblish.api.discover()
|
|
for plugin in plugins:
|
|
if plugin.__name__ == close_plugin_name:
|
|
return plugin
|
|
|
|
log.debug("Close plugin not found, app might not close.")
|
|
|
|
|
|
def remote_publish(log, close_plugin_name=None, raise_error=False):
|
|
"""Loops through all plugins, logs to console. Used for tests.
|
|
|
|
Args:
|
|
log (openpype.lib.Logger)
|
|
close_plugin_name (str): name of plugin with responsibility to
|
|
close host app
|
|
"""
|
|
# Error exit as soon as any error occurs.
|
|
error_format = "Failed {plugin.__name__}: {error} -- {error.traceback}"
|
|
|
|
close_plugin = find_close_plugin(close_plugin_name, log)
|
|
|
|
for result in pyblish.util.publish_iter():
|
|
for record in result["records"]:
|
|
log.info("{}: {}".format(
|
|
result["plugin"].label, record.msg))
|
|
|
|
if result["error"]:
|
|
error_message = error_format.format(**result)
|
|
log.error(error_message)
|
|
if close_plugin: # close host app explicitly after error
|
|
context = pyblish.api.Context()
|
|
close_plugin().process(context)
|
|
if raise_error:
|
|
# Fatal Error is because of Deadline
|
|
error_message = "Fatal Error: " + error_format.format(**result)
|
|
raise RuntimeError(error_message)
|
|
|
|
|
|
def get_errored_instances_from_context(context):
|
|
"""Collect failed instances from pyblish context.
|
|
|
|
Args:
|
|
context (pyblish.api.Context): Publish context where we're looking
|
|
for failed instances.
|
|
|
|
Returns:
|
|
List[pyblish.lib.Instance]: Instances which failed during processing.
|
|
"""
|
|
|
|
instances = list()
|
|
for result in context.data["results"]:
|
|
if result["instance"] is None:
|
|
# When instance is None we are on the "context" result
|
|
continue
|
|
|
|
if result["error"]:
|
|
instances.append(result["instance"])
|
|
|
|
return instances
|
|
|
|
|
|
def get_errored_plugins_from_context(context):
|
|
"""Collect failed plugins from pyblish context.
|
|
|
|
Args:
|
|
context (pyblish.api.Context): Publish context where we're looking
|
|
for failed plugins.
|
|
|
|
Returns:
|
|
List[pyblish.api.Plugin]: Plugins which failed during processing.
|
|
"""
|
|
|
|
plugins = list()
|
|
results = context.data.get("results", [])
|
|
for result in results:
|
|
if result["success"] is True:
|
|
continue
|
|
plugins.append(result["plugin"])
|
|
|
|
return plugins
|
|
|
|
|
|
def filter_instances_for_context_plugin(plugin, context):
|
|
"""Filter instances on context by context plugin filters.
|
|
|
|
This is for cases when context plugin need similar filtering like instance
|
|
plugin have, but for some reason must run on context or should find out
|
|
if there is at least one instance with a family.
|
|
|
|
Args:
|
|
plugin (pyblish.api.Plugin): Plugin with filters.
|
|
context (pyblish.api.Context): Pyblish context with insances.
|
|
|
|
Returns:
|
|
Iterator[pyblish.lib.Instance]: Iteration of valid instances.
|
|
"""
|
|
|
|
instances = []
|
|
plugin_families = set()
|
|
all_families = False
|
|
if plugin.families:
|
|
instances = context
|
|
plugin_families = set(plugin.families)
|
|
all_families = "*" in plugin_families
|
|
|
|
for instance in instances:
|
|
# Ignore inactive instances
|
|
if (
|
|
not instance.data.get("publish", True)
|
|
or not instance.data.get("active", True)
|
|
):
|
|
continue
|
|
|
|
family = instance.data.get("family")
|
|
families = instance.data.get("families") or []
|
|
if (
|
|
all_families
|
|
or (family and family in plugin_families)
|
|
or any(f in plugin_families for f in families)
|
|
):
|
|
yield instance
|
|
|
|
|
|
def context_plugin_should_run(plugin, context):
|
|
"""Return whether the ContextPlugin should run on the given context.
|
|
|
|
This is a helper function to work around a bug pyblish-base#250
|
|
Whenever a ContextPlugin sets specific families it will still trigger even
|
|
when no instances are present that have those families.
|
|
|
|
This actually checks it correctly and returns whether it should run.
|
|
|
|
Args:
|
|
plugin (pyblish.api.Plugin): Plugin with filters.
|
|
context (pyblish.api.Context): Pyblish context with instances.
|
|
|
|
Returns:
|
|
bool: Context plugin should run based on valid instances.
|
|
"""
|
|
|
|
for _ in filter_instances_for_context_plugin(plugin, context):
|
|
return True
|
|
return False
|
|
|
|
|
|
def get_instance_staging_dir(instance):
|
|
"""Unified way how staging dir is stored and created on instances.
|
|
|
|
First check if 'stagingDir' is already set in instance data.
|
|
In case there already is new tempdir will not be created.
|
|
|
|
It also supports `OPENPYPE_TMPDIR`, so studio can define own temp
|
|
shared repository per project or even per more granular context.
|
|
Template formatting is supported also with optional keys. Folder is
|
|
created in case it doesn't exists.
|
|
|
|
Available anatomy formatting keys:
|
|
- root[work | <root name key>]
|
|
- project[name | code]
|
|
|
|
Note:
|
|
Staging dir does not have to be necessarily in tempdir so be careful
|
|
about its usage.
|
|
|
|
Args:
|
|
instance (pyblish.lib.Instance): Instance for which we want to get
|
|
staging dir.
|
|
|
|
Returns:
|
|
str: Path to staging dir of instance.
|
|
"""
|
|
staging_dir = instance.data.get('stagingDir')
|
|
if staging_dir:
|
|
return staging_dir
|
|
|
|
anatomy = instance.context.data.get("anatomy")
|
|
|
|
# get customized tempdir path from `OPENPYPE_TMPDIR` env var
|
|
custom_temp_dir = tempdir.create_custom_tempdir(
|
|
anatomy.project_name, anatomy)
|
|
|
|
if custom_temp_dir:
|
|
staging_dir = os.path.normpath(
|
|
tempfile.mkdtemp(
|
|
prefix="pyblish_tmp_",
|
|
dir=custom_temp_dir
|
|
)
|
|
)
|
|
else:
|
|
staging_dir = os.path.normpath(
|
|
tempfile.mkdtemp(prefix="pyblish_tmp_")
|
|
)
|
|
instance.data['stagingDir'] = staging_dir
|
|
|
|
return staging_dir
|
|
|
|
|
|
def get_publish_repre_path(instance, repre, only_published=False):
|
|
"""Get representation path that can be used for integration.
|
|
|
|
When 'only_published' is set to true the validation of path is not
|
|
relevant. In that case we just need what is set in 'published_path'
|
|
as "reference". The reference is not used to get or upload the file but
|
|
for reference where the file was published.
|
|
|
|
Args:
|
|
instance (pyblish.Instance): Processed instance object. Used
|
|
for source of staging dir if representation does not have
|
|
filled it.
|
|
repre (dict): Representation on instance which could be and
|
|
could not be integrated with main integrator.
|
|
only_published (bool): Care only about published paths and
|
|
ignore if filepath is not existing anymore.
|
|
|
|
Returns:
|
|
str: Path to representation file.
|
|
None: Path is not filled or does not exists.
|
|
"""
|
|
|
|
published_path = repre.get("published_path")
|
|
if published_path:
|
|
published_path = os.path.normpath(published_path)
|
|
if os.path.exists(published_path):
|
|
return published_path
|
|
|
|
if only_published:
|
|
return published_path
|
|
|
|
comp_files = repre["files"]
|
|
if isinstance(comp_files, (tuple, list, set)):
|
|
filename = comp_files[0]
|
|
else:
|
|
filename = comp_files
|
|
|
|
staging_dir = repre.get("stagingDir")
|
|
if not staging_dir:
|
|
staging_dir = get_instance_staging_dir(instance)
|
|
|
|
# Expand the staging dir path in case it's been stored with the root
|
|
# template syntax
|
|
anatomy = instance.context.data["anatomy"]
|
|
staging_dir = anatomy.fill_root(staging_dir)
|
|
|
|
src_path = os.path.normpath(os.path.join(staging_dir, filename))
|
|
if os.path.exists(src_path):
|
|
return src_path
|
|
return None
|