From 99bd47ecda9a8f7cbf0a8bc459e266bd800407f1 Mon Sep 17 00:00:00 2001 From: Ant Date: Fri, 17 Jan 2025 13:56:09 -0500 Subject: [PATCH] #153 - Test workflow --- .../create-sphinx-documentation.yaml | 3 +-- .github/workflows/pytest-linux.yaml | 13 ----------- Makefile | 23 ++++++++++++++++++- documentation-requirements.txt | 9 ++++++++ .../extras/abstract_factory_parameters.py | 2 +- examples/extras/using_abstract_1.py | 2 +- examples/extras/using_abstract_2.py | 4 ++-- examples/misc/add_truthset_data.py | 2 +- examples/misc/add_truthset_datasources.py | 2 +- examples/misc/individual_classes.py | 2 +- examples/szabstractfactory/create_config.py | 2 +- .../szabstractfactory/create_configmanager.py | 2 +- .../szabstractfactory/create_diagnostic.py | 2 +- examples/szabstractfactory/create_engine.py | 2 +- examples/szabstractfactory/create_product.py | 2 +- .../initialize_with_config_id.py | 2 +- .../initialize_with_debug.py | 2 +- examples/szabstractfactory/reinitialize.py | 2 +- examples/szconfig/add_data_source.py | 2 +- examples/szconfig/create_and_close.py | 2 +- .../szconfig/create_export_import_close.py | 2 +- examples/szconfig/delete_data_source.py | 2 +- examples/szconfig/export_config.py | 2 +- examples/szconfig/get_data_sources.py | 2 +- examples/szconfig/import_config.py | 2 +- examples/szconfig/szconfig_constructor.py | 2 +- examples/szconfigmanager/add_config.py | 2 +- examples/szconfigmanager/get_config.py | 2 +- examples/szconfigmanager/get_configs.py | 2 +- .../szconfigmanager/get_default_config_id.py | 2 +- .../replace_default_config_id.py | 2 +- .../szconfigmanager/set_default_config_id.py | 2 +- .../szconfigmanager_constructor.py | 2 +- .../check_datastore_performance.py | 2 +- examples/szdiagnostic/get_datastore_info.py | 2 +- examples/szdiagnostic/get_feature.py | 2 +- examples/szdiagnostic/purge_repository.py | 2 +- .../szdiagnostic/szdiagnostic_constructor.py | 2 +- examples/szengine/add_record.py | 2 +- examples/szengine/count_redo_records.py | 2 +- examples/szengine/delete_record.py | 2 +- examples/szengine/export_csv_fetch_close.py | 2 +- examples/szengine/export_json_fetch_close.py | 2 +- .../szengine/find_network_by_entity_id.py | 2 +- .../szengine/find_network_by_record_id.py | 2 +- examples/szengine/find_path_by_entity_id.py | 2 +- examples/szengine/find_path_by_record_id.py | 2 +- examples/szengine/get_active_config_id.py | 2 +- examples/szengine/get_entity_by_entity_id.py | 2 +- examples/szengine/get_entity_by_record_id.py | 2 +- examples/szengine/get_record.py | 2 +- examples/szengine/get_redo_record.py | 2 +- examples/szengine/get_stats.py | 2 +- .../get_virtual_entity_by_record_id.py | 2 +- examples/szengine/how_entity_by_entity_id.py | 2 +- examples/szengine/preprocess_record.py | 2 +- examples/szengine/prime_engine.py | 2 +- examples/szengine/process_redo_record.py | 2 +- examples/szengine/reevaluate_entity.py | 2 +- examples/szengine/reevaluate_record.py | 2 +- examples/szengine/search_by_attributes.py | 2 +- examples/szengine/szengine_constructor.py | 2 +- examples/szengine/why_entities.py | 2 +- examples/szengine/why_record_in_entity.py | 2 +- examples/szengine/why_records.py | 2 +- examples/szproduct/get_license.py | 2 +- examples/szproduct/get_version.py | 2 +- examples/szproduct/szproduct_constructor.py | 2 +- makefiles/linux.mk | 3 +++ src/senzing_core/szabstractfactory.py | 2 +- src/senzing_core/szconfig.py | 2 +- src/senzing_core/szconfigmanager.py | 2 +- src/senzing_core/szdiagnostic.py | 2 +- src/senzing_core/szengine.py | 2 +- src/senzing_core/szproduct.py | 2 +- 75 files changed, 106 insertions(+), 87 deletions(-) create mode 100644 documentation-requirements.txt diff --git a/.github/workflows/create-sphinx-documentation.yaml b/.github/workflows/create-sphinx-documentation.yaml index 852447d2..a9f822bb 100644 --- a/.github/workflows/create-sphinx-documentation.yaml +++ b/.github/workflows/create-sphinx-documentation.yaml @@ -13,7 +13,6 @@ on: [push] permissions: contents: write -# TODO - testing with adding senzing to install dependencies jobs: docs: runs-on: ubuntu-latest @@ -34,7 +33,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - python -m pip install senzing==0.2.1 sphinx sphinx_rtd_theme myst_parser autodocsumm sphinx-toolbox sphinxext-remoteliteralinclude + python -m pip install documentation-requirements.txt - name: Sphinx build run: | diff --git a/.github/workflows/pytest-linux.yaml b/.github/workflows/pytest-linux.yaml index a260cff8..0a7fce89 100644 --- a/.github/workflows/pytest-linux.yaml +++ b/.github/workflows/pytest-linux.yaml @@ -66,19 +66,6 @@ jobs: source ./venv/bin/activate pytest tests/ --verbose --capture=no --cov=src --cov-append - # TODO - # - name: Run unittest on examples - # run: | - # source ./venv/bin/activate - # python3 -m unittest \ - # examples/szconfig/*.py \ - # examples/szconfigmanager/*.py \ - # examples/szdiagnostic/*.py \ - # examples/szengine/*.py \ - # examples/szproduct/*.py \ - # examples/misc/*.py \ - # || true - # Use pytest to check examples, there are no "test" classes/functions, pytest imports # the .py files. If there is a Python error in the examples, an exit code of 1 # is returned. If there are no Python errors but pytest didn't think it found any diff --git a/Makefile b/Makefile index 4f4f96da..d058275c 100755 --- a/Makefile +++ b/Makefile @@ -4,6 +4,11 @@ include makefiles/osdetect.mk +# Define newline for use +define \n + +endef + # ----------------------------------------------------------------------------- # Variables # ----------------------------------------------------------------------------- @@ -60,13 +65,18 @@ hello-world: hello-world-osarch-specific .PHONY: venv venv: venv-osarch-specific -# TODO Add for docs .PHONY: dependencies-for-development dependencies-for-development: venv dependencies-for-development-osarch-specific $(activate-venv); \ python3 -m pip install --upgrade pip; \ python3 -m pip install --requirement development-requirements.txt +.PHONY: dependencies-for-documentation +dependencies-for-documentation: venv dependencies-for-documentation-osarch-specific + $(activate-venv); \ + python3 -m pip install --upgrade pip; \ + python3 -m pip install --requirement documentation-requirements.txt + .PHONY: dependencies dependencies: venv @@ -171,63 +181,74 @@ print-make-variables: .PHONY: bandit bandit: + $(info ${\n}) $(info --- bandit ---------------------------------------------------------------------) @$(activate-venv); bandit -c pyproject.toml $(shell git ls-files '*.py' ':!:docs/source/*') .PHONY: black black: + $(info ${\n}) $(info --- black ----------------------------------------------------------------------) @$(activate-venv); black $(shell git ls-files '*.py' ':!:docs/source/*') .PHONY: flake8 flake8: + $(info ${\n}) $(info --- flake8 ---------------------------------------------------------------------) @$(activate-venv); flake8 $(shell git ls-files '*.py' ':!:docs/source/*') .PHONY: isort isort: + $(info ${\n}) $(info --- isort ----------------------------------------------------------------------) @$(activate-venv); isort $(shell git ls-files '*.py' ':!:docs/source/*') .PHONY: mypy mypy: + $(info ${\n}) $(info --- mypy -----------------------------------------------------------------------) @$(activate-venv); mypy --strict $(shell git ls-files '*.py' ':!:docs/source/*') .PHONY: pydoc pydoc: + $(info ${\n}) $(info --- pydoc ----------------------------------------------------------------------) @$(activate-venv); python3 -m pydoc .PHONY: pydoc-web pydoc-web: + $(info ${\n}) $(info --- pydoc-web ------------------------------------------------------------------) @$(activate-venv); python3 -m pydoc -p 8885 .PHONY: pylint pylint: + $(info ${\n}) $(info --- pylint ---------------------------------------------------------------------) @$(activate-venv); pylint $(shell git ls-files '*.py' ':!:docs/source/*') .PHONY: pytest pytest: + $(info ${\n}) $(info --- pytest ---------------------------------------------------------------------) @$(activate-venv); pytest $(shell git ls-files '*.py' ':!:docs/source/*') .PHONY: sphinx sphinx: sphinx-osarch-specific + $(info ${\n}) $(info --- sphinx ---------------------------------------------------------------------) .PHONY: view-sphinx view-sphinx: view-sphinx-osarch-specific + $(info ${\n}) $(info --- view-sphinx ----------------------------------------------------------------) diff --git a/documentation-requirements.txt b/documentation-requirements.txt new file mode 100644 index 00000000..b41fd0fc --- /dev/null +++ b/documentation-requirements.txt @@ -0,0 +1,9 @@ +autodocsumm==0.2.14 +myst_parser==4.0.0 +senzing==0.2.1 +sphinx-autodoc-typehints==3.0.0 +sphinx-prompt==1.9.0 +sphinxext-remoteliteralinclude==0.5.0 +sphinx-rtd-theme==3.0.2 +sphinx-toolbox==3.8.0 +sphinx==8.1.3 \ No newline at end of file diff --git a/examples/extras/abstract_factory_parameters.py b/examples/extras/abstract_factory_parameters.py index e7aa1100..8aff6102 100755 --- a/examples/extras/abstract_factory_parameters.py +++ b/examples/extras/abstract_factory_parameters.py @@ -18,4 +18,4 @@ try: sz_abstract_factory = SzAbstractFactoryCore(**FACTORY_PARAMETERS) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/extras/using_abstract_1.py b/examples/extras/using_abstract_1.py index 8704edab..1e121208 100755 --- a/examples/extras/using_abstract_1.py +++ b/examples/extras/using_abstract_1.py @@ -20,4 +20,4 @@ sz_abstract_factory = SzAbstractFactoryCore(**FACTORY_PARAMETERS) try_using_abstract(sz_abstract_factory) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/extras/using_abstract_2.py b/examples/extras/using_abstract_2.py index b9c36fd6..c12a3fad 100755 --- a/examples/extras/using_abstract_2.py +++ b/examples/extras/using_abstract_2.py @@ -13,7 +13,7 @@ def get_stats(sz_engine: SzEngine) -> None: stats = sz_engine.get_stats() print(f"Stats: {stats}") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") def try_using_abstract(sz_abstract_factory: SzAbstractFactoryCore) -> None: @@ -25,4 +25,4 @@ def try_using_abstract(sz_abstract_factory: SzAbstractFactoryCore) -> None: sz_engine = sz_abstract_factory.create_engine() get_stats(sz_engine) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/misc/add_truthset_data.py b/examples/misc/add_truthset_data.py index aee8875e..7fdb7edc 100755 --- a/examples/misc/add_truthset_data.py +++ b/examples/misc/add_truthset_data.py @@ -36,4 +36,4 @@ SZ_WITHOUT_INFO, ) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/misc/add_truthset_datasources.py b/examples/misc/add_truthset_datasources.py index c10e87e1..bbb9bdd2 100755 --- a/examples/misc/add_truthset_datasources.py +++ b/examples/misc/add_truthset_datasources.py @@ -32,4 +32,4 @@ 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") + print(f"\nERROR: {err}\n") diff --git a/examples/misc/individual_classes.py b/examples/misc/individual_classes.py index c0e83688..4522787c 100755 --- a/examples/misc/individual_classes.py +++ b/examples/misc/individual_classes.py @@ -69,4 +69,4 @@ def try_sz_product(sz_product_local: SzProduct) -> None: try_sz_product(sz_product) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szabstractfactory/create_config.py b/examples/szabstractfactory/create_config.py index 783242c0..a9aaf10b 100755 --- a/examples/szabstractfactory/create_config.py +++ b/examples/szabstractfactory/create_config.py @@ -18,4 +18,4 @@ sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS) sz_config = sz_abstract_factory.create_config() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szabstractfactory/create_configmanager.py b/examples/szabstractfactory/create_configmanager.py index 3a01ec0d..b12f9bdb 100755 --- a/examples/szabstractfactory/create_configmanager.py +++ b/examples/szabstractfactory/create_configmanager.py @@ -18,4 +18,4 @@ sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS) sz_configmanager = sz_abstract_factory.create_configmanager() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szabstractfactory/create_diagnostic.py b/examples/szabstractfactory/create_diagnostic.py index c39b63fa..6bb3e565 100755 --- a/examples/szabstractfactory/create_diagnostic.py +++ b/examples/szabstractfactory/create_diagnostic.py @@ -18,4 +18,4 @@ sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS) sz_diagnostic = sz_abstract_factory.create_diagnostic() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szabstractfactory/create_engine.py b/examples/szabstractfactory/create_engine.py index 00399e8c..d90a6c41 100755 --- a/examples/szabstractfactory/create_engine.py +++ b/examples/szabstractfactory/create_engine.py @@ -18,4 +18,4 @@ sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS) sz_engine = sz_abstract_factory.create_engine() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szabstractfactory/create_product.py b/examples/szabstractfactory/create_product.py index e854a9b3..43506d90 100755 --- a/examples/szabstractfactory/create_product.py +++ b/examples/szabstractfactory/create_product.py @@ -18,4 +18,4 @@ sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS) sz_product = sz_abstract_factory.create_product() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szabstractfactory/initialize_with_config_id.py b/examples/szabstractfactory/initialize_with_config_id.py index b80a01bc..806abcdd 100755 --- a/examples/szabstractfactory/initialize_with_config_id.py +++ b/examples/szabstractfactory/initialize_with_config_id.py @@ -19,4 +19,4 @@ try: sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS, CONFIG_ID) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szabstractfactory/initialize_with_debug.py b/examples/szabstractfactory/initialize_with_debug.py index dccbc697..3504745c 100755 --- a/examples/szabstractfactory/initialize_with_debug.py +++ b/examples/szabstractfactory/initialize_with_debug.py @@ -19,4 +19,4 @@ # Create an engine to show debug output sz_abstract_factory.create_engine() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szabstractfactory/reinitialize.py b/examples/szabstractfactory/reinitialize.py index 8bf81a3f..fba2d263 100755 --- a/examples/szabstractfactory/reinitialize.py +++ b/examples/szabstractfactory/reinitialize.py @@ -21,4 +21,4 @@ config_id = sz_engine.get_active_config_id() sz_abstract_factory.reinitialize(config_id) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfig/add_data_source.py b/examples/szconfig/add_data_source.py index 163d16fb..3bfdf68a 100755 --- a/examples/szconfig/add_data_source.py +++ b/examples/szconfig/add_data_source.py @@ -23,4 +23,4 @@ sz_config.close_config(config_handle) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfig/create_and_close.py b/examples/szconfig/create_and_close.py index 2f2d2064..c053114a 100755 --- a/examples/szconfig/create_and_close.py +++ b/examples/szconfig/create_and_close.py @@ -23,4 +23,4 @@ sz_config.close_config(config_handle) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfig/create_export_import_close.py b/examples/szconfig/create_export_import_close.py index ab690180..992b801c 100755 --- a/examples/szconfig/create_export_import_close.py +++ b/examples/szconfig/create_export_import_close.py @@ -23,4 +23,4 @@ sz_config.close_config(config_handle_1) sz_config.close_config(config_handle_2) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfig/delete_data_source.py b/examples/szconfig/delete_data_source.py index 038c193a..f11bac58 100755 --- a/examples/szconfig/delete_data_source.py +++ b/examples/szconfig/delete_data_source.py @@ -22,4 +22,4 @@ sz_config.delete_data_source(config_handle, DATA_SOURCE_CODE) sz_config.close_config(config_handle) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfig/export_config.py b/examples/szconfig/export_config.py index 3fa1f57f..10d7d9e7 100755 --- a/examples/szconfig/export_config.py +++ b/examples/szconfig/export_config.py @@ -22,4 +22,4 @@ sz_config.close_config(config_handle) print(f"\n{CONFIG_DEFINITION}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfig/get_data_sources.py b/examples/szconfig/get_data_sources.py index 33dd1d2f..33694439 100755 --- a/examples/szconfig/get_data_sources.py +++ b/examples/szconfig/get_data_sources.py @@ -22,4 +22,4 @@ sz_config.close_config(config_handle) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfig/import_config.py b/examples/szconfig/import_config.py index c8663c3a..13ef768b 100755 --- a/examples/szconfig/import_config.py +++ b/examples/szconfig/import_config.py @@ -22,4 +22,4 @@ CONFIG_DEFINITION = sz_configmanager.get_config(config_id) config_handle = sz_config.import_config(CONFIG_DEFINITION) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfig/szconfig_constructor.py b/examples/szconfig/szconfig_constructor.py index 783242c0..a9aaf10b 100755 --- a/examples/szconfig/szconfig_constructor.py +++ b/examples/szconfig/szconfig_constructor.py @@ -18,4 +18,4 @@ sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS) sz_config = sz_abstract_factory.create_config() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/add_config.py b/examples/szconfigmanager/add_config.py index abeda87b..9914a564 100755 --- a/examples/szconfigmanager/add_config.py +++ b/examples/szconfigmanager/add_config.py @@ -23,4 +23,4 @@ CONFIG_DEFINITION = sz_config.export_config(config_handle) config_id = sz_configmanager.add_config(CONFIG_DEFINITION, CONFIG_COMMENT) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/get_config.py b/examples/szconfigmanager/get_config.py index f918798e..6c5051dc 100755 --- a/examples/szconfigmanager/get_config.py +++ b/examples/szconfigmanager/get_config.py @@ -21,4 +21,4 @@ CONFIG_DEFINITION = sz_configmanager.get_config(config_id) print(f"\n{CONFIG_DEFINITION}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/get_configs.py b/examples/szconfigmanager/get_configs.py index 301f7846..590a8c4e 100755 --- a/examples/szconfigmanager/get_configs.py +++ b/examples/szconfigmanager/get_configs.py @@ -20,4 +20,4 @@ CONFIG_LIST = sz_configmanager.get_configs() print(f"\n{CONFIG_LIST}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/get_default_config_id.py b/examples/szconfigmanager/get_default_config_id.py index 160046ff..c87e63f8 100755 --- a/examples/szconfigmanager/get_default_config_id.py +++ b/examples/szconfigmanager/get_default_config_id.py @@ -20,4 +20,4 @@ CONFIG_ID = sz_configmanager.get_default_config_id() print(f"\n{CONFIG_ID}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/replace_default_config_id.py b/examples/szconfigmanager/replace_default_config_id.py index 4f2a3fbf..806895f6 100755 --- a/examples/szconfigmanager/replace_default_config_id.py +++ b/examples/szconfigmanager/replace_default_config_id.py @@ -36,4 +36,4 @@ sz_configmanager.replace_default_config_id(current_default_config_id, new_default_config_id) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/set_default_config_id.py b/examples/szconfigmanager/set_default_config_id.py index 07eb18d7..c4b344d4 100755 --- a/examples/szconfigmanager/set_default_config_id.py +++ b/examples/szconfigmanager/set_default_config_id.py @@ -36,4 +36,4 @@ sz_configmanager.set_default_config_id(config_id) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szconfigmanager/szconfigmanager_constructor.py b/examples/szconfigmanager/szconfigmanager_constructor.py index fb628113..e16bd227 100755 --- a/examples/szconfigmanager/szconfigmanager_constructor.py +++ b/examples/szconfigmanager/szconfigmanager_constructor.py @@ -17,4 +17,4 @@ sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS) sz_configmanager = sz_abstract_factory.create_configmanager() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szdiagnostic/check_datastore_performance.py b/examples/szdiagnostic/check_datastore_performance.py index 23e86fe3..5e3220c8 100755 --- a/examples/szdiagnostic/check_datastore_performance.py +++ b/examples/szdiagnostic/check_datastore_performance.py @@ -22,4 +22,4 @@ RESULT = sz_diagnostic.check_datastore_performance(SECONDS_TO_RUN) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szdiagnostic/get_datastore_info.py b/examples/szdiagnostic/get_datastore_info.py index 6429008e..e23b838e 100755 --- a/examples/szdiagnostic/get_datastore_info.py +++ b/examples/szdiagnostic/get_datastore_info.py @@ -20,4 +20,4 @@ RESULT = sz_diagnostic.get_datastore_info() print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szdiagnostic/get_feature.py b/examples/szdiagnostic/get_feature.py index 67b0a4dc..8a05005c 100755 --- a/examples/szdiagnostic/get_feature.py +++ b/examples/szdiagnostic/get_feature.py @@ -20,4 +20,4 @@ RESULT = sz_diagnostic.get_feature(1) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szdiagnostic/purge_repository.py b/examples/szdiagnostic/purge_repository.py index 1b142454..fbbc4d73 100755 --- a/examples/szdiagnostic/purge_repository.py +++ b/examples/szdiagnostic/purge_repository.py @@ -24,4 +24,4 @@ # sz_diagnostic.purge_repository() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szdiagnostic/szdiagnostic_constructor.py b/examples/szdiagnostic/szdiagnostic_constructor.py index c39b63fa..6bb3e565 100755 --- a/examples/szdiagnostic/szdiagnostic_constructor.py +++ b/examples/szdiagnostic/szdiagnostic_constructor.py @@ -18,4 +18,4 @@ sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS) sz_diagnostic = sz_abstract_factory.create_diagnostic() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/add_record.py b/examples/szengine/add_record.py index 7447b893..c598726f 100755 --- a/examples/szengine/add_record.py +++ b/examples/szengine/add_record.py @@ -39,4 +39,4 @@ 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") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/count_redo_records.py b/examples/szengine/count_redo_records.py index 21126827..8b335ecc 100755 --- a/examples/szengine/count_redo_records.py +++ b/examples/szengine/count_redo_records.py @@ -20,4 +20,4 @@ RESULT = sz_engine.count_redo_records() print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/delete_record.py b/examples/szengine/delete_record.py index 4b311049..fc85c531 100755 --- a/examples/szengine/delete_record.py +++ b/examples/szengine/delete_record.py @@ -23,4 +23,4 @@ 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") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/export_csv_fetch_close.py b/examples/szengine/export_csv_fetch_close.py index 09ef9852..05875d58 100755 --- a/examples/szengine/export_csv_fetch_close.py +++ b/examples/szengine/export_csv_fetch_close.py @@ -29,4 +29,4 @@ print(fragment, end="") sz_engine.close_export(export_handle) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/export_json_fetch_close.py b/examples/szengine/export_json_fetch_close.py index d11fb76f..06fe748b 100755 --- a/examples/szengine/export_json_fetch_close.py +++ b/examples/szengine/export_json_fetch_close.py @@ -25,4 +25,4 @@ print(fragment, end="") sz_engine.close_export(export_handle) except SzError as err: - print(f"\nError: {err}\n") + 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 d49d03f6..b81dacec 100755 --- a/examples/szengine/find_network_by_entity_id.py +++ b/examples/szengine/find_network_by_entity_id.py @@ -24,4 +24,4 @@ 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") + 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 f4019c13..0d3f52eb 100755 --- a/examples/szengine/find_network_by_record_id.py +++ b/examples/szengine/find_network_by_record_id.py @@ -25,4 +25,4 @@ 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") + 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 e0c14847..49101131 100755 --- a/examples/szengine/find_path_by_entity_id.py +++ b/examples/szengine/find_path_by_entity_id.py @@ -35,4 +35,4 @@ ) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/find_path_by_record_id.py b/examples/szengine/find_path_by_record_id.py index e4b2106b..f22890aa 100755 --- a/examples/szengine/find_path_by_record_id.py +++ b/examples/szengine/find_path_by_record_id.py @@ -39,4 +39,4 @@ ) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/get_active_config_id.py b/examples/szengine/get_active_config_id.py index 4c1825ec..7a41327e 100755 --- a/examples/szengine/get_active_config_id.py +++ b/examples/szengine/get_active_config_id.py @@ -20,4 +20,4 @@ RESULT = sz_engine.get_active_config_id() print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/get_entity_by_entity_id.py b/examples/szengine/get_entity_by_entity_id.py index 4d2bf266..e1492704 100755 --- a/examples/szengine/get_entity_by_entity_id.py +++ b/examples/szengine/get_entity_by_entity_id.py @@ -23,4 +23,4 @@ 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") + 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 e52eabed..3255b82d 100755 --- a/examples/szengine/get_entity_by_record_id.py +++ b/examples/szengine/get_entity_by_record_id.py @@ -23,4 +23,4 @@ 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") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/get_record.py b/examples/szengine/get_record.py index c9add2aa..598ccdc5 100755 --- a/examples/szengine/get_record.py +++ b/examples/szengine/get_record.py @@ -24,4 +24,4 @@ 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") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/get_redo_record.py b/examples/szengine/get_redo_record.py index 0ccd05d4..e2b5e071 100755 --- a/examples/szengine/get_redo_record.py +++ b/examples/szengine/get_redo_record.py @@ -20,4 +20,4 @@ RESULT = sz_engine.get_redo_record() print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/get_stats.py b/examples/szengine/get_stats.py index c4c82ab3..83034a43 100755 --- a/examples/szengine/get_stats.py +++ b/examples/szengine/get_stats.py @@ -20,4 +20,4 @@ RESULT = sz_engine.get_stats() print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + 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 506b74e6..5753262d 100755 --- a/examples/szengine/get_virtual_entity_by_record_id.py +++ b/examples/szengine/get_virtual_entity_by_record_id.py @@ -25,4 +25,4 @@ RESULT = sz_engine.get_virtual_entity_by_record_id(RECORD_LIST, FLAGS) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/how_entity_by_entity_id.py b/examples/szengine/how_entity_by_entity_id.py index 995b2bbf..fa4d45ad 100755 --- a/examples/szengine/how_entity_by_entity_id.py +++ b/examples/szengine/how_entity_by_entity_id.py @@ -22,4 +22,4 @@ 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") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/preprocess_record.py b/examples/szengine/preprocess_record.py index d31a11dc..0b2ab58b 100755 --- a/examples/szengine/preprocess_record.py +++ b/examples/szengine/preprocess_record.py @@ -37,4 +37,4 @@ RESULT = sz_engine.preprocess_record(RECORD_DEFINITION, FLAGS) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/prime_engine.py b/examples/szengine/prime_engine.py index 43d73da8..f13cbbac 100755 --- a/examples/szengine/prime_engine.py +++ b/examples/szengine/prime_engine.py @@ -19,4 +19,4 @@ sz_engine = sz_abstract_factory.create_engine() sz_engine.prime_engine() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/process_redo_record.py b/examples/szengine/process_redo_record.py index 7563d13e..94c324d0 100755 --- a/examples/szengine/process_redo_record.py +++ b/examples/szengine/process_redo_record.py @@ -25,4 +25,4 @@ result = sz_engine.process_redo_record(redo_record, FLAGS) print(result) except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/reevaluate_entity.py b/examples/szengine/reevaluate_entity.py index 3c728852..cb229d5e 100755 --- a/examples/szengine/reevaluate_entity.py +++ b/examples/szengine/reevaluate_entity.py @@ -22,4 +22,4 @@ RESULT = sz_engine.reevaluate_entity(ENTITY_ID, FLAGS) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/reevaluate_record.py b/examples/szengine/reevaluate_record.py index 4d266197..cf609816 100755 --- a/examples/szengine/reevaluate_record.py +++ b/examples/szengine/reevaluate_record.py @@ -23,4 +23,4 @@ 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") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/search_by_attributes.py b/examples/szengine/search_by_attributes.py index 6ff4b370..f235f750 100755 --- a/examples/szengine/search_by_attributes.py +++ b/examples/szengine/search_by_attributes.py @@ -23,4 +23,4 @@ RESULT = sz_engine.search_by_attributes(ATTRIBUTES, FLAGS, SEARCH_PROFILE) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/szengine_constructor.py b/examples/szengine/szengine_constructor.py index bdb06489..347b9b75 100755 --- a/examples/szengine/szengine_constructor.py +++ b/examples/szengine/szengine_constructor.py @@ -17,4 +17,4 @@ sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS) sz_engine = sz_abstract_factory.create_engine() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/why_entities.py b/examples/szengine/why_entities.py index 85829bf8..ed8d64e7 100755 --- a/examples/szengine/why_entities.py +++ b/examples/szengine/why_entities.py @@ -27,4 +27,4 @@ ) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/why_record_in_entity.py b/examples/szengine/why_record_in_entity.py index 65def1f1..22d8ef7a 100755 --- a/examples/szengine/why_record_in_entity.py +++ b/examples/szengine/why_record_in_entity.py @@ -27,4 +27,4 @@ ) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szengine/why_records.py b/examples/szengine/why_records.py index 9ae12a63..2f66cca1 100755 --- a/examples/szengine/why_records.py +++ b/examples/szengine/why_records.py @@ -31,4 +31,4 @@ ) print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szproduct/get_license.py b/examples/szproduct/get_license.py index 33a5461f..3716b5f9 100755 --- a/examples/szproduct/get_license.py +++ b/examples/szproduct/get_license.py @@ -20,4 +20,4 @@ RESULT = sz_product.get_license() print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szproduct/get_version.py b/examples/szproduct/get_version.py index 24d178f0..2fc27e07 100755 --- a/examples/szproduct/get_version.py +++ b/examples/szproduct/get_version.py @@ -20,4 +20,4 @@ RESULT = sz_product.get_version() print(f"\n{RESULT}\n") except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/examples/szproduct/szproduct_constructor.py b/examples/szproduct/szproduct_constructor.py index e854a9b3..43506d90 100755 --- a/examples/szproduct/szproduct_constructor.py +++ b/examples/szproduct/szproduct_constructor.py @@ -18,4 +18,4 @@ sz_abstract_factory = SzAbstractFactoryCore(INSTANCE_NAME, SETTINGS) sz_product = sz_abstract_factory.create_product() except SzError as err: - print(f"\nError: {err}\n") + print(f"\nERROR: {err}\n") diff --git a/makefiles/linux.mk b/makefiles/linux.mk index e1ca016f..78544cc3 100644 --- a/makefiles/linux.mk +++ b/makefiles/linux.mk @@ -37,6 +37,9 @@ coverage-osarch-specific: .PHONY: dependencies-for-development-osarch-specific dependencies-for-development-osarch-specific: +.PHONY: dependencies-for-documentation-osarch-specific +dependencies-for-documentation-osarch-specific: + .PHONY: documentation-osarch-specific documentation-osarch-specific: diff --git a/src/senzing_core/szabstractfactory.py b/src/senzing_core/szabstractfactory.py index d0cfa2b1..e63a8d12 100644 --- a/src/senzing_core/szabstractfactory.py +++ b/src/senzing_core/szabstractfactory.py @@ -29,7 +29,7 @@ __all__ = ["SzAbstractFactory", "SzAbstractFactoryParametersCore"] __version__ = "0.0.1" # See https://www.python.org/dev/peps/pep-0396/ __date__ = "2024-10-21" -__updated__ = "2025-01-16" +__updated__ = "2025-01-17" # ----------------------------------------------------------------------------- diff --git a/src/senzing_core/szconfig.py b/src/senzing_core/szconfig.py index 892fdc79..744b9dd4 100644 --- a/src/senzing_core/szconfig.py +++ b/src/senzing_core/szconfig.py @@ -40,7 +40,7 @@ __all__ = ["SzConfigCore"] __version__ = "0.0.1" # See https://www.python.org/dev/peps/pep-0396/ __date__ = "2023-10-30" -__updated__ = "2025-01-16" +__updated__ = "2025-01-17" # ----------------------------------------------------------------------------- diff --git a/src/senzing_core/szconfigmanager.py b/src/senzing_core/szconfigmanager.py index fe30f8f9..063f7c92 100644 --- a/src/senzing_core/szconfigmanager.py +++ b/src/senzing_core/szconfigmanager.py @@ -37,7 +37,7 @@ __all__ = ["SzConfigManagerCore"] __version__ = "0.0.1" # See https://www.python.org/dev/peps/pep-0396/ __date__ = "2023-10-30" -__updated__ = "2025-01-16" +__updated__ = "2025-01-17" # ----------------------------------------------------------------------------- diff --git a/src/senzing_core/szdiagnostic.py b/src/senzing_core/szdiagnostic.py index 1eff76ae..2496f3c6 100644 --- a/src/senzing_core/szdiagnostic.py +++ b/src/senzing_core/szdiagnostic.py @@ -38,7 +38,7 @@ __all__ = ["SzDiagnosticCore"] __version__ = "0.0.1" # See https://www.python.org/dev/peps/pep-0396/ __date__ = "2023-10-30" -__updated__ = "2025-01-16" +__updated__ = "2025-01-17" # ----------------------------------------------------------------------------- diff --git a/src/senzing_core/szengine.py b/src/senzing_core/szengine.py index 03ee8cd8..e0af2ad9 100644 --- a/src/senzing_core/szengine.py +++ b/src/senzing_core/szengine.py @@ -53,7 +53,7 @@ __all__ = ["SzEngineCore"] __version__ = "0.0.1" # See https://www.python.org/dev/peps/pep-0396/ __date__ = "2023-10-30" -__updated__ = "2025-01-16" +__updated__ = "2025-01-17" # ----------------------------------------------------------------------------- diff --git a/src/senzing_core/szproduct.py b/src/senzing_core/szproduct.py index 06e0ade8..e5824e1d 100644 --- a/src/senzing_core/szproduct.py +++ b/src/senzing_core/szproduct.py @@ -36,7 +36,7 @@ __all__ = ["SzProductCore"] __version__ = "0.0.1" # See https://www.python.org/dev/peps/pep-0396/ __date__ = "2023-10-30" -__updated__ = "2025-01-16" +__updated__ = "2025-01-17" # -----------------------------------------------------------------------------