Merge pull request #84 from ynput/enhancement/remove-backwards-compatibility

Chore: Remove backwards compatibility

Author: jakubjezek001

client/ayon_resolve/api/__init__.py

@@ -18,7 +18,6 @@
     maintain_current_timeline,
     get_project_manager,
     get_current_resolve_project,
-    get_current_project, # backward compatibility
     get_current_timeline,
     get_any_timeline,
     get_new_timeline,
@@ -33,11 +32,8 @@
     get_video_track_names,
     get_current_timeline_items,
     get_timeline_item_by_name,
-    get_pype_timeline_item_by_name,  # backward compatibility
     get_timeline_item_ayon_tag,
-    get_timeline_item_pype_tag,  # backward compatibility
     set_timeline_item_ayon_tag,
-    set_timeline_item_pype_tag,  # backward compatibility
     imprint,
     set_publish_attribute,
     get_publish_attribute,
@@ -101,7 +97,6 @@
     "maintain_current_timeline",
     "get_project_manager",
     "get_current_resolve_project",
-    "get_current_project", # backward compatibility
     "get_current_timeline",
     "get_any_timeline",
     "get_new_timeline",
@@ -116,11 +111,8 @@
     "get_video_track_names",
     "get_current_timeline_items",
     "get_timeline_item_by_name",
-    "get_pype_timeline_item_by_name",  # backward compatibility
     "get_timeline_item_ayon_tag",
-    "get_timeline_item_pype_tag",  # backward compatibility
     "set_timeline_item_ayon_tag",
-    "set_timeline_item_pype_tag",  # backward compatibility
     "imprint",
     "set_publish_attribute",
     "get_publish_attribute",

client/ayon_resolve/api/lib.py

@@ -163,9 +163,6 @@ def get_current_resolve_project():
     project_manager = get_project_manager()
     return project_manager.GetCurrentProject()
 
-# alias for backward compatibility
-get_current_project = get_current_resolve_project
-
 
 def get_current_timeline(new=False):
     """Get current timeline object.
@@ -510,7 +507,8 @@ def get_current_timeline_items(
             "track": {
                 "name": _track_name,
                 "index": track_index,
-                "type": track_type}
+                "type": track_type,
+            }
         }
         # get track item object and its color
         for clip_index, ti in enumerate(_clips[track_index]):
@@ -533,10 +531,11 @@ def get_timeline_item_by_name(name: str) -> object:
 
     Returns:
         object: resolve.TimelineItem
+
     """
     for _ti_data in get_current_timeline_items():
         _ti_clip = _ti_data["clip"]["item"]
-        tag_data = get_timeline_item_pype_tag(_ti_clip)
+        tag_data = get_timeline_item_ayon_tag(_ti_clip)
         tag_name = tag_data.get("namespace")
         if not tag_name:
             continue
@@ -545,19 +544,16 @@ def get_timeline_item_by_name(name: str) -> object:
     return None
 
 
-# alias for backward compatibility
-get_pype_timeline_item_by_name = get_timeline_item_by_name
-
-
 def get_timeline_item_ayon_tag(timeline_item):
     """
     Get ayon track item tag created by creator or loader plugin.
 
-    Attributes:
-        trackItem (resolve.TimelineItem): resolve object
+    Args:
+        timeline_item (resolve.TimelineItem): resolve object
 
     Returns:
         dict: ayon tag data
+
     """
     return_tag = None
 
@@ -577,9 +573,6 @@ def get_timeline_item_ayon_tag(timeline_item):
 
     return return_tag
 
-# alias for backward compatibility
-get_timeline_item_pype_tag = get_timeline_item_ayon_tag
-
 
 def set_timeline_item_ayon_tag(timeline_item, data=None):
     """
@@ -620,10 +613,6 @@ def set_timeline_item_ayon_tag(timeline_item, data=None):
     return tag_data
 
 
-# alias for backward compatibility
-set_timeline_item_pype_tag = set_timeline_item_ayon_tag
-
-
 def imprint(timeline_item, data=None):
     """
     Adding `AYON data` into a timeline item track item tag.
@@ -1188,7 +1177,7 @@ def iter_all_media_pool_clips(root=None):
         root (Optional[resolve.Folder]): root folder / bin object.
             When None, defaults to media pool root folder.
     """
-    root = root or get_current_project().GetMediaPool().GetRootFolder()
+    root = root or get_current_resolve_project().GetMediaPool().GetRootFolder()
     queue = [root]
     for folder in queue:
         for clip in folder.GetClipList():

client/ayon_resolve/api/plugin.py

@@ -35,7 +35,7 @@ def __init__(self, loader_obj, context, **options):
         """
         self.__dict__.update(loader_obj.__dict__)
         self.context = context
-        self.active_project = lib.get_current_project()
+        self.active_project = lib.get_current_resolve_project()
 
         # try to get value from options or evaluate key value for `handles`
         self.with_handles = options.get("handles") is True

client/ayon_resolve/api/rendering.py

@@ -9,7 +9,7 @@
 from ayon_core.lib import Logger
 
 from .lib import (
-    get_current_project,
+    get_current_resolve_project,
     maintain_current_timeline,
     maintain_page_by_name,
 )
@@ -45,7 +45,7 @@ def _render_timelines(timelines, target_render_directory):
     Returns:
         bool: True if all renders are successful, False otherwise
     """
-    bmr_project = get_current_project()
+    bmr_project = get_current_resolve_project()
     failed_timelines = []
     for timeline_to_render in timelines:
         with maintain_current_timeline(timeline_to_render):
@@ -80,7 +80,7 @@ def render_all_timelines(target_render_directory):
     Returns:
         bool: True if all renders are successful, False otherwise
     """
-    bmr_project = get_current_project()
+    bmr_project = get_current_resolve_project()
     with maintain_page_by_name("Deliver"):
         timelineCount = bmr_project.GetTimelineCount()
         all_timelines = [
@@ -109,7 +109,7 @@ def render_single_timeline(timeline, target_render_directory):
 
 def is_rendering_in_progress():
     """Check if rendering is in progress"""
-    bmr_project = get_current_project()
+    bmr_project = get_current_resolve_project()
     if not bmr_project:
         return False
 
@@ -133,7 +133,7 @@ def apply_drx_to_all_timeline_items(timeline, path, grade_mode=0):
 
 
 def apply_drx_to_all_timelines(path, grade_mode=0):
-    bmr_project = get_current_project()
+    bmr_project = get_current_resolve_project()
     if not bmr_project:
         return False
     timelineCount = bmr_project.GetTimelineCount()
@@ -148,7 +148,7 @@ def apply_drx_to_all_timelines(path, grade_mode=0):
 
 def delete_all_processed_jobs():
     """Delete all processed jobs"""
-    bmr_project = get_current_project()
+    bmr_project = get_current_resolve_project()
     if not _PROCESSING_JOBS:
         return
 
@@ -161,7 +161,7 @@ def delete_all_processed_jobs():
 def set_render_preset_from_file(preset_file_path):
     from . import bmdvr
 
-    bmr_project = get_current_project()
+    bmr_project = get_current_resolve_project()
     preset_path = Path(preset_file_path)
 
     # make sure the file exists
@@ -184,7 +184,7 @@ def set_render_preset_from_file(preset_file_path):
 
 
 def set_format_and_codec(render_format, render_codec):
-    bmr_project = get_current_project()
+    bmr_project = get_current_resolve_project()
 
     available_render_formats = bmr_project.GetRenderFormats()
     log.debug(f"Available formats: {pformat(available_render_formats)}")

client/ayon_resolve/plugins/create/create_workfile.py

@@ -32,12 +32,12 @@ def _dumps_data_as_project_setting(self, data):
         # https://forum.blackmagicdesign.com/viewtopic.php?f=21&t=
         # 189685&hilit=python+database#p991541
         note = json.dumps(data)
-        proj = lib.get_current_project()
+        proj = lib.get_current_resolve_project()
         proj.SetSetting("colorVersion10Name", note)
 
     def _loads_data_from_project_setting(self):
         """Retrieve workfile data from project setting."""
-        proj = lib.get_current_project()
+        proj = lib.get_current_resolve_project()
         setting_content = proj.GetSetting("colorVersion10Name")
 
         if setting_content:

client/ayon_resolve/plugins/load/load_editorial_package.py

@@ -37,7 +37,7 @@ def load(self, context, name, namespace, data):
         if not search_folder_path.exists():
             search_folder_path = Path(files).parent
 
-        project = lib.get_current_project()
+        project = lib.get_current_resolve_project()
         media_pool = project.GetMediaPool()
         folder_path = context["folder"]["path"]
 

client/ayon_resolve/plugins/load/load_media.py

@@ -52,7 +52,7 @@ def project_color_science_mode(project=None, mode="davinciYRGBColorManagedv2"):
     """
 
     if project is None:
-        project = lib.get_current_project()
+        project = lib.get_current_resolve_project()
 
     original_mode = project.GetSetting("colorScienceMode")
     if original_mode != mode:
@@ -107,7 +107,7 @@ def find_clip_usage(media_pool_item, project=None):
         return []
 
     if project is None:
-        project = lib.get_current_project()
+        project = lib.get_current_resolve_project()
 
     matching_items = []
     unique_id = media_pool_item.GetUniqueId()
@@ -202,7 +202,7 @@ def load(self, context, name, namespace, options):
         representation = context["representation"]
         self._project_name = context["project"]["name"]
 
-        project = lib.get_current_project()
+        project = lib.get_current_resolve_project()
         media_pool = project.GetMediaPool()
 
         # Allow to use an existing media pool item and re-use it
@@ -346,7 +346,7 @@ def update(self, container, context):
 
     def remove(self, container):
         # Remove MediaPoolItem entry
-        project = lib.get_current_project()
+        project = lib.get_current_resolve_project()
         media_pool = project.GetMediaPool()
         item = container["_item"]
 

client/ayon_resolve/plugins/publish/collect_shots.py

@@ -91,7 +91,7 @@ def process(self, instance):
 
             except KeyError:
                 # Retrieve resolution for project.
-                project = lib.get_current_project()
+                project = lib.get_current_resolve_project()
                 project_settings = project.GetSetting()
                 try:
                     pixel_aspect = int(project_settings["timelinePixelAspectRatio"])

client/ayon_resolve/plugins/publish/extract_editorial_package.py

@@ -7,7 +7,7 @@
 from ayon_core.pipeline.publish.lib import get_instance_expected_output_path
 from ayon_resolve.api.lib import (
     maintain_current_timeline,
-    get_current_project,
+    get_current_resolve_project,
     export_timeline_otio_native
 )
 from ayon_resolve.otio import davinci_export
@@ -62,7 +62,7 @@ def process(self, instance):
 
             # export otio representation
             self.export_otio_representation(
-                get_current_project(), timeline, otio_file_path
+                get_current_resolve_project(), timeline, otio_file_path
             )
 
         # Find Intermediate file representation file name

client/ayon_resolve/utility_scripts/develop/test_rendering_editorial_package.py

@@ -7,7 +7,7 @@
 from ayon_core.lib import Logger
 
 from ayon_resolve.api.lib import (
-    get_current_project,
+    get_current_resolve_project,
     maintain_page_by_name,
 )
 from ayon_resolve.api.rendering import (
@@ -47,7 +47,7 @@ def main(
             log.error("Unable to set render format and codec.")
             sys.exit()
 
-        timeline = get_current_project().GetCurrentTimeline()
+        timeline = get_current_resolve_project().GetCurrentTimeline()
 
         if not render_single_timeline(
             timeline,