diff --git a/CHANGELOG.md b/CHANGELOG.md index b1118dd9..35645831 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning]. ## [Unreleased] +## [0.2.8] - 2025-04-21 + +### Changed in 0.2.8 + +- Simplify and clean up examples + ## [0.2.7] - 2025-04-18 ### Changed in 0.2.7 diff --git a/examples/misc/add_truthset_data.py b/examples/misc/add_truthset_data.py index 5f8e3461..7096bcfe 100755 --- a/examples/misc/add_truthset_data.py +++ b/examples/misc/add_truthset_data.py @@ -7,13 +7,14 @@ from . import sz_abstract_factory +record_sets = [ + TRUTHSET_CUSTOMER_RECORDS, + TRUTHSET_REFERENCE_RECORDS, + TRUTHSET_WATCHLIST_RECORDS, +] + try: sz_engine = sz_abstract_factory.create_engine() - record_sets = [ - TRUTHSET_CUSTOMER_RECORDS, - TRUTHSET_REFERENCE_RECORDS, - TRUTHSET_WATCHLIST_RECORDS, - ] for record_set in record_sets: for record in record_set.values(): sz_engine.add_record( diff --git a/examples/misc/add_truthset_datasources.py b/examples/misc/add_truthset_datasources.py index b58804e9..158d139c 100755 --- a/examples/misc/add_truthset_datasources.py +++ b/examples/misc/add_truthset_datasources.py @@ -9,19 +9,19 @@ # Create a new Senzing configuration with additional datasources. - CURRENT_DEFAULT_CONFIG_ID = sz_configmanager.get_default_config_id() - sz_config = sz_configmanager.create_config_from_config_id(CURRENT_DEFAULT_CONFIG_ID) + current_default_config_id = sz_configmanager.get_default_config_id() + sz_config = sz_configmanager.create_config_from_config_id(current_default_config_id) for data_source_code in TRUTHSET_DATASOURCES: sz_config.add_data_source(data_source_code) # Persist new Senzing configuration. - NEW_CONFIG_DEFINITION = sz_config.export() - NEW_DEFAULT_CONFIG_ID = sz_configmanager.register_config(NEW_CONFIG_DEFINITION, "Add TruthSet datasources") + new_config_definition = sz_config.export() + new_default_config_id = sz_configmanager.register_config(new_config_definition, "Add TruthSet datasources") # Make new Senzing configuration the default and the active configuration. - sz_configmanager.replace_default_config_id(CURRENT_DEFAULT_CONFIG_ID, NEW_DEFAULT_CONFIG_ID) - sz_abstract_factory.reinitialize(NEW_DEFAULT_CONFIG_ID) + sz_configmanager.replace_default_config_id(current_default_config_id, new_default_config_id) + sz_abstract_factory.reinitialize(new_default_config_id) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szabstractfactory/reinitialize.py b/examples/szabstractfactory/reinitialize.py index 84d78163..e0f2bdc3 100755 --- a/examples/szabstractfactory/reinitialize.py +++ b/examples/szabstractfactory/reinitialize.py @@ -5,7 +5,7 @@ try: # Using get_active_config_id for demonstrations purposes. sz_engine = sz_abstract_factory.create_engine() - CONFIG_ID = sz_engine.get_active_config_id() - sz_abstract_factory.reinitialize(CONFIG_ID) + config_id = sz_engine.get_active_config_id() + sz_abstract_factory.reinitialize(config_id) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szconfig/add_data_source.py b/examples/szconfig/add_data_source.py index e8a54cd5..c87035f1 100755 --- a/examples/szconfig/add_data_source.py +++ b/examples/szconfig/add_data_source.py @@ -2,10 +2,11 @@ from . import sz_configmanager +data_source_code = "NAME_OF_DATASOURCE" + try: - DATA_SOURCE_CODE = "NAME_OF_DATASOURCE" sz_config = sz_configmanager.create_config_from_template() - result = sz_config.add_data_source(DATA_SOURCE_CODE) + result = sz_config.add_data_source(data_source_code) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szconfig/delete_data_source.py b/examples/szconfig/delete_data_source.py index 0818d80e..4590caa9 100755 --- a/examples/szconfig/delete_data_source.py +++ b/examples/szconfig/delete_data_source.py @@ -2,9 +2,10 @@ from . import sz_configmanager +data_source_code = "TEST" + try: - DATA_SOURCE_CODE = "TEST" sz_config = sz_configmanager.create_config_from_template() - _ = sz_config.delete_data_source(DATA_SOURCE_CODE) + _ = sz_config.delete_data_source(data_source_code) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szconfig/export.py b/examples/szconfig/export.py index f02409ea..81107d9f 100755 --- a/examples/szconfig/export.py +++ b/examples/szconfig/export.py @@ -4,7 +4,7 @@ try: sz_config = sz_configmanager.create_config_from_template() - CONFIG_DEFINITION = sz_config.export() - print(f"\n{CONFIG_DEFINITION}\n") + config_definition = sz_config.export() + print(f"\n{config_definition}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/create_config_from_config_id.py b/examples/szconfigmanager/create_config_from_config_id.py index f3aee274..0dbc406f 100755 --- a/examples/szconfigmanager/create_config_from_config_id.py +++ b/examples/szconfigmanager/create_config_from_config_id.py @@ -3,7 +3,7 @@ from . import sz_configmanager try: - CONFIG_ID = sz_configmanager.get_default_config_id() - sz_config = sz_configmanager.create_config_from_config_id(CONFIG_ID) + config_id = sz_configmanager.get_default_config_id() + sz_config = sz_configmanager.create_config_from_config_id(config_id) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/create_config_from_string.py b/examples/szconfigmanager/create_config_from_string.py index d8ac7861..6f0fcfb7 100755 --- a/examples/szconfigmanager/create_config_from_string.py +++ b/examples/szconfigmanager/create_config_from_string.py @@ -5,7 +5,7 @@ from . import sz_configmanager try: - CONFIG_DEFINITION = json.dumps({}) - sz_config = sz_configmanager.create_config_from_string(CONFIG_DEFINITION) + config_definition = json.dumps({}) + sz_config = sz_configmanager.create_config_from_string(config_definition) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/get_configs.py b/examples/szconfigmanager/get_configs.py index 02e521d2..0f087354 100755 --- a/examples/szconfigmanager/get_configs.py +++ b/examples/szconfigmanager/get_configs.py @@ -3,7 +3,7 @@ from . import sz_configmanager try: - CONFIG_LIST = sz_configmanager.get_configs() - print(f"\n{CONFIG_LIST}\n") + config_list = sz_configmanager.get_configs() + print(f"\n{config_list}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/get_default_config_id.py b/examples/szconfigmanager/get_default_config_id.py index c5fe4e54..c05a2f53 100755 --- a/examples/szconfigmanager/get_default_config_id.py +++ b/examples/szconfigmanager/get_default_config_id.py @@ -3,7 +3,7 @@ from . import sz_configmanager try: - CONFIG_ID = sz_configmanager.get_default_config_id() - print(f"\n{CONFIG_ID}\n") + config_id = sz_configmanager.get_default_config_id() + print(f"\n{config_id}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/register_config.py b/examples/szconfigmanager/register_config.py index 8941fb0e..357b2f35 100755 --- a/examples/szconfigmanager/register_config.py +++ b/examples/szconfigmanager/register_config.py @@ -3,9 +3,9 @@ from . import sz_configmanager try: - CONFIG_COMMENT = "Just an empty example" + config_comment = "Just an empty example" sz_config = sz_configmanager.create_config_from_template() - CONFIG_DEFINITION = sz_config.export() - CONFIG_ID = sz_configmanager.register_config(CONFIG_DEFINITION, CONFIG_COMMENT) + config_definition = sz_config.export() + config_id = sz_configmanager.register_config(config_definition, config_comment) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/replace_default_config_id.py b/examples/szconfigmanager/replace_default_config_id.py index 0630f5f3..47c77dbc 100755 --- a/examples/szconfigmanager/replace_default_config_id.py +++ b/examples/szconfigmanager/replace_default_config_id.py @@ -4,24 +4,25 @@ from . import sz_configmanager +config_comment = "Just an example" +data_source_code = f"REPLACE_DEFAULT_CONFIG_ID_{time.time()}" + try: sz_config = sz_configmanager.create_config_from_template() - CURRENT_DEFAULT_CONFIG_ID = sz_configmanager.get_default_config_id() + current_default_config_id = sz_configmanager.get_default_config_id() # Create a new config. - sz_config = sz_configmanager.create_config_from_config_id(CURRENT_DEFAULT_CONFIG_ID) - data_source_code = f"REPLACE_DEFAULT_CONFIG_ID_{time.time()}" + sz_config = sz_configmanager.create_config_from_config_id(current_default_config_id) sz_config.add_data_source(data_source_code) # Persist the new config. - CONFIG_DEFINITION = sz_config.export() - CONFIG_COMMENT = "Just an example" - NEW_DEFAULT_CONFIG_ID = sz_configmanager.register_config(CONFIG_DEFINITION, CONFIG_COMMENT) + config_definition = sz_config.export() + new_default_config_id = sz_configmanager.register_config(config_definition, config_comment) # Replace default config id. - sz_configmanager.replace_default_config_id(CURRENT_DEFAULT_CONFIG_ID, NEW_DEFAULT_CONFIG_ID) + sz_configmanager.replace_default_config_id(current_default_config_id, new_default_config_id) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/set_default_config.py b/examples/szconfigmanager/set_default_config.py index c69912b6..88ee808f 100755 --- a/examples/szconfigmanager/set_default_config.py +++ b/examples/szconfigmanager/set_default_config.py @@ -4,19 +4,19 @@ from . import sz_configmanager +config_comment = "Just an example" +data_source_code = f"REPLACE_DEFAULT_CONFIG_ID_{time.time()}" + try: # Create a new config. sz_config = sz_configmanager.create_config_from_template() - data_source_code = f"REPLACE_DEFAULT_CONFIG_ID_{time.time()}" sz_config.add_data_source(data_source_code) # Persist the new default config. - CONFIG_DEFINITION = sz_config.export() - CONFIG_COMMENT = "Just an example" - CONFIG_ID = sz_configmanager.set_default_config(CONFIG_DEFINITION, CONFIG_COMMENT) - + config_definition = sz_config.export() + config_id = sz_configmanager.set_default_config(config_definition, config_comment) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/set_default_config_id.py b/examples/szconfigmanager/set_default_config_id.py index 224ffabf..99b328fe 100755 --- a/examples/szconfigmanager/set_default_config_id.py +++ b/examples/szconfigmanager/set_default_config_id.py @@ -4,23 +4,23 @@ from . import sz_configmanager +config_comment = "Just an example" +data_source_code = f"REPLACE_DEFAULT_CONFIG_ID_{time.time()}" + try: # Create a new config. sz_config = sz_configmanager.create_config_from_template() - data_source_code = f"REPLACE_DEFAULT_CONFIG_ID_{time.time()}" sz_config.add_data_source(data_source_code) # Persist the new config. - CONFIG_DEFINITION = sz_config.export() - CONFIG_COMMENT = "Just an example" - NEW_DEFAULT_CONFIG_ID = sz_configmanager.register_config(CONFIG_DEFINITION, CONFIG_COMMENT) + config_definition = sz_config.export() + new_default_config_id = sz_configmanager.register_config(config_definition, config_comment) # Set default config id. - sz_configmanager.set_default_config_id(NEW_DEFAULT_CONFIG_ID) - + sz_configmanager.set_default_config_id(new_default_config_id) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szdiagnostic/check_datastore_performance.py b/examples/szdiagnostic/check_datastore_performance.py index 4b915c03..b7cd8c84 100755 --- a/examples/szdiagnostic/check_datastore_performance.py +++ b/examples/szdiagnostic/check_datastore_performance.py @@ -2,9 +2,10 @@ from . import sz_diagnostic +seconds_to_run = 3 + try: - SECONDS_TO_RUN = 3 - result = sz_diagnostic.check_datastore_performance(SECONDS_TO_RUN) + result = sz_diagnostic.check_datastore_performance(seconds_to_run) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/add_record.py b/examples/szengine/add_record.py index 96c6490b..4142f773 100755 --- a/examples/szengine/add_record.py +++ b/examples/szengine/add_record.py @@ -4,27 +4,28 @@ from . import sz_engine +data_source_code = "TEST" +flags = SzEngineFlags.SZ_WITH_INFO +record_definition = json.dumps( + { + "RECORD_TYPE": "PERSON", + "PRIMARY_NAME_LAST": "Smith", + "PRIMARY_NAME_FIRST": "Robert", + "DATE_OF_BIRTH": "12/11/1978", + "ADDR_TYPE": "MAILING", + "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132", + "PHONE_TYPE": "HOME", + "PHONE_NUMBER": "702-919-1300", + "EMAIL_ADDRESS": "bsmith@work.com", + "DATE": "1/2/18", + "STATUS": "Active", + "AMOUNT": "100", + } +) +record_id = "1" + try: - DATA_SOURCE_CODE = "TEST" - flags = SzEngineFlags.SZ_WITH_INFO - record_definition = json.dumps( - { - "RECORD_TYPE": "PERSON", - "PRIMARY_NAME_LAST": "Smith", - "PRIMARY_NAME_FIRST": "Robert", - "DATE_OF_BIRTH": "12/11/1978", - "ADDR_TYPE": "MAILING", - "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132", - "PHONE_TYPE": "HOME", - "PHONE_NUMBER": "702-919-1300", - "EMAIL_ADDRESS": "bsmith@work.com", - "DATE": "1/2/18", - "STATUS": "Active", - "AMOUNT": "100", - } - ) - RECORD_ID = "1" - result = sz_engine.add_record(DATA_SOURCE_CODE, RECORD_ID, record_definition, flags) + result = sz_engine.add_record(data_source_code, record_id, record_definition, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/delete_record.py b/examples/szengine/delete_record.py index c0e429cf..cf8eceb3 100755 --- a/examples/szengine/delete_record.py +++ b/examples/szengine/delete_record.py @@ -2,11 +2,12 @@ from . import sz_engine +data_source_code = "TEST" +flags = SzEngineFlags.SZ_WITH_INFO +record_id = "1" + try: - DATA_SOURCE_CODE = "TEST" - flags = SzEngineFlags.SZ_WITH_INFO - RECORD_ID = "1" - result = sz_engine.delete_record(DATA_SOURCE_CODE, RECORD_ID, flags) + result = sz_engine.delete_record(data_source_code, record_id, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/export_csv_fetch_close.py b/examples/szengine/export_csv_fetch_close.py index aff8bfa8..7421acae 100755 --- a/examples/szengine/export_csv_fetch_close.py +++ b/examples/szengine/export_csv_fetch_close.py @@ -2,17 +2,18 @@ from . import sz_engine +csv_column_list = ( + "RESOLVED_ENTITY_ID,RELATED_ENTITY_ID,RESOLVED_ENTITY_NAME,MATCH_LEVEL,MATCH_KEY,DATA_SOURCE,RECORD_ID" +) +flags = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS + try: - CSV_COLUMN_LIST = ( - "RESOLVED_ENTITY_ID,RELATED_ENTITY_ID,RESOLVED_ENTITY_NAME,MATCH_LEVEL,MATCH_KEY,DATA_SOURCE,RECORD_ID" - ) - flags = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS - EXPORT_HANDLE = sz_engine.export_csv_entity_report(CSV_COLUMN_LIST, flags) + export_handle = sz_engine.export_csv_entity_report(csv_column_list, flags) while True: - FRAGMENT = sz_engine.fetch_next(EXPORT_HANDLE) - if not FRAGMENT: + fragment = sz_engine.fetch_next(export_handle) + if not fragment: break - print(FRAGMENT, end="") - sz_engine.close_export(EXPORT_HANDLE) + print(fragment, end="") + sz_engine.close_export(export_handle) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/export_json_fetch_close.py b/examples/szengine/export_json_fetch_close.py index b8b01e8b..1086efca 100755 --- a/examples/szengine/export_json_fetch_close.py +++ b/examples/szengine/export_json_fetch_close.py @@ -2,14 +2,15 @@ from . import sz_engine +flags = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS + try: - flags = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS - EXPORT_HANDLE = sz_engine.export_json_entity_report(flags) + export_handle = sz_engine.export_json_entity_report(flags) while True: - FRAGMENT = sz_engine.fetch_next(EXPORT_HANDLE) - if not FRAGMENT: + fragment = sz_engine.fetch_next(export_handle) + if not fragment: break - print(FRAGMENT, end="") - sz_engine.close_export(EXPORT_HANDLE) + print(fragment, end="") + sz_engine.close_export(export_handle) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/find_network_by_entity_id.py b/examples/szengine/find_network_by_entity_id.py index 8d9227cb..0d969d0c 100755 --- a/examples/szengine/find_network_by_entity_id.py +++ b/examples/szengine/find_network_by_entity_id.py @@ -2,13 +2,14 @@ from . import sz_engine +build_out_degrees = 1 +entity_list = [1, 4] +flags = SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS +max_degrees = 2 +max_entities = 10 + try: - BUILD_OUT_DEGREES = 1 - entity_list = [1, 4] - flags = SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS - MAX_DEGREES = 2 - MAX_ENTITIES = 10 - result = sz_engine.find_network_by_entity_id(entity_list, MAX_DEGREES, BUILD_OUT_DEGREES, MAX_ENTITIES, flags) + result = sz_engine.find_network_by_entity_id(entity_list, max_degrees, build_out_degrees, max_entities, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/find_network_by_record_id.py b/examples/szengine/find_network_by_record_id.py index 24621a56..543d6c2b 100755 --- a/examples/szengine/find_network_by_record_id.py +++ b/examples/szengine/find_network_by_record_id.py @@ -2,13 +2,14 @@ from . import sz_engine +build_out_degrees = 1 +flags = SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS +max_degrees = 2 +max_entities = 10 +record_list = [("CUSTOMERS", "1001"), ("CUSTOMERS", "1009")] + try: - BUILD_OUT_DEGREES = 1 - flags = SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS - MAX_DEGREES = 2 - MAX_ENTITIES = 10 - record_list = [("CUSTOMERS", "1001"), ("CUSTOMERS", "1009")] - result = sz_engine.find_network_by_record_id(record_list, MAX_DEGREES, BUILD_OUT_DEGREES, MAX_ENTITIES, flags) + result = sz_engine.find_network_by_record_id(record_list, max_degrees, build_out_degrees, max_entities, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/find_path_by_entity_id.py b/examples/szengine/find_path_by_entity_id.py index 0167c339..64ce5e6e 100755 --- a/examples/szengine/find_path_by_entity_id.py +++ b/examples/szengine/find_path_by_entity_id.py @@ -4,17 +4,18 @@ from . import sz_engine +avoid_entity_ids: List[int] = [] +end_entity_id = 4 +flags = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS +max_degrees = 2 +required_data_sources: List[str] = [] +start_entity_id = 1 + try: - avoid_entity_ids: List[int] = [] - END_ENTITY_ID = 4 - flags = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS - MAX_DEGREES = 2 - required_data_sources: List[str] = [] - START_ENTITY_ID = 1 result = sz_engine.find_path_by_entity_id( - START_ENTITY_ID, - END_ENTITY_ID, - MAX_DEGREES, + start_entity_id, + end_entity_id, + max_degrees, avoid_entity_ids, required_data_sources, flags, diff --git a/examples/szengine/find_path_by_record_id.py b/examples/szengine/find_path_by_record_id.py index 4b4b9581..2796dadc 100755 --- a/examples/szengine/find_path_by_record_id.py +++ b/examples/szengine/find_path_by_record_id.py @@ -4,21 +4,22 @@ from . import sz_engine +avoid_record_keys: List[Tuple[str, str]] = [] +end_data_source_code = "CUSTOMERS" +end_record_id = "1009" +flags = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS +max_degrees = 2 +required_data_sources: List[str] = [] +start_data_source_code = "CUSTOMERS" +start_record_id = "1001" + try: - avoid_record_keys: List[Tuple[str, str]] = [] - END_DATA_SOURCE_CODE = "CUSTOMERS" - END_RECORD_ID = "1009" - flags = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS - MAX_DEGREES = 2 - required_data_sources: List[str] = [] - START_DATA_SOURCE_CODE = "CUSTOMERS" - START_RECORD_ID = "1001" result = sz_engine.find_path_by_record_id( - START_DATA_SOURCE_CODE, - START_RECORD_ID, - END_DATA_SOURCE_CODE, - END_RECORD_ID, - MAX_DEGREES, + start_data_source_code, + start_record_id, + end_data_source_code, + end_record_id, + max_degrees, avoid_record_keys, required_data_sources, flags, diff --git a/examples/szengine/get_entity_by_entity_id.py b/examples/szengine/get_entity_by_entity_id.py index 5cd96f9b..170fbe0f 100755 --- a/examples/szengine/get_entity_by_entity_id.py +++ b/examples/szengine/get_entity_by_entity_id.py @@ -2,10 +2,11 @@ from . import sz_engine +entity_id = 1 +flags = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS + try: - ENTITY_ID = 1 - flags = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS - result = sz_engine.get_entity_by_entity_id(ENTITY_ID, flags) + result = sz_engine.get_entity_by_entity_id(entity_id, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/get_entity_by_record_id.py b/examples/szengine/get_entity_by_record_id.py index c71c5fce..fb0867bc 100755 --- a/examples/szengine/get_entity_by_record_id.py +++ b/examples/szengine/get_entity_by_record_id.py @@ -2,11 +2,12 @@ from . import sz_engine +data_source_code = "CUSTOMERS" +flags = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS +record_id = "1001" + try: - DATA_SOURCE_CODE = "CUSTOMERS" - flags = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS - RECORD_ID = "1001" - result = sz_engine.get_entity_by_record_id(DATA_SOURCE_CODE, RECORD_ID, flags) + result = sz_engine.get_entity_by_record_id(data_source_code, record_id, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/get_record.py b/examples/szengine/get_record.py index 48378a9a..4398d54f 100755 --- a/examples/szengine/get_record.py +++ b/examples/szengine/get_record.py @@ -2,11 +2,12 @@ from . import sz_engine +data_source_code = "CUSTOMERS" +flags = SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS +record_id = "1001" + try: - DATA_SOURCE_CODE = "CUSTOMERS" - flags = SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS - RECORD_ID = "1001" - result = sz_engine.get_record(DATA_SOURCE_CODE, RECORD_ID, flags) + result = sz_engine.get_record(data_source_code, record_id, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/get_virtual_entity_by_record_id.py b/examples/szengine/get_virtual_entity_by_record_id.py index 9b5a760c..d8bfe329 100755 --- a/examples/szengine/get_virtual_entity_by_record_id.py +++ b/examples/szengine/get_virtual_entity_by_record_id.py @@ -2,12 +2,13 @@ from . import sz_engine +flags = SzEngineFlags.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS +record_list = [ + ("CUSTOMERS", "1001"), + ("CUSTOMERS", "1002"), +] + try: - flags = SzEngineFlags.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS - record_list = [ - ("CUSTOMERS", "1001"), - ("CUSTOMERS", "1002"), - ] result = sz_engine.get_virtual_entity_by_record_id(record_list, flags) print(f"\n{result}\n") except SzError as err: diff --git a/examples/szengine/how_entity_by_entity_id.py b/examples/szengine/how_entity_by_entity_id.py index 0fe2727c..27cd27e9 100755 --- a/examples/szengine/how_entity_by_entity_id.py +++ b/examples/szengine/how_entity_by_entity_id.py @@ -2,10 +2,11 @@ from . import sz_engine +entity_id = 1 +flags = SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS + try: - ENTITY_ID = 1 - flags = SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS - result = sz_engine.how_entity_by_entity_id(ENTITY_ID, flags) + result = sz_engine.how_entity_by_entity_id(entity_id, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/preprocess_record.py b/examples/szengine/preprocess_record.py index 4bdb624c..18430ca9 100755 --- a/examples/szengine/preprocess_record.py +++ b/examples/szengine/preprocess_record.py @@ -4,24 +4,25 @@ from . import sz_engine +flags = SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS +record_definition = json.dumps( + { + "RECORD_TYPE": "PERSON", + "PRIMARY_NAME_LAST": "Smith", + "PRIMARY_NAME_FIRST": "Robert", + "DATE_OF_BIRTH": "12/11/1978", + "ADDR_TYPE": "MAILING", + "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132", + "PHONE_TYPE": "HOME", + "PHONE_NUMBER": "702-919-1300", + "EMAIL_ADDRESS": "bsmith@work.com", + "DATE": "1/2/18", + "STATUS": "Active", + "AMOUNT": "100", + } +) + try: - flags = SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS - record_definition = json.dumps( - { - "RECORD_TYPE": "PERSON", - "PRIMARY_NAME_LAST": "Smith", - "PRIMARY_NAME_FIRST": "Robert", - "DATE_OF_BIRTH": "12/11/1978", - "ADDR_TYPE": "MAILING", - "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132", - "PHONE_TYPE": "HOME", - "PHONE_NUMBER": "702-919-1300", - "EMAIL_ADDRESS": "bsmith@work.com", - "DATE": "1/2/18", - "STATUS": "Active", - "AMOUNT": "100", - } - ) result = sz_engine.preprocess_record(record_definition, flags) print(f"\n{result}\n") except SzError as err: diff --git a/examples/szengine/process_redo_record.py b/examples/szengine/process_redo_record.py index f21df2b3..1f3ef3eb 100755 --- a/examples/szengine/process_redo_record.py +++ b/examples/szengine/process_redo_record.py @@ -2,13 +2,14 @@ from . import sz_engine +flags = SzEngineFlags.SZ_WITH_INFO + try: - flags = SzEngineFlags.SZ_WITH_INFO while True: - REDO_RECORD = sz_engine.get_redo_record() - if not REDO_RECORD: + redo_record = sz_engine.get_redo_record() + if not redo_record: break - result = sz_engine.process_redo_record(REDO_RECORD, flags) + result = sz_engine.process_redo_record(redo_record, flags) print(result) except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/reevaluate_entity.py b/examples/szengine/reevaluate_entity.py index d2f6638f..4a3de120 100755 --- a/examples/szengine/reevaluate_entity.py +++ b/examples/szengine/reevaluate_entity.py @@ -2,10 +2,11 @@ from . import sz_engine +entity_id = 1 +flags = SzEngineFlags.SZ_WITH_INFO + try: - ENTITY_ID = 1 - flags = SzEngineFlags.SZ_WITH_INFO - result = sz_engine.reevaluate_entity(ENTITY_ID, flags) + result = sz_engine.reevaluate_entity(entity_id, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/reevaluate_record.py b/examples/szengine/reevaluate_record.py index 8a0cbeeb..2e9445b4 100755 --- a/examples/szengine/reevaluate_record.py +++ b/examples/szengine/reevaluate_record.py @@ -2,11 +2,12 @@ from . import sz_engine +data_source_code = "CUSTOMERS" +flags = SzEngineFlags.SZ_WITH_INFO +record_id = "1001" + try: - DATA_SOURCE_CODE = "CUSTOMERS" - flags = SzEngineFlags.SZ_WITH_INFO - RECORD_ID = "1001" - result = sz_engine.reevaluate_record(DATA_SOURCE_CODE, RECORD_ID, flags) + result = sz_engine.reevaluate_record(data_source_code, record_id, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/search_by_attributes.py b/examples/szengine/search_by_attributes.py index 80cb9bd3..7611247b 100755 --- a/examples/szengine/search_by_attributes.py +++ b/examples/szengine/search_by_attributes.py @@ -4,11 +4,11 @@ from . import sz_engine +attributes = json.dumps({"NAME_FULL": "Bob Smith", "EMAIL_ADDRESS": "bsmith@work.com"}) +flags = SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS + try: - attributes = json.dumps({"NAME_FULL": "BOB SMITH", "EMAIL_ADDRESS": "bsmith@work.com"}) - flags = SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS - SEARCH_PROFILE = "" - result = sz_engine.search_by_attributes(attributes, flags, SEARCH_PROFILE) + result = sz_engine.search_by_attributes(attributes, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/examples/szengine/why_entities.py b/examples/szengine/why_entities.py index 2b297c32..25c968f7 100755 --- a/examples/szengine/why_entities.py +++ b/examples/szengine/why_entities.py @@ -2,13 +2,14 @@ from . import sz_engine +entity_id_1 = 1 +entity_id_2 = 4 +flags = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS + try: - ENTITY_ID_1 = 1 - ENTITY_ID_2 = 4 - flags = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS result = sz_engine.why_entities( - ENTITY_ID_1, - ENTITY_ID_2, + entity_id_1, + entity_id_2, flags, ) print(f"\n{result}\n") diff --git a/examples/szengine/why_record_in_entity.py b/examples/szengine/why_record_in_entity.py index bc8b3895..95f8a159 100755 --- a/examples/szengine/why_record_in_entity.py +++ b/examples/szengine/why_record_in_entity.py @@ -2,13 +2,14 @@ from . import sz_engine +data_source_code = "CUSTOMERS" +flags = SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS +record_id = "1001" + try: - DATA_SOURCE_CODE = "CUSTOMERS" - flags = SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS - RECORD_ID = "1001" result = sz_engine.why_record_in_entity( - DATA_SOURCE_CODE, - RECORD_ID, + data_source_code, + record_id, flags, ) print(f"\n{result}\n") diff --git a/examples/szengine/why_records.py b/examples/szengine/why_records.py index 0dd974ec..0c9ff055 100755 --- a/examples/szengine/why_records.py +++ b/examples/szengine/why_records.py @@ -2,17 +2,18 @@ from . import sz_engine +data_source_code_1 = "CUSTOMERS" +data_source_code_2 = "CUSTOMERS" +flags = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS +record_id_1 = "1001" +record_id_2 = "1002" + try: - DATA_SOURCE_CODE_1 = "CUSTOMERS" - DATA_SOURCE_CODE_2 = "CUSTOMERS" - flags = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS - RECORD_ID_1 = "1001" - RECORD_ID_2 = "1002" result = sz_engine.why_records( - DATA_SOURCE_CODE_1, - RECORD_ID_1, - DATA_SOURCE_CODE_2, - RECORD_ID_2, + data_source_code_1, + record_id_1, + data_source_code_2, + record_id_2, flags, ) print(f"\n{result}\n") diff --git a/examples/szengine/why_search.py b/examples/szengine/why_search.py index 6b8cd210..55a280c2 100755 --- a/examples/szengine/why_search.py +++ b/examples/szengine/why_search.py @@ -4,12 +4,12 @@ from . import sz_engine +attributes = json.dumps({"NAME_FULL": "BOB SMITH", "EMAIL_ADDRESS": "bsmith@work.com"}) +entity_id = 1 +flags = SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS + try: - attributes = json.dumps({"NAME_FULL": "BOB SMITH", "EMAIL_ADDRESS": "bsmith@work.com"}) - ENTITY_ID = 1 - flags = SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS - SEARCH_PROFILE = "SEARCH" - result = sz_engine.why_search(attributes, ENTITY_ID, flags, SEARCH_PROFILE) + result = sz_engine.why_search(attributes, entity_id, flags) print(f"\n{result}\n") except SzError as err: print(f"\nERROR: {err}\n") diff --git a/pyproject.toml b/pyproject.toml index b1b5e2c2..3c302c6e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -54,7 +54,9 @@ ignore = [ notes = [ "FIXME" ] -# NOTE Paths are regular expressions +# NOTE - Ignore invalid-name only in examples for simplified code without pylint complaining variables in global scope +# aren't uppercase. +# NOTE - Paths are regular expressions per-file-ignores = """ /examples/:invalid-name """ \ No newline at end of file diff --git a/setup.cfg b/setup.cfg index b11f5c87..4bb68a9c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = senzing -version = 0.2.7 +version = 0.2.8 author = senzing author_email = support@senzing.com description = Python SDK method definitions