libreflow.extensions.sk.export-psd-layers 1.1.7__tar.gz → 1.1.8__tar.gz

{libreflow_extensions_sk_export_psd_layers-1.1.7 → libreflow_extensions_sk_export_psd_layers-1.1.8}/CHANGELOG.md

@@ -19,6 +19,14 @@ Types of changes
 
 ## [Unreleased]
 
+## [1.1.8] - 2025-10-07
+
+### Fixed
+
+* Export resized to psd canvas - warning message for layers with a bouding box twice as large as the viewbox
+
+## [1.1.7] - 2025-08-19
+
 ### Added
 
 * Warning message when publishing regarding resolution and colour depth.

{libreflow_extensions_sk_export_psd_layers-1.1.7/src/libreflow.extensions.sk.export_psd_layers.egg-info → libreflow_extensions_sk_export_psd_layers-1.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: libreflow.extensions.sk.export_psd_layers
-Version: 1.1.7
+Version: 1.1.8
 Home-page: https://gitlab.com/lfs.coop/libreflow/libreflow_launcher
 Author: Thomas Thiebaut
 Author-email: autor@les-fees-speciales.coop
@@ -50,6 +50,14 @@ Types of changes
 
 ## [Unreleased]
 
+## [1.1.8] - 2025-10-07
+
+### Fixed
+
+* Export resized to psd canvas - warning message for layers with a bouding box twice as large as the viewbox
+
+## [1.1.7] - 2025-08-19
+
 ### Added
 
 * Warning message when publishing regarding resolution and colour depth.

{libreflow_extensions_sk_export_psd_layers-1.1.7 → libreflow_extensions_sk_export_psd_layers-1.1.8}/src/libreflow/extensions/sk/export_psd_layers/__init__.py

@@ -1,30 +1,26 @@
+import gc
+import json
 import os
 import re
-import json
-import gazu
 import time
 
+import gazu
 from kabaret import flow
-from libreflow.flows.default.flow.film import Film
 from libreflow.baseflow.file import (
-    GenericRunAction,
-    TrackedFile,
+    CreateWorkingCopyAction,
     FileRevisionNameChoiceValue,
-    UploadPNGToKitsu,
     PublishAndRenderPlayblast,
     PublishFileAction,
-    UploadAfterPublishValue,
-    CreateWorkingCopyAction,
+    TrackedFile,
+    UploadPNGToKitsu,
 )
+from libreflow.flows.default.flow.film import Film
 from psd_tools import PSDImage
-from psd_tools.psd import PSD
-
-from libreflow.baseflow.task import Task
-from libreflow.baseflow.task_manager import CreateTaskDefaultFiles
-from libreflow.baseflow.users import PresetValue, PresetSessionValue, PresetChoiceValue
 
 
 class ExportPSDLayers(flow.Action):
+    """Exports Photoshop (PSD/PSB) layers for background layout and color tasks."""
+
     ICON = ("icons.flow", "photoshop")
 
     _file = flow.Parent()
@@ -36,6 +32,15 @@ class ExportPSDLayers(flow.Action):
     revision = flow.Param(None, FileRevisionNameChoiceValue)
 
     def allow_context(self, context):
+        """Check whether the given context is valid for running the action.
+
+        Args:
+            context: Context object, usually representing the current project/task.
+
+        Returns:
+            bool: True if the action can be executed in this context, False otherwise.
+
+        """
         return (
             context
             and self._file.format.get() in ["psd", "psb"]
@@ -43,24 +48,45 @@ class ExportPSDLayers(flow.Action):
                 self._file.get_revision_names(
                     sync_status="Available", published_only=True
                 )
-            ) > 0
+            )
+            > 0
         )
 
     def needs_dialog(self):
+        """Indicate whether this action requires a dialog to be displayed.
+
+        Returns:
+            bool: always True.
+
+        """
         msg = ""
         if self._task.name() == "bg_layout":
             msg = "<b>Layout : Photoshop Project layers will be exported separately</b>"
         elif self._task.name() == "bg_color":
-            msg = "<b>BG Color : Photoshop Project will be exported as a single image</b>"
-        
+            msg = (
+                "<b>BG Color : Photoshop Project will be exported as a single image</b>"
+            )
+
         self.message.set(msg)
         return True
 
     def get_buttons(self):
+        """Return the buttons displayed in the dialog.
+
+        Returns:
+            list[str]: list of button labels, typically ['Export', 'Cancel'].
+
+        """
         self.revision.revert_to_default()
         return ["Export", "Cancel"]
 
     def ensure_render_folder(self):
+        """Ensure the render output folder exists for the current file.
+
+        Returns:
+            flow.File: The folder object where rendered files will be stored.
+
+        """
         folder_name = self._file.complete_name.get()
         folder_name += "_render"
 
@@ -73,6 +99,12 @@ class ExportPSDLayers(flow.Action):
         return self._files[folder_name]
 
     def ensure_render_folder_revision(self):
+        """Ensure the render folder has the correct revision.
+
+        Returns:
+            flow.Revision: The revision object in the render folder.
+
+        """
         folder = self.ensure_render_folder()
         revision_name = self.revision.get()
         source_revision = self._file.get_revision(self.revision.get())
@@ -90,37 +122,55 @@ class ExportPSDLayers(flow.Action):
         self._files.touch()
 
         return revision
-    
+
     def get_default_file(self):
+        """Retrieve the default file for exporting a BG color image.
+
+        Returns:
+            flow.File or None: The default file object, or None if not found.
+
+        """
         mng = self.root().project().get_task_manager()
         default_files = mng.default_files.get()
         for file_name, task_names in default_files.items():
-            if 'bg_color.png' in file_name:
+            if "bg_color.png" in file_name:
                 task = default_files[file_name][0]
-                file_mapped_name = file_name.replace(".", '_')
+                file_mapped_name = file_name.replace(".", "_")
                 break
 
         dft_task = mng.default_tasks[task]
-        if not dft_task.files.has_mapped_name(file_mapped_name): # check default file
+        if not dft_task.files.has_mapped_name(file_mapped_name):  # check default file
             # print(f'Scene Builder - default task {task_name} has no default file {filename} -> use default template')
             return None
 
         dft_file = dft_task.files[file_mapped_name]
         return dft_file
-    
+
     def _ensure_file(self, name, format, path_format, source_revision):
+        """Ensure a file exists in the project with the given name and revision.
+
+        Args:
+            name (str): The base name of the file.
+            format (str): The file extension (e.g., "png").
+            path_format (str): The default path format for the file.
+            source_revision (flow.Revision): The source revision to copy comments from.
+
+        Returns:
+            flow.Revision: The revision object created or retrieved.
+
+        """
         mapped_name = "%s_%s" % (name, format)
 
         file = None
-        
+
         if not self._files.has_mapped_name(mapped_name):
             if format:
                 file = self._files.add_file(
-                name=name,
-                extension=format,
-                tracked=True,
-                default_path_format=path_format,
-            )
+                    name=name,
+                    extension=format,
+                    tracked=True,
+                    default_path_format=path_format,
+                )
             else:
                 file = self._files.add_folder(name, tracked=True)
         else:
@@ -135,7 +185,7 @@ class ExportPSDLayers(flow.Action):
             r = file.get_revision(revision_name)
 
         r.comment.set(source_revision.comment.get())
-        
+
         file.ensure_last_revision_oid()
 
         r.set_sync_status("Available")
@@ -148,13 +198,22 @@ class ExportPSDLayers(flow.Action):
             os.remove(img_path)
 
         self._files.touch()
-        
+
         return r
 
     def run(self, button):
+        """Execute the render action.
+
+        Args:
+            button (str): The label of the button pressed by the user (e.g., 'Export' or 'Cancel').
+
+        Returns:
+            Any: the result of the parent run method if executed, or None if canceled.
+
+        """
         if button == "Cancel":
             return
-        
+
         session = self.root().session()
         log_format = "[EXPORT LAYERS] {message}"
 
@@ -171,23 +230,22 @@ class ExportPSDLayers(flow.Action):
         # Open photoshop file
         psb = PSDImage.open(source_revision.get_path())
 
-
         ############# BG LAYOUT PROCESS #############
 
-        if self._task.name() == "bg_layout" :
+        if self._task.name() == "bg_layout":
 
             render_revision = self.ensure_render_folder_revision()
             # JSON structure for layers order
             layers_data = {
                 "from": os.path.basename(source_revision.get_path()),
                 "layers": [],
-                "hidden_layers": []
+                "hidden_layers": [],
             }
 
             # Export image layers
             if os.path.exists(render_revision.get_path()) is False:
                 os.makedirs(render_revision.get_path())
-            
+
             folder_name = os.path.basename(render_revision.get_path())
 
             # frame_bbox = (0, 0, 0, 0)
@@ -209,22 +267,49 @@ class ExportPSDLayers(flow.Action):
             #     #     frame_bbox[2] - 5,
             #     #     frame_bbox[3] - 5,
             #     # )
-            
+
             # print(frame_bbox)
 
+            # Stop exporting action when find layers with a bouding box twice as large as the viewbox
+            layers_to_crop = []
+            for descendant in psb.descendants():
+                if not descendant.is_group():
+                    v_left, v_top, v_right, v_bottom = psb.viewbox
+                    v_width, v_height = v_right - v_left, v_bottom - v_top
+
+                    bbox_left, bbox_top, bbox_right, bbox_bottom = descendant.bbox
+                    bbox_width, bbox_height = (
+                        bbox_right - bbox_left,
+                        bbox_bottom - bbox_top,
+                    )
+
+                    if not (bbox_height <= v_height * 2 and bbox_width <= v_width * 2):
+                        layers_to_crop.append(descendant.name)
+
+            if len(layers_to_crop) != 0:
+                session.log_warning(
+                    log_format.format(
+                        message=f"You need to crop these layers : {layers_to_crop}"
+                    )
+                )
+                return None
+
             for layer in reversed(psb):
+
                 # Remove invalid characters
-                layer_name = layer.name.replace(' ','-')
+                layer_name = layer.name.replace(" ", "-")
                 match_invalid = re.search(r"[~\"#%&*:<>?/\\{|}]+", layer.name)
                 if match_invalid:
-                    layer_name = layer_name.replace(match_invalid.group(0), '')
+                    layer_name = layer_name.replace(match_invalid.group(0), "")
 
                 output_path = os.path.join(
                     render_revision.get_path(),
                     "{folder}-{layer}.png".format(folder=folder_name, layer=layer_name),
                 )
 
-                session.log_info(log_format.format(message=f'Exporting layer {layer_name}'))
+                session.log_info(
+                    log_format.format(message=f"Exporting layer {layer_name}")
+                )
 
                 if not layer.visible:
                     layer.visible = True
@@ -235,59 +320,67 @@ class ExportPSDLayers(flow.Action):
                     layer_name
                 )
 
-                image = layer.composite(viewport=psb.viewbox)
+                image = layer.composite(viewport=psb.viewbox, force=True)
                 image.save(output_path)
+                session.log_info(f"Layer {layer_name} exported !")
+                gc.collect()
 
-            
             # Export JSON data
             json_object = json.dumps(layers_data)
             json_path = os.path.join(render_revision.get_path(), "layers.json")
-            
-            session.log_info(log_format.format(message='Saving layers.json'))
+
+            session.log_info(log_format.format(message="Saving layers.json"))
             with open(json_path, "w") as outfile:
                 outfile.write(json_object)
-            
-            session.log_info(log_format.format(message='Export complete'))
-        
+
+            session.log_info(log_format.format(message="Export complete"))
+
         ############# BG COLOR PROCESS #############
-    
-        if self._task.name() == "bg_color" :
+
+        if self._task.name() == "bg_color":
 
             default_file = self.get_default_file()
 
             if default_file is not None:
-                                    
+
                 render_revision = self._ensure_file(
-                        name="bg_color",
-                        format="png",
-                        path_format=default_file.path_format.get(),
-                        source_revision=source_revision
-                    )
+                    name="bg_color",
+                    format="png",
+                    path_format=default_file.path_format.get(),
+                    source_revision=source_revision,
+                )
 
                 output_path = render_revision.get_path()
 
                 info_layer = psb.find("INFO")
-                if info_layer : info_layer.visible = False 
+                if info_layer:
+                    info_layer.visible = False
 
                 LO_layer = psb.find("REF_LAYOUT")
-                if LO_layer : LO_layer.visible = False 
+                if LO_layer:
+                    LO_layer.visible = False
 
                 DES_layer = psb.find("REF_DESIGN")
-                if DES_layer : DES_layer.visible = False
+                if DES_layer:
+                    DES_layer.visible = False
 
                 chara_layer = psb.find("character")
-                if chara_layer : chara_layer.visible = False 
+                if chara_layer:
+                    chara_layer.visible = False
 
                 utils_layer = psb.find("_utils")
-                if utils_layer : utils_layer.visible = False 
+                if utils_layer:
+                    utils_layer.visible = False
 
-                image = psb.composite(viewport=psb.viewbox,force=True)
+                image = psb.composite(viewport=psb.viewbox, force=True)
                 image.save(output_path)
 
-                session.log_info(log_format.format(message='Export complete'))
+                session.log_info(log_format.format(message="Export complete"))
 
             else:
-                self.root().session().log_error("[Export PSD] BG Color Image default file do not exist")
+                self.root().session().log_error(
+                    "[Export PSD] BG Color Image default file do not exist"
+                )
 
         return self.get_result(close=True)
 

{libreflow_extensions_sk_export_psd_layers-1.1.7 → libreflow_extensions_sk_export_psd_layers-1.1.8}/src/libreflow/extensions/sk/export_psd_layers/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-08-19T09:27:05+0000",
+ "date": "2025-10-07T12:13:47+0200",
  "dirty": false,
  "error": null,
- "full-revisionid": "b1b744a86ee00adf6e955054c0c0088b9bce95a0",
- "version": "1.1.7"
+ "full-revisionid": "9b4d99a24c5df5c15e21e86f38c101e653930ad1",
+ "version": "1.1.8"
 }
 '''  # END VERSION_JSON
 

{libreflow_extensions_sk_export_psd_layers-1.1.7 → libreflow_extensions_sk_export_psd_layers-1.1.8/src/libreflow.extensions.sk.export_psd_layers.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: libreflow.extensions.sk.export_psd_layers
-Version: 1.1.7
+Version: 1.1.8
 Home-page: https://gitlab.com/lfs.coop/libreflow/libreflow_launcher
 Author: Thomas Thiebaut
 Author-email: autor@les-fees-speciales.coop
@@ -50,6 +50,14 @@ Types of changes
 
 ## [Unreleased]
 
+## [1.1.8] - 2025-10-07
+
+### Fixed
+
+* Export resized to psd canvas - warning message for layers with a bouding box twice as large as the viewbox
+
+## [1.1.7] - 2025-08-19
+
 ### Added
 
 * Warning message when publishing regarding resolution and colour depth.