219 ant 1 (#221)

* #219 - Save point

* Changelog

* Add pylint-per-file-ignores to pylint workflow

Author: antaenc

.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")