fusion-platform-python-sdk 1.18.3__tar.gz → 2.0.7__tar.gz

{fusion_platform_python_sdk-1.18.3/fusion_platform_python_sdk.egg-info → fusion_platform_python_sdk-2.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fusion-platform-python-sdk
-Version: 1.18.3
+Version: 2.0.7
 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.18.3 → fusion_platform_python_sdk-2.0.7}/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.18.3'
-__version_date__ = '2025-07-04T14:43:33Z'
+__version__ = '2.0.7'
+__version_date__ = '2025-10-07T07:06:32Z'
 
 # Exclude certain sub-modules from documentation.
 # @formatter:off
@@ -142,7 +142,7 @@ def get_log_level():
     return logger.level
 
 
-def login(email=None, user_id=None, password=None, api_url=None):
+def login(email=None, user_id=None, password=None, api_url=None, session_options=None):
     """
     Attempts to log into the Fusion Platform<sup>&reg;</sup> to return a user model for the active session.
 
@@ -151,6 +151,7 @@ def login(email=None, user_id=None, password=None, api_url=None):
         user_id: The user account user id. Either an email address or a user id must be provided.
         password: The password for the user account.
         api_url: The optional custom API URL to use. Defaults to the production Fusion Platform<sup>&reg;</sup>.
+        session_options: The optional options to be passed to the session.
 
     Returns:
         The corresponding user model for the account on successful login.
@@ -160,7 +161,7 @@ def login(email=None, user_id=None, password=None, api_url=None):
         RequestError: on login failure.
     """
     # Create the session and attempt to login.
-    session = Session()
+    session = Session(options=session_options)
     session.login(email, user_id, password, api_url)
 
     # Now load the corresponding user model using the user id obtained from the session.

{fusion_platform_python_sdk-1.18.3 → fusion_platform_python_sdk-2.0.7}/fusion_platform/command.py

@@ -510,8 +510,6 @@ class Command(Base):
             The list of file tuples to be downloaded (file model, download path), and the metrics.
         """
         download_components = [] if download_components is None else download_components
-        started_at = process.created_at
-        ended_at = None
         metrics = []
         downloads = []
 
@@ -526,7 +524,7 @@ class Command(Base):
                 complete = True
 
             if not complete:
-                sleep(Model._API_UPDATE_WAIT_PERIOD)
+                sleep(process._session.api_update_wait_period)
 
         # Now download the inputs and/or outputs.
         execution_dir = output_dir
@@ -551,15 +549,6 @@ class Command(Base):
             )
         ]
 
-        if (started_at is None) or (execution.started_at < started_at):
-            started_at = execution.started_at
-
-        execution_ended_at = execution.ended_at if hasattr(execution, Model._FIELD_ENDED_AT) and (execution.ended_at is not None) else datetime.now(
-            timezone.utc)
-
-        if (ended_at is None) or (execution_ended_at > ended_at):
-            ended_at = execution_ended_at
-
         for j, component in enumerate(components):
             # Download the component.
             component_name = '_'.join([item for item in re.sub(r'[\W]', '_', component.name).split('_') if len(item) > 0])
@@ -567,6 +556,8 @@ class Command(Base):
             component_options = {item.get(Model._FIELD_NAME): item.get(Model._FIELD_VALUE) for item in component.options} if hasattr(component,
                                                                                                                                      Model._FIELD_OPTIONS) and (
                                                                                                                                      component.options is not None) else {}
+            component_started_at = component.started_at if hasattr(component, Model._FIELD_STARTED_AT) and (component.started_at is not None) else None
+            component_ended_at = component.ended_at if hasattr(component, Model._FIELD_ENDED_AT) and (component.ended_at is not None) else None
             component_success = component.success if hasattr(component, Model._FIELD_SUCCESS) and (component.success is not None) else False
             component_runtime = component.runtime if hasattr(component, Model._FIELD_RUNTIME) and (component.runtime is not None) else 0
 
@@ -575,7 +566,7 @@ class Command(Base):
             metric = {
                 Command._METRICS_EXECUTION: group_index if group_index is not None else 1,
                 Command._METRICS_PROCESS: process.name,
-                Command._METRICS_DURATION: ended_at - started_at if (started_at is not None) and (ended_at is not None) else 0,
+                Command._METRICS_DURATION: (component_ended_at - component_started_at).total_seconds() if (component_started_at is not None) and (component_ended_at is not None) else 0,
                 Command._METRICS_COMPONENT: component.name,
                 Command._METRICS_SUCCESS: component_success,
                 Command._METRICS_CPU: component.cpu,
@@ -1015,7 +1006,11 @@ class Command(Base):
 
         # 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)
+            try:
+                service = next((item for item in organisation.own_services if (str(item.id) == service_name) or (str(item.ssd_id) == service_name)), None)
+            except RequestError:
+                # We will get a RequestError if the user is not sufficiently privileged to list the organisation's own services. We therefore ignore this error.
+                pass
 
         if service is None:
             raise CommandError(i18n.t('command.no_such_service', service=service_name))

{fusion_platform_python_sdk-1.18.3 → fusion_platform_python_sdk-2.0.7}/fusion_platform/models/data.py

@@ -195,7 +195,7 @@ class Data(Model):
                 break
 
             # We are waiting, so block for a short while.
-            sleep(self.__class__._API_UPDATE_WAIT_PERIOD)
+            sleep(self._session.api_update_wait_period)
 
         return complete
 

{fusion_platform_python_sdk-1.18.3 → fusion_platform_python_sdk-2.0.7}/fusion_platform/models/model.py

@@ -148,9 +148,6 @@ class Model(Base):
     _METADATA_HIDE = 'hide'
     _METADATA_READ_ONLY = 'read_only'
 
-    # API job update frequency check.
-    _API_UPDATE_WAIT_PERIOD = 10  # Time in seconds to wait between checking jobs on the API.
-
     def __init__(self, session, schema=None):
         """
         Initialises the object.

{fusion_platform_python_sdk-1.18.3 → fusion_platform_python_sdk-2.0.7}/fusion_platform/models/process.py

@@ -1151,4 +1151,4 @@ class Process(Model):
                 raise ModelError(i18n.t('models.process.execution_should_have_started'))
 
             # We are waiting, so block for a short while.
-            sleep(self.__class__._API_UPDATE_WAIT_PERIOD)
+            sleep(self._session.api_update_wait_period)

{fusion_platform_python_sdk-1.18.3 → fusion_platform_python_sdk-2.0.7}/fusion_platform/models/process_execution.py

@@ -198,7 +198,7 @@ class ProcessExecution(Model):
                 break
 
             # We are waiting, so block for a short while.
-            sleep(self.__class__._API_UPDATE_WAIT_PERIOD)
+            sleep(self._session.api_update_wait_period)
 
         return complete
 

{fusion_platform_python_sdk-1.18.3 → fusion_platform_python_sdk-2.0.7}/fusion_platform/models/process_service_execution.md

@@ -11,8 +11,12 @@
 * **started_at**: When did the execution start?
 * **ended_at**: When did the execution end?
 * **runtime**: The execution runtime in seconds.
+* **architecture**: The processor architecture used to run the image.
 * **cpu**: The number of CPUs used to run the image.
+* **gpu**: The number of GPUs used to run the image.
 * **memory**: The memory in megabytes used to run the image.
+* **storage**: The local storage space in gigabytes used to run the image.
+* **instance_type**: The instance type allocated for use by the service.
 * **actions**: The custom actions associated with this execution.
     * **name**: The name of the value.
     * **values**: The values required for the action.

{fusion_platform_python_sdk-1.18.3 → fusion_platform_python_sdk-2.0.7}/fusion_platform/models/process_service_execution.py

@@ -148,8 +148,13 @@ class ProcessServiceExecutionSchema(Schema):
     runtime = fields.Integer(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
 
     # Removed input_size.
+    architecture = fields.String(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     cpu = fields.Decimal(required=True, metadata={'read_only': True})  # Changed to prevent this being updated.
+    gpu = fields.Decimal(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     memory = fields.Decimal(required=True, metadata={'read_only': True})  # Changed to prevent this being updated.
+    storage = fields.Decimal(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
+    instance_type = fields.String(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
+
     actions = fields.List(fields.Nested(ProcessServiceExecutionActionSchema()), allow_none=True)
     options = fields.List(fields.Nested(ProcessServiceExecutionOptionSchema()), allow_none=True,
                           metadata={'read_only': True})  # Changed to prevent this being updated.
@@ -158,9 +163,8 @@ class ProcessServiceExecutionSchema(Schema):
     # Removed storage_id.
     intermediate = fields.Boolean(allow_none=True)
     # Removed task_id.
-    # Removed task_definition_id.
-    # Removed access_point_ids.
-    # Removed security_group_id.
+    # Removed task_starts.
+    # Removed instance_id.
     success = fields.Boolean(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
 
     metrics = fields.List(fields.Nested(ProcessServiceExecutionMetricSchema()), allow_none=True,

{fusion_platform_python_sdk-1.18.3 → fusion_platform_python_sdk-2.0.7}/fusion_platform/models/service.md

@@ -46,8 +46,8 @@
     * **url**: The URL which can be executed to receive the value of the action.
     * **title**: The title for the action.
     * **description**: The description of the action.
-* **urls**: The list of allowed external URLs the service can access.
-* **cidrs**: The list of allowed external IP addresses as CIDRs the service can access.
+* **urls**: 
+* **cidrs**: 
 * **input_expressions**: The list of expressions which are applied to the inputs of the service.
     * **lhs_ssd_id**: The SSD associated with the left-hand side of the input expression.
     * **lhs_input**: The input associated with the left-hand side of the input expression.

{fusion_platform_python_sdk-1.18.3 → fusion_platform_python_sdk-2.0.7}/fusion_platform/session.py

@@ -93,15 +93,22 @@ class Session(Base):
     # Default Fusion Platform<sup>&reg;</sup> API endpoint.
     API_URL_DEFAULT = 'https://api.thefusionplatform.com'
 
+    # Session option fields and their defaults.
+    API_UPDATE_WAIT_PERIOD = 'api_update_wait_period'  # Time in seconds to wait between checking jobs on the API.
+    API_UPDATE_WAIT_PERIOD_DEFAULT = 10
+
     # Mask keys.
     _MASK_KEYS = ['password', 'old_password', 'new_password', 'access_token', 'id_token', 'refresh_token']
 
     # Download temporary file name extension.
     DOWNLOAD_EXTENSION = '.download'
 
-    def __init__(self):
+    def __init__(self, options=None):
         """
         Initialises the object.
+
+            Args:
+                options: The optional session options.
         """
         super(Session, self).__init__()
 
@@ -110,6 +117,11 @@ class Session(Base):
         self.__bearer_token = None
         self.__api_url = Session.API_URL_DEFAULT
 
+        # Extract any options.
+        options = {} if options is None else options
+        self.api_update_wait_period = options.get(Session.API_UPDATE_WAIT_PERIOD, Session.API_UPDATE_WAIT_PERIOD_DEFAULT)
+        self._logger.debug('api_update_wait_period: %d', self.api_update_wait_period)
+
     def download_file(self, url, destination, callback=None):
         """
         Downloads a file to the destination path. The destination directories are created if they do not exist. The optional callback function receives three
@@ -267,6 +279,9 @@ class Session(Base):
                     except:
                         pass  # Ignore the inability to extract the error message.
 
+                    if message is None:
+                        message = response
+
                     raise RequestError(i18n.t('session.request_failed', message=message))
 
                 payload = response.json()

{fusion_platform_python_sdk-1.18.3 → fusion_platform_python_sdk-2.0.7/fusion_platform_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fusion-platform-python-sdk
-Version: 1.18.3
+Version: 2.0.7
 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.18.3 → fusion_platform_python_sdk-2.0.7}/setup.py

@@ -19,7 +19,7 @@ PACKAGE_DIR = pathlib.Path(__file__).parent
 # @formatter:off
 setup(
     name='fusion-platform-python-sdk',
-    version='1.18.3',
+    version='2.0.7',
     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.18.3 → fusion_platform_python_sdk-2.0.7}/tests/test_session.py

@@ -53,7 +53,12 @@ class TestSession(CustomTestCase):
         """
         Test initialisation of the class to ensure no exceptions are raised.
         """
-        Session()
+        session = Session()
+        self.assertEqual(Session.API_UPDATE_WAIT_PERIOD_DEFAULT, session.api_update_wait_period)
+
+        api_update_wait_period_default = 45
+        session = Session(options={Session.API_UPDATE_WAIT_PERIOD: api_update_wait_period_default})
+        self.assertEqual(api_update_wait_period_default, session.api_update_wait_period)
 
     def test_download_file(self):
         """