Enhancement: Some publish logs cosmetics (#5917)

* Write logs in sorted order for better logs

* Typo in log message

* More descriptive log

* Skip logging profile since `filter_profiles` already logs "Profile selected: {profile}"

* Fix grammar

* Fix grammar

* Improve logged information

openpype/hosts/tvpaint/plugins/load/load_reference_image.py

@@ -190,7 +190,7 @@ def _remove_container(self, container):
 
         if pop_idx is None:
             self.log.warning(
-                "Didn't found container in workfile containers. {}".format(
+                "Didn't find container in workfile containers. {}".format(
                     container
                 )
             )

openpype/modules/ftrack/event_handlers_server/action_tranfer_hierarchical_values.py

@@ -66,7 +66,7 @@ def _selection_interface(self, session, event_values=None):
                 "items": [{
                     "type": "label",
                     "value": (
-                        "Didn't found custom attributes"
+                        "Didn't find custom attributes"
                         " that can be transferred."
                     )
                 }]

openpype/modules/ftrack/event_handlers_server/event_next_task_update.py

@@ -257,7 +257,7 @@ def set_next_task_statuses(
             new_task_name = mapping.get(old_status_name)
             if not new_task_name:
                 self.log.debug(
-                    "Didn't found mapping for status \"{}\".".format(
+                    "Didn't find mapping for status \"{}\".".format(
                         task_status["name"]
                     )
                 )

openpype/modules/ftrack/event_handlers_server/event_sync_to_avalon.py

@@ -387,7 +387,7 @@ def get_found_data(entity):
             if not data:
                 # TODO logging
                 self.log.warning(
-                    "Didn't found entity by key/value \"{}\" / \"{}\"".format(
+                    "Didn't find entity by key/value \"{}\" / \"{}\"".format(
                         key, value
                     )
                 )

openpype/modules/ftrack/event_handlers_user/action_component_open.py

@@ -51,7 +51,7 @@ def launch(self, session, entities, event):
         else:
             return {
                 'success': False,
-                'message': "Didn't found file: " + fpath
+                'message': "Didn't find file: " + fpath
             }
 
         return {

openpype/modules/ftrack/event_handlers_user/action_delete_asset.py

@@ -169,7 +169,7 @@ def interface(self, session, entities, event):
             return {
                 "success": True,
                 "message": (
-                    "Didn't found entities in avalon."
+                    "Didn't find entities in avalon."
                     " You can use Ftrack's Delete button for the selection."
                 )
             }

openpype/modules/ftrack/event_handlers_user/action_delivery.py

@@ -61,7 +61,7 @@ def interface(self, session, entities, event):
             return {
                 "success": False,
                 "message": (
-                    "Didn't found project \"{}\" in avalon."
+                    "Didn't find project \"{}\" in avalon."
                 ).format(project_name)
             }
 

openpype/modules/ftrack/event_handlers_user/action_job_killer.py

@@ -29,7 +29,7 @@ def interface(self, session, entities, event):
         if not jobs:
             return {
                 "success": True,
-                "message": "Didn't found any running jobs"
+                "message": "Didn't find any running jobs"
             }
 
         # Collect user ids from jobs

openpype/plugins/publish/cleanup_explicit.py

@@ -58,21 +58,21 @@ def _remove_full_paths(self, full_paths):
         # Store failed paths with exception
         failed = []
         # Store removed filepaths for logging
-        succeded_files = set()
+        succeeded_files = set()
         # Remove file by file
         for filepath in filepaths:
             try:
                 os.remove(filepath)
-                succeded_files.add(filepath)
+                succeeded_files.add(filepath)
             except Exception as exc:
                 failed.append((filepath, exc))
 
-        if succeded_files:
+        if succeeded_files:
             self.log.info(
-                "Removed files:\n{}".format("\n".join(succeded_files))
+                "Removed files:\n{}".format("\n".join(sorted(succeeded_files)))
             )
 
-        # Delete folders with it's content
+        # Delete folders with its content
         succeeded = set()
         for dirpath in dirpaths:
             # Check if directory still exists
@@ -87,17 +87,21 @@ def _remove_full_paths(self, full_paths):
 
         if succeeded:
             self.log.info(
-                "Removed directories:\n{}".format("\n".join(succeeded))
+                "Removed directories:\n{}".format(
+                    "\n".join(sorted(succeeded))
+                )
             )
 
-        # Prepare lines for report of failed removements
+        # Prepare lines for report of failed removals
         lines = []
         for filepath, exc in failed:
             lines.append("{}: {}".format(filepath, str(exc)))
 
         if lines:
             self.log.warning(
-                "Failed to remove filepaths:\n{}".format("\n".join(lines))
+                "Failed to remove filepaths:\n{}".format(
+                    "\n".join(sorted(lines))
+                )
             )
 
     def _remove_empty_dirs(self, empty_dirpaths):
@@ -134,8 +138,8 @@ def _remove_empty_dirs(self, empty_dirpaths):
 
         if to_skip_dirpaths:
             self.log.debug(
-                "Skipped directories because contain files:\n{}".format(
-                    "\n".join(to_skip_dirpaths)
+                "Skipped directories because they contain files:\n{}".format(
+                    "\n".join(sorted(to_skip_dirpaths))
                 )
             )
 
@@ -147,6 +151,6 @@ def _remove_empty_dirs(self, empty_dirpaths):
         if to_delete_dirpaths:
             self.log.debug(
                 "Deleted empty directories:\n{}".format(
-                    "\n".join(to_delete_dirpaths)
+                    "\n".join(sorted(to_delete_dirpaths))
                 )
             )

openpype/plugins/publish/collect_rendered_files.py

@@ -54,6 +54,8 @@ def _fill_staging_dir(self, data_object, anatomy):
         staging_dir = data_object.get("stagingDir")
         if staging_dir:
             data_object["stagingDir"] = anatomy.fill_root(staging_dir)
+            self.log.debug("Filling stagingDir with root to: %s",
+                           data_object["stagingDir"])
 
     def _process_path(self, data, anatomy):
         """Process data of a single JSON publish metadata file.
@@ -108,7 +110,6 @@ def _process_path(self, data, anatomy):
             instance = self._context.create_instance(
                 instance_data.get("subset")
             )
-            self.log.debug("Filling stagingDir...")
 
             self._fill_staging_dir(instance_data, anatomy)
             instance.data.update(instance_data)
@@ -161,7 +162,7 @@ def process(self, context):
             anatomy.project_name
         ))
 
-        self.log.debug("anatomy: {}".format(anatomy.roots))
+        self.log.debug("Anatomy roots: {}".format(anatomy.roots))
         try:
             session_is_set = False
             for path in paths:

openpype/plugins/publish/extract_burnin.py

@@ -171,8 +171,6 @@ def main_process(self, instance):
             ).format(host_name, family, task_name, task_type, subset))
             return
 
-        self.log.debug("profile: {}".format(profile))
-
         # Pre-filter burnin definitions by instance families
         burnin_defs = self.filter_burnins_defs(profile, instance)
         if not burnin_defs:
@@ -450,7 +448,7 @@ def prepare_basic_data(self, instance):
                 filling burnin strings. `temp_data` are for repre pre-process
                 preparation.
         """
-        self.log.debug("Prepring basic data for burnins")
+        self.log.debug("Preparing basic data for burnins")
         context = instance.context
 
         version = instance.data.get("version")

openpype/plugins/publish/extract_color_transcode.py

@@ -326,7 +326,6 @@ def _get_profile(self, instance):
               " | Task type \"{}\" | Subset \"{}\" "
             ).format(host_name, family, task_name, task_type, subset))
 
-        self.log.debug("profile: {}".format(profile))
         return profile
 
     def _repre_is_valid(self, repre):

openpype/plugins/publish/extract_review.py

@@ -143,7 +143,7 @@ def _get_outputs_per_representations(self, instance, profile_outputs):
             custom_tags = repre.get("custom_tags")
             if "review" not in tags:
                 self.log.debug((
-                    "Repre: {} - Didn't found \"review\" in tags. Skipping"
+                    "Repre: {} - Didn't find \"review\" in tags. Skipping"
                 ).format(repre_name))
                 continue
 

openpype/plugins/publish/integrate_thumbnail.py

@@ -200,7 +200,7 @@ def _get_thumbnail_path_from_published(self, published_representations):
 
         if thumb_repre_doc is None:
             self.log.debug(
-                "There is not representation with name \"thumbnail\""
+                "There is no representation with name \"thumbnail\""
             )
             return None
 

openpype/plugins/publish/integrate_thumbnail_ayon.py

@@ -137,7 +137,7 @@ def _get_instance_thumbnail_path(self, published_representations):
 
         if thumb_repre_doc is None:
             self.log.debug(
-                "There is not representation with name \"thumbnail\""
+                "There is no representation with name \"thumbnail\""
             )
             return None
 

openpype/settings/entities/dict_conditional.py

@@ -352,7 +352,7 @@ def get_child_path(self, child_obj):
                     break
 
         if result_key is None:
-            raise ValueError("Didn't found child {}".format(child_obj))
+            raise ValueError("Didn't find child {}".format(child_obj))
 
         return "/".join([self.path, result_key])
 

openpype/settings/entities/dict_immutable_keys_entity.py

@@ -232,7 +232,7 @@ def get_child_path(self, child_obj):
                 break
 
         if result_key is None:
-            raise ValueError("Didn't found child {}".format(child_obj))
+            raise ValueError("Didn't find child {}".format(child_obj))
 
         return "/".join([self.path, result_key])
 

openpype/settings/entities/dict_mutable_keys_entity.py

@@ -284,7 +284,7 @@ def get_child_path(self, child_obj):
                 break
 
         if result_key is None:
-            raise ValueError("Didn't found child {}".format(child_obj))
+            raise ValueError("Didn't find child {}".format(child_obj))
 
         return "/".join([self.path, result_key])
 

openpype/settings/entities/item_entities.py

@@ -295,7 +295,7 @@ def get_child_path(self, child_obj):
                 break
 
         if result_idx is None:
-            raise ValueError("Didn't found child {}".format(child_obj))
+            raise ValueError("Didn't find child {}".format(child_obj))
 
         return "/".join([self.path, str(result_idx)])
 

openpype/settings/entities/list_entity.py

@@ -258,7 +258,7 @@ def get_child_path(self, child_obj):
                 break
 
         if result_idx is None:
-            raise ValueError("Didn't found child {}".format(child_obj))
+            raise ValueError("Didn't find child {}".format(child_obj))
 
         return "/".join([self.path, str(result_idx)])
 

openpype/settings/entities/root_entities.py

@@ -270,7 +270,7 @@ def get_child_path(self, child_entity):
         for key, _child_entity in self.non_gui_children.items():
             if _child_entity is child_entity:
                 return key
-        raise ValueError("Didn't found child {}".format(child_entity))
+        raise ValueError("Didn't find child {}".format(child_entity))
 
     @property
     def value(self):