deltafi 2.14.0__py3-none-any.whl → 2.15.0__py3-none-any.whl

deltafi/action.py

@@ -38,10 +38,184 @@ class Join(ABC):
         return TransformInput(content=all_content, metadata=all_metadata)
 
 
+class ContentSpec:
+    name: str
+    media_type: str
+    description: str
+
+    def __init__(self, name: str = None, media_type: str = None, description: str = None):
+        self.name = name
+        self.media_type = media_type
+        self.description = description
+
+    def json(self):
+        json_dictionary = {}
+        if self.name is not None:
+            json_dictionary['name'] = self.name
+        if self.media_type is not None:
+            json_dictionary['mediaType'] = self.media_type
+        if self.description is not None:
+            json_dictionary['description'] = self.description
+        return json_dictionary
+
+
+class KeyedDescription:
+    key: str
+    description: str
+
+    def __init__(self, key: str, description: str):
+        self.key = key
+        self.description = description
+
+    def json(self):
+        json_dictionary = {}
+        if self.key is not None:
+            json_dictionary['key'] = self.key
+            json_dictionary['description'] = self.description
+        return json_dictionary
+
+
+class InputSpec:
+    content_summary: str
+    content_specs: List[ContentSpec]
+    metadata_summary: str
+    metadata_descriptions: List[KeyedDescription]
+
+    def __init__(self, content_summary: str = None, content_specs: List[ContentSpec] = None,
+                 metadata_summary: str = None, metadata_descriptions: List[KeyedDescription] = None):
+        self.content_summary = content_summary
+        self.content_specs = content_specs
+        self.metadata_summary = metadata_summary
+        self.metadata_descriptions = metadata_descriptions
+
+    def json(self):
+        json_dictionary = {}
+        if self.content_summary is not None:
+            json_dictionary['contentSummary'] = self.content_summary
+        if self.content_specs is not None:
+            json_dictionary['contentSpecs'] = [cs.json() for cs in self.content_specs]
+        if self.metadata_summary is not None:
+            json_dictionary['metadataSummary'] = self.metadata_summary
+        if self.metadata_descriptions is not None:
+            json_dictionary['metadataDescriptions'] = [md.json() for md in self.metadata_descriptions]
+        return json_dictionary
+
+
+class OutputSpec:
+    content_summary: str
+    content_specs: List[ContentSpec]
+    metadata_summary: str
+    metadata_descriptions: List[KeyedDescription]
+    passthrough: bool
+    annotations_summary: str
+    annotation_descriptions: List[KeyedDescription]
+
+    def __init__(self, content_summary: str = None, content_specs: List[ContentSpec] = None,
+                 metadata_summary: str = None, metadata_descriptions: List[KeyedDescription] = None,
+                 passthrough: bool = False, annotations_summary: str = None,
+                 annotation_descriptions: List[KeyedDescription] = None):
+        self.content_summary = content_summary
+        self.content_specs = content_specs
+        self.metadata_summary = metadata_summary
+        self.metadata_descriptions = metadata_descriptions
+        self.passthrough = passthrough
+        self.annotations_summary = annotations_summary
+        self.annotation_descriptions = annotation_descriptions
+
+    def json(self):
+        json_dictionary = {}
+        if self.content_summary is not None:
+            json_dictionary['contentSummary'] = self.content_summary
+        if self.content_specs is not None:
+            json_dictionary['contentSpecs'] = [cs.json() for cs in self.content_specs]
+        if self.metadata_summary is not None:
+            json_dictionary['metadataSummary'] = self.metadata_summary
+        if self.metadata_descriptions is not None:
+            json_dictionary['metadataDescriptions'] = [md.json() for md in self.metadata_descriptions]
+        if self.passthrough is not None:
+            json_dictionary['passthrough'] = self.passthrough
+        if self.annotations_summary is not None:
+            json_dictionary['annotationsSummary'] = self.annotations_summary
+        if self.annotation_descriptions is not None:
+            json_dictionary['annotationDescriptions'] = [ad.json() for ad in self.annotation_descriptions]
+        return json_dictionary
+
+
+class DescriptionWithConditions:
+    description: str
+    conditions: List[str]
+
+    def __init__(self, description: str = None, conditions: List[str] = None):
+        self.description = description
+        self.conditions = conditions
+
+    def json(self):
+        json_dictionary = {}
+        if self.description is not None:
+            json_dictionary['description'] = self.description
+        if self.conditions is not None:
+            json_dictionary['conditions'] = [c for c in self.conditions]
+        return json_dictionary
+
+
+class ActionOptions:
+    description: str
+    input_spec: InputSpec
+    output_spec: OutputSpec
+    filters: List[DescriptionWithConditions] = None
+    errors: List[DescriptionWithConditions] = None
+    notes: List[str]
+    details: str
+
+    def __init__(self, description: str = None, input_spec: InputSpec = None, output_spec: OutputSpec = None,
+                 filters: List = None, errors: List = None, notes: List[str] = None, details: str = None):
+        self.description = description
+        self.input_spec = input_spec
+        self.output_spec = output_spec
+        if filters is not None:
+            self.filters = []
+            for f in filters:
+                if isinstance(f, DescriptionWithConditions):
+                    self.filters.append(f)
+                else:
+                    self.filters.append(DescriptionWithConditions(description=f))
+        if errors is not None:
+            self.errors = []
+            for e in errors:
+                if isinstance(e, DescriptionWithConditions):
+                    self.errors.append(e)
+                else:
+                    self.errors.append(DescriptionWithConditions(description=e))
+        self.notes = notes
+        self.details = details
+
+    def json(self):
+        json_dictionary = {}
+        if self.description is not None:
+            json_dictionary['description'] = self.description
+        if self.input_spec is not None:
+            json_dictionary['inputSpec'] = self.input_spec.json()
+        if self.output_spec is not None:
+            json_dictionary['outputSpec'] = self.output_spec.json()
+        if self.filters is not None:
+            json_dictionary['filters'] = [f.json() for f in self.filters]
+        if self.errors is not None:
+            json_dictionary['errors'] = [e.json() for e in self.errors]
+        if self.notes is not None:
+            json_dictionary['notes'] = [n for n in self.notes]
+        if self.details is not None:
+            json_dictionary['details'] = self.details
+        return json_dictionary
+
+
 class Action(ABC):
-    def __init__(self, action_type: ActionType, description: str, valid_result_types: tuple):
+    def __init__(self, action_type: ActionType, description: str, valid_result_types: tuple,
+                 action_options: ActionOptions = None):
         self.action_type = action_type
-        self.description = description
+        if action_options is None:
+            self.action_options = ActionOptions(description=description)
+        else:
+            self.action_options = action_options
         self.valid_result_types = valid_result_types
 
     @abstractmethod
@@ -92,8 +266,8 @@ class Action(ABC):
 
 
 class EgressAction(Action, ABC):
-    def __init__(self, description: str):
-        super().__init__(ActionType.EGRESS, description, (EgressResult, ErrorResult, FilterResult))
+    def __init__(self, description: str, action_options: ActionOptions = None):
+        super().__init__(ActionType.EGRESS, description, (EgressResult, ErrorResult, FilterResult), action_options)
 
     def build_input(self, context: Context, delta_file_message: DeltaFileMessage):
         return EgressInput(content=delta_file_message.content_list[0], metadata=delta_file_message.metadata)
@@ -107,8 +281,8 @@ class EgressAction(Action, ABC):
 
 
 class TimedIngressAction(Action, ABC):
-    def __init__(self, description: str):
-        super().__init__(ActionType.TIMED_INGRESS, description, (IngressResult, ErrorResult))
+    def __init__(self, description: str, action_options: ActionOptions = None):
+        super().__init__(ActionType.TIMED_INGRESS, description, (IngressResult, ErrorResult), action_options)
 
     def build_input(self, context: Context, delta_file_message: DeltaFileMessage):
         return None
@@ -122,9 +296,9 @@ class TimedIngressAction(Action, ABC):
 
 
 class TransformAction(Action, ABC):
-    def __init__(self, description: str):
+    def __init__(self, description: str, action_options: ActionOptions = None):
         super().__init__(ActionType.TRANSFORM, description,
-                         (TransformResult, TransformResults, ErrorResult, FilterResult))
+                         (TransformResult, TransformResults, ErrorResult, FilterResult), action_options)
 
     def build_input(self, context: Context, delta_file_message: DeltaFileMessage):
         return TransformInput(content=delta_file_message.content_list, metadata=delta_file_message.metadata)

deltafi/plugin.py

@@ -29,7 +29,7 @@ from datetime import datetime, timezone, timedelta
 from importlib import metadata
 from os.path import isdir, isfile, join
 from pathlib import Path
-from typing import List
+from typing import List, NamedTuple
 
 import requests
 import yaml
@@ -250,25 +250,13 @@ class Plugin(object):
     def action_name(self, action):
         return f"{self.coordinates.group_id}.{action.__class__.__name__}"
 
-    def _load_action_docs(self, action):
-        docs_path = str(Path(os.path.dirname(os.path.abspath(sys.argv[0]))) / 'docs')
-        if not isdir(docs_path):
-            return None
-
-        action_docs_file = join(docs_path, action.__class__.__name__ + '.md')
-        if not isfile(action_docs_file):
-            return None
-
-        return open(action_docs_file).read()
-
     def _action_json(self, action):
         return {
             'name': self.action_name(action),
-            'description': action.description,
             'type': action.action_type.name,
             'supportsJoin': isinstance(action, Join),
             'schema': action.param_class().model_json_schema(),
-            'docsMarkdown': self._load_action_docs(action)
+            'actionOptions': action.action_options.json()
         }
 
     @staticmethod
@@ -337,10 +325,10 @@ class Plugin(object):
         self.logger.info("Plugin starting")
 
         for action in self.singleton_actions:
-            num_threads = 1;
+            num_threads = 1
             if self.action_name(action) in self.thread_config:
                 maybe_num_threads = self.thread_config[self.action_name(action)]
-                if type(maybe_num_threads) == int and maybe_num_threads > 0:
+                if maybe_num_threads is int and maybe_num_threads > 0:
                     num_threads = maybe_num_threads
                 else:
                     self.logger.error(f"Ignoring non-int or invalid thread value {maybe_num_threads}")

{deltafi-2.14.0.dist-info → deltafi-2.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: deltafi
-Version: 2.14.0
+Version: 2.15.0
 Summary: SDK for DeltaFi plugins and actions
 License: Apache License, Version 2.0
 Keywords: deltafi

{deltafi-2.14.0.dist-info → deltafi-2.15.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 deltafi/__init__.py,sha256=FHwsfe4TgGeVLINN6940urXAzxGvl_Hof0gmOB32N7Y,709
-deltafi/action.py,sha256=WPfBd6WCh-tttL__sKlQ9zJQZ8wo5NYkDLdzFFAOj7s,5708
+deltafi/action.py,sha256=1axu4vgrmYVnIVzspCY04HG14eK3eGTKGg8h6uwyPk8,12749
 deltafi/actioneventqueue.py,sha256=3f-ZClq2B1QsfNubvgnlvWT_Y-B5fvER9TDrMkJkfmQ,3005
 deltafi/actiontype.py,sha256=2FnTbryP2zVlJfghrh9IqhIHWarPfSKSKt2UxoIrGLU,913
 deltafi/domain.py,sha256=4tj5DFw6nsSZo9KG5LmUb3-IETRzth_wOt38VVT74HE,13720
@@ -8,7 +8,7 @@ deltafi/genericmodel.py,sha256=0qgii2o-fzHS6lM1C5X7_WTTSYsiZAM0i7RTfw0nw4U,1152
 deltafi/input.py,sha256=CZ02GsObhu6CpdBKzNE5TJ_PSihQF3cr4XKPqouqRUU,1780
 deltafi/logger.py,sha256=Lms9wmjyZWe9-SCKj4raNmGC9Cyn3BrfiniPXeM9VDY,2140
 deltafi/metric.py,sha256=5Q40bLpNXk8mwu1wnN5L8GX22-iZxYEFBGt3zSNmYxI,972
-deltafi/plugin.py,sha256=w8nklsfTjVbkACZ_NwaGvWEAPQpcxoK3e6Gav4e9cKk,19500
+deltafi/plugin.py,sha256=sGpGhsOZXojrXx6UOZxu8VhUBsIALpLUZaywBTj_WMg,19082
 deltafi/result.py,sha256=j_3icJ74xIQo9KQV738XiqaFOYirjuIgFEtld4pBvXk,9555
 deltafi/storage.py,sha256=zgBkaDTiT4BLEE1lAYjq4mqS4zqZKzuoVmG1CNbkD20,2979
 deltafi/test_kit/__init__.py,sha256=FHwsfe4TgGeVLINN6940urXAzxGvl_Hof0gmOB32N7Y,709
@@ -19,6 +19,6 @@ deltafi/test_kit/egress.py,sha256=MXEsYsgiG1G-1zCuwV23RCn7w5bPObP1J0_7nVN03MU,18
 deltafi/test_kit/framework.py,sha256=pU8tLsMNWUhVtIhLusbQL3uPT4y8xsKWdzzXuxmxRrU,15432
 deltafi/test_kit/timed_ingress.py,sha256=ogk6AzbPZInLOPMYy3MhjEXpITPn9-Ha6YSILGBdpro,4177
 deltafi/test_kit/transform.py,sha256=7KOsNY9OSDiyTFXIx0knZeweXIA421vHS6PAxQAcOc0,4122
-deltafi-2.14.0.dist-info/METADATA,sha256=gj3kNQpZU3-6_pOqw5ATP5S9nJy_Q2G3QX3HiCnqCUI,1519
-deltafi-2.14.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-deltafi-2.14.0.dist-info/RECORD,,
+deltafi-2.15.0.dist-info/METADATA,sha256=Bqa4ypyIaqu3wrNVKkRMWvZmyp4SFOAnI6ymu2KJoX4,1519
+deltafi-2.15.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+deltafi-2.15.0.dist-info/RECORD,,

{deltafi-2.14.0.dist-info → deltafi-2.15.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.1
+Generator: poetry-core 2.1.2
 Root-Is-Purelib: true
 Tag: py3-none-any