219 ant 1

.github/workflows/pylint.yaml

@@ -31,7 +31,7 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install --requirement requirements.txt
           python -m pip install --requirement test-requirements.txt
-          python -m pip install psutil pylint pytest pytest_schema
+          python -m pip install psutil pylint pylint-per-file-ignores pytest pytest_schema
 
       - name: Analysing the code with pylint
         run: |

CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.2.7] - 2025-04-18
+
+### Changed in 0.2.7
+
+- Case on example variables
+
+### Removed in 0.2.7
+
+- Documentation on early adaptor methods
+- Empty example files for early adaptor methods
+
 ## [0.2.6] - 2025-04-16
 
 ### Added in 0.2.6

development-requirements.txt

@@ -8,6 +8,7 @@ isort==6.0.1
 mypy==1.15.0
 psutil==7.0.0
 pylint==3.3.6
+pylint-per-file-ignores==1.4.0 
 pytest-cov==6.1.1
 pytest-schema==0.1.2
 pytest==8.3.5

docs/source/conf.py

@@ -51,3 +51,14 @@
 html_theme = "sphinx_rtd_theme"
 # autodoc_inherit_docstrings = False  # don't include docstrings from the parent class
 # autodoc_typehints = "description"   # Show types only in descriptions, not in signatures
+
+# Methods that are not to be documented. Intended to be internal use or experimental
+doc_excludes = ("find_interesting_entities_by_entity_id", "find_interesting_entities_by_record_id", "get_feature")
+
+
+def autodoc_skip_member(app, what, name, obj, skip, options):
+    return True if name in doc_excludes else None
+
+
+def setup(app):
+    app.connect("autodoc-skip-member", autodoc_skip_member)

examples/szconfig/add_data_source.py

@@ -5,7 +5,7 @@
 try:
     DATA_SOURCE_CODE = "NAME_OF_DATASOURCE"
     sz_config = sz_configmanager.create_config_from_template()
-    RESULT = sz_config.add_data_source(DATA_SOURCE_CODE)
-    print(f"\n{RESULT}\n")
+    result = sz_config.add_data_source(DATA_SOURCE_CODE)
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szconfig/get_data_sources.py

@@ -4,7 +4,7 @@
 
 try:
     sz_config = sz_configmanager.create_config_from_template()
-    RESULT = sz_config.get_data_sources()
-    print(f"\n{RESULT}\n")
+    result = sz_config.get_data_sources()
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szdiagnostic/check_datastore_performance.py

@@ -4,7 +4,7 @@
 
 try:
     SECONDS_TO_RUN = 3
-    RESULT = sz_diagnostic.check_datastore_performance(SECONDS_TO_RUN)
-    print(f"\n{RESULT}\n")
+    result = sz_diagnostic.check_datastore_performance(SECONDS_TO_RUN)
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szdiagnostic/get_datastore_info.py

@@ -3,7 +3,7 @@
 from . import sz_diagnostic
 
 try:
-    RESULT = sz_diagnostic.get_datastore_info()
-    print(f"\n{RESULT}\n")
+    result = sz_diagnostic.get_datastore_info()
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/add_record.py

@@ -24,7 +24,7 @@
         }
     )
     RECORD_ID = "1"
-    RESULT = sz_engine.add_record(DATA_SOURCE_CODE, RECORD_ID, record_definition, flags)
-    print(f"\n{RESULT}\n")
+    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")

examples/szengine/count_redo_records.py

@@ -3,7 +3,7 @@
 from . import sz_engine
 
 try:
-    RESULT = sz_engine.count_redo_records()
-    print(f"\n{RESULT}\n")
+    result = sz_engine.count_redo_records()
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/delete_record.py

@@ -6,7 +6,7 @@
     DATA_SOURCE_CODE = "TEST"
     flags = SzEngineFlags.SZ_WITH_INFO
     RECORD_ID = "1"
-    RESULT = sz_engine.delete_record(DATA_SOURCE_CODE, RECORD_ID, flags)
-    print(f"\n{RESULT}\n")
+    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")

examples/szengine/find_network_by_entity_id.py

@@ -8,7 +8,7 @@
     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)
-    print(f"\n{RESULT}\n")
+    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")

examples/szengine/find_network_by_record_id.py

@@ -8,7 +8,7 @@
     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)
-    print(f"\n{RESULT}\n")
+    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")

examples/szengine/find_path_by_entity_id.py

@@ -11,14 +11,14 @@
     MAX_DEGREES = 2
     required_data_sources: List[str] = []
     START_ENTITY_ID = 1
-    RESULT = sz_engine.find_path_by_entity_id(
+    result = sz_engine.find_path_by_entity_id(
         START_ENTITY_ID,
         END_ENTITY_ID,
         MAX_DEGREES,
         avoid_entity_ids,
         required_data_sources,
         flags,
     )
-    print(f"\n{RESULT}\n")
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/find_path_by_record_id.py

@@ -13,7 +13,7 @@
     required_data_sources: List[str] = []
     START_DATA_SOURCE_CODE = "CUSTOMERS"
     START_RECORD_ID = "1001"
-    RESULT = sz_engine.find_path_by_record_id(
+    result = sz_engine.find_path_by_record_id(
         START_DATA_SOURCE_CODE,
         START_RECORD_ID,
         END_DATA_SOURCE_CODE,
@@ -23,6 +23,6 @@
         required_data_sources,
         flags,
     )
-    print(f"\n{RESULT}\n")
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/get_active_config_id.py

@@ -3,7 +3,7 @@
 from . import sz_engine
 
 try:
-    RESULT = sz_engine.get_active_config_id()
-    print(f"\n{RESULT}\n")
+    result = sz_engine.get_active_config_id()
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/get_entity_by_entity_id.py

@@ -5,7 +5,7 @@
 try:
     ENTITY_ID = 1
     flags = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS
-    RESULT = sz_engine.get_entity_by_entity_id(ENTITY_ID, flags)
-    print(f"\n{RESULT}\n")
+    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")

examples/szengine/get_entity_by_record_id.py

@@ -6,7 +6,7 @@
     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)
-    print(f"\n{RESULT}\n")
+    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")

examples/szengine/get_record.py

@@ -6,7 +6,7 @@
     DATA_SOURCE_CODE = "CUSTOMERS"
     flags = SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS
     RECORD_ID = "1001"
-    RESULT = sz_engine.get_record(DATA_SOURCE_CODE, RECORD_ID, flags)
-    print(f"\n{RESULT}\n")
+    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")

examples/szengine/get_redo_record.py

@@ -3,7 +3,7 @@
 from . import sz_engine
 
 try:
-    RESULT = sz_engine.get_redo_record()
-    print(f"\n{RESULT}\n")
+    result = sz_engine.get_redo_record()
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/get_stats.py

@@ -3,7 +3,7 @@
 from . import sz_engine
 
 try:
-    RESULT = sz_engine.get_stats()
-    print(f"\n{RESULT}\n")
+    result = sz_engine.get_stats()
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/get_virtual_entity_by_record_id.py

@@ -8,7 +8,7 @@
         ("CUSTOMERS", "1001"),
         ("CUSTOMERS", "1002"),
     ]
-    RESULT = sz_engine.get_virtual_entity_by_record_id(record_list, flags)
-    print(f"\n{RESULT}\n")
+    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")

examples/szengine/how_entity_by_entity_id.py

@@ -5,7 +5,7 @@
 try:
     ENTITY_ID = 1
     flags = SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS
-    RESULT = sz_engine.how_entity_by_entity_id(ENTITY_ID, flags)
-    print(f"\n{RESULT}\n")
+    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")

examples/szengine/preprocess_record.py

@@ -22,7 +22,7 @@
             "AMOUNT": "100",
         }
     )
-    RESULT = sz_engine.preprocess_record(record_definition, flags)
-    print(f"\n{RESULT}\n")
+    result = sz_engine.preprocess_record(record_definition, flags)
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/process_redo_record.py

@@ -8,7 +8,7 @@
         REDO_RECORD = sz_engine.get_redo_record()
         if not REDO_RECORD:
             break
-        RESULT = sz_engine.process_redo_record(REDO_RECORD, flags)
-        print(RESULT)
+        result = sz_engine.process_redo_record(REDO_RECORD, flags)
+        print(result)
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/reevaluate_entity.py

@@ -5,7 +5,7 @@
 try:
     ENTITY_ID = 1
     flags = SzEngineFlags.SZ_WITH_INFO
-    RESULT = sz_engine.reevaluate_entity(ENTITY_ID, flags)
-    print(f"\n{RESULT}\n")
+    result = sz_engine.reevaluate_entity(ENTITY_ID, flags)
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/reevaluate_record.py

@@ -6,7 +6,7 @@
     DATA_SOURCE_CODE = "CUSTOMERS"
     flags = SzEngineFlags.SZ_WITH_INFO
     RECORD_ID = "1001"
-    RESULT = sz_engine.reevaluate_record(DATA_SOURCE_CODE, RECORD_ID, flags)
-    print(f"\n{RESULT}\n")
+    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")

examples/szengine/search_by_attributes.py

@@ -8,7 +8,7 @@
     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)
-    print(f"\n{RESULT}\n")
+    result = sz_engine.search_by_attributes(attributes, flags, SEARCH_PROFILE)
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/why_entities.py

@@ -6,11 +6,11 @@
     ENTITY_ID_1 = 1
     ENTITY_ID_2 = 4
     flags = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS
-    RESULT = sz_engine.why_entities(
+    result = sz_engine.why_entities(
         ENTITY_ID_1,
         ENTITY_ID_2,
         flags,
     )
-    print(f"\n{RESULT}\n")
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/why_record_in_entity.py

@@ -6,11 +6,11 @@
     DATA_SOURCE_CODE = "CUSTOMERS"
     flags = SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS
     RECORD_ID = "1001"
-    RESULT = sz_engine.why_record_in_entity(
+    result = sz_engine.why_record_in_entity(
         DATA_SOURCE_CODE,
         RECORD_ID,
         flags,
     )
-    print(f"\n{RESULT}\n")
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/why_records.py

@@ -8,13 +8,13 @@
     flags = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS
     RECORD_ID_1 = "1001"
     RECORD_ID_2 = "1002"
-    RESULT = sz_engine.why_records(
+    result = sz_engine.why_records(
         DATA_SOURCE_CODE_1,
         RECORD_ID_1,
         DATA_SOURCE_CODE_2,
         RECORD_ID_2,
         flags,
     )
-    print(f"\n{RESULT}\n")
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szengine/why_search.py

@@ -9,7 +9,7 @@
     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)
-    print(f"\n{RESULT}\n")
+    result = sz_engine.why_search(attributes, ENTITY_ID, flags, SEARCH_PROFILE)
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szproduct/get_license.py

@@ -3,7 +3,7 @@
 from . import sz_product
 
 try:
-    RESULT = sz_product.get_license()
-    print(f"\n{RESULT}\n")
+    result = sz_product.get_license()
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")

examples/szproduct/get_version.py

@@ -3,7 +3,7 @@
 from . import sz_product
 
 try:
-    RESULT = sz_product.get_version()
-    print(f"\n{RESULT}\n")
+    result = sz_product.get_version()
+    print(f"\n{result}\n")
 except SzError as err:
     print(f"\nERROR: {err}\n")