fusion-platform-python-sdk 1.13.1__tar.gz → 1.13.5__tar.gz

{fusion-platform-python-sdk-1.13.1/fusion_platform_python_sdk.egg-info → fusion-platform-python-sdk-1.13.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fusion-platform-python-sdk
-Version: 1.13.1
+Version: 1.13.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-1.13.1 → fusion-platform-python-sdk-1.13.5}/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.13.1'
-__version_date__ = '2024-07-15T06:23:24Z'
+__version__ = '1.13.5'
+__version_date__ = '2024-08-08T11:19:48Z'
 
 # Exclude certain sub-modules from documentation.
 # @formatter:off

{fusion-platform-python-sdk-1.13.1 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/data.py

@@ -215,7 +215,7 @@ class Data(Model):
         # Return the copy.
         return self.__class__._model_from_api_id(self._session, organisation_id=self.organisation_id, id=copy_data_id)
 
-    def _create(self, name, file_type, files, wait=False):
+    def _create(self, name, file_type, files, wait=False, **kwargs):
         """
         Attempts to create the model object with the given values. This assumes the model template has been loaded first using the _new method, and that the model
         is then created using a POST RESTful request. This assumes that the post body contains key names which include the name of the model class.
@@ -223,10 +223,11 @@ class Data(Model):
         This method is overridden to also upload the corresponding files and optionally wait for the upload and analysis to complete.
 
         Args:
-        name: The name of the data object.
-        file_type: The type of files that the data object will hold.
-        files: The list of file paths to be uploaded.
-        wait: Optionally wait for the upload and analysis to complete? Default False.
+            name: The name of the data object.
+            file_type: The type of files that the data object will hold.
+            files: The list of file paths to be uploaded.
+            wait: Optionally wait for the upload and analysis to complete? Default False.
+            kwargs: The model attributes which override those already in the template.
 
         Returns:
             The created data object.
@@ -236,7 +237,7 @@ class Data(Model):
             ModelError: if the model could not be created and validated by the Fusion Platform<sup>&reg;</sup>.
         """
         # Use the super method to create the data item with the correct attributes. This will raise an exception if anything fails.
-        super(Data, self)._create(name=name)
+        super(Data, self)._create(name=name, **kwargs)
 
         # Add each of the files, assuming that each is of the same file type, and start its upload in a thread.
         try:

{fusion-platform-python-sdk-1.13.1 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/model.py

@@ -165,11 +165,12 @@ class Model(Base):
 
         return attributes
 
-    def __build_body(self, **kwargs):
+    def __build_body(self, create=False, **kwargs):
         """
-        Builds a request body suitable for sending to the API. All current model attributes are included, with the keywords arguments overridding their value.
+        Builds a request body suitable for sending to the API. All current model attributes are included, with the keywords arguments overriding their value.
 
         Args:
+            create: Whether the body is being built for a create request. This allows the id to be overridden.
             kwargs: The model attributes which override those already in the template.
 
         Returns:
@@ -184,9 +185,11 @@ class Model(Base):
             if (self.__model is not None) and (key in self.__model):
                 body[Model._REQUEST_KEY_NAME.format(model=model_name, key=key)] = self.__model.get(key)
 
-        # Now override any of the passed in attributes, ignoring anything which is read-only or hidden.
+        # Now override any of the passed in attributes, ignoring anything which is read-only or hidden. The exception here is the id, which can be overridden
+        # during a create operation.
         for key in kwargs:
-            if (Model._METADATA_READ_ONLY not in schema.fields[key].metadata) and (Model._METADATA_HIDE not in schema.fields[key].metadata):
+            if (create and (key == Model._FIELD_ID)) or (
+                    (Model._METADATA_READ_ONLY not in schema.fields[key].metadata) and (Model._METADATA_HIDE not in schema.fields[key].metadata)):
                 body[Model._REQUEST_KEY_NAME.format(model=model_name, key=key)] = kwargs[key]
 
         return body
@@ -228,7 +231,7 @@ class Model(Base):
             raise ModelError(i18n.t('models.model.already_persisted'))
 
         # Form the post body dictionary from the current object and the keyword arguments.
-        body = self.__build_body(**kwargs)
+        body = self.__build_body(create=True, **kwargs)
 
         # Make sure there is a create which can be performed. This requires a non-empty body.
         if len(body) <= 0:

{fusion-platform-python-sdk-1.13.1 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/organisation.py

@@ -113,7 +113,7 @@ class Organisation(Model):
     _PATH_SERVICES = f"{_PATH_BASE}/services/latest"
     _PATH_DISPATCHERS = f"{_PATH_BASE}/services/dispatchers"
 
-    def create_data(self, name, file_type, files, wait=False):
+    def create_data(self, name, file_type, files, wait=False, **kwargs):
         """
         Creates a data object for the organisation and uploads the corresponding files. Optionally waits for the upload and analysis to complete.
 
@@ -122,6 +122,7 @@ class Organisation(Model):
             file_type: The type of files that the data object will hold.
             files: The list of file paths to be uploaded.
             wait: Optionally wait for the upload and analysis to complete? Default False.
+            kwargs: The model attributes which override those already in the template.
 
         Returns:
             The created data object.
@@ -134,8 +135,8 @@ class Organisation(Model):
         data = Data(self._session)
         data._new(organisation_id=self.id)
 
-        # Now attempt to create the data item.
-        data._create(name, file_type, files, wait)
+        # Now attempt to create the data item with any overriding keyword arguments.
+        data._create(name, file_type, files, wait=wait, **kwargs)
 
         return data
 

{fusion-platform-python-sdk-1.13.1 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/process.md

@@ -29,3 +29,5 @@
 * **test_run**: Is this a test run of a service?
 * **price**: The price in FPUs to execute this process given its inputs and options.
 * **deletable**: Is this process scheduled for deletion?
+* **non_aggregator_count**: The count of non-aggregator executions within the current or last execution.
+* **aggregator_count**: The count of aggregator executions within the current or last execution.

{fusion-platform-python-sdk-1.13.1 → fusion-platform-python-sdk-1.13.5}/fusion_platform/models/process.py

@@ -473,6 +473,8 @@ class ProcessSchema(Schema):
     has_executions = fields.String(required=True, metadata={'hide': True})  # Changed to hide as an attribute.
     has_executions_organisation_id = fields.String(required=True, metadata={'hide': True})  # Changed to hide as an attribute.
     executions = fields.List(fields.Nested(ProcessExecutionStatusSchema()), allow_none=True, metadata={'hide': True})  # Changed to hide as an attribute.
+    non_aggregator_count = fields.Integer(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
+    aggregator_count = fields.Integer(allow_none=True, metadata={'read_only': True})  # Changed to prevent this being updated.
     # Removed creator.
 
     # Removed search.
@@ -657,16 +659,19 @@ class Process(Model):
         # Return the copy.
         return process
 
-    def create(self):
+    def create(self, **kwargs):
         """
         Attempts to persist the template process in the Fusion Platform<sup>&reg;</sup> so that it can be executed.
 
+        Args:
+            kwargs: The model attributes which override those already in the template.
+
         Raises:
             RequestError: if the create fails.
             ModelError: if the model could not be created and validated by the Fusion Platform<sup>&reg;</sup>.
         """
         # Attempt to issue the create.
-        self._create()
+        self._create(**kwargs)
 
     def __dispatchers(self, dispatchers):
         """

{fusion-platform-python-sdk-1.13.1 → fusion-platform-python-sdk-1.13.5/fusion_platform_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fusion-platform-python-sdk
-Version: 1.13.1
+Version: 1.13.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-1.13.1 → fusion-platform-python-sdk-1.13.5}/setup.py

@@ -19,7 +19,7 @@ PACKAGE_DIR = pathlib.Path(__file__).parent
 # @formatter:off
 setup(
     name='fusion-platform-python-sdk',
-    version='1.13.1',
+    version='1.13.5',
     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',