#153 - Save point

Makefile

@@ -4,6 +4,11 @@
 
 include makefiles/osdetect.mk
 
+# Define newline for use
+define \n
+
+endef
+
 # -----------------------------------------------------------------------------
 # Variables
 # -----------------------------------------------------------------------------
@@ -70,6 +75,12 @@ dependencies-for-development: venv dependencies-for-development-osarch-specific
 		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
@@ -113,15 +124,15 @@ test-tests:
 	@$(activate-venv); pytest tests --verbose --capture=no --cov=src/senzing --cov-report xml:coverage.xml
 
 
-.PHONY: test-examples
-test-examples:
-	$(info --- Test examples --------------------------------------------------------------)
-	@$(activate-venv); python3 -m unittest \
-		examples/szconfig/*.py \
-		examples/szconfigmanager/*.py \
-		examples/szdiagnostic/*.py \
-		examples/szengine/*.py \
-		examples/szproduct/*.py
+# .PHONY: test-examples
+# test-examples:
+# 	$(info --- Test examples --------------------------------------------------------------)
+# 	@$(activate-venv); python3 -m unittest \
+# 		examples/szconfig/*.py \
+# 		examples/szconfigmanager/*.py \
+# 		examples/szdiagnostic/*.py \
+# 		examples/szengine/*.py \
+# 		examples/szproduct/*.py
 
 
 .PHONY: docker-test
@@ -187,63 +198,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/*' ':!:examples/*')
 
 
 .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 ----------------------------------------------------------------)

docs/development.md

@@ -63,6 +63,15 @@ Since the Senzing library is a prerequisite, it must be installed first.
 
    ```
 
+1. Install dependencies needed for documentation.
+   Example:
+
+   ```console
+   cd ${GIT_REPOSITORY_DIR}
+   make dependencies-for-documentation
+
+   ```
+
 ## Lint
 
 1. Run linting.

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

makefiles/linux.mk

@@ -34,6 +34,8 @@ 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:
@@ -62,21 +64,13 @@ test-osarch-specific-2:
 	@pytest tests/ --verbose --capture=no --cov=src/senzing --cov-report xml:coverage.xml
 #	$(info --- Test examples ----------------------------------------------------)
 #	@pytest examples/ --verbose --capture=no --cov=src/senzing
-	$(info --- Test examples using unittest -------------------------------------)
-	@python3 -m unittest \
-		examples/szconfig/*.py \
-		examples/szconfigmanager/*.py \
-		examples/szdiagnostic/*.py \
-		examples/szengine/*.py \
-		examples/szproduct/*.py
-
-
-.PHONY: test-examples-2
-test-examples-2:
-	$(info --- Test examples using unittest -------------------------------------)
-	@python3 -m unittest \
-		examples/misc/add_truthset_datasources.py \
-		examples/misc/add_truthset_data.py
+#	$(info --- Test examples using unittest -------------------------------------)
+#	@python3 -m unittest \
+#		examples/szconfig/*.py \
+#		examples/szconfigmanager/*.py \
+#		examples/szdiagnostic/*.py \
+#		examples/szengine/*.py \
+#		examples/szproduct/*.py
 
 
 .PHONY: venv-osarch-specific

pyproject.toml

@@ -30,6 +30,10 @@ warn_unused_ignores = "false"
 [[tool.mypy.overrides]]
 module = "examples.*"
 
+[[tool.mypy.overrides]]
+module = "pytest_schema.*"
+ignore_missing_imports = "true"
+
 [tool.pylint]
 disable = [
     "duplicate-code",

src/senzing/szengineflags.py

@@ -30,7 +30,6 @@ class SzEngineFlags(IntFlag):
     def _members_dict(cls) -> Dict[str, int]:
         return {member.name: member.value for member in cls if member.name and not member.name.startswith("_")}
 
-    # TODO Change tests and add these 2 new methods
     @classmethod
     def flags_by_name(cls: type[TSzEngineFlags]) -> Dict[str, int]:
         """
@@ -161,7 +160,7 @@ def flags_by_value(cls) -> Dict[int, str]:
     # Flag for returning (or not) with info responses.
 
     SZ_WITH_INFO = 1 << 62
-    __SZ_WITHOUT_INFO = 0  # __SZ_WITHOUT_INFO isn't in the C API, will be used for future methods.
+    _SZ_WITHOUT_INFO = 0  # __SZ_WITHOUT_INFO isn't in the C API, will be used for future methods.
 
     # Flags for searching for entities.
 

tests/szengineflags_test.py

@@ -4,7 +4,6 @@
 TODO: szengineflags_test.py
 """
 
-from pytest_schema import schema
 
 from senzing import SzEngineFlags
 
@@ -16,13 +15,19 @@
 def test_flags_by_name() -> None:
     """Test szengineflags.flags_by_name()."""
     actual = SzEngineFlags.flags_by_name()
-    assert schema(test_flags_by_name_schema) == actual
+    # assert schema(test_flags_by_name_schema) == actual
+    assert isinstance(actual, dict)
+    for k, v in actual.items():
+        assert isinstance(k, str) and isinstance(v, int)
 
 
 def test_flags_by_value() -> None:
     """Test szengineflags.flags_by_value()."""
     actual = SzEngineFlags.flags_by_value()
-    assert schema(test_flags_by_value_schema) == actual
+    # assert schema(test_flags_by_value_schema) == actual
+    assert isinstance(actual, dict)
+    for k, v in actual.items():
+        assert isinstance(k, int) and isinstance(v, str)
 
 
 # -----------------------------------------------------------------------------