moved 'create_workdir_extra_folders' to 'openpype.pipeline.workfile'

openpype/hooks/pre_create_extra_workdir_folders.py

@@ -1,8 +1,6 @@
 import os
-from openpype.lib import (
-    PreLaunchHook,
-    create_workdir_extra_folders
-)
+from openpype.lib import PreLaunchHook
+from openpype.pipeline.workfile import create_workdir_extra_folders
 
 
 class AddLastWorkfileToLaunchArgs(PreLaunchHook):

openpype/lib/path_tools.py

@@ -16,6 +16,51 @@ from .profiles_filtering import filter_profiles
 log = logging.getLogger(__name__)
 
 
+class PathToolsDeprecatedWarning(DeprecationWarning):
+    pass
+
+
+def deprecated(new_destination):
+    """Mark functions as deprecated.
+
+    It will result in a warning being emitted when the function is used.
+    """
+
+    func = None
+    if callable(new_destination):
+        func = new_destination
+        new_destination = None
+
+    def _decorator(decorated_func):
+        if new_destination is None:
+            warning_message = (
+                " Please check content of deprecated function to figure out"
+                " possible replacement."
+            )
+        else:
+            warning_message = " Please replace your usage with '{}'.".format(
+                new_destination
+            )
+
+        @functools.wraps(decorated_func)
+        def wrapper(*args, **kwargs):
+            warnings.simplefilter("always", PathToolsDeprecatedWarning)
+            warnings.warn(
+                (
+                    "Call to deprecated function '{}'"
+                    "\nFunction was moved or removed.{}"
+                ).format(decorated_func.__name__, warning_message),
+                category=PathToolsDeprecatedWarning,
+                stacklevel=4
+            )
+            return decorated_func(*args, **kwargs)
+        return wrapper
+
+    if func is None:
+        return _decorator
+    return _decorator(func)
+
+
 def format_file_size(file_size, suffix=None):
     """Returns formatted string with size in appropriate unit.
 
@@ -333,6 +378,7 @@ def get_project_basic_paths(project_name):
     return _list_path_items(folder_structure)
 
 
+@deprecated("openpype.pipeline.workfile.create_workdir_extra_folders")
 def create_workdir_extra_folders(
     workdir, host_name, task_type, task_name, project_name,
     project_settings=None
@@ -349,37 +395,18 @@ def create_workdir_extra_folders(
         project_name (str): Name of project on which task is.
         project_settings (dict): Prepared project settings. Are loaded if not
             passed.
+
+    Deprecated:
+        Function will be removed after release version 3.16.*
     """
-    # Load project settings if not set
-    if not project_settings:
-        project_settings = get_project_settings(project_name)
 
-    # Load extra folders profiles
-    extra_folders_profiles = (
-        project_settings["global"]["tools"]["Workfiles"]["extra_folders"]
+    from openpype.pipeline.project_folders import create_workdir_extra_folders
+
+    return create_workdir_extra_folders(
+        workdir,
+        host_name,
+        task_type,
+        task_name,
+        project_name,
+        project_settings
     )
-    # Skip if are empty
-    if not extra_folders_profiles:
-        return
-
-    # Prepare profiles filters
-    filter_data = {
-        "task_types": task_type,
-        "task_names": task_name,
-        "hosts": host_name
-    }
-    profile = filter_profiles(extra_folders_profiles, filter_data)
-    if profile is None:
-        return
-
-    for subfolder in profile["folders"]:
-        # Make sure backslashes are converted to forwards slashes
-        #   and does not start with slash
-        subfolder = subfolder.replace("\\", "/").lstrip("/")
-        # Skip empty strings
-        if not subfolder:
-            continue
-
-        fullpath = os.path.join(workdir, subfolder)
-        if not os.path.exists(fullpath):
-            os.makedirs(fullpath)

openpype/lib/plugin_tools.py

@@ -3,7 +3,6 @@
 import os
 import logging
 import re
-import json
 
 import warnings
 import functools

openpype/pipeline/workfile/__init__.py

@@ -9,6 +9,8 @@ from .path_resolving import (
 
     get_custom_workfile_template,
     get_custom_workfile_template_by_string_context,
+
+    create_workdir_extra_folders,
 )
 
 from .build_workfile import BuildWorkfile
@@ -26,5 +28,7 @@ __all__ = (
     "get_custom_workfile_template",
     "get_custom_workfile_template_by_string_context",
 
+    "create_workdir_extra_folders",
+
     "BuildWorkfile",
 )

openpype/pipeline/workfile/path_resolving.py

@@ -467,3 +467,60 @@ def get_custom_workfile_template_by_string_context(
     return get_custom_workfile_template(
         project_doc, asset_doc, task_name, host_name, anatomy, project_settings
     )
+
+
+def create_workdir_extra_folders(
+    workdir,
+    host_name,
+    task_type,
+    task_name,
+    project_name,
+    project_settings=None
+):
+    """Create extra folders in work directory based on context.
+
+    Args:
+        workdir (str): Path to workdir where workfiles is stored.
+        host_name (str): Name of host implementation.
+        task_type (str): Type of task for which extra folders should be
+            created.
+        task_name (str): Name of task for which extra folders should be
+            created.
+        project_name (str): Name of project on which task is.
+        project_settings (dict): Prepared project settings. Are loaded if not
+            passed.
+    """
+
+    # Load project settings if not set
+    if not project_settings:
+        project_settings = get_project_settings(project_name)
+
+    # Load extra folders profiles
+    extra_folders_profiles = (
+        project_settings["global"]["tools"]["Workfiles"]["extra_folders"]
+    )
+    # Skip if are empty
+    if not extra_folders_profiles:
+        return
+
+    # Prepare profiles filters
+    filter_data = {
+        "task_types": task_type,
+        "task_names": task_name,
+        "hosts": host_name
+    }
+    profile = filter_profiles(extra_folders_profiles, filter_data)
+    if profile is None:
+        return
+
+    for subfolder in profile["folders"]:
+        # Make sure backslashes are converted to forwards slashes
+        #   and does not start with slash
+        subfolder = subfolder.replace("\\", "/").lstrip("/")
+        # Skip empty strings
+        if not subfolder:
+            continue
+
+        fullpath = os.path.join(workdir, subfolder)
+        if not os.path.exists(fullpath):
+            os.makedirs(fullpath)

openpype/tools/workfiles/files_widget.py

@@ -10,10 +10,7 @@ from openpype.host import IWorkfileHost
 from openpype.client import get_asset_by_id
 from openpype.tools.utils import PlaceholderLineEdit
 from openpype.tools.utils.delegates import PrettyTimeDelegate
-from openpype.lib import (
-    emit_event,
-    create_workdir_extra_folders,
-)
+from openpype.lib import emit_event
 from openpype.pipeline import (
     registered_host,
     legacy_io,
@@ -23,7 +20,10 @@ from openpype.pipeline.context_tools import (
     compute_session_changes,
     change_current_context
 )
-from openpype.pipeline.workfile import get_workfile_template_key
+from openpype.pipeline.workfile import (
+    get_workfile_template_key,
+    create_workdir_extra_folders,
+)
 
 from .model import (
     WorkAreaFilesModel,