#237 #231

Author: antaenc

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.2.11] - 2025-05-05
+
+### Changed in 0.2.11
+
+- Fixed incorrect flag defaults in szengine.py
+- Fixed incorrect flag defaults in szengine.py in doc strings
+- Spelling corrections
+
 ## [0.2.10] - 2025-04-30
 
 ### Changed in 0.2.10

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = senzing
-version = 0.2.10
+version = 0.2.11
 author = senzing
 author_email = support@senzing.com
 description = Python SDK method definitions

src/senzing/szengine.py

@@ -289,7 +289,7 @@ def find_network_by_entity_id(
             max_degrees (int): The maximum number of degrees in paths between search entities.
             build_out_degrees (int): The number of degrees of relationships to show around each search entity.
             build_out_max_entities (int): The maximum number of entities to return in the discovered network.
-            flags (int, optional): The maximum number of entities to return in the discovered network. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.
+            flags (int, optional): The maximum number of entities to return in the discovered network. Defaults to SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS.
 
         Returns:
             str: A JSON document.
@@ -329,7 +329,7 @@ def find_network_by_record_id(
             max_degrees (int): The maximum number of degrees in paths between search entities.
             build_out_degrees (int): The number of degrees of relationships to show around each search entity.
             build_out_max_entities (int): The maximum number of entities to return in the discovered network.
-            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS.
 
         Returns:
             str: A JSON document.
@@ -622,7 +622,7 @@ def get_virtual_entity_by_record_id(
 
         Args:
             record_keys (list(tuple(str, str))): The data source codes and record IDs identifying records to create the virtual entity from.
-            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS.
 
         Returns:
             str:  A JSON document.
@@ -686,7 +686,7 @@ def preprocess_record(
 
         Args:
             record_definition (str): A JSON document containing the record to be tested.
-            flags (int, optional): Flags used to control information returned. Defaults to 0.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS.
 
         Returns:
             str: A JSON document containing metadata as specified by the flags.
@@ -845,7 +845,7 @@ def why_entities(
         Args:
             entity_id_1 (int): The entity ID for the starting entity of the search path.
             entity_id_2 (int): The entity ID for the ending entity of the search path.
-            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS.
 
         Returns:
             str: A JSON document.
@@ -870,15 +870,15 @@ def why_record_in_entity(
         self,
         data_source_code: str,
         record_id: str,
-        flags: int = SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS,
+        flags: int = SzEngineFlags.SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS,
     ) -> str:
         """
         The `why_record_in_entity` method determines why a record is included in an entity.
 
         Args:
             data_source_code (str): Identifies the provenance of the data.
             record_id (str): The unique identifier within the records of the same data source.
-            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS.
 
         Returns:
             str: A JSON document.

src/senzing/szengineflags.py

@@ -220,26 +220,11 @@ def flags_by_value(cls) -> Dict[int, str]:
     )
 
     # The recommended default flag values for why-analysis on entities.
-    SZ_WHY_ENTITIES_DEFAULT_FLAGS = (
-        SZ_ENTITY_DEFAULT_FLAGS
-        | SZ_ENTITY_INCLUDE_INTERNAL_FEATURES
-        | SZ_ENTITY_INCLUDE_FEATURE_STATS
-        | SZ_INCLUDE_FEATURE_SCORES
-    )
+    SZ_WHY_ENTITIES_DEFAULT_FLAGS = SZ_INCLUDE_FEATURE_SCORES
 
-    SZ_WHY_RECORDS_DEFAULT_FLAGS = (
-        SZ_ENTITY_DEFAULT_FLAGS
-        | SZ_ENTITY_INCLUDE_INTERNAL_FEATURES
-        | SZ_ENTITY_INCLUDE_FEATURE_STATS
-        | SZ_INCLUDE_FEATURE_SCORES
-    )
+    SZ_WHY_RECORDS_DEFAULT_FLAGS = SZ_INCLUDE_FEATURE_SCORES
 
-    SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS = (
-        SZ_ENTITY_DEFAULT_FLAGS
-        | SZ_ENTITY_INCLUDE_INTERNAL_FEATURES
-        | SZ_ENTITY_INCLUDE_FEATURE_STATS
-        | SZ_INCLUDE_FEATURE_SCORES
-    )
+    SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS = SZ_INCLUDE_FEATURE_SCORES
 
     SZ_WHY_SEARCH_DEFAULT_FLAGS = (
         SZ_INCLUDE_FEATURE_SCORES | SZ_SEARCH_INCLUDE_REQUEST_DETAILS | SZ_SEARCH_INCLUDE_STATS
@@ -260,6 +245,7 @@ def flags_by_value(cls) -> Dict[int, str]:
         | SZ_ENTITY_INCLUDE_ENTITY_NAME
         | SZ_ENTITY_INCLUDE_RECORD_SUMMARY
         | SZ_INCLUDE_FEATURE_SCORES
+        | SZ_SEARCH_INCLUDE_STATS
     )
 
     # The recommended flag values for searching by attributes, returning only strongly matching entities.
@@ -270,13 +256,16 @@ def flags_by_value(cls) -> Dict[int, str]:
         | SZ_ENTITY_INCLUDE_ENTITY_NAME
         | SZ_ENTITY_INCLUDE_RECORD_SUMMARY
         | SZ_INCLUDE_FEATURE_SCORES
+        | SZ_SEARCH_INCLUDE_STATS
     )
 
     # Return minimal data with all matches.
-    SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL = SZ_SEARCH_INCLUDE_ALL_ENTITIES
+    SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL = SZ_SEARCH_INCLUDE_ALL_ENTITIES | SZ_SEARCH_INCLUDE_STATS
 
     # Return minimal data with only the strongest matches.
-    SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG = SZ_SEARCH_INCLUDE_RESOLVED | SZ_SEARCH_INCLUDE_POSSIBLY_SAME
+    SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG = (
+        SZ_SEARCH_INCLUDE_RESOLVED | SZ_SEARCH_INCLUDE_POSSIBLY_SAME | SZ_SEARCH_INCLUDE_STATS
+    )
 
     # Rhe recommended default flag values for search-by-attributes.
     SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS = SZ_SEARCH_BY_ATTRIBUTES_ALL

src/senzing/szerror.py

@@ -136,7 +136,7 @@ class SzDatabaseError(SzUnrecoverableError):
 
 
 class SzLicenseError(SzUnrecoverableError):
-    """Licence exception"""
+    """License exception"""
 
 
 class SzNotInitializedError(SzUnrecoverableError):