pyPreservica 3.2.0__py3-none-any.whl → 3.2.1__py3-none-any.whl

pyPreservica/__init__.py

@@ -35,6 +35,6 @@ from .settingsAPI import SettingsAPI
 __author__ = "James Carr (drjamescarr@gmail.com)"
 
 # Version of the pyPreservica package
-__version__ = "3.2.0"
+__version__ = "3.2.1"
 
 __license__ = "Apache License Version 2.0"

pyPreservica/common.py

@@ -27,6 +27,7 @@ from requests import Session
 from urllib3.util import Retry
 import requests
 from requests.adapters import HTTPAdapter
+from typing import TypeVar
 
 import pyPreservica
 
@@ -420,6 +421,26 @@ class Bitstream:
         return self.__str__()
 
 
+class ExternIdentifier:
+    """
+        Class to represent the External Identifier Object in the Preservica data model
+    """
+
+    def __init__(self, identifier_type: str, identifier_value: str):
+        self.type = identifier_type
+        self.value = identifier_value
+        self.id = None
+
+    def __str__(self):
+        return f"""
+           Identifier:          {self.id}
+           Identifier Type:     {self.type}
+           Identifier Value:    {self.value}
+        """
+
+    def __repr__(self):
+        return self.__str__()
+
 class Generation:
     """
          Class to represent the Generation Object in the Preservica data model
@@ -528,6 +549,9 @@ class ContentObject(Entity):
         self.tag = "ContentObject"
 
 
+EntityT = TypeVar("EntityT", Folder, Asset, ContentObject, None)
+
+
 class Representation:
     """
         Class to represent the Representation Object in the Preservica data model
@@ -738,7 +762,7 @@ class AuthenticatedAPI:
         Return the edition of this tenancy
         """
         if self.major_version < 8 and self.minor_version < 3:
-            raise RuntimeError("Entitlement  API is only available when connected to a v7.3 System")
+            raise RuntimeError("Entitlement API is only available when connected to a v7.3 System")
 
         headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/json'}
 
@@ -777,6 +801,7 @@ class AuthenticatedAPI:
                 self.sec_ns = f"{NS_SEC_ROOT}/v{self.major_version}.{self.minor_version}"
                 self.admin_ns = f"{NS_ADMIN}/v{self.major_version}.{self.minor_version}"
 
+
     def __version_number__(self):
         """
         Determine the version number of the server
@@ -801,7 +826,7 @@ class AuthenticatedAPI:
             RuntimeError(request.status_code, "version number failed")
 
     def __str__(self):
-        return f"pyPreservica version: {pyPreservica.__version__}  (Preservica 7.0 Compatible) " \
+        return f"pyPreservica version: {pyPreservica.__version__}  (Preservica 8.0 Compatible) " \
                f"Connected to: {self.server} Preservica version: {self.version} as {self.username} " \
                f"in tenancy {self.tenant}"
 

pyPreservica/entityAPI.py

@@ -486,6 +486,54 @@ class EntityAPI(AuthenticatedAPI):
             logger.error(request)
             raise RuntimeError(request.status_code, "delete_identifier failed")
 
+    def entity_identifiers(self, entity: Entity,  external_identifier_type = None) -> set[ExternIdentifier]:
+        """
+         Get all external identifiers on an entity
+
+         Returns the set of external identifiers on the entity
+
+         :param entity: The Entity (Asset or Folder)
+         :param external_identifier_type: Optional identifier type to filter the results
+         :type  entity: Entity
+        """
+        headers = {HEADER_TOKEN: self.token}
+        request = self.session.get(
+            f'{self.protocol}://{self.server}/api/entity/{entity.path}/{entity.reference}/identifiers',
+            headers=headers)
+        if request.status_code == requests.codes.ok:
+            xml_response = str(request.content.decode('utf-8'))
+            logger.debug(xml_response)
+            entity_response = xml.etree.ElementTree.fromstring(xml_response)
+            identifier_list = entity_response.findall(f'.//{{{self.xip_ns}}}Identifier')
+            result = set()
+            for identifier in identifier_list:
+                identifier_value = identifier_type = identifier_id = ""
+                for child in identifier:
+                    if child.tag.endswith("Type"):
+                        identifier_type = child.text
+                    if child.tag.endswith("Value"):
+                        identifier_value = child.text
+                    if child.tag.endswith("ApiId"):
+                        identifier_id = child.text
+                if external_identifier_type is None:
+                    external_id: ExternIdentifier = ExternIdentifier(identifier_type, identifier_value)
+                    external_id.identifier_id = identifier_id
+                    result.add(external_id)
+                else:
+                    if identifier_type == external_identifier_type:
+                        external_id: ExternIdentifier = ExternIdentifier(identifier_type, identifier_value)
+                        external_id.identifier_id = identifier_id
+                        result.add(external_id)
+            return result
+        elif request.status_code == requests.codes.unauthorized:
+            self.token = self.__token__()
+            return self.entity_identifiers(entity)
+        else:
+            exception = HTTPException(entity.reference, request.status_code, request.url, "identifiers_for_entity",
+                                      request.content.decode('utf-8'))
+            logger.error(exception)
+            raise exception
+
 
     def identifiers_for_entity(self, entity: Entity) -> set[Tuple]:
         """
@@ -526,14 +574,14 @@ class EntityAPI(AuthenticatedAPI):
 
 
 
-    def identifier(self, identifier_type: str, identifier_value: str) -> set[Entity]:
+    def identifier(self, identifier_type: str, identifier_value: str) -> set[EntityT]:
         """
-             Get all entities which have the external identifier
+         Get all entities which have the external identifier
 
-             Returns the set of entities which have the external identifier
+         Returns the set of entities which have the external identifier
 
-             :param identifier_type: The identifier type
-             :param identifier_value: The identifier value
+         :param identifier_type: The identifier type
+         :param identifier_value: The identifier value
           """
         headers = {HEADER_TOKEN: self.token}
         payload = {'type': identifier_type, 'value': identifier_value}
@@ -861,7 +909,7 @@ class EntityAPI(AuthenticatedAPI):
             logger.error(exception)
             raise exception
 
-    def delete_metadata(self, entity: Entity, schema: str) -> Entity:
+    def delete_metadata(self, entity: EntityT, schema: str) -> EntityT:
         """
         Deletes all the metadata fragments on an entity which match the schema URI
 
@@ -887,7 +935,7 @@ class EntityAPI(AuthenticatedAPI):
 
         return self.entity(entity.entity_type, entity.reference)
 
-    def update_metadata(self, entity: Entity, schema: str, data: Any) -> Entity:
+    def update_metadata(self, entity: EntityT, schema: str, data: Any) -> EntityT:
         """
         Update all existing metadata fragments which match the schema
 
@@ -933,7 +981,9 @@ class EntityAPI(AuthenticatedAPI):
                     raise exception
         return self.entity(entity.entity_type, entity.reference)
 
-    def add_metadata_as_fragment(self, entity: Entity, schema: str, xml_fragment: str) -> Entity:
+    def add_metadata_as_fragment(
+        self, entity: EntityT, schema: str, xml_fragment: str
+    ) -> EntityT:
         """
         Add a metadata fragment with a given namespace URI to an Entity
 
@@ -969,8 +1019,7 @@ class EntityAPI(AuthenticatedAPI):
             logger.error(exception)
             raise exception
 
-
-    def add_metadata(self, entity: Entity, schema: str, data) -> Entity:
+    def add_metadata(self, entity: EntityT, schema: str, data) -> EntityT:
         """
         Add a metadata fragment with a given namespace URI
 
@@ -1011,7 +1060,7 @@ class EntityAPI(AuthenticatedAPI):
             logger.error(exception)
             raise exception
 
-    def save(self, entity: Entity) -> Entity:
+    def save(self, entity: EntityT) -> EntityT:
         """
         Save the title and description of an entity
 
@@ -1129,7 +1178,7 @@ class EntityAPI(AuthenticatedAPI):
             logger.error(exception)
             raise exception
 
-    def move_sync(self, entity: Entity, dest_folder: Folder) -> Entity:
+    def move_sync(self, entity: EntityT, dest_folder: Folder) -> EntityT:
         """
         Move an Entity (Asset or Folder) to a new Folder
         If dest_folder is None then the entity must be a Folder and will be moved to the root of the repository
@@ -1169,7 +1218,7 @@ class EntityAPI(AuthenticatedAPI):
             logger.error(exception)
             raise exception
 
-    def move(self, entity: Entity, dest_folder: Folder) -> Entity:
+    def move(self, entity: EntityT, dest_folder: Folder) -> EntityT:
         """
         Move an Entity (Asset or Folder) to a new Folder
         If dest_folder is None then the entity must be a Folder and will be moved to the root of the repository
@@ -1274,7 +1323,7 @@ class EntityAPI(AuthenticatedAPI):
             else:
                 return xml_object.find(tag).text
 
-    def security_tag_sync(self, entity: Entity, new_tag: str):
+    def security_tag_sync(self, entity: EntityT, new_tag: str) -> EntityT:
         """
          Change the security tag for a folder or asset
 
@@ -1354,7 +1403,7 @@ class EntityAPI(AuthenticatedAPI):
             logger.error(exception)
             raise exception
 
-    def entity(self, entity_type: EntityType, reference: str) -> Entity:
+    def entity(self, entity_type: EntityType, reference: str) -> EntityT:
         """
         Retrieve an entity by its type and reference
 

{pypreservica-3.2.0.dist-info → pypreservica-3.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyPreservica
-Version: 3.2.0
+Version: 3.2.1
 Summary: Python library for the Preservica API
 Home-page: https://pypreservica.readthedocs.io/
 Author: James Carr
@@ -23,8 +23,8 @@ License-File: LICENSE.txt
 Requires-Dist: requests
 Requires-Dist: urllib3
 Requires-Dist: certifi
-Requires-Dist: boto3
-Requires-Dist: botocore
+Requires-Dist: boto3>=1.36.0
+Requires-Dist: botocore>=1.36.0
 Requires-Dist: s3transfer
 Requires-Dist: azure-storage-blob
 Requires-Dist: tqdm

{pypreservica-3.2.0.dist-info → pypreservica-3.2.1.dist-info}/RECORD

@@ -1,9 +1,9 @@
-pyPreservica/__init__.py,sha256=erL11_X3f9F3yfHhgtVxRdAH1m2LIOsYkTvReMS3em4,1250
+pyPreservica/__init__.py,sha256=IDGY2--79x65wptaP8fj5cWTaDT_a2_2TaSrYJF1UfY,1250
 pyPreservica/adminAPI.py,sha256=aMN2twcUZOFoGx2yapC6GVtBTdYHUJFA-5bdWVkCwS8,37773
 pyPreservica/authorityAPI.py,sha256=jpf_m9i-IakyNVooi2yELuKt4yhX73hWqQNbPRHZx2g,9206
-pyPreservica/common.py,sha256=iEeF4Kg51d4Vug-Dv8TeqS1lP2zcfM7YtBO8oANEcCU,38273
+pyPreservica/common.py,sha256=pPg29dQYa3SeKvRIci7Q4AwAY9CjCe0ENDaElWYqCxk,38929
 pyPreservica/contentAPI.py,sha256=ZvX2aGQEaksmw-m-oEUI6daVSqFe_IcE1cGwCNbSCDQ,22286
-pyPreservica/entityAPI.py,sha256=cIuipvOlFUNgaLBOXtevTYQrT0zh1NG2y5gXz5sr_k0,125673
+pyPreservica/entityAPI.py,sha256=0ATOcwhBF8Cu6R-BnsV0I4EtXmkLW9jeWbXQaqYyMmo,128230
 pyPreservica/mdformsAPI.py,sha256=_hBjT4-OzgLQGDfYX7b_01P27wc-RmsCEu57VtyAdh8,19173
 pyPreservica/monitorAPI.py,sha256=LJOUrynBOWKlNiYpZ1iH8qB1oIIuKX1Ms1SRBcuXohA,6274
 pyPreservica/opex.py,sha256=ccra1S4ojUXS3PlbU8WfxajOkJrwG4OykBnNrYP_jus,4875
@@ -13,8 +13,8 @@ pyPreservica/settingsAPI.py,sha256=jXnMOCq3mimta6E-Os3J1I1if2pYsjLpOazAx8L-ZQI,1
 pyPreservica/uploadAPI.py,sha256=uX67mW-2q7FmjtXQ759GwHPL6Zs7R-iE8-86PBApvbY,99823
 pyPreservica/webHooksAPI.py,sha256=B3C6PV_3JLlJrr9PtsTzL-21M0msx8Mnj18Xb3Bv4RE,6814
 pyPreservica/workflowAPI.py,sha256=OcOiiUdrQerbPllrkj1lWpmuW0jTuyyV0urwPSYcd_U,17561
-pypreservica-3.2.0.dist-info/licenses/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-pypreservica-3.2.0.dist-info/METADATA,sha256=x3FR1zZKihN0pfSN_JdvM10pfP_IsfY1GWV8t3Yd_bo,3009
-pypreservica-3.2.0.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-pypreservica-3.2.0.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
-pypreservica-3.2.0.dist-info/RECORD,,
+pypreservica-3.2.1.dist-info/licenses/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+pypreservica-3.2.1.dist-info/METADATA,sha256=rrmuhukqFCtJTb5_Q-oM6HX5Q2sUlSgO0AcC0ciPvSg,3025
+pypreservica-3.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pypreservica-3.2.1.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
+pypreservica-3.2.1.dist-info/RECORD,,

{pypreservica-3.2.0.dist-info → pypreservica-3.2.1.dist-info}/WHEEL

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