312 ant 1 (#319)

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Save point

* #312 - Abstract factory improvements

* #312 - Abstract factory improvements

Author: antaenc

.vscode/cspell.json

@@ -66,6 +66,7 @@
     "FCLASS",
     "FELEM",
     "felems",
+    "finalizer",
     "FMES",
     "fpvs",
     "FTYPE",
@@ -196,4 +197,4 @@
     "**/__pycache__/**",
     "development-requirements.txt"
   ]
-}
+}

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.4.0] - 2025-07-19
+
+### Changed in 0.4.0
+
+- Abstract factory improvements
+
 ## [0.3.17] - 2025-07-11
 
 ### Changed in 0.3.17

Migration.md

@@ -121,7 +121,6 @@ print(response)
 The separate `WithInfo` methods have been removed in the version 4.0 SDK. The capability is now included in the `add_record`, `delete_record`, `process_redo_record`,`reevaluate_entity`, and `reevaluate_record` methods. Requesting the with info response is achieved with the use of the optional `flags` argument and specifying the `SZ_WITH_INFO` engine flag. The default is not to return the with info response, in which case an empty string is returned:
 
 ```python
-from senzing import SzError
 ...
 try:
    _ = sz_engine.add_record("TEST", "78720B", record_json_str)
@@ -135,6 +134,7 @@ Return the with info response using the `flags` argument:
 ```python
 from senzing import SzEngineFlags, SzError
 ...
+
 try:
    response = sz_engine.add_record("TEST", "78720B", record_json_str, flags=SzEngineFlags.SZ_WITH_INFO)
 except SzError as err:
@@ -385,7 +385,7 @@ finally:
 In version 4.0, the `SzConfig` module is subordinate to the `SzConfigManager` and literally represents a Senzing configuration as an object. It removes the hassle of dealing with "config handles" that have to be closed as well:
 
 ```python
-sz_factory = SzAbstractFactoryCore(MODULE_NAME, SETTINGS, verbose_logging=False)
+sz_factory = SzAbstractFactoryCore(MODULE_NAME, SETTINGS)
 
 try:
     # Get the config manager from the abstract factory
@@ -398,7 +398,8 @@ try:
     sz_config.register_data_source("CUSTOMERS")
 
     # Register and set the default config in one shot
-    new_config_id = sz_configmanager.set_default_config(sz_config.export(), "Register data source CUSTOMERS")
+    new_config = sz_config.export()
+    new_config_id = sz_configmanager.set_default_config(new_config), "Register data source CUSTOMERS")
 except SzError as err:
     raise err
 ```

examples/szabstractfactory/destroy.py

@@ -0,0 +1,26 @@
+from senzing import SzError
+
+from senzing_core import SzAbstractFactoryCore
+
+instance_name = "Example"
+settings = {
+    "PIPELINE": {
+        "CONFIGPATH": "/etc/opt/senzing",
+        "RESOURCEPATH": "/opt/senzing/er/resources",
+        "SUPPORTPATH": "/opt/senzing/data",
+    },
+    "SQL": {"CONNECTION": "sqlite3://na:na@/tmp/sqlite/G2C.db"},
+}
+
+try:
+    sz_abstract_factory = SzAbstractFactoryCore(instance_name, settings)
+    sz_engine = sz_abstract_factory.create_engine()
+    sz_diagnostic = sz_abstract_factory.create_diagnostic()
+
+    # Do work...
+except SzError as err:
+    print(f"\nERROR: {err}\n")
+finally:
+    # Destroys the abstract factory and all objects it created, such as sz_engine and sz_diagnostic above
+    # If sz_abstract_factory goes out of scope destroy() is automatically called
+    sz_abstract_factory.destroy()

examples/szabstractfactory/destroy.txt

@@ -0,0 +1 @@
+// No output from this example.

requirements.txt

@@ -1,2 +1,2 @@
 orjson==3.11.0
-senzing==0.2.17
+senzing==0.2.20

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = senzing_core
-version = 0.3.17
+version = 0.4.0
 author = senzing
 author_email = support@senzing.com
 description = Senzing Python SDK
@@ -21,7 +21,7 @@ package_dir =
 packages = find:
 python_requires = >=3.9
 install_requires =
-    senzing >= 0.2.17,<1.0.0
+    senzing >= 0.2.20,<1.0.0
 
 [options.packages.find]
 where = src

src/senzing_core/__init__.py

@@ -13,7 +13,7 @@
     from .szproduct import SzProductCore
 
     sz_product = SzProductCore()
-    sz_product.initialize("sdk_init_check", "{}")
+    sz_product._initialize("sdk_init_check", "{}")
     version: str = json.loads(sz_product.get_version()).get("VERSION", "0.0.0")
     is_senzing_binary_version_supported(version)
 except (ImportError, SyntaxError) as err:

src/senzing_core/_helpers.py

@@ -58,8 +58,9 @@ def _json_dumps(_obj: Any, *args: Any, **kwargs: Any) -> str:
 # NOTE - Using earlier Python version typing to support v3.9 still and not rely on typing_extensions.
 # NOTE - F can be changed to use ParamSpec when no longer need to support v3.9.
 # NOTE - SelfFreeCResources can be changed to use Self at v3.11.
-F = TypeVar("F", bound=Callable[..., Any])
-SelfFreeCResources = TypeVar("SelfFreeCResources", bound="FreeCResources")
+_F = TypeVar("_F", bound=Callable[..., Any])
+_SelfFreeCResources = TypeVar("_SelfFreeCResources", bound="FreeCResources")
+_WrappedFunc = TypeVar("_WrappedFunc", bound=Callable[..., Any])
 
 PYTHON_VERSION_MINIMUM = "3.9"
 SENZING_VERSION_MINIMUM = "4.0.0"
@@ -85,7 +86,7 @@ def __init__(self, handle: CDLL, resource: _Pointer[c_char]) -> None:
         self.handle = handle
         self.resource = resource
 
-    def __enter__(self: SelfFreeCResources) -> SelfFreeCResources:
+    def __enter__(self: _SelfFreeCResources) -> _SelfFreeCResources:
         return self
 
     def __exit__(
@@ -102,7 +103,7 @@ def __exit__(
 # -----------------------------------------------------------------------------
 
 
-def catch_sdk_exceptions(func_to_decorate: F) -> F:
+def catch_sdk_exceptions(func_to_decorate: _F) -> _F:
     """
     The Python SDK methods convert Python types to ctypes and utilize helper functions. If incorrect types/values are
     used standard library exceptions are raised not SzError exceptions as the Senzing library hasn't been called
@@ -114,9 +115,9 @@ def catch_sdk_exceptions(func_to_decorate: F) -> F:
     """
 
     @wraps(func_to_decorate)
-    def wrapped_func(*args: Any, **kwargs: Any) -> F:
+    def wrapped_func(*args: Any, **kwargs: Any) -> _F:
         try:
-            return typing_cast(F, func_to_decorate(*args, **kwargs))
+            return typing_cast(_F, func_to_decorate(*args, **kwargs))
         except (ArgumentError, TypeError, ValueError) as err:
             # Get wrapped function annotation, remove unwanted keys
             annotations_dict = func_to_decorate.__annotations__
@@ -143,7 +144,24 @@ def wrapped_func(*args: Any, **kwargs: Any) -> F:
 
             raise SzSdkError(err) from err
 
-    return typing_cast(F, wrapped_func)
+    return typing_cast(_F, wrapped_func)
+
+
+# -----------------------------------------------------------------------------
+# Decorators
+# -----------------------------------------------------------------------------
+
+
+def check_is_destroyed(func: _WrappedFunc) -> _WrappedFunc:
+    """Check if an engine instance has been destroyed"""
+
+    @wraps(func)
+    def wrapped_check_destroyed(self, *args, **kwargs):  # type: ignore
+        if self._is_destroyed:  # pylint: disable=protected-access
+            raise SzSdkError("engine object has been destroyed and can no longer be used, create a new one")
+        return func(self, *args, **kwargs)
+
+    return typing_cast(_WrappedFunc, wrapped_check_destroyed)
 
 
 # -----------------------------------------------------------------------------