fusion-platform-python-sdk 1.14.7__tar.gz → 1.15.12__tar.gz

{fusion_platform_python_sdk-1.14.7/fusion_platform_python_sdk.egg-info → fusion_platform_python_sdk-1.15.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fusion-platform-python-sdk
-Version: 1.14.7
+Version: 1.15.12
 Summary: Python SDK used to interact with the Fusion Platform(r)
 Home-page: https://github.com/d-cat-support/fusion-platform-python-sdk
 Author: Digital Content Analysis Technology Ltd

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/fusion_platform/__init__.py

@@ -11,8 +11,8 @@ API, and this is defined within the corresponding OpenAPI 3.0 specification, whi
 """
 
 # Do not modify the following two lines as they are maintained by the version.sh script.
-__version__ = '1.14.7'
-__version_date__ = '2024-10-29T15:47:22Z'
+__version__ = '1.15.12'
+__version_date__ = '2024-12-20T11:33:56Z'
 
 # Exclude certain sub-modules from documentation.
 # @formatter:off
@@ -73,6 +73,7 @@ __pdoc__ = {
     'models.service.ServiceInputExpressionSchema': False,
     'models.service.ServiceOptionExpressionSchema': False,
     'models.service.ServiceValidationSchema': False,
+    'models.service.ServiceOrganisationChargeExpressionSchema': False,
     'models.user.UserSchema.Meta': False,
     'models.user.UserSchema.opts': False,
     'models.user.UserOrganisationSchema': False,

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/fusion_platform/base.py

@@ -31,7 +31,7 @@ class Base:
         Localise.setup()
 
         # Set up logging.
-        logging.basicConfig(format='%(asctime)s.%(msecs)03d [%(levelname)s] %(pathname)s:%(funcName)s:%(lineno)d - %(message)s')
+        logging.basicConfig(format='%(asctime)s.%(msecs)03d [%(levelname)s] %(filename)s:%(funcName)s:%(lineno)d - %(message)s')
         self._logger = logging.getLogger(fusion_platform.FUSION_PLATFORM_LOGGER)
         self._logger.debug('sdk %s (%s): %s', fusion_platform.__version__, fusion_platform.__version_date__, self.__class__.__name__)
 

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/fusion_platform/command.py

@@ -305,7 +305,7 @@ class Command(Base):
             non_aggregator_digits = len(str(non_aggregator_count))
             non_aggregator_chains = process.chains if hasattr(process, Model._FIELD_CHAINS) else []
 
-            self.__print(logging.INFO, i18n.t('command.define_storage', files=non_aggregator_count))
+            self.__print(logging.INFO, i18n.t('command.define_storage', slices=non_aggregator_count))
             progress_bar = tqdm(total=non_aggregator_count, ncols=100)
 
             for group_index in range(1, non_aggregator_count + 1):
@@ -345,6 +345,60 @@ class Command(Base):
 
         return process_definition
 
+    def display_service(self, organisation, service_name):
+        """
+        Displays the documentation for the service. If the service does not exist, it will be ignored.
+
+        Args:
+            organisation: The logged in organisation.
+            service_name: The name of the service to display.
+
+        Returns:
+            True if a service was displayed.
+        """
+        found = False
+
+        # Try to find any existing service, ignoring any error.
+        try:
+            service = self.get_service(organisation, service_name)
+            found = True
+
+            self.__print_service(service)
+
+        except CommandError as e:
+            self.__print(logging.DEBUG, str(e))
+
+        return found
+
+    def display_process(self, organisation, process_name):
+        """
+        Displays the current configuration of the process. If the process does not exist, it will be ignored.
+
+        Args:
+            organisation: The logged in organisation.
+            process_name: The name of the process to display.
+
+        Returns:
+            True if a process was displayed.
+        """
+        found = False
+
+        # Try to find any existing process, ignoring any error.
+        try:
+            process, _ = self.get_process_or_execution(organisation, process_name)
+            found = True
+
+            self.__print_process(process)
+
+            # Display the status of any execution.
+            for execution in process.executions:
+                self.__print_execution(execution)
+
+        except CommandError as e:
+            self.__print(logging.DEBUG, str(e))
+
+        return found
+
     def __download_execution(self, process, download_inputs, download_outputs, download_storage, download_intermediate, download_components, output_dir, execution):
         """
         Downloads an execution.
@@ -756,10 +810,13 @@ class Command(Base):
 
         Args:
             organisation: The logged in organisation.
-            process_name: The name of the process to be downloaded. This can also be the id of a process or an execution.
+            process_name: The name of the process. This can also be the id of a process or an execution.
 
         Returns:
             The found process and/or execution.
+
+        Raises:
+            CommandError: if a process or execution could not be found.
         """
 
         # Attempt to find the process.
@@ -782,6 +839,37 @@ class Command(Base):
 
         return process, execution
 
+    def get_service(self, organisation, service_name):
+        """
+        Attempts to find a service using the given service name, service id or SSD id.
+
+        Args:
+            organisation: The logged in organisation.
+            service_name: The name of the service. This can also be the id or SSD id of a service.
+
+        Returns:
+            The found service.
+
+        Raises:
+            CommandError: if a service could not be found.
+        """
+
+        # Find the service using its case-sensitive name (starts with).
+        service, _ = organisation.find_services(name=service_name)
+
+        # If the service cannot be found, try to find it by its id or SSD id.
+        if service is None:
+            service = next((item for item in organisation.services if (str(item.id) == service_name) or (str(item.ssd_id) == service_name)), None)
+
+        # If the service still cannot be found, then try it as a specific service for the organisation.
+        if service is None:
+            service = next((item for item in organisation.own_services if (str(item.id) == service_name) or (str(item.ssd_id) == service_name)), None)
+
+        if service is None:
+            raise CommandError(i18n.t('command.no_such_service', service=service_name))
+
+        return service
+
     def __get_storage_data_item(self, process, group_index, group_count, ssd_id, chain_index):
         """
         Gets the storage date item for a process' group and chain index.
@@ -896,7 +984,8 @@ class Command(Base):
         # Change the print and logging to the desired level.
         self._logger.setLevel(logging.CRITICAL)
 
-        if arguments.verbose:
+        if arguments.debug:
+            self._logger.setLevel(logging.DEBUG)
             self.__print_level = logging.DEBUG
         else:
             self.__print_level = logging.INFO
@@ -905,8 +994,15 @@ class Command(Base):
             # Login to the correct deployment and select the organisation.
             organisation, _, _ = self.login(arguments.deployment, arguments.email, arguments.organisation)
 
-            # Perform the start, define or download.
-            if arguments.command == i18n.t('command.start.command'):
+            # Perform the display, start, define or download.
+            if arguments.command == i18n.t('command.display.command'):
+                # Display a service or process with the specified name or ids. If a service is displayed, we do not display a process.
+                for process_or_service in arguments.process_or_service:
+                    if not self.display_service(organisation, process_or_service):
+                        if not self.display_process(organisation, process_or_service):
+                            self.__print(logging.WARNING, i18n.t('command.no_process_or_service', process_or_service=process_or_service))
+
+            elif arguments.command == i18n.t('command.start.command'):
                 # Start one or more processes.
                 for service_or_yaml in arguments.service_or_yaml:
                     # Extract the command line or YAML file arguments.
@@ -979,20 +1075,27 @@ class Command(Base):
 
         # Create the subparsers.
         subparsers = parser.add_subparsers(help=i18n.t('command.subparser'), dest='command')
+        parser.add_argument(i18n.t('command.version_short'), i18n.t('command.version_long'), help=i18n.t('command.version_help'), action='version',
+                            version=i18n.t('command.version_content', version=fusion_platform.__version__, version_date=fusion_platform.__version_date__))
+
         subparsers.required = True
+        parser_display = subparsers.add_parser(i18n.t('command.display.command'), help=i18n.t('command.display.help'))
         parser_start = subparsers.add_parser(i18n.t('command.start.command'), help=i18n.t('command.start.help'))
         parser_define = subparsers.add_parser(i18n.t('command.define.command'), help=i18n.t('command.define.help'))
         parser_download = subparsers.add_parser(i18n.t('command.download.command'), help=i18n.t('command.download.help'))
 
         # Add in the common arguments.
-        for subparser in [parser_start, parser_define, parser_download]:
+        for subparser in [parser_display, parser_start, parser_define, parser_download]:
             subparser.add_argument(i18n.t('command.deployment_short'), i18n.t('command.deployment_long'), help=i18n.t('command.deployment_help'),
                                    default=Command._DEPLOYMENT_PRODUCTION_IRL)
             subparser.add_argument(i18n.t('command.email_short'), i18n.t('command.email_long'), help=i18n.t('command.email_help'))
             subparser.add_argument(i18n.t('command.organisation_short'), i18n.t('command.organisation_long'), help=i18n.t('command.organisation_help'))
-            subparser.add_argument(i18n.t('command.verbose_short'), i18n.t('command.verbose_long'), help=i18n.t('command.verbose_help'), default=False,
+            subparser.add_argument(i18n.t('command.debug_short'), i18n.t('command.debug_long'), help=i18n.t('command.debug_help'), default=False,
                                    action="store_true")
 
+        # Display arguments.
+        parser_display.add_argument(i18n.t('command.display.service_or_process_long'), help=i18n.t('command.display.service_or_process_help'), nargs='+')
+
         # Start arguments.
         parser_start.add_argument(i18n.t('command.start.definition_long'), help=i18n.t('command.start.definition_help'), nargs='+')
         parser_start.add_argument(i18n.t('command.start.input_list_short'), i18n.t('command.start.input_list_long'), help=i18n.t('command.start.input_list_help'),
@@ -1059,6 +1162,48 @@ class Command(Base):
             else:
                 print(message)
 
+    def __print_execution(self, execution):
+        """
+        Prints an execution. This just shows the status in a simple format.
+
+        Args:
+            execution: The execution to be logged.
+        """
+
+        # Form the status of the execution.
+        status = ''
+        group = ''
+
+        if execution.success:
+            status = i18n.t('command.log_execution_success')
+
+        elif execution.stopped:
+            status = i18n.t('command.log_execution_stopped')
+
+        elif execution.progress < 100:
+            status = i18n.t('command.log_execution_progress', progress=execution.progress)
+
+        else:
+            abort_reason = i18n.t('command.log_execution_abort_reason', abort_reason=execution.abort_reason) if hasattr(execution,
+                                                                                                                        Model._FIELD_ABORT_REASON) else ''
+            exit_type = i18n.t('command.log_execution_exit_type', exit_type=execution.exit_type) if hasattr(execution, Model._FIELD_EXIT_TYPE) else ''
+            status = i18n.t('command.log_execution_failed', exit_type=exit_type, abort_reason=abort_reason)
+
+        started_at = execution.started_at.strftime('%Y-%m-%d %H:%M:%S')
+        ended_at = i18n.t('command.log_execution_ended_at', ended_at=execution.ended_at.strftime('%Y-%m-%d %H:%M:%S')) if hasattr(execution,
+                                                                                                                                  Model._FIELD_ENDED_AT) else ''
+        period = i18n.t('command.log_execution_period', started_at=started_at, ended_at=ended_at)
+        duration = i18n.t('command.log_execution_duration', minutes=round((execution.ended_at - execution.started_at).total_seconds() // 60)) if hasattr(execution,
+                                                                                                                                                         Model._FIELD_ENDED_AT) and (
+                                                                                                                                                         execution.ended_at is not None) else ''
+
+        if (hasattr(execution, Model._FIELD_GROUP_ID) and (execution.group_id is not None)) and (
+                hasattr(execution, Model._FIELD_GROUP_INDEX) and (execution.group_index is not None)) and (
+                hasattr(execution, Model._FIELD_GROUP_COUNT) and (execution.group_count is not None)):
+            group = i18n.t('command.log_execution_group', group_id=execution.group_id, group_index=execution.group_index, group_count=execution.group_count)
+
+        self.__print(logging.INFO, i18n.t('command.log_execution', id=execution.id, period=period, status=status, duration=duration, group=group))
+
     def __print_process(self, process):
         """
         Prints a process.
@@ -1073,26 +1218,88 @@ class Command(Base):
             if hasattr(process, field):
                 self.__print(logging.INFO, i18n.t('command.log_field', field=field, value=getattr(process, field)))
 
-        self.__print(logging.INFO, i18n.t('command.log_divider'))
-        self.__print(logging.INFO, i18n.t('command.log_inputs'))
+        process_inputs = [input for input in process.inputs]
+
+        if len(process_inputs) > 0:
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_inputs'))
+
+            for data_item in process_inputs:
+                self.__print(logging.INFO, str(data_item), format=False)
+
+        process_options = [option for option in process.options]
+
+        if len(process_options) > 0:
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_options'))
+
+            for option in process_options:
+                self.__print(logging.INFO, str(option), format=False)
+
+        process_dispatchers = [dispatcher for dispatcher in process.dispatchers]
+
+        if len(process_dispatchers) > 0:
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_dispatchers'))
+
+            for dispatcher in process_dispatchers:
+                self.__print(logging.INFO, i18n.t('command.log_subdivider'))
+                self.__print(logging.INFO, str(dispatcher), format=False)
 
-        for data_item in process.inputs:
-            self.__print(logging.INFO, str(data_item), format=False)
+                for option in dispatcher.options:
+                    self.__print(logging.INFO, str(option), format=False)
+
+        self.__print(logging.INFO, i18n.t('command.log_bookend'))
+
+    def __print_service(self, service):
+        """
+        Prints the documentation for a service.
+
+        Args:
+            service: The service to be logged.
+        """
+        self.__print(logging.INFO, i18n.t('command.log_bookend'))
+        self.__print(logging.INFO, i18n.t('command.log_service', service=service.name))
+
+        self.__print(logging.INFO, i18n.t('command.log_field', field=Model._FIELD_CATEGORIES, value=service.categories))
+        self.__print(logging.INFO, i18n.t('command.log_field', field=Model._FIELD_KEYWORDS, value=service.keywords))
 
         self.__print(logging.INFO, i18n.t('command.log_divider'))
-        self.__print(logging.INFO, i18n.t('command.log_options'))
+        self.__print(logging.INFO, i18n.t('command.log_summary'))
+        self.__print(logging.INFO, service.documentation_summary, format=False)
 
-        for option in process.options:
-            self.__print(logging.INFO, str(option), format=False)
+        self.__print(logging.INFO, i18n.t('command.log_divider'))
+        self.__print(logging.INFO, i18n.t('command.log_description'))
+        self.__print(logging.INFO, service.documentation_description, format=False)
 
         self.__print(logging.INFO, i18n.t('command.log_divider'))
-        self.__print(logging.INFO, i18n.t('command.log_dispatchers'))
+        self.__print(logging.INFO, i18n.t('command.log_assumptions'))
+        self.__print(logging.INFO, service.documentation_assumptions, format=False)
+
+        if len(service.documentation_actions.strip()) > 0:
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_actions'))
+            self.__print(logging.INFO, service.documentation_actions, format=False)
+
+        if hasattr(service, Model._FIELD_DOCUMENTATION_INPUTS):
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_inputs'))
+
+            for input in service.documentation_inputs:
+                self.__print(logging.INFO, str(input), format=False)
 
-        for dispatcher in process.dispatchers:
-            self.__print(logging.INFO, i18n.t('command.log_subdivider'))
-            self.__print(logging.INFO, str(dispatcher), format=False)
+        if hasattr(service, Model._FIELD_DOCUMENTATION_OUTPUTS):
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_outputs'))
 
-            for option in dispatcher.options:
+            for output in service.documentation_outputs:
+                self.__print(logging.INFO, str(output), format=False)
+
+        if hasattr(service, Model._FIELD_DOCUMENTATION_OPTIONS):
+            self.__print(logging.INFO, i18n.t('command.log_divider'))
+            self.__print(logging.INFO, i18n.t('command.log_options'))
+
+            for option in service.documentation_options:
                 self.__print(logging.INFO, str(option), format=False)
 
         self.__print(logging.INFO, i18n.t('command.log_bookend'))
@@ -1234,16 +1441,8 @@ class Command(Base):
         else:
             data_items = []
 
-        # Find the service using its case-sensitive name (starts with).
-        service, _ = organisation.find_services(name=service_name)
-
-        # If the service cannot be found, then try it as a specific service for the organisation.
-        if service is None:
-            service = next((item for item in organisation.own_services if item.name == service_name), None)
-
-        if service is None:
-            raise CommandError(i18n.t('command.no_such_service', service=service_name))
-
+        # Find the service.
+        service = self.get_service(organisation, service_name)
         self.__print(logging.DEBUG, i18n.t('command.using_service', service=service.name))
 
         # Create the process with its options and inputs.
@@ -1416,3 +1615,7 @@ def main():
     Main entry point for command line.
     """
     Command().main()
+
+
+if __name__ == "__main__":
+    main()

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/fusion_platform/models/model.py

@@ -35,14 +35,21 @@ class Model(Base):
     # Define the standard template model paths. Override these with the correct paths.
     _PATH_CREATE = None
     _PATH_DELETE = None
+    _PATH_EDIT = None
     _PATH_GET = None
     _PATH_NEW = None
     _PATH_PATCH = None
 
+    # Define the expected model and list extras. Override these with the correct values.
+    _EXTRAS_MODEL = None
+    _EXTRAS_LIST = None
+
     # Useful fields and templates.
+    _FIELD_ABORT_REASON = 'abort_reason'
     _FIELD_AVAILABLE_DISPATCHERS = 'available_dispatchers'
     _FIELD_BOUNDS = 'bounds'
     _FIELD_CATEGORY = 'category'
+    _FIELD_CATEGORIES = 'categories'
     _FIELD_CHAINS = 'chains'
     _FIELD_CHAIN_INDEX = 'chain_index'
     _FIELD_CONSTRAINED_NAMES = 'constrained_names'
@@ -53,8 +60,13 @@ class Model(Base):
     _FIELD_DISPATCHERS = 'dispatchers'
     _FIELD_DOCUMENTATION_SUMMARY = 'documentation_summary'
     _FIELD_DOCUMENTATION_DESCRIPTION = 'documentation_description'
+    _FIELD_DOCUMENTATION_INPUTS = 'documentation_inputs'
+    _FIELD_DOCUMENTATION_OUTPUTS = 'documentation_outputs'
+    _FIELD_DOCUMENTATION_OPTIONS = 'documentation_options'
+    _FIELD_ENDED_AT = 'ended_at'
     _FIELD_ERROR = 'error'
     _FIELD_EXECUTIONS = 'executions'
+    _FIELD_EXIT_TYPE = 'exit_type'
     _FIELD_EXTENSIONS = 'extensions'
     _FIELD_FILE = 'file'
     _FIELD_FILE_NAME = 'file_name'
@@ -153,6 +165,27 @@ class Model(Base):
         self.__model = None
         self.__persisted = False
 
+    @classmethod
+    def _extract_extras(cls, response, extras=None):
+        """
+        Extracts the optional extras from the response. If the extras are not found, they are not loaded.
+
+        Args:
+            response: The response to be modified.
+            extras: The optional list of extras as tuples (key, attribute) to extract.
+
+        Returns:
+            The extracted extras.
+        """
+        extracted_extras = {}
+        model_extras = response.get(Model._RESPONSE_KEY_EXTRAS, {})
+
+        for key, attribute in (extras if extras is not None else []):
+            if (key is not None) and (attribute is not None):
+                extracted_extras[attribute] = model_extras.get(key)
+
+        return extracted_extras
+
     @property
     def attributes(self):
         """
@@ -308,9 +341,9 @@ class Model(Base):
     def get(self, **kwargs):
         """
         Gets the model object by loading it from the Fusion Platform<sup>&reg;</sup>. Uses the model's current id and base model id for the get unless explicit
-        values are provided via keyword arguments. This assumes the model is obtained using a GET RESTful request, and that the model data is held with the expected
-        dictionary key within the response. The model is then loaded using the supplied schema to obtain the corresponding Python representation of it, before
-        loading it into the model as a set of read-only attributes.
+        values are provided via keyword arguments. Any expected extras are also added. This assumes the model is obtained using a GET RESTful request, and that the
+        model data is held with the expected dictionary key within the response. The model is then loaded using the supplied schema to obtain the corresponding
+        Python representation of it, before loading it into the model as a set of read-only attributes.
 
         Args:
             kwargs: Any explicit ids to be used.
@@ -431,7 +464,7 @@ class Model(Base):
     @classmethod
     def _model_from_api_id(cls, session, **kwargs):
         """
-        Loads a model object with the given ids as keyword arguments from the Fusion Platform<sup>&reg;</sup>.
+        Loads a model object with the given ids as keyword arguments from the Fusion Platform<sup>&reg;</sup>. Any required extras are also added.
 
         Args:
             session: The linked session object for interfacing with the Fusion Platform<sup>&reg;</sup>.
@@ -455,7 +488,7 @@ class Model(Base):
     @classmethod
     def _models_from_api_ids(cls, session, ids):
         """
-        Generates an iterator through a series of models using their ids. Each model is loaded using an id.
+        Generates an iterator through a series of models using their ids. Each model is loaded using an id. Any extras are optionally added.
 
         Args:
             session: The linked session object for interfacing with the Fusion Platform<sup>&reg;</sup>.
@@ -471,10 +504,10 @@ class Model(Base):
         return (cls._model_from_api_id(session, **id) for id in ids)
 
     @classmethod
-    def _models_from_api_path(cls, session, path, items_per_request=24, reverse=False, filter=None, search=None, **kwargs):
+    def _models_from_api_path(cls, session, path, items_per_request=24, reverse=False, filter=None, search=None, load_extras=True, **kwargs):
         """
-        Generates an iterator through a series of models using a path which returns a list of objects. Each model is loaded from the list. Since API lists are
-        paged, the generator takes into account having to get subsequent pages of results.
+        Generates an iterator through a series of models using a path which returns a list of objects. Each model is loaded from the list with its expected extras.
+        Since API lists are paged, the generator takes into account having to get subsequent pages of results.
 
         Use the items per request, reverse and filter parameters to modify the set of results returned. The items per request parameter determines how many results
         are returned by each request to the API for a page of results, up to the maximum number of results available. The reverse parameter can be used to return
@@ -508,6 +541,7 @@ class Model(Base):
             reverse: Whether the list should be reversed or not. Default False.
             filter: The optional filter to be applied to the results. Default is no filter.
             search: The optional search term to be applied to the results. Default to no search term.
+            load_extras: Should the model extras be automatically loaded? Default True.
             kwargs: Any additional attributes which are to be set on each model which are not provided in each item from the path.
 
         Returns:
@@ -541,55 +575,40 @@ class Model(Base):
                 Model._RESPONSE_KEY_LAST) is not None else {}
             finished = len(last) <= 0
 
-            # Build the generator around all of the returned items, which must all have been persisted.
+            # Optionally extract the extras.
+            extracted_extras = cls._extract_extras(response, extras=cls._EXTRAS_LIST) if load_extras else {}
+
+            # Build the generator around all of the returned items, which must all have been persisted. Optional extras are added to each model.
             for item in response.get(Model._RESPONSE_KEY_LIST, []):
+                # Add the optional extras into the item.
+                for key, value in extracted_extras.items():
+                    item[key] = value
+
+                # Build the model from the modified item dictionary.
                 model = cls(session)
                 model._set_model_from_response(item, **kwargs)
                 model.__persisted = True
 
                 yield model
 
-    def _new(self, query_parameters=None, extras=None, **kwargs):
+    def _new(self, query_parameters=None, **kwargs):
         """
-        Gets a new template model object by loading it from the Fusion Platform<sup>&reg;</sup>. The explicit base model id value should be provided via a keyword
-        argument. This assumes the model is obtained using a GET RESTful request from the corresponding path, and that the model data is held with the expected
-        dictionary key within the response. The template model is then loaded using the supplied schema to obtain the corresponding Python representation of it,
-        before loading it into the model as a set of read-only attributes. If any extras are provided as a list of tuples (key, attribute), where key refers to the
-        field in the extras, and attribute is the corresponding model attribute to be set from the field, then each is added to the model.
+        Gets a new template model object by loading it from the Fusion Platform<sup>&reg;</sup>. Any expected extras are also added. The explicit base model id
+        value should be provided via a keyword argument. This assumes the model is obtained using a GET RESTful request from the corresponding path, and that the
+        model data is held with the expected dictionary key within the response. The template model is then loaded using the supplied schema to obtain the
+        corresponding Python representation of it, before loading it into the model as a set of read-only attributes.
 
         Args:
             query_parameters: The optional query parameters as a dictionary.
-            extras: The optional list of extras tuples (key, attribute) which should be added to the model.
             kwargs: Should include the base model id, if needed.
 
         Raises:
             RequestError: if the new fails.
             ModelError: if the model could not be loaded or validated from the Fusion Platform<sup>&reg;</sup>.
         """
-        # Get the data.
-        response = self._session.request(path=self._get_path(self.__class__._PATH_NEW, **kwargs), query_parameters=query_parameters)
 
-        # Assume that the resulting model is held within the expected key within the resulting dictionary.
-        if Model._RESPONSE_KEY_MODEL not in response:
-            raise ModelError(i18n.t('models.model.failed_model_new_model'))
-
-        # If any extras are required, extract them.
-        if (Model._RESPONSE_KEY_EXTRAS not in response) and (extras is not None):
-            raise ModelError(i18n.t('models.model.failed_model_new_extras'))
-
-        modified_response = response.get(Model._RESPONSE_KEY_MODEL, {})
-        model_extras = response.get(Model._RESPONSE_KEY_EXTRAS, {})
-
-        for key, attribute in (extras if extras is not None else []):
-            if (key is not None) and (attribute is not None):
-                modified_response[attribute] = model_extras.get(key)
-
-        # Add in the keyword arguments to the response so that they are set in the model as well.
-        for key, value in kwargs.items():
-            modified_response[key] = value
-
-        # Load the response into the model. We ignore missing required fields and those which are None.
-        self._set_model_from_response(modified_response, partial=True)
+        # Get and load the data, setting the extras as well.
+        self._send_and_load(self._get_path(self.__class__._PATH_NEW, **kwargs), partial=True, query_parameters=query_parameters, **kwargs)
 
         # The model is not persisted.
         self.__persisted = False
@@ -604,25 +623,40 @@ class Model(Base):
         """
         return self.__persisted
 
-    def _send_and_load(self, path, method=Session.METHOD_GET, body=None, key=_RESPONSE_KEY_MODEL):
+    def _send_and_load(self, path, method=Session.METHOD_GET, body=None, key=_RESPONSE_KEY_MODEL, partial=False, query_parameters=None, **kwargs):
         """
-        Sends the body to the path using the method and then loads the resulting model.
+        Sends the body to the path using the method and then loads the resulting model. Additional query parameters may be specified that should be added to the
+        model. Keyword arguments can be used to be added to the model, overriding any values that may have been retrieved.
 
         Args:
             path: The path to send the request to.
             method: The optional RESTful method for sending. Default is GET.
             body: The optional body to send. Default is None.
             key: The optional key to load the model from the response. Default is RESPONSE_KEY_MODEL.
+            partial: Skip validation of required fields which are missing? Default False.
+            query_parameters: The optional query parameters as a dictionary.
+            kwargs: Should include the base model id, if needed.
         """
         # Send the request.
-        response = self._session.request(path=path, method=method, body=body)
+        response = self._session.request(path=path, query_parameters=query_parameters, method=method, body=body)
 
         # Assume that the resulting model is held within the expected key within the resulting dictionary.
         if key not in response:
             raise ModelError(i18n.t('models.model.failed_model_send_and_load'))
 
-        # Load the response into the model.
-        self._set_model_from_response(response.get(key, {}))
+        # If any extras are required, extract them and add them to the model.
+        modified_response = response.get(key, {}) if key is not None else response
+        extracted_extras = self.__class__._extract_extras(response, extras=self.__class__._EXTRAS_MODEL)
+
+        for key, value in extracted_extras.items():
+            modified_response[key] = value
+
+        # Add in the keyword arguments to the response so that they are set in the model as well.
+        for key, value in kwargs.items():
+            modified_response[key] = value
+
+        # Load the response into the model. Optionally ignore missing required fields and those which are None.
+        self._set_model_from_response(modified_response, partial=partial)
 
     def __setattr__(self, key, value):
         """
@@ -760,8 +794,8 @@ class Model(Base):
     def update(self, **kwargs):
         """
         Attempts to update the model object with the given values. For models which have not been persisted, the relevant fields are updated without validation,
-        which will occur when the model is persisted. For models which have been persisted, the update is made via the Fusion Platform<sup>&reg;</sup>. All current model
-        attributes are sent to the Fusion Platform<sup>&reg;</sup> which will automatically ignore any which are not allowed or are read-only.
+        which will occur when the model is persisted. For models which have been persisted, the update is made via the Fusion Platform<sup>&reg;</sup>. All current
+        model attributes are sent to the Fusion Platform<sup>&reg;</sup> which will automatically ignore any which are not allowed or are read-only.
 
         Args:
             kwargs: The model attributes which are to be patched.

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/fusion_platform/models/organisation.py

@@ -301,8 +301,7 @@ class Organisation(Model):
         """
         # Get a new template for the process model using the service.
         process = Process(self._session)
-        process._new(query_parameters={Model._get_id_name(Service.__name__): service.id},
-                     extras=[(self.__class__._FIELD_DISPATCHERS, self.__class__._FIELD_AVAILABLE_DISPATCHERS)], organisation_id=self.id, name=name)
+        process._new(query_parameters={Model._get_id_name(Service.__name__): service.id}, organisation_id=self.id, name=name)
 
         return process
 

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/fusion_platform/models/process.py

@@ -228,7 +228,7 @@ class Option(Model):
         Returns:
             A string representation of the object.
         """
-        return f"{self.title} ('{self.name}', {self.data_type}{', required' if self.required else ''}) = {self.value}: {self.description}"
+        return f"{self.title} ('{self.name}', {self.data_type}{' ' + str(self.constrained_values) if self.data_type == fusion_platform.DATA_TYPE_CONSTRAINED else ''}{', required' if self.required else ''}) = {self.value}: {self.description}"
 
 
 # Define a model class for an input which overrides the representation to display more relevant information.
@@ -319,6 +319,7 @@ class ProcessExecutionStatusSchema(Schema):
     group_count = fields.Integer(allow_none=True)
     job_status = fields.String(required=True)
     abort_reason = fields.String(allow_none=True)
+    exit_type = fields.String(allow_none=True)
     started_at = fields.DateTime(required=True)
     ended_at = fields.DateTime(allow_none=True)
     delete_warning_status = fields.String(required=True)
@@ -517,6 +518,10 @@ class Process(Model):
     _PATH_EXECUTIONS = f"{_PATH_BASE}/executions"
     _PATH_STOP = f"{_PATH_BASE}/stop"
 
+    # Define the expected model and list extras.
+    _EXTRAS_MODEL = [(Model._FIELD_DISPATCHERS, Model._FIELD_AVAILABLE_DISPATCHERS)]
+    _EXTRAS_LIST = [(Model._FIELD_DISPATCHERS, Model._FIELD_AVAILABLE_DISPATCHERS)]
+
     # Process status values.
     _PROCESS_STATUS_EXECUTE = 'execute'
     _PROCESS_STATUS_STOP = 'stop'
@@ -631,6 +636,12 @@ class Process(Model):
         modified_response = response.get(Model._RESPONSE_KEY_MODEL, {})
         modified_response['organisation_id'] = self.organisation_id
 
+        # Extract the extras.
+        extracted_extras = self.__class__._extract_extras(response, extras=self.__class__._EXTRAS_LIST)
+
+        for key, value in extracted_extras.items():
+            modified_response[key] = value
+
         # Load the response into the model. We ignore missing required fields and those which are None.
         process._set_model_from_response(modified_response, partial=True)
 
@@ -745,7 +756,8 @@ class Process(Model):
             RequestError: if any get fails.
             ModelError: if a model could not be loaded or validated from the Fusion Platform<sup>&reg;</sup>.
         """
-        return ProcessExecution._models_from_api_path(self._session, self._get_path(self.__class__._PATH_EXECUTIONS), reverse=True)  # Most recent first.
+        return ProcessExecution._models_from_api_path(self._session, self._get_path(self.__class__._PATH_EXECUTIONS), reverse=True,
+                                                      load_extras=False)  # Most recent first.
 
     def find_executions(self, id=None, group_id=None):
         """
@@ -766,7 +778,7 @@ class Process(Model):
             [(self.__class__._FIELD_ID, self.__class__._FILTER_MODIFIER_EQ, id), (self.__class__._FIELD_GROUP_ID, self.__class__._FILTER_MODIFIER_EQ, group_id)])
 
         # Build the partial find generator and execute it.
-        find = partial(ProcessExecution._models_from_api_path, self._session, self._get_path(self.__class__._PATH_EXECUTIONS), filter=filter)
+        find = partial(ProcessExecution._models_from_api_path, self._session, self._get_path(self.__class__._PATH_EXECUTIONS), filter=filter, load_extras=False)
         return self.__class__._first_and_generator(find)
 
     @property

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/fusion_platform/models/process_execution.md

@@ -33,6 +33,7 @@
 * **stopped**: Has the execution been stopped by a user?
 * **abort**: Has the execution been aborted?
 * **abort_reason**: The reason for any abort of the execution.
+* **exit_type**: The type of exit experienced by the execution.
 * **success**: Has the execution completed successfully?
 * **progress**: Percentage progress of the execution.
 * **delete_expiry**: When will the execution expire and therefore be deleted?

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/fusion_platform/models/process_execution.py

@@ -106,6 +106,7 @@ class ProcessExecutionSchema(Schema):
     stopped = fields.Boolean(required=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     abort = fields.Boolean(required=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     abort_reason = fields.String(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
+    exit_type = fields.String(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     success = fields.Boolean(required=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     progress = fields.Integer(required=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     delete_expiry = fields.DateTime(required=True)

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/fusion_platform/models/service.md

@@ -68,6 +68,10 @@
 * **charge_expression_platform**: The expression used to calculate the charge in FPUs levied for the platform.
 * **charge_expression_owner**: The expression used to calculate the charge in FPUs levied for the owner of the service.
 * **organisations**: The optional whitelist of organisations who can use this service.
+* **organisation_charge_expressions**: For the whitelisted organisations, these provide the optional charge expressions to be applied.
+    * **id**: The owning organisation.
+    * **platform**: The expression used to calculate the charge in FPUs levied for the platform.
+    * **owner**: The expression used to calculate the charge in FPUs levied for the owner of the service.
 * **geographic_regions**: The optional list of geographic regions from which this service can be used.
 * **documentation_summary**: The documentation summary of the service.
 * **documentation_description**: The documentation description of the service.

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/fusion_platform/models/service.py

@@ -184,6 +184,22 @@ class ServiceValidationSchema(Schema):
         ordered = True
 
 
+class ServiceOrganisationChargeExpressionSchema(Schema):
+    """
+    Nested schema class for service organisation.
+    """
+    id = fields.UUID(required=True)
+    platform = fields.String(allow_none=True)
+    owner = fields.String(allow_none=True)
+
+    class Meta:
+        """
+        When loading an object, make sure we exclude any unknown fields, rather than raising an exception, and put fields in their definition order.
+        """
+        unknown = EXCLUDE
+        ordered = True
+
+
 class ServiceSchema(Schema):
     """
     Schema class for service model.
@@ -230,6 +246,7 @@ class ServiceSchema(Schema):
     charge_expression_owner = fields.String(allow_none=True)  # Changed to optional.
 
     organisations = fields.List(fields.UUID(required=True), allow_none=True)
+    organisation_charge_expressions = fields.List(fields.Nested(ServiceOrganisationChargeExpressionSchema()), allow_none=True)
     geographic_regions = fields.List(fields.String(required=True), allow_none=True)
 
     # Removed creator.

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/fusion_platform/translations.py

@@ -13,19 +13,37 @@ import i18n
 # @formatter:off
 i18n.add_translation('command.validate_constrained_error', 'Not one of %{constrained}', 'en')
 i18n.add_translation('command.unknown_command', 'Unknown command \'%{command}\'', 'en')
+i18n.add_translation('command.no_process_or_service', 'No such service, process or execution \'%{process_or_service}\'', 'en')
 i18n.add_translation('command.no_such_service', 'No such service \'%{service}\'', 'en')
 i18n.add_translation('command.no_such_process', 'No such process or execution \'%{process}\'', 'en')
 i18n.add_translation('command.no_such_organisation', 'No such organisation \'%{organisation}\'', 'en')
 i18n.add_translation('command.no_such_input', 'No such input \'%{input_name}\'', 'en')
 i18n.add_translation('command.no_executions', 'No executions for process \'%{process}\'', 'en')
 i18n.add_translation('command.invalid_login_response', 'Incorrect username or password', 'en')
-i18n.add_translation('command.log_subdivider', '................................................................................................', 'en')
-i18n.add_translation('command.log_process', 'Process \'%{process}\'', 'en')
+i18n.add_translation('command.log_execution_group', ' (group \'%{group_id}\' %{group_index} of %{group_count})', 'en')
+i18n.add_translation('command.log_execution_duration', ' - %{minutes} minute(s)', 'en')
+i18n.add_translation('command.log_execution_period', ' (%{started_at}%{ended_at})', 'en')
+i18n.add_translation('command.log_execution_ended_at', ' -> %{ended_at}', 'en')
+i18n.add_translation('command.log_execution_failed', 'failed%{exit_type}%{abort_reason}', 'en')
+i18n.add_translation('command.log_execution_exit_type', ' (%{exit_type})', 'en')
+i18n.add_translation('command.log_execution_abort_reason', ': %{abort_reason}', 'en')
+i18n.add_translation('command.log_execution_stopped', 'stopped', 'en')
+i18n.add_translation('command.log_execution_progress', 'processing %{progress}%%', 'en')
+i18n.add_translation('command.log_execution_success', 'success', 'en')
+i18n.add_translation('command.log_actions', 'Actions:', 'en')
+i18n.add_translation('command.log_assumptions', 'Assumptions:', 'en')
+i18n.add_translation('command.log_description', 'Description:', 'en')
+i18n.add_translation('command.log_summary', 'Summary:', 'en')
+i18n.add_translation('command.log_dispatchers', 'Dispatchers:', 'en')
 i18n.add_translation('command.log_options', 'Options:', 'en')
+i18n.add_translation('command.log_outputs', 'Outputs:', 'en')
 i18n.add_translation('command.log_inputs', 'Inputs:', 'en')
+i18n.add_translation('command.log_execution', 'Execution \'%{id}\'%{period}: %{status}%{duration}%{group}', 'en')
+i18n.add_translation('command.log_service', 'Service \'%{service}\'', 'en')
+i18n.add_translation('command.log_process', 'Process \'%{process}\'', 'en')
 i18n.add_translation('command.log_field', '%{field}: %{value}', 'en')
+i18n.add_translation('command.log_subdivider', '................................................................................................', 'en')
 i18n.add_translation('command.log_divider', '------------------------------------------------------------------------------------------------', 'en')
-i18n.add_translation('command.log_dispatchers', 'Dispatchers:', 'en')
 i18n.add_translation('command.log_bookend', '************************************************************************************************', 'en')
 i18n.add_translation('command.wait_for_next', 'Waiting for next execution...', 'en')
 i18n.add_translation('command.using_storage', 'Uploading storage \'%{filename}\' with id %{storage_id} to \'%{storage_name}\'', 'en')
@@ -48,7 +66,7 @@ i18n.add_translation('command.download_process', 'Downloading process \'%{proces
 i18n.add_translation('command.download_files', 'Downloading %{files} file(s)...', 'en')
 i18n.add_translation('command.download_executions', 'Gathering files for %{executions} execution(s)...', 'en')
 i18n.add_translation('command.download_execution', 'Downloading execution %{execution} to %{output}', 'en')
-i18n.add_translation('command.define_storage', 'Defining %{files} storage file(s)...', 'en')
+i18n.add_translation('command.define_storage', 'Defining storage file(s) for %{slices} slice(s)...', 'en')
 i18n.add_translation('command.define_process', 'Defining \'%{process}\' (inputs %{inputs}, storage %{storage})', 'en')
 i18n.add_translation('command.define_inputs', 'Defining %{files} input file(s)...', 'en')
 i18n.add_translation('command.add_dispatcher', 'Add %{dispatcher} dispatcher?', 'en')
@@ -97,10 +115,18 @@ i18n.add_translation('command.start.definition_help', 'the names of the service
 i18n.add_translation('command.start.definition_long', 'service_or_yaml', 'en')
 i18n.add_translation('command.start.help', 'starts a process', 'en')
 i18n.add_translation('command.start.command', 'start', 'en')
-i18n.add_translation('command.subparser', 'starts, defines or downloads a process', 'en')
-i18n.add_translation('command.verbose_help', 'show verbose output (default \'%%(default)s\')', 'en')
-i18n.add_translation('command.verbose_long', '--verbose', 'en')
-i18n.add_translation('command.verbose_short', '-v', 'en')
+i18n.add_translation('command.display.service_or_process_help', 'the names of the service, id, SSD id, process, process id or associated execution id that are to be displayed', 'en')
+i18n.add_translation('command.display.service_or_process_long', 'process_or_service', 'en')
+i18n.add_translation('command.display.help', 'displays service information or a configured process', 'en')
+i18n.add_translation('command.display.command', 'display', 'en')
+i18n.add_translation('command.subparser', 'displays a service or process, or starts, defines or downloads a process', 'en')
+i18n.add_translation('command.version_content', '%%(prog)s %{version} (%{version_date})', 'en')
+i18n.add_translation('command.version_help', 'show the version information and exit', 'en')
+i18n.add_translation('command.version_long', '--version', 'en')
+i18n.add_translation('command.version_short', '-v', 'en')
+i18n.add_translation('command.debug_help', 'show debug output (default \'%%(default)s\')', 'en')
+i18n.add_translation('command.debug_long', '--debug', 'en')
+i18n.add_translation('command.debug_short', '-b', 'en')
 i18n.add_translation('command.organisation_help', 'the organisation to be used', 'en')
 i18n.add_translation('command.organisation_long', '--organisation', 'en')
 i18n.add_translation('command.organisation_short', '-g', 'en')
@@ -113,18 +139,26 @@ i18n.add_translation('command.deployment_short', '-y', 'en')
 i18n.add_translation('command.epilog', '''
 For more detailed options, use:
 
+  fusion_platform display --help
   fusion_platform start --help
   fusion_platform define --help
   fusion_platform download --help
 
 ''', 'en')
 i18n.add_translation('command.description', '''
-Use this command to execute any service (by case-sensitive name) or to retrieve its inputs and outputs. The service can be selected via command line options or
-defined by a YAML file. This command can also be used to build a YAML file from an existing process.
+Use this command to display service information and processes, and to start, download or define processes. Processes can be selected via command line options or
+defined by a YAML file.
 
 Usage:
-  The following will attempt to create one or more processes from the given \'service_name\' to use the inputs (in order) and options and execute them. All processes
-  will use the same inputs and options:
+  The following will display information about one or more services or processes from the given \'service_or_process_name\'.
+
+    fusion_platform display <service_or_process_name> ...
+
+  For a service, this will display the full service documentation, including its expected inputs and options. For a process, it will show the current process
+  configuration.
+
+  The following will attempt to create one or more processes from the given \'service_name\' to use the inputs (in order) and options and execute them. All
+  processes will use the same inputs and options:
 
     fusion_platform start <service_name> ... -l <input_file|input_name> ... -p <option=value> ...
 
@@ -237,8 +271,6 @@ i18n.add_translation('models.fields.boolean.invalid', 'Not a valid boolean', 'en
 i18n.add_translation('models.model.update_empty_body', 'Update cannot be requested as there are no attributes to be used (read-only attributes have been removed)', 'en')
 i18n.add_translation('models.model.create_empty_body', 'Create cannot be requested as there are no attributes to be used (read-only attributes have been removed)', 'en')
 i18n.add_translation('models.model.failed_model_validation', 'Failed to validate model: %{message}', 'en')
-i18n.add_translation('models.model.failed_model_new_extras', 'Failed to get model extras from response', 'en')
-i18n.add_translation('models.model.failed_model_new_model', 'Failed to get model template from response', 'en')
 i18n.add_translation('models.model.failed_model_send_and_load', 'Failed to request and load model', 'en')
 i18n.add_translation('models.model.no_such_keys', 'No such keys %{keys}', 'en')
 i18n.add_translation('models.model.readonly_property', 'Property %{property} is read-only and cannot be set', 'en')

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12/fusion_platform_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fusion-platform-python-sdk
-Version: 1.14.7
+Version: 1.15.12
 Summary: Python SDK used to interact with the Fusion Platform(r)
 Home-page: https://github.com/d-cat-support/fusion-platform-python-sdk
 Author: Digital Content Analysis Technology Ltd

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/setup.py

@@ -19,7 +19,7 @@ PACKAGE_DIR = pathlib.Path(__file__).parent
 # @formatter:off
 setup(
     name='fusion-platform-python-sdk',
-    version='1.14.7',
+    version='1.15.12',
     description='Python SDK used to interact with the Fusion Platform(r)',
     long_description=(PACKAGE_DIR / 'README.md').read_text(),
     long_description_content_type='text/markdown',

{fusion_platform_python_sdk-1.14.7 → fusion_platform_python_sdk-1.15.12}/tests/test_session.py

@@ -61,17 +61,15 @@ class TestSession(CustomTestCase):
         """
 
         with tempfile.TemporaryDirectory() as dir:
-            destination = os.path.join(dir, 'file.pdf')
+            destination = os.path.join(dir, 'file.html')
 
             session = Session()
 
             with pytest.raises(RequestError):
-                session.download_file('https://www.d-cat.co.uk/rails/active_storage/blobs/rubbish/Water%20RA%20Webinar%20IoT%20September%202020.pdf?', destination)
+                session.download_file('https://www.d-cat.co.uk/.well-known/acme-challenge/test.html', destination)
 
             self.assertFalse(os.path.exists(destination))
-            session.download_file(
-                'https://www.d-cat.co.uk/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBkUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--8a6deba9596edd3e9f0c341d274ae1317da59bbc/Water%20RA%20Webinar%20IoT%20September%202020.pdf?',
-                destination, self.download_callback)
+            session.download_file('https://www.d-cat.co.uk/home', destination, self.download_callback)
             self.assertTrue(os.path.exists(destination))
             self.assertIsNotNone(self._download_size)