feat: Backlog/generic publisher

libs/constants/release_notes.md

@@ -1,5 +1,9 @@
 # ftrack Constants library release Notes
 
+## Upcoming
+
+* [new] Add HOST_SYNC_TOOL_CONFIG_TOPIC constant.
+
 ## v3.0.0
 2024-09-19
 

libs/constants/source/ftrack_constants/framework/event/__init__.py

@@ -60,6 +60,9 @@
 # Client wants to verify the plugins are registered in host
 HOST_VERIFY_PLUGINS_TOPIC = '{}.host.verify.plugins'.format(_BASE_)
 
+# Client wants to verify the plugins are registered in host
+HOST_SYNC_TOOL_CONFIG_TOPIC = '{}.host.sync.tool_config'.format(_BASE_)
+
 # Remote integration<>Python communication; Connection and alive check
 DISCOVER_REMOTE_INTEGRATION_TOPIC = "{}.discover.remote.integration".format(
     _BASE_

libs/framework-core/release_notes.md

@@ -1,5 +1,12 @@
 # ftrack Framework Core library release Notes
 
+## upcoming
+
+* [change] Registry; support get tool config extensions by reference.
+* [new] Client; Add method save_tool_config_in_destination; Save given tool config as yaml file in specific destination.
+* [new] Client, Host, Event Manager; Add host_sync_tool_config on event manager to sync tool config from the client to the host.
+
+
 ## v3.0.0
 2024-09-19
 

libs/framework-core/source/ftrack_framework_core/client/__init__.py

@@ -5,6 +5,7 @@
 import logging
 import uuid
 from collections import defaultdict
+import yaml
 
 from six import string_types
 
@@ -545,6 +546,22 @@ def set_config_options(
                 item_reference
             ] = options
 
+    def sync_tool_config(self, tool_config):
+        '''
+        Sync the given *tool_config* with the host.
+        '''
+        self.event_manager.publish.host_sync_tool_config(
+            self.host_id,
+            tool_config,
+        )
+
+    def save_tool_config_in_destination(self, tool_config, destination):
+        '''
+        Save the given *tool_config* in the given *destination*.
+        '''
+        with open(destination, 'w') as file:
+            yaml.dump(tool_config, file)
+
     def run_ui_hook(
         self, tool_config_reference, plugin_config_reference, payload
     ):

libs/framework-core/source/ftrack_framework_core/event/__init__.py

@@ -320,6 +320,25 @@ def host_verify_plugins(self, host_id, plugin_names, callback=None):
         event_topic = constants.event.HOST_VERIFY_PLUGINS_TOPIC
         return self._publish_event(event_topic, data, callback)
 
+    def host_sync_tool_config(
+        self,
+        host_id,
+        tool_config,
+        callback=None,
+        mode=constants.event.LOCAL_EVENT_MODE,
+    ):
+        '''
+        Publish an event with topic
+        :const:`~ftrack_framework_core.constants.event.HOST_VERIFY_PLUGINS_TOPIC`
+        '''
+        data = {
+            'host_id': host_id,
+            'tool_config': tool_config,
+        }
+
+        event_topic = constants.event.HOST_SYNC_TOOL_CONFIG_TOPIC
+        return self._publish_event(event_topic, data, callback, mode)
+
 
 class Subscribe(object):
     '''Class with all the events subscribed by the framework'''
@@ -453,3 +472,13 @@ def host_verify_plugins(self, host_id, callback=None):
             constants.event.HOST_VERIFY_PLUGINS_TOPIC, host_id
         )
         return self._subscribe_event(event_topic, callback)
+
+    def host_sync_tool_config(self, host_id, callback=None):
+        '''
+        Subscribe to an event with topic
+        :const:`~ftrack_framework_core.constants.event.HOST_SYNC_TOOL_CONFIG_TOPIC`
+        '''
+        event_topic = '{} and data.host_id={}'.format(
+            constants.event.HOST_SYNC_TOOL_CONFIG_TOPIC, host_id
+        )
+        return self._subscribe_event(event_topic, callback)

libs/framework-core/source/ftrack_framework_core/host/__init__.py

@@ -220,6 +220,11 @@ def _subscribe_events(self):
             self.id, self._verify_plugins_callback
         )
 
+        # Subscribe to sync tool config from the client
+        self.event_manager.subscribe.host_sync_tool_config(
+            self.id, self._sync_tool_config_callback
+        )
+
     @delegate_to_main_thread_wrapper
     def _client_context_change_callback(self, event):
         '''Callback when the client has changed context'''
@@ -310,6 +315,7 @@ def run_ui_hook_callback(self, event):
         client_options = event['data']['client_options']
         payload = event['data']['payload']
 
+        # TODO: we should be able to replace this to: tool_config = self.registry.get_one(extension_type='tool_config', reference=tool_config_reference)
         for typed_configs in self.tool_configs.values():
             tool_config = None
             for _tool_config in typed_configs:
@@ -398,3 +404,32 @@ def verify_plugins(self, plugin_names):
                 f'correct extensions path: {unregistered_plugins}'
             )
         return unregistered_plugins
+
+    def _sync_tool_config_callback(self, event):
+        '''
+        Runs the data with the defined engine type of the given *event*
+
+        Returns result of the engine run.
+
+        *event* : Published from the client host connection at
+        :meth:`~ftrack_framework_core.client.HostConnection.run`
+        '''
+
+        tool_config = event['data']['tool_config']
+
+        registered_tool_config = self.registry.get_one(
+            extension_type='tool_config', reference=tool_config['reference']
+        )
+
+        if not registered_tool_config:
+            self.registry.add(
+                tool_config['type'],
+                name=tool_config['name'],
+                extension=tool_config,
+                path="Memory",
+                create_reference=False,
+            )
+        else:
+            registered_tool_config = tool_config
+
+        return registered_tool_config

libs/framework-core/source/ftrack_framework_core/registry/__init__.py

@@ -124,13 +124,15 @@ def scan_extensions(self, paths, extension_types=None):
         for extension in unique_extensions:
             self.add(**extension)
 
-    def add(self, extension_type, name, extension, path):
+    def add(
+        self, extension_type, name, extension, path, create_reference=True
+    ):
         '''
         Add the given *extension_type* with *name*, *extension* and *path to
         the registry
         '''
-        if extension_type == 'tool_config':
-            self.augment_tool_config(extension)
+        if extension_type == 'tool_config' and create_reference:
+            self.create_unic_references(extension, skip_root=False)
         # We use extension_type and not type to not interfere with python
         # build in type
         self.__registry[extension_type].append(
@@ -141,12 +143,12 @@ def add(self, extension_type, name, extension, path):
             }
         )
 
-    def _get(self, extensions, name, extension, path):
+    def _get(self, extensions, name, extension, path, reference=None):
         '''
         Check given *extensions* list to match given *name*, *extension* and *path* if
         neither provided, return all available extensions
         '''
-        if not any([name, extension, path]):
+        if not any([name, extension, path, reference]):
             return extensions
         found_extensions = []
         for _extension in extensions:
@@ -156,10 +158,21 @@ def _get(self, extensions, name, extension, path):
                 continue
             if path and _extension['path'] != path:
                 continue
+            if reference and isinstance(_extension['extension'], dict):
+                if _extension['extension'].get('type') == 'tool_config':
+                    if _extension['extension'].get('reference') != reference:
+                        continue
             found_extensions.append(_extension)
         return found_extensions
 
-    def get(self, name=None, extension=None, path=None, extension_type=None):
+    def get(
+        self,
+        name=None,
+        extension=None,
+        path=None,
+        extension_type=None,
+        reference=None,
+    ):
         '''
         Return given matching *name*, *extension*, *path* or *extension_type*.
         If nothing provided, return all available extensions.
@@ -168,13 +181,25 @@ def get(self, name=None, extension=None, path=None, extension_type=None):
         if extension_type:
             extensions = self.registry.get(extension_type)
             found_extensions.extend(
-                self._get(extensions, name, extension, path)
+                self._get(
+                    extensions=extensions,
+                    name=name,
+                    extension=extension,
+                    path=path,
+                    reference=reference,
+                )
             )
         else:
             for extension_type in list(self.registry.keys()):
                 extensions = self.registry.get(extension_type)
                 found_extensions.extend(
-                    self._get(extensions, name, extension, path)
+                    self._get(
+                        extensions=extensions,
+                        name=name,
+                        extension=extension,
+                        path=path,
+                        reference=reference,
+                    )
                 )
 
         return found_extensions
@@ -186,30 +211,37 @@ def get_one(self, *args, **kwargs):
         '''
         matching_extensions = self.get(*args, **kwargs)
         if len(matching_extensions) == 0:
-            kwargs_string = ''.join([('%s=%s' % x) for x in kwargs.items()])
-            raise Exception(
+            kwargs_string = ', '.join([('%s=%s' % x) for x in kwargs.items()])
+            self.logger.warning(
                 "Extension not found. Arguments: {}".format(
                     (''.join(args), kwargs_string)
                 )
             )
+            return None
 
         if len(matching_extensions) > 1:
-            kwargs_string = ''.join([('%s=%s' % x) for x in kwargs.items()])
-            raise Exception(
+            kwargs_string = ', '.join([('%s=%s' % x) for x in kwargs.items()])
+            self.logger.warning(
                 "Multiple matching extensions found.Arguments: {}".format(
                     (''.join(args), kwargs_string)
                 )
             )
+            return None
         return matching_extensions[0]
 
-    def augment_tool_config(self, tool_config):
+    def create_unic_references(self, tool_config, skip_root=False):
         '''
         Augment the given *tool_config* to add a reference id to it
         and each plugin and group
         '''
-        tool_config['reference'] = uuid.uuid4().hex
+        if not skip_root:
+            tool_config['reference'] = uuid.uuid4().hex
         if 'engine' in tool_config:
             self._recursive_create_reference(tool_config['engine'])
+        else:
+            # if doesn't contain engine, we assume that is a portion of the tool
+            # config so we augment that portion
+            self._recursive_create_reference([tool_config])
         return tool_config
 
     def _recursive_create_reference(self, tool_config_engine_portion):

libs/framework-core/source/ftrack_framework_core/widget/dialog.py

@@ -423,6 +423,12 @@ def run_tool_config(self, tool_config_reference):
         arguments = {"tool_config_reference": tool_config_reference}
         self.client_method_connection('run_tool_config', arguments=arguments)
 
+    def sync_tool_config(self, tool_config):
+        args = {
+            'tool_config': tool_config,
+        }
+        self.client_method_connection('sync_tool_config', arguments=args)
+
     def _on_client_notify_ui_log_item_added_callback(self, event):
         '''
         Client notify dialog that a new log item has been added.

libs/qt-style/release_notes.md

@@ -1,5 +1,9 @@
 # ftrack Framework QT Style library release Notes
 
+## upcoming
+
+* [changed] LineEdit; Support label property.
+
 ## v3.0.0
 2024-09-19
 

libs/qt/release_notes.md

@@ -1,5 +1,14 @@
 # ftrack QT library release Notes
 
+
+## upcoming
+
+* [new] MenuButton; Button supporting menu if multiple action items provided.
+* [changed] Improved AccordionWidget and AcordionHeaderWidget to use EditableLabelWidget and possibility to add a remove button. Emits bin_clicked, title_changed, title_edited signals.
+* [changed] StatusMaterialIconWidget clickable.
+* [new] Editable label widget.
+
+
 ## v3.0.0
 2024-09-19