NGPIris 5.4.2.dev6__tar.gz → 5.4.3__tar.gz

{ngpiris-5.4.2.dev6 → ngpiris-5.4.3}/NGPIris/cli/__init__.py

@@ -6,6 +6,7 @@ from pathlib import Path
 from boto3 import set_stream_logger
 from typing import Any, Generator
 from bitmath import Byte, TiB
+import sys
 
 from NGPIris.hcp import HCPHandler
 
@@ -108,7 +109,8 @@ def upload(context : Context, bucket : str, source : str, destination : str, dry
     """
 
     if equal_parts <= 0:
-        exit("Error: --equal_parts value must be a positive integer")
+        click.echo("Error: --equal_parts value must be a positive integer", err=True)
+        sys.exit(1)
     
     upload_mode_choice = HCPHandler.UploadMode(upload_mode.lower())
 

{ngpiris-5.4.2.dev6 → ngpiris-5.4.3}/NGPIris/hci/hci.py

@@ -26,11 +26,13 @@ class HCIHandler:
         """
         credentials_handler = CredentialsHandler(credentials_path)
         self.hci = credentials_handler.hci
+        
         self.username = self.hci["username"]
         self.password = self.hci["password"]
         self.address = self.hci["address"]
         self.auth_port = self.hci["auth_port"]
         self.api_port = self.hci["api_port"]
+
         self.token = ""
 
         self.use_ssl = use_ssl
@@ -94,12 +96,12 @@ class HCIHandler:
         
         return {}
 
-    def raw_query(self, query_dict : dict[str, str]) -> dict:
+    def raw_query(self, query_dict : dict[str, str | list | dict]) -> dict:
         """
         Make query to an HCI index, with a dictionary
 
         :param query_dict: Dictionary consisting of the query
-        :type query_dict: dict[str, str]
+        :type query_dict: dict[str, str | list | dict]
 
         :return: Dictionary containing the raw query
         :rtype: dict
@@ -129,4 +131,29 @@ class HCIHandler:
             self.api_port, 
             self.token, 
             self.use_ssl
-        ).json())
+        ).json())
+
+    def query(self, index_name : str, query_string : str = "", facets : list[str] = []) -> dict:
+        """
+        Make a query to the HCI based on the parameters of this method
+
+        :param index_name: Name of the index
+        :type index_name: str
+
+        :param query_string: The Solr query string. Defaults to the empty string
+        :type query_string: str, optional
+
+        :param facets: List of facets that should be returned included in the response. Defaults to []
+        :type facets: list[str], optional
+        
+        :return: The response in the form of a dictionary 
+        :rtype: dict
+        """
+        facetRequests = [{"fieldName" : facet } for facet in facets]
+        return self.raw_query(
+            {
+                "indexName" : index_name,
+                "queryString" : query_string,
+                "facetRequests" : facetRequests
+            }
+        )

{ngpiris-5.4.2.dev6 → ngpiris-5.4.3}/NGPIris/hci/helpers.py

@@ -44,7 +44,7 @@ def get_index_response(address : str, api_port : str, token : str, use_ssl : boo
     return response
 
 def get_query_response(
-        query_dict : dict[str, str], 
+        query_dict : dict[str, str | list | dict], 
         address : str, 
         api_port : str, 
         token : str, 
@@ -55,7 +55,7 @@ def get_query_response(
     Retrieve the query response given the address, API port and token.
 
     :param query_dict: The query dictionary
-    :type query_dict: dict[str, str]
+    :type query_dict: dict[str, str | list | dict]
 
     :param address: The address where request is to be made
     :type address: str
@@ -79,7 +79,7 @@ def get_query_response(
         raise RuntimeError("Field indexName is missing in the query dictionary")
 
     url     : str            = "https://" + address + ":" + api_port + "/api/search/query/" + path_extension
-    query   : dict[str, str] = query_dict
+    query   : dict[str, str | list | dict] = query_dict
     headers : dict[str, str] = {
         "Content-Type": "application/json",
         "Accept": "application/json",

{ngpiris-5.4.2.dev6 → ngpiris-5.4.3/NGPIris.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: NGPIris
-Version: 5.4.2.dev6
+Version: 5.4.3
 Author-email: Erik Brink <erik.brink@gu.se>, Isak Sylvin <isak.sylvin@gu.se>
 Description-Content-Type: text/markdown
 License-File: LICENSE

{ngpiris-5.4.2.dev6/NGPIris.egg-info → ngpiris-5.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: NGPIris
-Version: 5.4.2.dev6
+Version: 5.4.3
 Author-email: Erik Brink <erik.brink@gu.se>, Isak Sylvin <isak.sylvin@gu.se>
 Description-Content-Type: text/markdown
 License-File: LICENSE

{ngpiris-5.4.2.dev6 → ngpiris-5.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "NGPIris"
-version = "5.4.2.dev6"
+version = "5.4.3"
 readme = "README.md"
 dependencies = [
     "requests >= 2.31.0",

{ngpiris-5.4.2.dev6 → ngpiris-5.4.3}/tests/test_hci.py

@@ -26,10 +26,11 @@ def test_fail_index_look_up() -> None:
 def test_make_simple_raw_query() -> None:
     list_of_indexes = hci_h.list_index_names()
     arbitrary_index = list_of_indexes[randint(0, len(list_of_indexes) - 1)]
-    query = {
-        "indexName" : arbitrary_index
-    }
-    result = hci_h.raw_query(query)
+    result = hci_h.raw_query(
+        {
+            "indexName" : arbitrary_index
+        }
+    )
     assert result["indexName"] == arbitrary_index
 
 def test_raw_query_with_results() -> None: