add some extra search tests and fix issue with nested f-strings to work with python 3.10

Author: carj

docs/content.rst

@@ -197,6 +197,16 @@ For example to create a report on the security tags of all assets within a folde
     client.search_index_filter_csv(query="%", csv_file="security.csv", filter_values=filters)
 
 
+Filter values can also be provided as a list of values to match on:
+
+.. code-block:: python
+
+    client = ContentAPI()
+
+    filters = {"xip.title": "%", "xip.description": "%", "xip.security_descriptor": ["open", "public"], "xip.parent_ref": "48c79abd-01f3-4b77-8132-546a76e0d337"}
+    client.search_index_filter_csv(query="%", csv_file="security.csv", filter_values=filters)
+
+
 Search Progress
 ^^^^^^^^^^^^^^^^^^^^^
 
@@ -262,11 +272,19 @@ To exclude filters in the search use:
 
 .. code-block:: python
 
-    fields = [Field(name='xip.title', value='Blockchain', operator="NOT",  sort_order=SortOrder.desc)]
+    fields = [Field(name='xip.title', value='Blockchain', operator=Operator.NOT,  sort_order=SortOrder.desc)]
 
     for hit in content.search_fields(query="%", fields=fields):
         print(hit)
 
+To use a list of possible values use:
+
+.. code-block:: python
+
+    term = Field(name='xip.security_descriptor', value=["open", "public"])
+
+    for hit in content.search_fields(query="%", fields=[term]):
+        print(hit)
 
 Reporting Examples
 ^^^^^^^^^^^^^^^^^^^^

docs/intro.rst

@@ -146,7 +146,7 @@ pyPreservica is available from the Python Package Index (PyPI)
 
 https://pypi.org/project/pyPreservica/
 
-pyPreservica is built and tested against Python 3.8. Older versions of Python may not work.
+pyPreservica is built and tested against Python 3.10 onwards. Older versions of Python may not work.
 
 
 To install pyPreservica, simply run this simple command in your terminal of choice:

pyPreservica/__init__.py

@@ -8,21 +8,21 @@
 """
 
 from .common import *
-from .contentAPI import ContentAPI, Field, SortOrder
+from .contentAPI import ContentAPI, Field, SortOrder, Operator
 from .entityAPI import EntityAPI
 from .uploadAPI import (
     UploadAPI,
     simple_asset_package,
     complex_asset_package,
-    cvs_to_xsd,
-    cvs_to_xml,
-    cvs_to_cmis_xslt,
+    csv_to_xsd,
+    csv_to_xml,
+    csv_to_cmis_xslt,
     csv_to_search_xml,
     generic_asset_package,
     upload_config,
     multi_asset_package,
 )
-from .workflowAPI import WorkflowAPI, WorkflowContext, WorkflowInstance
+from .workflowAPI import WorkflowAPI, WorkflowContext, WorkflowInstance, ProcessAPI, Process
 from .retentionAPI import RetentionAPI, RetentionAssignment, RetentionPolicy
 from .parAPI import PreservationActionRegistry
 from .adminAPI import AdminAPI
@@ -35,6 +35,6 @@
 __author__ = "James Carr (drjamescarr@gmail.com)"
 
 # Version of the pyPreservica package
-__version__ = "3.4.1"
+__version__ = "3.4.3"
 
 __license__ = "Apache License Version 2.0"

pyPreservica/common.py

@@ -81,7 +81,7 @@ def __call__(self, file):
         return hash_algorithm.hexdigest()
 
 
-def identifiersToDict(identifiers: set) -> dict:
+def identifiers_to_dict(identifiers: set) -> dict:
     """
         Convert a set of tuples to a dict
         :param identifiers:
@@ -867,8 +867,7 @@ def manager_token(self, username: str, password: str) -> str:
             logger.error(response.status_code)
             logger.error(str(response.content))
             RuntimeError(response.status_code, "Could not generate valid manager approval token")
-
-        return None
+            return ""
 
     def __token__(self) -> str:
         """
@@ -939,7 +938,7 @@ def __token__(self) -> str:
                 msg = "Failed to create a shared secret authentication token. Check your credentials are correct"
                 logger.error(msg)
                 raise RuntimeError(response.status_code, msg)
-        return None
+        return ""
 
     def __init__(self, username: str = None, password: str = None, tenant: str = None, server: str = None,
                  use_shared_secret: bool = False, two_fa_secret_key: str = None,

pyPreservica/contentAPI.py

@@ -20,20 +20,23 @@ class SortOrder(Enum):
     asc = 1
     desc = 2
 
+class Operator(Enum):
+    IS = "IS"
+    NOT = "NOT"
+
 class Field:
     name: str
-    value: Optional[str]
-    operator: Optional[str]
+    value: Optional[Union[str, list[str]]] = None
+    operator: Optional[Operator]
     sort_order: Optional[SortOrder]
 
-    def __init__(self, name: str, value: str, operator: Optional[str]=None, sort_order: Optional[SortOrder]=None):
+    def __init__(self, name: str, value: Union[str, list[str]], operator: Optional[Operator]=Operator.IS, sort_order: Optional[SortOrder]=None):
         self.name = name
         self.value = value
         self.operator = operator
         self.sort_order = sort_order
 
 
-
 class ContentAPI(AuthenticatedAPI):
     """
         The ContentAPI class provides the search interface to the Preservica repository.
@@ -73,8 +76,8 @@ def user_security_tags(self, with_permissions: bool = False):
 
     def full_text(self, reference: str):
         """
-        Return the full text index value for the reference
-        The reference must be an Asset.
+        Return the full text index value for asset.
+        The reference must be for an Asset.
 
         If the Asset has been OCR'd then this will return the OCR text
 
@@ -341,10 +344,23 @@ def _search_fields(self, query: str = "%", fields: list[Field]=None, start_index
             metadata_elements.append(field.name)
             if field.value is None or field.value == "":
                 field_list.append('{' f' "name": "{field.name}", "values": [] ' + '}')
-            elif field.operator == "NOT":
-                field_list.append('{' f' "name": "{field.name}", "values": ["{field.value}"], "operator": "NOT" ' + '}')
             else:
-                field_list.append('{' f' "name": "{field.name}", "values": ["{field.value}"] ' + '}')
+
+                if isinstance(field.value, str):
+                    if field.operator == Operator.NOT:
+                        field_list.append(
+                            '{' f' "name": "{field.name}", "values": ["{field.value}"], "operator": "NOT" ' + '}')
+                    else:
+                        field_list.append('{' f' "name": "{field.name}", "values":[ "{field.value}" ]' '}')
+                if isinstance(field.value, list):
+                    values = [f'"{w}"' for w in field.value]
+                    v:str = f' {",".join(values)} '
+                    if field.operator == Operator.NOT:
+                        field_list.append(
+                            '{' f' "name": "{field.name}", "values": [ {v} ], "operator": "NOT" ' + '}')
+                    else:
+                        field_list.append('{' f' "name": "{field.name}", "values":[ {v} ]' '}')
+
 
             if field.sort_order is not None:
                 sort_list.append(f'{{"sortFields": ["{field.name}"], "sortOrder": "{field.sort_order.name}"}}')
@@ -434,7 +450,8 @@ def search_index_filter_hits(self, query: str = "%", filter_values: dict = None)
                 if isinstance(value, str):
                     field_list.append('{' f' "name": "{key}", "values": ["{value}"] ' + '}')
                 if isinstance(value, list):
-                    v = f' {",".join(f'"{w}"' for w in value)} '
+                    values = [f'"{w}"' for w in value]
+                    v: str = f' {",".join(values)} '
                     field_list.append('{' f' "name": "{key}", "values":[ {v} ]' '}')
 
         filter_terms = ','.join(field_list)
@@ -470,7 +487,8 @@ def _search_index_filter(self, query: str = "%", start_index: int = 0, page_size
                 if isinstance(value, str):
                     field_list.append('{' f' "name": "{key}", "values": ["{value}"] ' + '}')
                 if isinstance(value, list):
-                    v = f' {",".join(f'"{w}"' for w in value)} '
+                    values = [f'"{w}"' for w in value]
+                    v: str = f' {",".join(values)} '
                     field_list.append('{' f' "name": "{key}", "values":[ {v} ]' '}')
 
         filter_terms = ','.join(field_list)

pyPreservica/entityAPI.py

@@ -12,7 +12,7 @@
 import os.path
 import uuid
 import xml.etree.ElementTree
-from datetime import datetime, timedelta, timezone
+from datetime import timedelta, timezone
 from io import BytesIO
 from time import sleep
 from typing import Any, Generator, Tuple, Iterable, Union, Callable
@@ -63,7 +63,7 @@ def bitstream_chunks(self, bitstream: Bitstream, chunk_size: int = CHUNK_SIZE) -
         process chunks as they are downloaded.
 
         :param  bitstream: A bitstream object
-        :type  url: Bitstream
+        :type   bitstream: Bitstream
         :param  chunk_size: Optional size of the chunks to be downloaded
         :type  chunk_size: int
         :return: Iterator
@@ -867,6 +867,7 @@ def __relationships__(self, entity: Entity, maximum: int = 50, next_page: str =
 
             return PagedSet(results, has_more, int(total_hits.text), url)
         elif request.status_code == requests.codes.unauthorized:
+            self.token = self.__token__()
             return self.__relationships__(entity=entity, maximum=maximum, next_page=next_page)
         else:
             exception = HTTPException(entity.reference, request.status_code, request.url, "relationships",
@@ -2055,6 +2056,7 @@ def replace_generation_async(self, content_object: ContentObject, file_name, fix
         if request.status_code == requests.codes.ok:
             return str(request.content.decode('utf-8'))
         elif request.status_code == requests.codes.unauthorized:
+            self.token = self.__token__()
             return self.replace_generation_async(content_object=content_object, file_name=file_name,
                                                  fixity_algorithm=fixity_algorithm, fixity_value=fixity_value)
         else:
@@ -2718,6 +2720,8 @@ def delete_asset(self, asset: Asset, operator_comment: str, supervisor_comment:
         """
         Initiate and approve the deletion of an asset.
 
+        :param credentials_path:
+        :type credentials_path:
         :param Asset asset: The asset to delete
         :param str operator_comment: The comments from the operator which are added to the logs
         :param str supervisor_comment: The comments from the supervisor which are added to the logs