fusion-platform-python-sdk 2.2.2__py3-none-any.whl → 2.2.5__py3-none-any.whl

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__ = '2.2.2'
-__version_date__ = '2026-04-28T07:42:59Z'
+__version__ = '2.2.5'
+__version_date__ = '2026-09-01T12:45:40Z'
 
 # Exclude certain sub-modules from documentation.
 # @formatter:off

fusion_platform/command.py

@@ -1264,16 +1264,19 @@ class Command(Base):
         )
 
         # Create the subparsers.
-        subparsers = parser.add_subparsers(help=i18n.t('command.subparser'), dest='command')
+        subparsers = parser.add_subparsers(description=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_list = subparsers.add_parser(i18n.t('command.list.command'), help=i18n.t('command.list.help'))
-        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'))
+        parser_list = subparsers.add_parser(i18n.t('command.list.command'), help=i18n.t('command.list.help'), description=i18n.t('command.list.description'))
+        parser_display = subparsers.add_parser(i18n.t('command.display.command'), help=i18n.t('command.display.help'),
+                                               description=i18n.t('command.display.description'))
+        parser_start = subparsers.add_parser(i18n.t('command.start.command'), help=i18n.t('command.start.help'), description=i18n.t('command.start.description'))
+        parser_define = subparsers.add_parser(i18n.t('command.define.command'), help=i18n.t('command.define.help'),
+                                              description=i18n.t('command.define.description'))
+        parser_download = subparsers.add_parser(i18n.t('command.download.command'), help=i18n.t('command.download.help'),
+                                                description=i18n.t('command.download.description'))
 
         # Add in the common arguments.
         for subparser in [parser_list, parser_display, parser_start, parser_define, parser_download]:

fusion_platform/models/process.py

@@ -588,7 +588,7 @@ class Process(Model):
                 break
 
         if found_dispatcher is None:
-            raise ModelError(i18n.t('models.process.cannot_find_dispatcher'))
+            raise ModelError(i18n.t('models.process.cannot_find_dispatcher', dispatcher=name if name is not None else number))
 
         # Add the dispatcher to the end of the existing list.
         dispatchers = list(self._model.get(self.__class__._FIELD_DISPATCHERS, []))  # Convert read-only tuple to list, so we can modify it.
@@ -850,7 +850,7 @@ class Process(Model):
                 break
 
         if found_dispatcher is None:
-            raise ModelError(i18n.t('models.process.cannot_find_dispatcher'))
+            raise ModelError(i18n.t('models.process.cannot_find_dispatcher', dispatcher=number))
 
         # Remove the dispatcher from the existing list.
         dispatchers = list(self._model.get(self.__class__._FIELD_DISPATCHERS, []))  # Convert read-only tuple to list, so we can modify it.
@@ -899,7 +899,7 @@ class Process(Model):
                 break
 
         if found_dispatcher is None:
-            raise ModelError(i18n.t('models.process.cannot_find_dispatcher'))
+            raise ModelError(i18n.t('models.process.cannot_find_dispatcher', dispatcher=number))
 
         # Get the dispatcher so that it can be modified.
         dispatchers = list(self._model.get(self.__class__._FIELD_DISPATCHERS, []))  # Convert read-only tuple to list, so we can access it.
@@ -921,7 +921,7 @@ class Process(Model):
                     break
 
             if found_option is None:
-                raise ModelError(i18n.t('models.process.cannot_find_option'))
+                raise ModelError(i18n.t('models.process.cannot_find_dispatcher_option', option=option_name))
 
             # We can now update the option. All options are expressed as strings with the correct format.
             option_value = Option.get_option_value(found_option, value, coerce_value)
@@ -981,7 +981,7 @@ class Process(Model):
                 break
 
         if found_input is None:
-            raise ModelError(i18n.t('models.process.cannot_find_input'))
+            raise ModelError(i18n.t('models.process.cannot_find_input', input=input.input if input is not None else number))
 
         # Check that all the files in the data object are ready to be used. Along the way, pick out the first file type.
         found_file_type = None
@@ -1041,7 +1041,7 @@ class Process(Model):
                 break
 
         if found_option is None:
-            raise ModelError(i18n.t('models.process.cannot_find_option'))
+            raise ModelError(i18n.t('models.process.cannot_find_option', option=option.name if option is not None else name))
 
         # We can now update the option. All options are expressed as strings with the correct format.
         option_value = Option.get_option_value(found_option, value, coerce_value)
@@ -1113,15 +1113,15 @@ class Process(Model):
             RequestError: if any request fails.
             ModelError: if a model could not be loaded or validated from the Fusion Platform<sup>&reg;</sup>.
         """
+        # Confirm that the model is executing. We do not do this in the loop as the process will be set to stop once all of its executions have finished.
+        if hasattr(self, self.__class__._FIELD_PROCESS_STATUS) and (self.process_status == Process._PROCESS_STATUS_STOP):
+            raise ModelError(i18n.t('models.process.execution_stopped'))
+
         # Wait until we find the next execution.
         while True:
             # Load in the most recent version of the model.
             self.get(organisation_id=self.organisation_id)
 
-            # Check that the model is executing. It may have stopped on error.
-            if hasattr(self, self.__class__._FIELD_PROCESS_STATUS) and (self.process_status == Process._PROCESS_STATUS_STOP):
-                raise ModelError(i18n.t('models.process.execution_stopped'))
-
             # Check whether we have the next execution listed in the model. We sort the list to find the most recent.
             self._logger.debug('checking for next execution')
             executions = []
@@ -1143,7 +1143,7 @@ class Process(Model):
 
             # Stop if we have an execution which is beyond the repeat start date.
             if execution is not None:
-                self._logger.debug('execution %s found', execution.get(self.__class__._FIELD_ID))
+                self._logger.debug('execution %s found', execution)
                 break
 
             # If we have no recent executions, and longer than the allowed period has elapsed since the next execution was meant to start, then raise an exception.

fusion_platform/translations.py

@@ -80,11 +80,13 @@ i18n.add_translation('command.dispatch_intermediate', 'Dispatch intermediate com
 i18n.add_translation('command.add_dispatcher', 'Add %{dispatcher} dispatcher?', 'en')
 i18n.add_translation('command.download.process_help', 'the name of the process, the process id or execution id to download', 'en')
 i18n.add_translation('command.download.process_long', 'process', 'en')
-i18n.add_translation('command.download.help', 'downloads the inputs and/or outputs for each process', 'en')
+i18n.add_translation('command.download.description', 'Downloads the inputs and/or outputs for existing processes.', 'en')
+i18n.add_translation('command.download.help', 'downloads the inputs and/or outputs for existing processes', 'en')
 i18n.add_translation('command.download.command', 'download', 'en')
 i18n.add_translation('command.define.process_help', 'the name of the process, the process id or execution id to build the YAML file', 'en')
 i18n.add_translation('command.define.process_long', 'process', 'en')
-i18n.add_translation('command.define.help', 'outputs a YAML file for each existing process', 'en')
+i18n.add_translation('command.define.description', 'Creates new YAML files to define existing processes.', 'en')
+i18n.add_translation('command.define.help', 'creates new YAML files to define existing processes', 'en')
 i18n.add_translation('command.define.command', 'define', 'en')
 i18n.add_translation('command.start.no_wait_for_completion_help', 'do not wait for the execution to complete (default %%(default)s)', 'en')
 i18n.add_translation('command.start.no_wait_for_completion_long', '--no_wait_for_completion', 'en')
@@ -127,15 +129,18 @@ i18n.add_translation('command.start.input_list_long', '--input_list', 'en')
 i18n.add_translation('command.start.input_list_short', '-l', 'en')
 i18n.add_translation('command.start.definition_help', 'the names of the service used to start processes or YAML files which defines everything', 'en')
 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.description', 'Creates and starts new processes.', 'en')
+i18n.add_translation('command.start.help', 'creates and starts new processes', 'en')
 i18n.add_translation('command.start.command', 'start', '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.description', 'Displays details of services or existing processes.', 'en')
+i18n.add_translation('command.display.help', 'displays details of services or existing processes', 'en')
 i18n.add_translation('command.display.command', 'display', 'en')
-i18n.add_translation('command.list.help', 'lists configured processes', 'en')
+i18n.add_translation('command.list.description', 'Lists all configured processes.', 'en')
+i18n.add_translation('command.list.help', 'lists all configured processes', 'en')
 i18n.add_translation('command.list.command', 'list', 'en')
-i18n.add_translation('command.subparser', 'displays a service or process, or starts, defines or downloads a process', 'en')
+i18n.add_translation('command.subparser', 'Commands are available to display a service or process, or start, define or download 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')
@@ -306,9 +311,10 @@ i18n.add_translation('models.process.execution_stopped', 'Process execution has
 i18n.add_translation('models.process.wrong_file_type', 'File type of supplied data object (%{actual}) does not match the file type for the input (%{expected})', 'en')
 i18n.add_translation('models.process.data_not_ready', 'Data object is not ready to be used in a process', 'en')
 i18n.add_translation('models.process.option_wrong_type', 'Option value should be of type %{type}', 'en')
-i18n.add_translation('models.process.cannot_find_option', 'No such option', 'en')
-i18n.add_translation('models.process.cannot_find_input', 'No such input', 'en')
-i18n.add_translation('models.process.cannot_find_dispatcher', 'No such dispatcher', 'en')
+i18n.add_translation('models.process.cannot_find_dispatcher_option', 'No such dispatcher option \'%{option}\'', 'en')
+i18n.add_translation('models.process.cannot_find_option', 'No such option \'%{option}\'', 'en')
+i18n.add_translation('models.process.cannot_find_input', 'No such input %{input}', 'en')
+i18n.add_translation('models.process.cannot_find_dispatcher', 'No such dispatcher \'%{dispatcher}\'', 'en')
 i18n.add_translation('models.process.option_not_specified', 'Option name or object must be provided to set option', 'en')
 i18n.add_translation('models.process.data_not_specified', 'Data object must be provided to set input', 'en')
 i18n.add_translation('models.process.input_not_specified', 'Input number or object must be provided to set input', 'en')

{fusion_platform_python_sdk-2.2.2.dist-info → fusion_platform_python_sdk-2.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fusion-platform-python-sdk
-Version: 2.2.2
+Version: 2.2.5
 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-2.2.2.dist-info → fusion_platform_python_sdk-2.2.5.dist-info}/RECORD

@@ -1,7 +1,7 @@
-fusion_platform/__init__.py,sha256=FmWrrWcyGr0t9Ngs1gP7iAOznqxaOQA_oqamCc-AA08,7410
+fusion_platform/__init__.py,sha256=_qV7P3Fh1KvJlm7cnB6A6IiFe2sWDniiASuFABZIllM,7410
 fusion_platform/__main__.py,sha256=R5HbEtVMEtyv4BqWpn1cob-wJ2-g9IFhwP1WGDLF79g,266
 fusion_platform/base.py,sha256=QsVxjk4sXrcFB6zcH6dmP4BL956bXVFE_ksO-LmlhSk,1456
-fusion_platform/command.py,sha256=onfCrT_jJ7YFL6MA7Xch7uAGTtrJ8bjMzSgZB5k8Udo,92328
+fusion_platform/command.py,sha256=Ake_YApf_MI-SpFTs2bZdRjU2kjnV8623CGsmqcLOwc,92726
 fusion_platform/detailed_example.py,sha256=3mcv_lAmkY9bf9-ZfoY-Ug7dfDxX-GMGzf6XOLChcHw,4579
 fusion_platform/documentation.py,sha256=m4uiD28sxNfDSkHEkaGrrW-QVPt-Ooz9Hhre1R2vwy4,4092
 fusion_platform/fusion_platform_sdk.pdf,sha256=eu8223jBte1UbaBeQ6CNeVISU3Kb446qXLpwbJXO0Z0,1792653
@@ -11,7 +11,7 @@ fusion_platform/localisations.py,sha256=fq7kFJjEXT2S0HDhkjV5hiDoxOLJ_i-FIpq2LqrS
 fusion_platform/localise.py,sha256=TDG3b9OnqxmYu7jSFaxvy3KPwUD9Llg-qYHxDc5KiyY,1189
 fusion_platform/quick_example.py,sha256=KLb-dydYzVW_kDGf7pyFWugnVEeI69sBm3Ss0Et5HZ0,1891
 fusion_platform/session.py,sha256=dmArPmniTreSU-cOyw1OHqVhtbViqwdA9VR9P6GdWxk,12440
-fusion_platform/translations.py,sha256=8NIbw3VW7OglWXBoncKSVlzB3vQNkQw27-vqQiQnQN8,25740
+fusion_platform/translations.py,sha256=JGZlz0z7rZbg-nDOVL-cUqxY33D2jfBus5qUyeIDKJE,26483
 fusion_platform/common/__init__.py,sha256=7hmOi1N27eeAQd8sA07nm4cs4lltqMrviO7giRFEGmc,133
 fusion_platform/common/raise_thread.py,sha256=I3jn39VLK6LM-Q8ou-OzLk37yjABTIeklTwakO4If9Y,1398
 fusion_platform/common/utilities.py,sha256=LCVIWF0CzNEhlug5e2PHuGfH0XSZ7V-GtlHWV1G8RyQ,6590
@@ -27,7 +27,7 @@ fusion_platform/models/model.py,sha256=jw1qs3CkGENwmdRMSgbCcYuEp8XGBhpDUxizf-lzB
 fusion_platform/models/organisation.md,sha256=sEqpImqM4H7T1D_0LuUVuMD_BaWSuPL5m-P0O13Qruw,1475
 fusion_platform/models/organisation.py,sha256=r8u7NNzh0jlcSC_QEfO8nA-ZRNz0D50AtYZTk-LoRNk,14968
 fusion_platform/models/process.md,sha256=ipC6yu3v1SC5yO5c58LO5CVclihp_osZCLNMvQvPUhE,2154
-fusion_platform/models/process.py,sha256=mNe4WmUYzTV7eDZGZRU7IBLLno6-Kp-GLLgY6Wj0A6A,52545
+fusion_platform/models/process.py,sha256=LhV8hDKJIudtrnw1rdhejZri-b2PAGMa67x-P-Tju7A,52804
 fusion_platform/models/process_execution.md,sha256=mM1yj4iJ4XCOo6i_dqq1ck8vJkkXxhK1R19odxOjLHo,2666
 fusion_platform/models/process_execution.py,sha256=jFWo9L980yWK1wRcSNIzHC7P-NoFgv2M9KKF1yXhL7Y,9329
 fusion_platform/models/process_service_execution.md,sha256=upWQZ7MJ6O79tXK8fI7NvAet0XsQfwC8O2u5SURsT-A,4062
@@ -38,9 +38,9 @@ fusion_platform/models/service.md,sha256=qgZp9lEclkLT3vUDvd5SybysbnfBs0IuW3YdTup
 fusion_platform/models/service.py,sha256=xTJY7EvlGgvnhGToWH4xH_Br4Xf1ur70UimkYd5qB_g,10099
 fusion_platform/models/user.md,sha256=yTJwkwZX6ub_rL7UoJdf_FwsV4AIlDgilR5jehy9nEg,1063
 fusion_platform/models/user.py,sha256=O9J6944eKXgIaJqiaAI8ctb4i_liqPFtc3FteFsMfg0,5630
-fusion_platform_python_sdk-2.2.2.dist-info/licenses/LICENSE.txt,sha256=rRNH3lp1zmb02PJQpWFHR49EXtRGPGEcb-T-RVR9Hf8,1096
-fusion_platform_python_sdk-2.2.2.dist-info/METADATA,sha256=WjnLCoW234ewtD8gSMe5iQ9jHbczJ2xLVgwgOz17-ow,5634
-fusion_platform_python_sdk-2.2.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-fusion_platform_python_sdk-2.2.2.dist-info/entry_points.txt,sha256=YbiPXiDDcEXfVTUXFpyojkMdN17Xe_0k_W5ia2J4ENU,65
-fusion_platform_python_sdk-2.2.2.dist-info/top_level.txt,sha256=0fI4dcqLKd-KNt6Q20mOYdO2eVDM5r8YJmwzUT2ot2c,16
-fusion_platform_python_sdk-2.2.2.dist-info/RECORD,,
+fusion_platform_python_sdk-2.2.5.dist-info/licenses/LICENSE.txt,sha256=rRNH3lp1zmb02PJQpWFHR49EXtRGPGEcb-T-RVR9Hf8,1096
+fusion_platform_python_sdk-2.2.5.dist-info/METADATA,sha256=8H2M7eY7T5llO2r4jesSKNrZmlgdukuzNquJt2PMirI,5634
+fusion_platform_python_sdk-2.2.5.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+fusion_platform_python_sdk-2.2.5.dist-info/entry_points.txt,sha256=YbiPXiDDcEXfVTUXFpyojkMdN17Xe_0k_W5ia2J4ENU,65
+fusion_platform_python_sdk-2.2.5.dist-info/top_level.txt,sha256=0fI4dcqLKd-KNt6Q20mOYdO2eVDM5r8YJmwzUT2ot2c,16
+fusion_platform_python_sdk-2.2.5.dist-info/RECORD,,

{fusion_platform_python_sdk-2.2.2.dist-info → fusion_platform_python_sdk-2.2.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.1)
+Generator: setuptools (84.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any