Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-26 13:52:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

added docstring to ftrack get repre path method

Browse source
This commit is contained in:
Jakub Trllo 2022-07-26 10:57:23 +02:00
parent 266bce0f48
commit 8e5a2a082e
1 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
openpype/modules/ftrack/plugins/publish/integrate_ftrack_instances.py
View file

@ -360,6 +360,26 @@ class IntegrateFtrackInstance(pyblish.api.InstancePlugin):
instance.data["ftrackComponentsList"] = component_list
def _get_repre_path(self, instance, repre, only_published):
"""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)