85 ant 1 (#87)

* #85 - Continued improvements

* #85 - Continued improvements

* #85 - Continued improvements

* #85 - Continued improvements

* #85 - Continued improvements

* #85 - Continued improvements

* #85 - Continued improvements

* #85 - Continued improvements

* #85 - Continued improvements

* #85 - Continued improvements

* #85

* #85

* #85

* #85 - Continued improvements

* #85

* #85

* #85 - Continued improvements

* #85 - Continued initial

* Update _helpers.py

#85

* Update _helpers.py

#85

* #85 - Fix for 3.11

* #85 - Fix issues

Author: antaenc

examples/szconfig/add_data_source.py

@@ -3,7 +3,7 @@
 
 from senzing import SzConfig, SzError
 
-DATA_SOURCE_CODE = "TEST2"
+DATA_SOURCE_CODE = "test2"
 INSTANCE_NAME = "Example"
 settings = {
     "PIPELINE": {

src/senzing/_helpers.py

@@ -31,14 +31,17 @@
 from types import TracebackType
 from typing import Any, Callable, Dict, List, Optional, Type, TypeVar, Union
 
-from senzing_abstract.szerror import _ENGINE_EXCEPTION_MAP
+from senzing_abstract.szerror import ENGINE_EXCEPTION_MAP
 
 from senzing import SzError
 
-if sys.version_info < (3, 10):
-    from typing_extensions import ParamSpec
+# if sys.version_info < (3, 10):
+if sys.version_info < (3, 11):
+    from typing_extensions import ParamSpec, Self
 else:
-    from typing import ParamSpec
+    from typing import ParamSpec, Self
+
+# TODO Add metadata, should use __all__ ?
 
 T = TypeVar("T")
 P = ParamSpec("P")
@@ -64,8 +67,8 @@ def __init__(self, handle: CDLL, resource: _Pointer[c_char]) -> None:
         self.handle = handle
         self.resource = resource
 
-    def __enter__(self) -> None:
-        pass
+    def __enter__(self) -> Self:
+        return self
 
     def __exit__(
         self,
@@ -155,9 +158,10 @@ def load_sz_library(lib: str = "") -> CDLL:
         # TODO Change to Sz library when the libG2.so is changed in a build
         # TODO Wording & links for V4
         print(
-            "ERROR: Unable to load Senzing library. Did you remember to setup your environment by sourcing the setupEnv file?\n"
-            "ERROR: For more information see https://senzing.zendesk.com/hc/en-us/articles/115002408867-Introduction-G2-Quickstart\n"
-            "ERROR: If you are running Ubuntu or Debian please also review the ssl and crypto information at https://senzing.zendesk.com/hc/en-us/articles/115010259947-System-Requirements\n",
+            f"ERROR: Unable to load the Senzing library: {err}\n"
+            "ERROR: Did you remember to setup your environment by sourcing the setupEnv file?\n"
+            "ERROR: For more information: https://senzing.zendesk.com/hc/en-us/articles/115002408867-Introduction-G2-Quickstart\n"
+            "ERROR: If you are running Ubuntu or Debian also review the ssl and crypto information at https://senzing.zendesk.com/hc/en-us/articles/115010259947-System-Requirements\n",
         )
         raise sdk_exception(1) from err
 
@@ -235,6 +239,7 @@ def check_list_types(to_check: List[Any]) -> None:
             )
 
 
+# TODO - Ant - And Jira
 def escape_json_str(to_escape: str) -> str:
     """
     Escape strings when building a new JSON string.
@@ -245,6 +250,9 @@ def escape_json_str(to_escape: str) -> str:
         raise TypeError(f"expected a str, got{to_escape}")
     # TODO ensure_ascii=False = èAnt\\n👍
     # TODO             =True  = \\u00e8Ant\\n\\ud83d\\udc4d'
+    print(f"{to_escape = }")
+    jdumps = json.dumps({"escaped": to_escape}["escaped"])
+    print(f"{jdumps = }")
     return json.dumps({"escaped": to_escape}["escaped"])
 
 
@@ -440,7 +448,7 @@ def engine_exception(
     """
     sz_error_code = get_last_exception_code()
     sz_error_text = get_senzing_error_text(get_last_exception, clear_last_exception)
-    senzing_error_class = _ENGINE_EXCEPTION_MAP.get(sz_error_code, SzError)
+    senzing_error_class = ENGINE_EXCEPTION_MAP.get(sz_error_code, SzError)
     return senzing_error_class(sz_error_text)
 
 

src/senzing/szdiagnostic.py

@@ -235,6 +235,7 @@ def get_datastore_info(self, **kwargs: Any) -> str:
             return as_python_str(result.response)
 
     # NOTE This is included but not to be documented
+    # NOTE Is used by sz_explorer
     def get_feature(self, feature_id: int, **kwargs: Any) -> str:
         result = self.library_handle.G2Diagnostic_getFeature_helper(feature_id)
         with FreeCResources(self.library_handle, result.response):

src/senzing/szengine.py

@@ -595,6 +595,7 @@ def __init__(
         )
         self.initialized = True
 
+    # TODO Add garbage collection to ensure destruction
     def __del__(self) -> None:
         """Destructor"""
         if self.initialized:
@@ -749,6 +750,7 @@ def find_network_by_entity_id(
             build_out_max_entities,
             flags,
         )
+
         with FreeCResources(self.library_handle, result.response):
             self.check_result(result.return_code)
             return as_python_str(result.response)

src/senzing/szproduct.py

@@ -30,7 +30,6 @@
     catch_exceptions,
     check_result_rc,
     load_sz_library,
-    sdk_exception,
 )
 
 # Metadata
@@ -104,7 +103,9 @@ class SzProduct(SzProductAbstract):
     def __init__(
         self,
         instance_name: str = "",
-        settings: Union[str, Dict[Any, Any]] = "",
+        # TODO
+        # settings: Union[str, Dict[Any, Any]] = "",
+        settings: Union[str, Dict[Any, Any]] = "{}",
         verbose_logging: int = 0,
         **kwargs: Any,
     ) -> None:
@@ -144,8 +145,9 @@ def __init__(
         self.library_handle.G2GoHelper_free.argtypes = [c_char_p]
 
         # NOTE both get_license and get_version will work if "", "{}" are passed in
-        if not self.instance_name or len(self.settings) == 0:
-            raise sdk_exception(2)
+        # TODO
+        # if not self.instance_name or len(self.settings) == 0:
+        #     raise sdk_exception(2)
 
         # Initialize Senzing engine.
         self._initialize(self.instance_name, self.settings, self.verbose_logging)

src/senzing_abstract/szengineflags.py

@@ -3,7 +3,9 @@
 """
 
 from enum import IntFlag
-from typing import Any, List
+from typing import List, Union
+
+from senzing_abstract.szerror import SzError
 
 # Metadata
 
@@ -18,25 +20,57 @@
 # -----------------------------------------------------------------------------
 
 
+# TODO - Ant - Flag instead? https://realpython.com/python-enum/#exploring-other-enumeration-classes
 class SzEngineFlags(IntFlag):
-    """Engine Flags ..."""
+    """Engine Flags"""
 
     @classmethod
-    def combine_flags(
-        cls, list_of_strings: List[str], *args: Any, **kwargs: Any
-    ) -> int:
-        """OR together all strings in list_of_strings"""
-        # pylint: disable=unused-argument
+    def combine_flags(cls, flags: Union[List[IntFlag], List[str]]) -> int:
+        """
+        The `combine_flags` method ORs together all flags in a list of strings.
+
+        Args:
+            flags (List[str]): A list of strings each representing an engine flag.
+
+        Returns:
+            int: Value of ORing flags together.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/misc/engine_flags_combine_flags.py
+                :linenos:
+                :language: python
+
+            **Output:**
 
+            .. literalinclude:: ../../examples/misc/engine_flags_combine_flags.txt
+                :linenos:
+                :language: json
+        """
         result = 0
-        for string in list_of_strings:
-            result = result | SzEngineFlags[string]
+        try:
+            for flag in flags:
+                if isinstance(flag, str):
+                    result = result | cls[flag.upper()]
+                else:
+                    result = result | flag
+        except (AttributeError, KeyError) as err:
+            raise SzError(f"{err} is not a valid engine flag") from err
         return result
 
     @classmethod
-    def get_flag_int(cls, flag: IntFlag) -> int:
+    # TODO - Ant - Correct type?
+    def get_flag_int(cls, flag: Union[IntFlag, str]) -> int:
         """# TODO"""
-        return flag.value
+        try:
+            if isinstance(flag, str):
+                flag = cls[flag.upper()]
+            flag_int = flag.value
+        except (AttributeError, KeyError) as err:
+            raise SzError(f"{err} is not a valid engine flag") from err
+        return flag_int
 
     # Flags for exporting entity data.
 

src/senzing_abstract/szerror.py

@@ -14,7 +14,7 @@
 # Metadata
 
 __all__ = [
-    "_ENGINE_EXCEPTION_MAP",
+    "ENGINE_EXCEPTION_MAP",
     "SzBadInputError",
     "SzConfigurationError",
     "SzDatabaseConnectionLostError",
@@ -130,7 +130,7 @@ class SzUnhandledError(SzUnrecoverableError):
 # -----------------------------------------------------------------------------
 
 # fmt: off
-_ENGINE_EXCEPTION_MAP = {
+ENGINE_EXCEPTION_MAP = {
     2: SzBadInputError,                     # EAS_ERR_INVALID_MESSAGE                                                               "Invalid Message"
     5: SzError,                             # EAS_ERR_EXCEEDED_MAX_RETRIES                                                          "Exceeded the Maximum Number of Retries Allowed"
     7: SzBadInputError,                     # EAS_ERR_EMPTY_MESSAGE                                                                 "Empty Message"

tests/szproduct_test.py

@@ -4,7 +4,7 @@
 import pytest
 from pytest_schema import Regex, schema
 
-from senzing import SzError, SzProduct
+from senzing import SzProduct
 
 # -----------------------------------------------------------------------------
 # SzProduct testcases
@@ -26,26 +26,27 @@ def test_constructor(engine_vars: Dict[Any, Any]) -> None:
     assert isinstance(actual, SzProduct)
 
 
-def test_constructor_bad_instance_name(engine_vars: Dict[Any, Any]) -> None:
-    """Test constructor."""
-    bad_instance_name = ""
-    with pytest.raises(SzError):
-        actual = SzProduct(
-            bad_instance_name,
-            engine_vars["SETTINGS"],
-        )
-        assert isinstance(actual, SzProduct)
-
-
-def test_constructor_bad_settings(engine_vars: Dict[Any, Any]) -> None:
-    """Test constructor."""
-    bad_settings = ""
-    with pytest.raises(SzError):
-        actual = SzProduct(
-            engine_vars["INSTANCE_NAME"],
-            bad_settings,
-        )
-        assert isinstance(actual, SzProduct)
+# NOTE szproduct can be initialized without an instance name
+# def test_constructor_bad_instance_name(engine_vars: Dict[Any, Any]) -> None:
+#     """Test constructor."""
+#     bad_instance_name = ""
+#     with pytest.raises(SzError):
+#         actual = SzProduct(
+#             bad_instance_name,
+#             engine_vars["SETTINGS"],
+#         )
+#         assert isinstance(actual, SzProduct)
+
+# NOTE szproduct can be initialized without settings
+# def test_constructor_bad_settings(engine_vars: Dict[Any, Any]) -> None:
+#     """Test constructor."""
+#     bad_settings = ""
+#     with pytest.raises(SzError):
+#         actual = SzProduct(
+#             engine_vars["INSTANCE_NAME"],
+#             bad_settings,
+#         )
+#         assert isinstance(actual, SzProduct)
 
 
 def test_double_destroy(engine_vars: Dict[Any, Any]) -> None: