#169 - Update recently changed flags

Author: antaenc

CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.0.21] - 2025-05-14
+
+### Fixed in 0.0.21
+
+- Flag SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS was changed to SZ_ENTITY_INCLUDE_RECORD_FEATURES in the SDK, update in sz_explorer and sz_export
+- Update help examples in sz_command
+
 ## [0.0.20] - 2025-05-06
 
 ### Added in 0.0.20

development-requirements.txt

@@ -18,7 +18,7 @@ sphinx-prompt==1.9.0
 sphinxext-remoteliteralinclude==0.5.0
 sphinx-rtd-theme==3.0.2
 sphinx-tabs==3.4.7
-sphinx-toolbox==4.0.0
+sphinx-toolbox==3.0.0
 sphinx==8.2.3
 sphinxcontrib-applehelp==2.0.0
 sphinxcontrib-devhelp==2.0.0

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = python-tools
-version = 0.0.20
+version = 0.0.21
 author = senzing
 author_email = support@senzing.com
 description = Python Tools
@@ -21,8 +21,8 @@ package_dir =
 packages = find:
 python_requires = >=3.9
 install_requires =
-    senzing >= 0.2.10
-    senzing-core >= 0.3.9
+    senzing >= 0.2.12
+    senzing-core >= 0.3.11
 
 [options.packages.find]
 where = src

sz_tools/sz_command

@@ -1628,7 +1628,6 @@ class SzCmdShell(cmd.Cmd):
 
         Examples:
             preprocess_record '{"NAME_FULL":"Robert Smith", "DATE_OF_BIRTH":"7/4/1976", "PHONE_NUMBER":"787-767-2088"}'
-            preprocess_record '{"NAME_FULL":"Robert Smith", "DATE_OF_BIRTH":"7/4/1976", "PHONE_NUMBER":"787-767-2088"}' -f SZ_RECORD_DEFAULT_FLAGS
 
         Arguments:
             record_definition = Senzing mapped JSON representation of a record
@@ -1712,14 +1711,15 @@ class SzCmdShell(cmd.Cmd):
         Search for entities
 
         Syntax:
-            search_by_attributes attributes [-f FLAG ...]
+            search_by_attributes attributes [search_profile] [-f FLAG ...]
 
         Examples:
             search_by_attributes '{"name_full":"Robert Smith", "date_of_birth":"11/12/1978"}'
             search_by_attributes '{"name_full":"Robert Smith", "date_of_birth":"11/12/1978"}' -f SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL
 
         Arguments:
             attributes = Senzing mapped JSON containing the attributes to search on
+            search_profile = A configured search profile (don't specify for default)
             flag = Space separated list of engine flag(s) to determine output (don't specify for defaults)
 
         Notes:
@@ -1749,7 +1749,7 @@ class SzCmdShell(cmd.Cmd):
 
         Examples:
             why_entities 96 200011
-            why_entities 96 200011 -f SZ_WHY_ENTITY_DEFAULT_FLAGS SZ_ENTITY_INCLUDE_RECORD_RECORD_DEFINITION
+            why_entities 96 200011 -f SZ_WHY_ENTITIES_DEFAULT_FLAGS SZ_INCLUDE_MATCH_KEY_DETAILS
 
         Arguments:
             entity_id_1 = Identifier for first entity
@@ -1778,7 +1778,7 @@ class SzCmdShell(cmd.Cmd):
 
         Examples:
             why_record_in_entity reference 2121
-            why_record_in_entity reference 2121 -f SZ_WHY_ENTITY_DEFAULT_FLAGS SZ_ENTITY_INCLUDE_RECORD_RECORD_DEFINITION
+            why_record_in_entity reference 2121 -f SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS SZ_INCLUDE_MATCH_KEY_DETAILS
 
         Arguments:
             data_source_code = Data source code
@@ -1807,7 +1807,7 @@ class SzCmdShell(cmd.Cmd):
 
         Examples:
             why_records reference 2121 watchlist 2092
-            why_records reference 2121 watchlist 2092 -f SZ_WHY_ENTITY_DEFAULT_FLAGS SZ_ENTITY_INCLUDE_RECORD_RECORD_DEFINITION
+            why_records reference 2121 watchlist 2092 -f SZ_WHY_RECORDS_DEFAULT_FLAGS SZ_INCLUDE_MATCH_KEY_DETAILS
 
         Arguments:
             data_source_code_1 = Data source code for first record
@@ -1840,7 +1840,7 @@ class SzCmdShell(cmd.Cmd):
 
         Examples:
             why_search '{"name_full":"Robert Smith", "date_of_birth":"11/12/1978"}' 1
-            why_search '{"name_full":"Robert Smith", "date_of_birth":"11/12/1978"}' 1 -f SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL
+            why_search '{"name_full":"Robert Smith", "date_of_birth":"11/12/1978"}' 1 -f SZ_WHY_SEARCH_DEFAULT_FLAGS SZ_INCLUDE_MATCH_KEY_DETAILS
 
         Arguments:
             attributes = Senzing mapped JSON containing the attributes to search on

sz_tools/sz_explorer

@@ -420,7 +420,7 @@ class EdaReports:
         return review_features
 
     def show_audit_sample(self, audit_records, use_color=True):
-        get_flag_list = ["SZ_ENTITY_INCLUDE_ALL_FEATURES", "SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS"]
+        get_flag_list = ["SZ_ENTITY_INCLUDE_ALL_FEATURES", "SZ_ENTITY_INCLUDE_RECORD_FEATURES"]
         features_by_record = {}
         entity_list = set([x["NEWER_ID"] for x in audit_records])
         for entity_id in entity_list:
@@ -1406,7 +1406,7 @@ class EdaSdkWrapper:
             "SZ_ENTITY_INCLUDE_INTERNAL_FEATURES",
             "SZ_ENTITY_INCLUDE_FEATURE_STATS",
             "SZ_ENTITY_INCLUDE_RECORD_DATA",
-            "SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS",
+            "SZ_ENTITY_INCLUDE_RECORD_FEATURES",
             "SZ_INCLUDE_MATCH_KEY_DETAILS",
         ]
         try:
@@ -1895,7 +1895,7 @@ class EdaSdkWrapper:
             "SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME",
             "SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO",
             "SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY",
-            "SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS",
+            "SZ_ENTITY_INCLUDE_RECORD_FEATURES",
             "SZ_ENTITY_INCLUDE_ALL_FEATURES",
             "SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA",
         ]
@@ -2114,7 +2114,7 @@ class EdaSdkWrapper:
             "SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME",
             "SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO",
             "SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY",
-            "SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS",
+            "SZ_ENTITY_INCLUDE_RECORD_FEATURES",
             "SZ_ENTITY_INCLUDE_ALL_FEATURES",
             "SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA",
         ]
@@ -2445,7 +2445,7 @@ class EdaSdkWrapper:
     def why_records(self, entity_list, **kwargs):
         whyFlagList = [
             "SZ_WHY_ENTITIES_DEFAULT_FLAGS",
-            "SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS",
+            "SZ_ENTITY_INCLUDE_RECORD_FEATURES",
             "SZ_INCLUDE_MATCH_KEY_DETAILS",
         ]
         try:
@@ -2538,7 +2538,7 @@ class EdaSdkWrapper:
             "SZ_ENTITY_INCLUDE_FEATURE_STATS",
             "SZ_ENTITY_INCLUDE_RECORD_DATA",
             "SZ_ENTITY_INCLUDE_RECORD_JSON_DATA",
-            "SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS",
+            "SZ_ENTITY_INCLUDE_RECORD_FEATURES",
             "SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA",
             "SZ_ENTITY_INCLUDE_ALL_RELATIONS",
             "SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME",

sz_tools/sz_export

@@ -21,6 +21,47 @@ from senzing import SzEngineFlags, SzError
 from senzing_core import SzAbstractFactoryCore
 
 MODULE_NAME = pathlib.Path(__file__).stem
+VALID_FLAGS = [
+    "SZ_ENTITY_BRIEF_DEFAULT_FLAGS",
+    "SZ_ENTITY_CORE_FLAGS",
+    "SZ_ENTITY_DEFAULT_FLAGS",
+    "SZ_ENTITY_INCLUDE_ALL_FEATURES",
+    "SZ_ENTITY_INCLUDE_ALL_RELATIONS",
+    "SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS",
+    "SZ_ENTITY_INCLUDE_ENTITY_NAME",
+    "SZ_ENTITY_INCLUDE_INTERNAL_FEATURES",
+    "SZ_ENTITY_INCLUDE_FEATURE_STATS",
+    "SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS",
+    "SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS",
+    "SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS",
+    "SZ_ENTITY_INCLUDE_RECORD_DATA",
+    "SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS",
+    "SZ_ENTITY_INCLUDE_RECORD_FEATURES",
+    "SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS",
+    "SZ_ENTITY_INCLUDE_RECORD_JSON_DATA",
+    "SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO",
+    "SZ_ENTITY_INCLUDE_RECORD_SUMMARY",
+    "SZ_ENTITY_INCLUDE_RECORD_TYPES",
+    "SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA",
+    "SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME",
+    "SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO",
+    "SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA",
+    "SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY",
+    "SZ_ENTITY_INCLUDE_RELATED_RECORD_TYPES",
+    "SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES",
+    "SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA",
+    "SZ_EXPORT_DEFAULT_FLAGS",
+    "SZ_EXPORT_INCLUDE_ALL_ENTITIES",
+    "SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS",
+    "SZ_EXPORT_INCLUDE_NAME_ONLY",
+    "SZ_EXPORT_INCLUDE_DISCLOSED",
+    "SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES",
+    "SZ_EXPORT_INCLUDE_POSSIBLY_RELATED",
+    "SZ_EXPORT_INCLUDE_POSSIBLY_SAME",
+    "SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES",
+    "SZ_INCLUDE_MATCH_KEY_DETAILS",
+    "SZ_RECORD_DEFAULT_FLAGS",
+]
 
 
 def csv_fetch_next(handle, csv_header=None):
@@ -207,45 +248,6 @@ def open_file(file_name):
 
 
 if __name__ == "__main__":
-    SZ_VALID_FLAGS = [
-        "SZ_ENTITY_BRIEF_DEFAULT_FLAGS",
-        "SZ_ENTITY_DEFAULT_FLAGS",
-        "SZ_ENTITY_INCLUDE_ALL_FEATURES",
-        "SZ_ENTITY_INCLUDE_ALL_RELATIONS",
-        "SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS",
-        "SZ_ENTITY_INCLUDE_ENTITY_NAME",
-        "SZ_ENTITY_INCLUDE_INTERNAL_FEATURES",
-        "SZ_ENTITY_INCLUDE_FEATURE_STATS",
-        "SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS",
-        "SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS",
-        "SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS",
-        "SZ_ENTITY_INCLUDE_RECORD_DATA",
-        "SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS",
-        "SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS",
-        "SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS",
-        "SZ_ENTITY_INCLUDE_RECORD_JSON_DATA",
-        "SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO",
-        "SZ_ENTITY_INCLUDE_RECORD_SUMMARY",
-        "SZ_ENTITY_INCLUDE_RECORD_TYPES",
-        "SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA",
-        "SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME",
-        "SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO",
-        "SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA",
-        "SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY",
-        "SZ_ENTITY_INCLUDE_RELATED_RECORD_TYPES",
-        "SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES",
-        "SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA",
-        "SZ_EXPORT_DEFAULT_FLAGS",
-        "SZ_EXPORT_INCLUDE_ALL_ENTITIES",
-        "SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS",
-        "SZ_EXPORT_INCLUDE_NAME_ONLY",
-        "SZ_EXPORT_INCLUDE_DISCLOSED",
-        "SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES",
-        "SZ_EXPORT_INCLUDE_POSSIBLY_RELATED",
-        "SZ_EXPORT_INCLUDE_POSSIBLY_SAME",
-        "SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES",
-    ]
-
     cli_args = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter, allow_abbrev=False)
     cli_args.add_argument(
         "-o",
@@ -481,7 +483,7 @@ if __name__ == "__main__":
 
     # Get only the string flags to check against accepted flags
     string_flags = [flag for flag in flags if isinstance(flag, str)]
-    invalid_string_flags = set(string_flags).difference(SZ_VALID_FLAGS)
+    invalid_string_flags = set(string_flags).difference(VALID_FLAGS)
     if invalid_string_flags:
         print_warning("Ignoring invalid flag(s): ", end_str=" ")
         print(", ".join(invalid_string_flags))