#345 - Update all method doc strings for raises (#348)

Author: antaenc

CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [4.0.2] - 2025-08-11
+
+### Changed in 4.0.2
+
+- Documentation updates
+- Removed `typing-extensions` dependency
+
 ## [4.0.1] - 2025-08-07
 
 ### Added in 4.0.1

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = senzing
-version = 4.0.1
+version = 4.0.2
 author = senzing
 author_email = support@senzing.com
 description = Python SDK method definitions
@@ -20,8 +20,6 @@ package_dir =
     = src
 packages = find:
 python_requires = >=3.9
-install_requires =
-    typing-extensions >= 4.12.2; python_version<'3.11'
 
 [options.packages.find]
 where = src

src/senzing/constants.py

@@ -15,9 +15,7 @@
     "SZ_VERBOSE_LOGGING",
     "SZ_WITHOUT_INFO",
 ]
-__version__ = "4.0.0"
-__date__ = "2025-08-05"
-__updated__ = "2025-08-05"
+__updated__ = "2025-08-11"
 
 # -----------------------------------------------------------------------------
 # Constant helper values useful for flags

src/senzing/szabstractfactory.py

@@ -21,9 +21,7 @@
 # Metadata
 
 __all__ = ["SzAbstractFactory"]
-__version__ = "4.0.1"
-__date__ = "2025-08-05"
-__updated__ = "2025-08-07"
+__updated__ = "2025-08-11"
 
 
 # -----------------------------------------------------------------------------
@@ -52,6 +50,7 @@ def create_configmanager(self) -> SzConfigManager:
             SzConfigManager: A new implementation.
 
         Raises:
+            SzError
 
         .. collapse:: Example:
 
@@ -77,6 +76,7 @@ def create_diagnostic(self) -> SzDiagnostic:
             SzDiagnostic: A new implementation.
 
         Raises:
+            SzError
 
         .. collapse:: Example:
 
@@ -102,6 +102,7 @@ def create_engine(self) -> SzEngine:
             SzEngine: A new implementation.
 
         Raises:
+            SzError
 
         .. collapse:: Example:
 
@@ -127,6 +128,7 @@ def create_product(self) -> SzProduct:
             SzProduct: A new implementation.
 
         Raises:
+            SzError
 
         .. collapse:: Example:
 
@@ -148,8 +150,7 @@ def destroy(self) -> None:
         AbstractFactory.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
-            szexception.SzError: config_id does not exist.
+            SzError
 
         .. collapse:: Example:
 
@@ -169,8 +170,7 @@ def reinitialize(self, config_id: int) -> None:
             config_id (int): The configuration ID used for the initialization
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
-            szexception.SzError: config_id does not exist.
+            SzError
 
         .. collapse:: Example:
 

src/senzing/szconfig.py

@@ -2,18 +2,14 @@
 szconfig.py is the abstract class for all implementations of SzConfig.
 """
 
-# TODO: Determine specific SzErrors, Errors for "Raises:" documentation.
-
 from abc import ABC, abstractmethod
 
 from .szhelpers import construct_help
 
 # Metadata
 
 __all__ = ["SzConfig"]
-__version__ = "4.0.1"
-__date__ = "2025-08-05"
-__updated__ = "2025-08-07"
+__updated__ = "2025-08-11"
 
 # -----------------------------------------------------------------------------
 # SzConfig
@@ -41,7 +37,7 @@ def export(self) -> str:
             str: A string containing a JSON Document representation of the Senzing SzConfig object.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 
@@ -67,7 +63,7 @@ def get_data_source_registry(self) -> str:
             str: A string containing a JSON document listing all of the data sources.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 
@@ -97,7 +93,7 @@ def register_data_source(self, data_source_code: str) -> str:
             str: A string containing a JSON document listing the newly created data source.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 
@@ -129,7 +125,7 @@ def unregister_data_source(self, data_source_code: str) -> str:
             data_source_code (str): Name of data source code to delete.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 

src/senzing/szconfigmanager.py

@@ -2,8 +2,6 @@
 szconfigmanager.py is the abstract class for all implementations of SzConfigManager.
 """
 
-# TODO: Determine specific SzErrors, Errors for "Raises:" documentation.
-
 from abc import ABC, abstractmethod
 
 from .szconfig import SzConfig
@@ -12,9 +10,7 @@
 # Metadata
 
 __all__ = ["SzConfigManager"]
-__version__ = "4.0.1"
-__date__ = "2025-08-05"
-__updated__ = "2025-08-07"
+__updated__ = "2025-08-11"
 
 # -----------------------------------------------------------------------------
 # SzConfigManager
@@ -43,7 +39,7 @@ def create_config_from_config_id(self, config_id: int) -> SzConfig:
             SzConfig: Represents an in-memory Senzing configuration that can be modified.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 
@@ -70,7 +66,7 @@ def create_config_from_string(self, config_definition: str) -> SzConfig:
             SzConfig: Represents an in-memory Senzing configuration that can be modified.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 
@@ -98,7 +94,7 @@ def create_config_from_template(self) -> SzConfig:
             SzConfig: Represents an in-memory Senzing configuration that can be modified.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 
@@ -127,7 +123,7 @@ def get_config_registry(self) -> str:
             str: A JSON document containing Senzing configurations.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 
@@ -155,7 +151,7 @@ def get_default_config_id(self) -> int:
             int:  The current default configuration ID or zero if the default configuration has not been set.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 
@@ -187,7 +183,7 @@ def register_config(self, config_definition: str, config_comment: str) -> int:
             int: A configuration identifier.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 
@@ -217,7 +213,7 @@ def replace_default_config_id(self, current_default_config_id: int, new_default_
             new_default_config_id (int): The configuration identifier to use as the default.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 
@@ -239,7 +235,7 @@ def set_default_config(self, config_definition: str, config_comment: str) -> int
             config_comment (str):  free-form string of comments describing the configuration document.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 
@@ -267,7 +263,7 @@ def set_default_config_id(self, config_id: int) -> None:
             config_id (int): The configuration identifier of the Senzing Engine configuration to use as the default.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
+            SzError
 
         .. collapse:: Example:
 

src/senzing/szdiagnostic.py

@@ -9,9 +9,7 @@
 # Metadata
 
 __all__ = ["SzDiagnostic"]
-__version__ = "4.0.1"
-__date__ = "2025-08-05"
-__updated__ = "2025-08-07"
+__updated__ = "2025-08-11"
 
 # -----------------------------------------------------------------------------
 # SzDiagnostic
@@ -44,8 +42,7 @@ def check_repository_performance(self, seconds_to_run: int) -> str:
             str: A string containing a JSON document.
 
         Raises:
-            TypeError: Incorrect datatype of input parameter.
-            szexception.SzError:
+            SzError
 
         .. collapse:: Example:
 
@@ -71,7 +68,7 @@ def get_repository_info(self) -> str:
         The `get_repository_info` method returns overview information about the repository.
 
         Raises:
-            szexception.SzError:
+            SzError
 
         .. collapse:: Example:
 
@@ -99,6 +96,7 @@ def purge_repository(self) -> None:
         The only means of recovery would be restoring from a database backup.
 
         Raises:
+            SzError
 
         .. collapse:: Example: