Added action that can add note to multiple asset versions

pype/ftrack/actions/action_multiple_notes.py

@@ -0,0 +1,162 @@
+import os
+import sys
+import argparse
+import logging
+import json
+import ftrack_api
+
+from pype.ftrack import BaseAction
+
+
+class MultipleNotes(BaseAction):
+    '''Edit meta data action.'''
+
+    #: Action identifier.
+    identifier = 'multiple.notes'
+    #: Action label.
+    label = 'Multiple Notes'
+    #: Action description.
+    description = 'Add same note to multiple Asset Versions'
+    icon = (
+        'https://cdn2.iconfinder.com/data/icons/'
+        'mixed-rounded-flat-icon/512/note_1-512.png'
+    )
+
+    def discover(self, session, entities, event):
+        ''' Validation '''
+        valid = True
+        for entity in entities:
+            if entity.entity_type.lower() != 'assetversion':
+                valid = False
+                break
+        return valid
+
+    def interface(self, session, entities, event):
+        if not event['data'].get('values', {}):
+            note_label = {
+                'type': 'label',
+                'value': '# Enter note: #'
+            }
+
+            note_value = {
+                'name': 'note',
+                'type': 'textarea'
+            }
+
+            category_label = {
+                'type': 'label',
+                'value': '## Category: ##'
+            }
+
+            category_data = []
+            category_data.append({
+                'label': '- None -',
+                'value': 'none'
+            })
+            all_categories = session.query('NoteCategory').all()
+            for cat in all_categories:
+                category_data.append({
+                    'label': cat['name'],
+                    'value': cat['id']
+                })
+            category_value = {
+                'type': 'enumerator',
+                'name': 'category',
+                'data': category_data,
+                'value': 'none'
+            }
+
+            splitter = {
+                'type': 'label',
+                'value': '{}'.format(200*"-")
+            }
+
+            items = []
+            items.append(note_label)
+            items.append(note_value)
+            items.append(splitter)
+            items.append(category_label)
+            items.append(category_value)
+            return items
+
+    def launch(self, session, entities, event):
+        if 'values' not in event['data']:
+            return
+
+        values = event['data']['values']
+        if len(values) <= 0 or 'note' not in values:
+            return False
+        # Get Note text
+        note_value = values['note']
+        if note_value.lower().strip() == '':
+            return False
+        # Get User
+        user = session.query(
+            'User where username is "{}"'.format(session.api_user)
+        ).one()
+        # Base note data
+        note_data = {
+            'content': note_value,
+            'author': user
+        }
+        # Get category
+        category_value = values['category']
+        if category_value != 'none':
+            category = session.query(
+                'NoteCategory where id is "{}"'.format(category_value)
+            ).one()
+            note_data['category'] = category
+        # Create notes for entities
+        for entity in entities:
+            new_note = session.create('Note', note_data)
+            entity['notes'].append(new_note)
+            session.commit()
+        return True
+
+
+def register(session, **kw):
+    '''Register plugin. Called when used as an plugin.'''
+
+    if not isinstance(session, ftrack_api.session.Session):
+        return
+
+    MultipleNotes(session).register()
+
+
+def main(arguments=None):
+    '''Set up logging and register action.'''
+    if arguments is None:
+        arguments = []
+
+    parser = argparse.ArgumentParser()
+    # Allow setting of logging level from arguments.
+    loggingLevels = {}
+    for level in (
+        logging.NOTSET, logging.DEBUG, logging.INFO, logging.WARNING,
+        logging.ERROR, logging.CRITICAL
+    ):
+        loggingLevels[logging.getLevelName(level).lower()] = level
+
+    parser.add_argument(
+        '-v', '--verbosity',
+        help='Set the logging output verbosity.',
+        choices=loggingLevels.keys(),
+        default='info'
+    )
+    namespace = parser.parse_args(arguments)
+
+    # Set up basic logging
+    logging.basicConfig(level=loggingLevels[namespace.verbosity])
+
+    session = ftrack_api.Session()
+    register(session)
+
+    # Wait for events
+    logging.info(
+        'Registered actions and listening for events. Use Ctrl-C to abort.'
+    )
+    session.event_hub.wait()
+
+
+if __name__ == '__main__':
+    raise SystemExit(main(sys.argv[1:]))