269 ant 1 (#272)

* #269 - Save point

* #269 - Save point

* #269 - Save point

* #269 - Save point

* #269 - Save point

* #269 - Save point

* #269 - Save point

* #269 - Work around not needing typing_extensions

* #269 - Type fix

* #269 - Type fix

* #269 - Type fix

Author: antaenc

CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.3.13] - 2025-06-10
+
+### Changed in 0.3.13
+
+- To be consistent with Sz engine and orjson, if json.dumps() is used (orjson not available) in _helpers.py don't add spaces after : and , separators
+
+### Removed in 0.3.13
+
+- `from typing_extensions import ...` in _helpers.py is removed to simplify product requirements
+
 ## [0.3.12] - 2025-05-21
 
 ### Added in 0.3.12

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = senzing_core
-version = 0.3.12
+version = 0.3.13
 author = senzing
 author_email = support@senzing.com
 description = Senzing Python SDK

src/senzing_core/_helpers.py

@@ -2,15 +2,14 @@
 SDK Helper functions
 """
 
-# NOTE This is to prevent TypeError: '_ctypes.PyCPointerType' object is not subscriptable
-# on _Pointer[c_char]) for FreeCResources
-# ctypes._Pointer is generic for type checkers, but at runtime it's not generic, so annotations
-# import is necessary - or string annotation ("_Pointer[c_char]") .
+# NOTE - This is to prevent TypeError: '_ctypes.PyCPointerType' object is not subscriptable  on _Pointer[c_char]) for
+# NOTE - FreeCResources ctypes._Pointer is generic for type checkers, but at runtime it's not generic, so annotations
+# NOTE - import is necessary - or string annotation ("_Pointer[c_char]") .
 from __future__ import annotations
 
 import platform
-import sys
 import threading
+from collections.abc import Callable
 from contextlib import suppress
 from ctypes import (
     CDLL,
@@ -28,30 +27,30 @@
 from ctypes.util import find_library
 from functools import wraps
 from types import TracebackType
-from typing import Any, Callable, Dict, List, Optional, Type, TypeVar, Union
+from typing import Any, Dict, List, Optional, Type, TypeVar, Union
+from typing import cast as typing_cast
 
 from senzing import ENGINE_EXCEPTION_MAP, SzError, SzSdkError
 
 try:
-    import orjson
+    import orjson  # type: ignore[import-not-found, unused-ignore]
 
     def _json_dumps(object_: Any) -> str:
-        return orjson.dumps(object_).decode("utf-8")
+        return orjson.dumps(object_).decode("utf-8")  # type: ignore[no-any-return, unused-ignore]
 
 except ImportError:
     import json
 
+    # NOTE - separators= is used to be consistent with Sz engine and orjson output
     def _json_dumps(object_: Any) -> str:
-        return json.dumps(object_, ensure_ascii=False)
+        return json.dumps(object_, ensure_ascii=False, separators=(",", ":"))
 
 
-if sys.version_info < (3, 11):
-    from typing_extensions import ParamSpec, Self
-else:
-    from typing import ParamSpec, Self
-
-T = TypeVar("T")
-P = ParamSpec("P")
+# 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")
 
 START_DSRC_JSON = '{"DATA_SOURCES": ['
 START_ENTITIES_JSON = '{"ENTITIES": ['
@@ -74,7 +73,7 @@ def __init__(self, handle: CDLL, resource: _Pointer[c_char]) -> None:
         self.handle = handle
         self.resource = resource
 
-    def __enter__(self) -> Self:
+    def __enter__(self: SelfFreeCResources) -> SelfFreeCResources:
         return self
 
     def __exit__(
@@ -91,7 +90,8 @@ def __exit__(
 # -----------------------------------------------------------------------------
 
 
-def catch_sdk_exceptions(func_to_decorate: Callable[P, T]) -> Callable[P, T]:
+# def catch_sdk_exceptions(func_to_decorate: Callable[P, T]) -> Callable[P, T]:
+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
@@ -103,9 +103,9 @@ def catch_sdk_exceptions(func_to_decorate: Callable[P, T]) -> Callable[P, T]:
     """
 
     @wraps(func_to_decorate)
-    def wrapped_func(*args: P.args, **kwargs: P.kwargs) -> T:
+    def wrapped_func(*args: Any, **kwargs: Any) -> F:
         try:
-            return 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__
@@ -132,7 +132,7 @@ def wrapped_func(*args: P.args, **kwargs: P.kwargs) -> T:
 
             raise SzSdkError(err) from err
 
-    return wrapped_func
+    return typing_cast(F, wrapped_func)
 
 
 # -----------------------------------------------------------------------------
@@ -160,7 +160,7 @@ def load_sz_library(lib: str = "", os: str = "") -> CDLL:
 
         raise SzSdkError(f"{system_name} is an unsupported operating system")
     except OSError as err:
-        # TODO Wording & links for V4
+        # TODO - Wording & links for V4
         print(
             f"ERROR: Unable to load the Senzing library: {err}\n"
             "       Did you remember to setup your environment by sourcing the setupEnv file?\n"

tests/helpers_test.py

@@ -41,8 +41,8 @@ def test_as_str() -> None:
         "test2": 5,
         "test3": {"test3.1": "Wilma"},
     }
-    # NOTE replace() is needed, dumps() adds spaces but as_str() doesn't
-    actual = json.dumps(a_dict).replace(" ", "")
+    # NOTE - separators= is used to be consistent with Sz engine and orjson output as used in _helpers.py
+    actual = json.dumps(a_dict, separators=(",", ":"))
     result1 = as_str(a_dict)
     assert isinstance(result1, str)
     assert result1 == actual