diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 0000000..0202064 --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 911cc15ec8845b27730b48e7e5b32f05 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle new file mode 100644 index 0000000..a06a430 Binary files /dev/null and b/.doctrees/environment.pickle differ diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree new file mode 100644 index 0000000..7446875 Binary files /dev/null and b/.doctrees/index.doctree differ diff --git a/.doctrees/modules.doctree b/.doctrees/modules.doctree new file mode 100644 index 0000000..9daf09c Binary files /dev/null and b/.doctrees/modules.doctree differ diff --git a/.doctrees/senzing_abstract.doctree b/.doctrees/senzing_abstract.doctree new file mode 100644 index 0000000..ad113ee Binary files /dev/null and b/.doctrees/senzing_abstract.doctree differ diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/_modules/index.html b/_modules/index.html new file mode 100644 index 0000000..ba5a69f --- /dev/null +++ b/_modules/index.html @@ -0,0 +1,107 @@ + + + + + + Overview: module code — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Overview: module code
    • +
  • +
    • +
+
+
+
+ +
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/senzing_abstract/szconfig_abstract.html b/_modules/senzing_abstract/szconfig_abstract.html new file mode 100644 index 0000000..f23f5c3 --- /dev/null +++ b/_modules/senzing_abstract/szconfig_abstract.html @@ -0,0 +1,427 @@ + + + + + + senzing_abstract.szconfig_abstract — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Module code
    • +
  • senzing_abstract.szconfig_abstract
    • +
  • +
    • +
+
+
+
+
+ +

Source code for senzing_abstract.szconfig_abstract

+#! /usr/bin/env python3
+
+"""
+szconfig_abstract.py is the abstract class for all implementations of szconfig.
+"""
+
+# TODO: Determine specific SzErrors, Errors for "Raises:" documentation.
+
+from abc import ABC, abstractmethod
+from typing import Any, Dict, Union
+
+# Metadata
+
+__all__ = ["SzConfigAbstract"]
+__version__ = "0.0.1"  # See https://www.python.org/dev/peps/pep-0396/
+__date__ = "2023-10-30"
+__updated__ = "2023-11-08"
+
+# -----------------------------------------------------------------------------
+# SzConfigAbstract
+# -----------------------------------------------------------------------------
+
+
+

+[docs]
+class SzConfigAbstract(ABC):
+    """
+    SzConfigAbstract is the definition of the Senzing Python API that is
+    implemented by packages such as szconfig.py.
+    """
+
+    # -------------------------------------------------------------------------
+    # Messages
+    # -------------------------------------------------------------------------
+
+    PREFIX = "szconfig."
+    ID_MESSAGES = {
+        4001: PREFIX + "add_data_source({0}) failed. Return code: {1}",
+        4002: PREFIX + "close_config() failed. Return code: {0}",
+        4003: PREFIX + "create_config() failed. Return code: {0}",
+        4004: PREFIX + "delete_data_source({0}) failed. Return code: {1}",
+        4005: PREFIX + "destroy() failed. Return code: {0}",
+        4006: PREFIX + "export_config() failed. Return code: {0}",
+        4007: PREFIX + "get_data_sources() failed. Return code: {0}",
+        4008: PREFIX + "initialize({0}, {1}, {2}) failed. Return code: {3}",
+        4009: PREFIX + "import_config({0}) failed. Return code: {1}",
+        4010: PREFIX
+        + "SzConfig({0}, {1}) failed. instance_name and settings must both be set or both be empty",
+    }
+
+    # -------------------------------------------------------------------------
+    # Interface definition
+    # -------------------------------------------------------------------------
+
+

+[docs]
+    @abstractmethod
+    def add_data_source(
+        self,
+        config_handle: int,
+        # data_source_code: Union[str, Dict[Any, Any]],
+        data_source_code: str,
+        **kwargs: Any
+    ) -> str:
+        """
+        The `add_data_source` method adds a data source to an existing in-memory configuration.
+
+        Args:
+            config_handle (int): An identifier of an in-memory configuration. Usually created by the `create` or `load` methods.
+            data_source_code (str): Name of data source code to add.
+
+        Returns:
+            str: A string containing a JSON document listing the newly created data source.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfig/add_data_source.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szconfig/add_data_source.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def close_config(self, config_handle: int, **kwargs: Any) -> None:
+        """
+        The `close_config` method cleans up the Senzing SzConfig object pointed to by the `config_handle`.
+
+        Args:
+            config_handle (int): An identifier of an in-memory configuration. Usually created by the `create_config` or `import_config` methods.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfig/create_and_close.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def create_config(self, **kwargs: Any) -> int:
+        """
+        The `create_config` method creates an in-memory Senzing configuration
+        from the `g2config.json` template configuration file located
+        in the PIPELINE.RESOURCEPATH path.
+        A handle is returned to identify the in-memory configuration.
+        The handle is used by the `add_data_source`, `list_data_sources`,
+        `delete_data_source`, and `export_config` methods.
+        The handle is terminated by the `close_config` method.
+
+        Returns:
+            int: A pointer to an in-memory Senzing configuration.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfig/create_and_close.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def delete_data_source(
+        self, config_handle: int, data_source_code: str, **kwargs: Any
+    ) -> None:
+        """
+        The `delete_data_source` method removes a data source from an existing in-memory configuration.
+
+        Args:
+            config_handle (int): An identifier of an in-memory configuration. Usually created by the `create` or `load` methods
+            data_source_code (str): Name of data source code to delete.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfig/delete_data_source.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def destroy(self, **kwargs: Any) -> None:
+        """
+        The `destroy` method will destroy and perform cleanup for the Senzing SzConfig object.
+        It should be called after all other calls are complete.
+
+        **Note:** If the `SzConfig` constructor was called with parameters,
+        the destructor will automatically call the destroy() method.
+        In this case, a separate call to `destroy()` is not needed.
+
+        Raises:
+            szerror.SzError:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfig/szconfig_initialize_and_destroy.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def export_config(self, config_handle: int, **kwargs: Any) -> str:
+        """
+        The `export_config` method creates a JSON string representation of the Senzing SzConfig object.
+
+        Args:
+            config_handle (int): An identifier of an in-memory configuration. Usually created by the `create` or `load` methods
+
+        Returns:
+            str: A string containing a JSON Document representation of the Senzing SzConfig object.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfig/export_config.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szconfig/export_config.txt
+                :linenos:
+                :language: json
+
+            **Create, export, import, and close example**
+
+            .. literalinclude:: ../../examples/szconfig/create_export_import_close.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_data_sources(self, config_handle: int, **kwargs: Any) -> str:
+        """
+        The `get_data_sources` method returns a JSON document of data sources
+        contained in an in-memory configuration.
+
+        Args:
+            config_handle (int): An identifier of an in-memory configuration. Usually created by the `create` or `load` methods
+
+        Returns:
+            str: A string containing a JSON document listing all of the data sources.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfig/get_data_sources.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szconfig/get_data_sources.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def initialize(
+        self,
+        instance_name: str,
+        settings: Union[str, Dict[Any, Any]],
+        verbose_logging: int = 0,
+        **kwargs: Any
+    ) -> None:
+        """
+        The `initialize` method initializes the Senzing SzConfig object.
+        It must be called prior to any other calls.
+
+        **Note:** If the SzConfig constructor is called with parameters,
+        the constructor will automatically call the `initialize()` method.
+        In this case, a separate call to `initialize()` is not needed.
+
+        Args:
+            instance_name (str): A short name given to this instance of the SzConfig object, to help identify it within system logs.
+            settings (Union[str, Dict[Any, Any]]): A JSON string containing configuration parameters.
+            verbose_logging (int): `Optional:` A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfig/szconfig_initialize_and_destroy.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def import_config(
+        self, config_definition: Union[str, Dict[Any, Any]], **kwargs: Any
+    ) -> int:
+        """
+        The `import_config` method initializes an in-memory Senzing SzConfig object from a JSON string.
+        A handle is returned to identify the in-memory configuration.
+        The handle is used by the `add_data_source`, `get_data_sources`,
+        `delete_data_source`, and `save` methods.
+        The handle is terminated by the `close` method.
+
+        Args:
+            config_definition (Union[str, Dict[Any, Any]]): A JSON document containing the Senzing configuration.
+
+        Returns:
+            int: An identifier (config_handle) of an in-memory configuration.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfig/import_config.py
+                :linenos:
+                :language: python
+
+            **Create, save, load, and close**
+
+            .. literalinclude:: ../../examples/szconfig/create_export_import_close.py
+                :linenos:
+                :language: python
+        """

+

+
+
+    # -------------------------------------------------------------------------
+    # Convenience methods
+    # -------------------------------------------------------------------------
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/senzing_abstract/szconfigmanager_abstract.html b/_modules/senzing_abstract/szconfigmanager_abstract.html new file mode 100644 index 0000000..ef94d04 --- /dev/null +++ b/_modules/senzing_abstract/szconfigmanager_abstract.html @@ -0,0 +1,371 @@ + + + + + + senzing_abstract.szconfigmanager_abstract — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Module code
    • +
  • senzing_abstract.szconfigmanager_abstract
    • +
  • +
    • +
+
+
+
+
+ +

Source code for senzing_abstract.szconfigmanager_abstract

+#! /usr/bin/env python3
+
+"""
+szconfigmanager_abstract.py is the abstract class for all implementations of szconfigmanager.
+"""
+
+# TODO: Determine specific SzErrors, Errors for "Raises:" documentation.
+
+from abc import ABC, abstractmethod
+from typing import Any, Dict, Union
+
+# Metadata
+
+__all__ = ["SzConfigManagerAbstract"]
+__version__ = "0.0.1"  # See https://www.python.org/dev/peps/pep-0396/
+__date__ = "2023-10-30"
+__updated__ = "2023-11-08"
+
+# -----------------------------------------------------------------------------
+# SzConfigManagerAbstract
+# -----------------------------------------------------------------------------
+
+
+

+[docs]
+class SzConfigManagerAbstract(ABC):
+    """
+    SzConfigManagerAbstract is the definition of the Senzing Python API that is
+    implemented by packages such as szconfigmanager.py.
+    """
+
+    # -------------------------------------------------------------------------
+    # Messages
+    # -------------------------------------------------------------------------
+
+    PREFIX = "szconfigmanager."
+    ID_MESSAGES = {
+        4001: PREFIX + "add_config({0}, {1}) failed. Return code: {2}",
+        4002: PREFIX + "destroy() failed. Return code: {0}",
+        4003: PREFIX + "get_config({0}) failed. Return code: {1}",
+        4004: PREFIX + "get_config_list() failed. Return code: {0}",
+        4005: PREFIX + "get_default_config_id() failed. Return code: {0}",
+        4006: PREFIX + "initialize({0}, {1}, {2}) failed. Return code: {3}",
+        4007: PREFIX + "replace_default_config_id({0}, {1}) failed. Return code: {2}",
+        4008: PREFIX + "set_default_config_id({0}) failed. Return code: {1}",
+        4009: PREFIX
+        + "SzConfigManager({0}, {1}) failed. instance_name and settings must both be set or both be empty",
+    }
+
+    # -------------------------------------------------------------------------
+    # Interface definition
+    # -------------------------------------------------------------------------
+
+

+[docs]
+    @abstractmethod
+    def add_config(
+        self,
+        config_definition: Union[str, Dict[Any, Any]],
+        config_comment: str,
+        **kwargs: Any
+    ) -> int:
+        """
+        The `add_config` method adds a Senzing configuration JSON document to the Senzing database.
+
+        Args:
+            config_definition (Union[str, Dict[Any, Any]]): The Senzing configuration JSON document.
+            config_comment (str):  free-form string of comments describing the configuration document.
+
+        Returns:
+            int: A configuration identifier.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfigmanager/add_config.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def destroy(self, **kwargs: Any) -> None:
+        """
+        The `destroy` method will destroy and perform cleanup for the Senzing SzConfigManager object.
+        It should be called after all other calls are complete.
+
+        **Note:** If the `SzConfigManager` constructor was called with parameters,
+        the destructor will automatically call the destroy() method.
+        In this case, a separate call to `destroy()` is not needed.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfigmanager/szconfigmanager_initialize_and_destroy.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_config(self, config_id: int, **kwargs: Any) -> str:
+        """
+        The `get_config` method retrieves a specific Senzing configuration JSON document from the Senzing database.
+
+        Args:
+            config_id (int): The configuration identifier of the desired Senzing Engine configuration JSON document to retrieve.
+
+        Returns:
+            str: A JSON document containing the Senzing configuration.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfigmanager/get_config.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szconfigmanager/get_config.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_config_list(self, **kwargs: Any) -> str:
+        """
+        The `get_config_list` method retrieves a list of Senzing configurations from the Senzing database.
+
+        Returns:
+            str: A JSON document containing Senzing configurations.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfigmanager/get_config_list.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szconfigmanager/get_config_list.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_default_config_id(self, **kwargs: Any) -> int:
+        """
+        The `get_default_config_id` method retrieves from the Senzing database the configuration identifier of the default Senzing configuration.
+
+        Returns:
+            int:  A configuration identifier which identifies the current configuration in use.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfigmanager/get_default_config_id.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def initialize(
+        self,
+        instance_name: str,
+        settings: Union[str, Dict[Any, Any]],
+        verbose_logging: int = 0,
+        **kwargs: Any
+    ) -> None:
+        """
+        The `initialize` method initializes the Senzing SzConfigManager object.
+        It must be called prior to any other calls.
+
+        **Note:** If the SzConfigManager constructor is called with parameters,
+        the constructor will automatically call the `initialize()` method.
+        In this case, a separate call to `initialize()` is not needed.
+
+        Args:
+            instance_name (str): A short name given to this instance of the SzProduct object, to help identify it within system logs.
+            settings (Union[str, Dict[Any, Any]]): A JSON string containing configuration parameters.
+            verbose_logging (int): `Optional:` A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfigmanager/szconfigmanager_initialize_and_destroy.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def replace_default_config_id(
+        self, current_default_config_id: int, new_default_config_id: int, **kwargs: Any
+    ) -> None:
+        """
+        The `replace_default_config_id` method replaces the old configuration identifier with a new configuration identifier in the Senzing database.
+        It is like a "compare-and-swap" instruction to serialize concurrent editing of configuration.
+        If `current_default_config_id` is no longer the "current configuration identifier", the operation will fail.
+        To simply set the default configuration ID, use `set_default_config_id`.
+
+        Args:
+            current_default_config_id (int): The configuration identifier to replace.
+            new_default_config_id (int): The configuration identifier to use as the default.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfigmanager/replace_default_config_id.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def set_default_config_id(self, config_id: int, **kwargs: Any) -> None:
+        """
+        The `set_default_config_id` method replaces the sets a new configuration identifier in the Senzing database.
+        To serialize modifying of the configuration identifier, see `replace_default_config_id`.
+
+        Args:
+            config_id (int): The configuration identifier of the Senzing Engine configuration to use as the default.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szconfigmanager/set_default_config_id.py
+                :linenos:
+                :language: python
+        """

+

+
+
+    # -------------------------------------------------------------------------
+    # Convenience methods
+    # -------------------------------------------------------------------------
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/senzing_abstract/szdiagnostic_abstract.html b/_modules/senzing_abstract/szdiagnostic_abstract.html new file mode 100644 index 0000000..425a67e --- /dev/null +++ b/_modules/senzing_abstract/szdiagnostic_abstract.html @@ -0,0 +1,316 @@ + + + + + + senzing_abstract.szdiagnostic_abstract — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Module code
    • +
  • senzing_abstract.szdiagnostic_abstract
    • +
  • +
    • +
+
+
+
+
+ +

Source code for senzing_abstract.szdiagnostic_abstract

+#! /usr/bin/env python3
+
+"""
+TODO: szdiagnostic_abstract.py
+"""
+
+from abc import ABC, abstractmethod
+from typing import Any, Dict, Optional, Union
+
+# Metadata
+
+__all__ = ["SzDiagnosticAbstract"]
+__version__ = "0.0.1"  # See https://www.python.org/dev/peps/pep-0396/
+__date__ = "2023-10-30"
+__updated__ = "2023-10-30"
+
+# -----------------------------------------------------------------------------
+# SzDiagnosticAbstract
+# -----------------------------------------------------------------------------
+
+
+

+[docs]
+class SzDiagnosticAbstract(ABC):
+    """
+    Senzing diagnostic module access library
+    """
+
+    # -------------------------------------------------------------------------
+    # Messages
+    # -------------------------------------------------------------------------
+
+    PREFIX = "szdiagnostic."
+    ID_MESSAGES = {
+        4001: PREFIX + "check_datastore_performance({0}) failed. Return code: {1}",
+        4002: PREFIX + "destroy() failed. Return code: {0}",
+        4003: PREFIX + "get_datastore_info() failed. Return code: {0}",
+        4004: PREFIX + "get_feature({0}) failed. Return code: {1}",
+        4005: PREFIX + "initialize({0}, {1}, {2}, {3}) failed. Return code: {4}",
+        4006: PREFIX + "purge_repository() failed. Return code: {0}",
+        4007: PREFIX + "reinitialize({0}) failed. Return Code: {1}",
+        4008: PREFIX
+        + "SzDiagnostic({0}, {1}) failed. instance_name and settings must both be set or both be empty",
+    }
+
+    # -------------------------------------------------------------------------
+    # Interface definition
+    # -------------------------------------------------------------------------
+
+

+[docs]
+    @abstractmethod
+    def check_datastore_performance(self, seconds_to_run: int, **kwargs: Any) -> str:
+        """
+        The `check_datastore_performance` method performs inserts to determine rate of insertion.
+
+        Args:
+            seconds_to_run (int): Duration of the test in seconds.
+
+        Returns:
+            str: A string containing a JSON document.
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+            szexception.SzError:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szdiagnostic/check_datastore_performance.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szdiagnostic/check_datastore_performance.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def destroy(self, **kwargs: Any) -> None:
+        """
+        The `destroy` method will destroy and perform cleanup for the Senzing SzDiagnostic object.
+        It should be called after all other calls are complete.
+
+        **Note:** If the `SzDiagnostic` constructor was called with parameters,
+        the destructor will automatically call the destroy() method.
+        In this case, a separate call to `destroy()` is not needed.
+
+        Raises:
+            szexception.SzError:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szdiagnostic/szdiagnostic_initialize_and_destroy.py
+                :linenos:
+                :language: python
+        """

+
+
+    # TODO docstring
+

+[docs]
+    @abstractmethod
+    def get_datastore_info(self, **kwargs: Any) -> str:
+        """
+        The `get_datastore_info` method will...
+
+        Raises:
+            szexception.SzError:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szdiagnostic/get_datastore_info.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szdiagnostic/get_datastore_info.txt
+                :linenos:
+                :language: json
+        """

+
+
+    # NOTE This is included but not to be documented
+

+[docs]
+    @abstractmethod
+    def get_feature(self, feature_id: int, **kwargs: Any) -> str:
+        """"""

+
+
+

+[docs]
+    @abstractmethod
+    def initialize(
+        self,
+        instance_name: str,
+        settings: Union[str, Dict[Any, Any]],
+        config_id: Optional[int] = None,
+        verbose_logging: int = 0,
+        **kwargs: Any
+    ) -> None:
+        """
+        The `initialize` method initializes the Senzing SzDiagnosis object.
+        It must be called prior to any other calls.
+
+        **Note:** If the Sz Diagnosis constructor is called with parameters,
+        the constructor will automatically call the `initialize()` method.
+        In this case, a separate call to `initialize()` is not needed.
+
+        Args:
+            instance_name (str): A name for the auditing node, to help identify it within system logs.
+            settings (Union[str, Dict[Any, Any]]): A JSON string containing configuration parameters.
+            config_id (int): `Optional:` Initialize with a specific configuration ID and not the current default.
+            verbose_logging (int): `Optional:` A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+            szexception.SzError:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szdiagnostic/szdiagnostic_initialize_and_destroy.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def purge_repository(self, **kwargs: Any) -> None:
+        """
+        **Warning:**
+        The `purge_repository` method removes every record in the Senzing repository.
+
+        Before calling `purge_repository` all other instances of the Senzing API
+        MUST be destroyed or shutdown.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szdiagnostic/purge_repository.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def reinitialize(self, config_id: int, **kwargs: Any) -> None:
+        """
+        The `reinitialize` method re-initializes the Senzing SzDiagnostic object.
+
+        Args:
+            config_id (int): The configuration ID used for the initialization
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+            szexception.SzError: config_id does not exist.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szdiagnostic/szdiagnostic_reinitialize.py
+                :linenos:
+                :language: python
+        """

+

+
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/senzing_abstract/szengine_abstract.html b/_modules/senzing_abstract/szengine_abstract.html new file mode 100644 index 0000000..3fbed68 --- /dev/null +++ b/_modules/senzing_abstract/szengine_abstract.html @@ -0,0 +1,1682 @@ + + + + + + senzing_abstract.szengine_abstract — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Module code
    • +
  • senzing_abstract.szengine_abstract
    • +
  • +
    • +
+
+
+
+
+ +

Source code for senzing_abstract.szengine_abstract

+#! /usr/bin/env python3
+
+"""
+TODO: szengine_abstract.py
+"""
+
+# pylint: disable=C0302
+# AC - Temp disables to get changes in for move to senzing garage
+# pylint: disable=W0511,W1113
+
+
+# Import from standard library. https://docs.python.org/3/library/
+
+import json
+from abc import ABC, abstractmethod
+from typing import Any, Dict, List, Optional, Union, cast
+
+from .szengineflags import SzEngineFlags
+
+# Metadata
+
+# __all__ = ["SzEngineAbstract", "WithInfoResponsesAbstract"]
+__all__ = ["SzEngineAbstract"]
+__version__ = "0.0.1"  # See https://www.python.org/dev/peps/pep-0396/
+__date__ = "2023-10-30"
+__updated__ = "2023-10-30"
+
+
+# -------------------------------------------------------------------------
+# Classes
+# -------------------------------------------------------------------------
+
+
+

+[docs]
+class SzEngineAbstract(ABC):
+    """
+    Senzing engine module access library
+    """
+
+    # -------------------------------------------------------------------------
+    # Messages
+    # -------------------------------------------------------------------------
+
+    PREFIX = "szengine."
+    """ :meta private: """
+
+    ID_MESSAGES = {
+        4001: PREFIX + "add_record({0}, {1}, {2}, {3}) failed. Return code: {4}",
+        4002: PREFIX + "close_export() failed. Return code: {0}",
+        4003: PREFIX + "count_redo_records() failed. Return code: {0}",
+        4004: PREFIX + "delete_record({0}, {1}, {2}) failed. Return code: {3}",
+        4005: PREFIX + "destroy() failed. Return code: {0}",
+        4006: PREFIX + "export_csv_entity_report({0}, {1}) failed. Return code: {2}",
+        4007: PREFIX + "export_json_entity_report({0}) failed. Return code: {1}",
+        4008: PREFIX + "fetch_next({0}) failed. Return code: {1}",
+        # NOTE Included but not documented or examples, early adaptor feature, needs manual additions to config
+        4009: PREFIX
+        + "find_interesting_entities_by_entity_id({0}, {1}) failed. Return code: {2}",
+        # NOTE Included but not documented or examples, early adaptor feature, needs manual additions to config
+        4010: (
+            PREFIX
+            + "find_interesting_entities_by_record_id({0}, {1}, {2}) failed. Return"
+            " code: {3}"
+        ),
+        4011: (
+            PREFIX
+            + "find_network_by_entity_id({0}, {1}, {2}, {3}, {4}) failed. Return code: {5}"
+        ),
+        4012: (
+            PREFIX
+            + "find_network_by_record_id({0}, {1}, {2}, {3}, {4}) failed. Return code: {5}"
+        ),
+        4013: PREFIX
+        + "find_path_by_entity_id({0}, {1}, {2}, {3}, {4}, {5}) failed. Return code: {6}",
+        4014: PREFIX
+        + "find_path_by_record_id({0}, {1}, {2}, {3}, {4}, {5}, {6}, {7}) failed. Return code: {8}",
+        4015: PREFIX + "get_active_config_id() failed. Return code: {0}",
+        4016: PREFIX + "get_entity_by_entity_id({0}, {1}) failed. Return code: {2}",
+        4017: PREFIX
+        + "get_entity_by_record_id({0}, {1}, {3}) failed. Return code: {4}",
+        4018: PREFIX + "get_record({0}, {1}, {2}) failed. Return code: {3}",
+        4019: PREFIX + "get_redo_record() failed. Return code: {0}",
+        4020: PREFIX + "get_repository_last_modified_time() failed. Return code: {0}",
+        4021: PREFIX + "get_stats() failed. Return code: {0}",
+        4022: PREFIX + "get_virtual_entity_by_record_id({0}) failed. Return code: {1}",
+        4023: PREFIX + "how_entity_by_entity_id({0}) failed. Return code: {1}",
+        4024: PREFIX + "initialize({0}, {1}, {2}, {3}) failed. Return code: {4}",
+        4025: PREFIX + "prime_engine() failed. Return code: {0}",
+        4026: PREFIX + "process_redo_record({0}, {1}) failed. Return code: {2}",
+        4027: PREFIX + "reevaluate_entity({0}, {1}) failed. Return code: {2}",
+        4028: PREFIX + "reevaluate_record({0}, {1}, {2}) failed. Return code: {3}",
+        4029: PREFIX + "reinitialize({0}) failed. Return code: {1}",
+        4030: PREFIX + "search_by_attributes({0}) failed. Return code: {1}",
+        4031: PREFIX + "why_entities({0}, {1}) failed. Return code: {2}",
+        4032: PREFIX + "why_records({0}, {1}, {2}, {3}, {4}) failed. Return code: {5}",
+        4033: PREFIX + "why_record_in_entity{0}, {1}, {2}) failed. Return code: {3}",
+        4034: (
+            PREFIX
+            + "SzEngine({0}, {1}) failed. instance_name and settings must both be set or"
+            " both be empty"
+        ),
+    }
+    """ :meta private: """
+
+    # -------------------------------------------------------------------------
+    # Interface definition
+    # -------------------------------------------------------------------------
+
+

+[docs]
+    @abstractmethod
+    def add_record(
+        self,
+        data_source_code: str,
+        record_id: str,
+        record_definition: Union[str, Dict[Any, Any]],
+        flags: int = 0,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `add_record` method adds a record into the Senzing repository.
+        Can be called as many times as desired and from multiple threads at the same time.
+
+        Args:
+            data_source_code (str): Identifies the provenance of the data.
+            record_id (str): The unique identifier within the records of the same data source.
+            record_definition (str | Dict): A JSON document containing the record to be added to the Senzing repository.
+            flags (int, optional): Flags used to control information returned. Defaults to 0.
+
+        Returns:
+            str: If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/add_record.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/add_record.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def close_export(self, export_handle: int, **kwargs: Any) -> None:
+        """
+        The `close_export` method closes the exported document created by `export_json_entity_report`.
+        It is part of the `export_json_entity_report`, `fetch_next`, `close_export`
+        lifecycle of a list of sized entities.
+
+        Args:
+            export_handle (int): A handle created by `export_json_entity_report` or `export_csv_entity_report`.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/export_json_fetch_close.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/export_json_fetch_close.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def count_redo_records(self, **kwargs: Any) -> int:
+        """
+        The `count_redo_records` method returns the number of records in need of redo-ing.
+
+        Returns:
+            int: The number of redo records in Senzing's redo queue.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/count_redo_records.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/count_redo_records.txt
+                :linenos:
+                :language: guess
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def delete_record(
+        self,
+        data_source_code: str,
+        record_id: str,
+        flags: int = 0,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `delete_record` method deletes a record from the Senzing repository.
+        Can be called as many times as desired and from multiple threads at the same time.
+
+        Args:
+            data_source_code (str): Identifies the provenance of the data.
+            record_id (str): The unique identifier within the records of the same data source.
+            load_id (str, optional): An identifier used to distinguish different load batches/sessions. An empty string is acceptable. Defaults to "".
+            flags (int, optional): Flags used to control information returned. Defaults to 0.
+
+        Returns:
+            str: If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/delete_record.py
+                :linenos:
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/delete_record.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def destroy(self, **kwargs: Any) -> None:
+        """
+        The `destroy` method releases resources and performs cleanup for the SzEngine object and any in-memory configurations.
+        It should be called after all other calls are complete.
+
+        **Note:** If the `SzEngine` constructor was called with parameters,
+        the destructor will automatically call the destroy() method.
+        In this case, a separate call to `destroy()` is not needed.
+
+        Raises:
+            szexception.SzError:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/szengine_initialize_and_destroy.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def export_csv_entity_report(
+        self,
+        csv_column_list: str,
+        flags: int = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> int:
+        # TODO Add into docstring a good default csv_column_list example
+        """
+        **Warning:** `export_csv_entity_report` is not recommended for large systems as it does not scale.
+        It is recommended larger systems implement real-time replication to a data warehouse.
+
+        The `export_csv_entity_report` method initializes a cursor over a document of exported entities.
+        It is part of the `export_csv_entity_report`, `fetch_next`, `close_export`
+        lifecycle of a list of entities to export.
+
+        Args:
+            csv_column_list (str): A comma-separated list of column names for the CSV export.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS.
+
+        Returns:
+            int: A handle that identifies the document to be scrolled through using `fetch_next`.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/export_csv_fetch_close.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/export_csv_fetch_close.txt
+                :linenos:
+                :language: guess
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def export_json_entity_report(
+        self, flags: int = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS, **kwargs: Any
+    ) -> int:
+        """
+        **Warning:** `export_json_entity_report` is not recommended for large systems as it does not scale.
+        It is recommended larger systems implement real-time replication to a data warehouse.
+
+        The `export_json_entity_report` method initializes a cursor over a document of exported entities.
+        It is part of the `export_json_entity_report`, `fetch_next`, `close_export`
+        lifecycle of a list of entities to export.
+
+        Args:
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS.
+
+        Returns:
+            int: A handle that identifies the document to be scrolled through using `fetch_next`.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/export_json_fetch_close.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/export_json_fetch_close.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def fetch_next(self, export_handle: int, **kwargs: Any) -> str:
+        """
+        The `fetch_next` method is used to scroll through an exported document one entity at a time.
+        Successive calls of `fetch_next` will export successive rows of entity data until there is no more.
+        It is part of the `export_json_entity_report` or `export_json_entity_report`, `fetch_next`, `close_export`
+        lifecycle of a list of exported entities.
+
+        Args:
+            response_handle (int): A handle created by `export_json_entity_report` or `export_json_entity_report`.
+
+        Returns:
+            str: TODO:
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/export_json_fetch_close.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/export_json_fetch_close.txt
+                :linenos:
+                :language: json
+        """

+
+
+    # NOTE Included but not to be documented or examples, early adaptor feature, needs manual additions to config
+

+[docs]
+    @abstractmethod
+    def find_interesting_entities_by_entity_id(
+        self, entity_id: int, flags: int = 0, **kwargs: Any
+    ) -> str:
+        """"""

+
+
+    # NOTE Included but not to be documented or examples, early adaptor feature, needs manual additions to config
+

+[docs]
+    @abstractmethod
+    def find_interesting_entities_by_record_id(
+        self, data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any
+    ) -> str:
+        """"""

+
+
+

+[docs]
+    @abstractmethod
+    def find_network_by_entity_id(
+        self,
+        entity_list: Union[str, Dict[str, List[Dict[str, int]]]],
+        max_degrees: int,
+        build_out_degree: int,
+        max_entities: int,
+        flags: int = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `find_network_by_entity_id` method finds all entities surrounding a requested set of entities.
+        This includes the requested entities, paths between them, and relations to other nearby entities.
+        Returns a JSON document that identifies the path between the each set of search entities (if the path exists),
+        and the information for the entities in the path.
+
+        Args:
+            entity_list (str): A JSON document listing entities.
+            max_degrees (int): The maximum number of degrees in paths between search entities.
+            build_out_degree (int): The number of degrees of relationships to show around each search entity.
+            max_entities (int): The maximum number of entities to return in the discovered network.
+            flags (int, optional): The maximum number of entities to return in the discovered network. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/find_network_by_entity_id.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/find_network_by_entity_id.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def find_network_by_record_id(
+        self,
+        record_list: Union[str, Dict[str, List[Dict[str, str]]]],
+        max_degrees: int,
+        build_out_degree: int,
+        max_entities: int,
+        flags: int = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `find_network_by_record_id` method finds all entities surrounding a requested set of entities by their RECORD_ID values.
+        This includes the requested entities, paths between them, and relations to other nearby entities.
+        Returns a JSON document that identifies the path between the each set of search entities (if the path exists),
+        and the information for the entities in the path.
+
+        Args:
+            record_list (str): A JSON document listing records.
+            max_degrees (int): The maximum number of degrees in paths between search entities.
+            build_out_degree (int): The number of degrees of relationships to show around each search entity.
+            max_entities (int): The maximum number of entities to return in the discovered network.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/find_network_by_record_id.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/find_network_by_record_id.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def find_path_by_entity_id(
+        self,
+        start_entity_id: int,
+        end_entity_id: int,
+        max_degrees: int,
+        # TODO Should accept both entity and record IDs in V4, test
+        exclusions: Union[str, Dict[Any, Any]] = "",
+        required_data_sources: Union[str, Dict[Any, Any]] = "",
+        flags: int = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `find_path_by_entity_id` method finds the most efficient relationship between two entities path based on the parameters
+        and returns a JSON document with an ENTITY_PATHS section that details the path between the entities.
+        The ENTITIES sections details information on the entities. Paths are found using known relationships with other entities.
+        Paths are found using known relationships with other entities.
+
+        Args:
+            start_entity_id (int): The entity ID for the starting entity of the search path.
+            end_entity_id (int): The entity ID for the ending entity of the search path.
+            max_degrees (int): The maximum number of degrees in paths between search entities.
+            exclusions (str): TODO
+            required_data_sources (str): TODO
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document with an ENTITY_PATHS section that details the path between the entities.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/find_path_by_entity_id.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/find_path_by_entity_id.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def find_path_by_record_id(
+        self,
+        start_data_source_code: str,
+        start_record_id: str,
+        end_data_source_code: str,
+        end_record_id: str,
+        max_degrees: int,
+        exclusions: Union[str, Dict[Any, Any]] = "",
+        required_data_sources: Union[str, Dict[Any, Any]] = "",
+        flags: int = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `find_path_by_record_id` method finds the most efficient relationship between
+        two entities path based on the parameters by RECORD_ID values
+        and returns a JSON document with an ENTITY_PATHS section that details the path between the entities.
+        The ENTITIES sections details information on the entities.
+        Paths are found using known relationships with other entities.
+        The entities are identified by starting and ending records.
+
+        Args:
+            start_data_source_code (str): Identifies the provenance of the record for the starting entity of the search path.
+            start_record_id (str): The unique identifier within the records of the same data source for the starting entity of the search path.
+            end_data_source_code (str): Identifies the provenance of the record for the ending entity of the search path.
+            end_record_id (str): The unique identifier within the records of the same data source for the ending entity of the search path.
+            max_degrees (int): The maximum number of degrees in paths between search entities.
+            exclusions (str): TODO
+            required_data_sources (str): TODO
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/find_path_by_record_id.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/find_path_by_record_id.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_active_config_id(self, **kwargs: Any) -> int:
+        """
+        The `get_active_config_id` method returns the identifier of the currently active Senzing engine configuration.
+
+        Returns:
+            int: The identifier of the active Senzing Engine configuration.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/get_active_config_id.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/get_active_config_id.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_entity_by_entity_id(
+        self,
+        entity_id: int,
+        flags: int = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `get_entity_by_entity_id` method returns entity data based on the ID of a resolved identity.
+
+        Args:
+            entity_id (int): The unique identifier of an entity.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/get_entity_by_entity_id.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/get_entity_by_entity_id.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_entity_by_record_id(
+        self,
+        data_source_code: str,
+        record_id: str,
+        flags: int = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `get_entity_by_record_id` method returns entity data based on the ID of a record which is a member of the entity.
+
+        Args:
+            data_source_code (str): Identifies the provenance of the data.
+            record_id (str): The unique identifier within the records of the same data source.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/get_entity_by_record_id.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/get_entity_by_record_id.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_record(
+        self,
+        data_source_code: str,
+        record_id: str,
+        flags: int = SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `get_record` method returns a JSON document of a single record from the Senzing repository.
+        Can be called as many times as desired and from multiple threads at the same time.
+
+        Args:
+            data_source_code (str): Identifies the provenance of the data.
+            record_id (str): The unique identifier within the records of the same data source.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document of a single record.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/get_record.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/get_record.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_redo_record(self, **kwargs: Any) -> str:
+        """
+        The `get_redo_record` method returns the next internally queued redo record from the Senzing repository.
+        Usually, the `process_redo_record` or `process_redo_record_with_info` method is called to process the redo record
+        retrieved by `get_redo_record`.
+
+        Returns:
+            str: A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/get_redo_record.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/get_redo_record.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_repository_last_modified_time(self, **kwargs: Any) -> int:
+        """
+        The `get_repository_last_modified_time` method retrieves the last modified time of the Senzing repository,
+        measured in the number of seconds between the last modified time and January 1, 1970 12:00am GMT (epoch time).
+
+        Returns:
+            int: A Unix Timestamp.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/get_repository_last_modified_time.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/get_repository_last_modified_time.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_stats(self, **kwargs: Any) -> str:
+        """
+        The `get_stats` method retrieves workload statistics for the current process.
+        These statistics will automatically reset after retrieval.
+
+        Returns:
+            str:  A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/get_stats.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/get_stats.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_virtual_entity_by_record_id(
+        self,
+        record_list: Union[str, Dict[Any, Any]],
+        flags: int = SzEngineFlags.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `get_virtual_entity_by_record_id` method creates a view of a virtual entity
+        using a list of existing loaded records.
+        The virtual entity is composed of only those records and their features.
+        Entity resolution is not performed.
+
+        Args:
+            record_list (str): A JSON document of one or more records by DATA_SOURCE and RECORD_ID pairs, formatted as `{"RECORDS":[{"DATA_SOURCE":"DS1","RECORD_ID":"R1"},{"DATA_SOURCE":"DS2","RECORD_ID":"R2"}]}`.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS.
+
+        Returns:
+            str:  A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/get_virtual_entity_by_record_id.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/get_virtual_entity_by_record_id.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def how_entity_by_entity_id(
+        self,
+        entity_id: int,
+        flags: int = SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `how_entity_by_entity_id` method determines and details steps-by-step *how* records resolved to an ENTITY_ID.
+
+        In most cases, *how* provides more detailed information than *why* as the resolution is detailed step-by-step.
+
+        Args:
+            entity_id (int): The unique identifier of an entity.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/how_entity_by_entity_id.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/how_entity_by_entity_id.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def initialize(
+        self,
+        instance_name: str,
+        settings: Union[str, Dict[Any, Any]],
+        config_id: Optional[int] = None,
+        verbose_logging: int = 0,
+        **kwargs: Any,
+    ) -> None:
+        # TODO docstring plugin
+        """
+        he ``initialize`` method initializes the Senzing SzEngine object.
+        It must be called prior to any other calls.
+
+        **Note:** If the SzEngine constructor is called with parameters,
+        the constructor will automatically call the ``initialize()`` method.
+        In this case, a separate call to ``initialize()`` is not needed.
+
+        Args:
+            instance_name (str): A short name given to this instance of the SzEngine object, to help identify it within system logs.
+            settings (str): A JSON string containing configuration parameters.
+            config_id (int):
+            verbose_logging (int): `Optional:` A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/szengine_initialize_and_destroy.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def prime_engine(self, **kwargs: Any) -> None:
+        """
+        The `prime_engine` method initializes high resource consumption components of Senzing
+        used in some functions. If this call is not made, these resources are initialized the
+        first time they are needed and can cause unusually long processing times the first time
+        a function is called that requires these resources.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/prime_engine.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def process_redo_record(self, redo_record: str, flags: int, **kwargs: Any) -> str:
+        """
+        #TODO The `process_redo_record` method...
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/process_redo_record.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/process_redo_record.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def reevaluate_entity(self, entity_id: int, flags: int = 0, **kwargs: Any) -> str:
+        """
+        The `reevaluate_entity` method reevaluates the specified entity.
+
+        Args:
+            entity_id (int): The unique identifier of an entity.
+            flags (int, optional): Flags used to control information returned. Defaults to 0.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/reevaluate_entity.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/reevaluate_entity.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def reevaluate_record(
+        self, data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any
+    ) -> str:
+        """
+        The `reevaluate_record` method reevaluates a specific record.
+
+        Args:
+            data_source_code (str): Identifies the provenance of the data.
+            record_id (str): The unique identifier within the records of the same data source.
+            flags (int, optional):  Flags used to control information returned. Defaults to 0.
+
+        Returns:
+            str: If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/reevaluate_record.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/reevaluate_record.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def reinitialize(self, config_id: int, **kwargs: Any) -> None:
+        """
+        The `reinitialize` method reinitializes the Senzing SzEngine object using a specific configuration
+        identifier. A list of available configuration identifiers can be retrieved using
+        `szconfigmanager.get_config_list`.
+
+        Args:
+            config_id (int): The configuration ID used for the initialization
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+            szexception.SzError: config_id does not exist.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/szengine_reinitialize.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def search_by_attributes(
+        self,
+        attributes: Union[str, Dict[Any, Any]],
+        search_profile: str = "",
+        flags: int = SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `search_by_attributes` method retrieves entity data based on a user-specified set of entity attributes.
+
+        Args:
+            attributes (str):  A JSON document with the attribute data to search for.
+            search_profile (str): The name of a configured search profile. Defaults to SEARCH.
+            flags (int, optional): _description_. Defaults to SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/search_by_attributes.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/search_by_attributes.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def why_entities(
+        self,
+        entity_id_1: int,
+        entity_id_2: int,
+        flags: int = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `why_entities` method determines why entities did not resolve or why they do relate.
+
+        Args:
+            entity_id_1 (int): The entity ID for the starting entity of the search path.
+            entity_id_2 (int): The entity ID for the ending entity of the search path.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/why_entities.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szengine/why_entities.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def why_record_in_entity(
+        self,
+        data_source_code: str,
+        record_id: str,
+        flags: int = SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `why_record_in_entity` ... TODO:
+
+        Args:
+            data_source_code (str): Identifies the provenance of the data.
+            record_id (str): The unique identifier within the records of the same data source.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/why_record_in_entity.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+        .. literalinclude:: ../../examples/szengine/why_record_in_entity.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def why_records(
+        self,
+        data_source_code_1: str,
+        record_id_1: str,
+        data_source_code_2: str,
+        record_id_2: str,
+        flags: int = SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> str:
+        """
+        The `why_records` determines if any two records can or cannot resolve together, or if they relate.
+
+        Args:
+            data_source_code_1 (str): Identifies the provenance of the data.
+            record_id_1 (str): The unique identifier within the records of the same data source.
+            data_source_code_2 (str): Identifies the provenance of the data.
+            record_id_2 (str): The unique identifier within the records of the same data source.
+            flags (int, optional): Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.
+
+        Returns:
+            str: A JSON document.
+
+        Raises:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szengine/why_records.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+        .. literalinclude:: ../../examples/szengine/why_records.txt
+                :linenos:
+                :language: json
+        """

+
+
+    # -------------------------------------------------------------------------
+    # Convenience methods
+    # -------------------------------------------------------------------------
+
+    # TODO doc strings for all return_dict methods it _return_dict methods are staying?
+

+[docs]
+    def add_record_return_dict(
+        self,
+        data_source_code: str,
+        record_id: str,
+        record_definition: Union[str, Dict[Any, Any]],
+        flags: int = 0,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """ """
+        return cast(
+            Dict[str, Any],
+            # TODO orjson?
+            json.loads(
+                self.add_record(
+                    data_source_code, record_id, record_definition, flags, **kwargs
+                )
+            ),
+        )

+
+
+

+[docs]
+    def delete_record_return_dict(
+        self,
+        data_source_code: str,
+        record_id: str,
+        flags: int = 0,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.delete_record(data_source_code, record_id, flags, **kwargs)
+            ),
+        )

+
+
+

+[docs]
+    def find_interesting_entities_by_entity_id_return_dict(
+        self, entity_id: int, flags: int = 0, **kwargs: Any
+    ) -> Dict[str, Any]:
+        """ """
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.find_interesting_entities_by_entity_id(entity_id, flags, **kwargs)
+            ),
+        )

+
+
+

+[docs]
+    def find_interesting_entities_by_record_id_return_dict(
+        self, data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any
+    ) -> Dict[str, Any]:
+        """T"""
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.find_interesting_entities_by_record_id(
+                    data_source_code, record_id, flags, **kwargs
+                )
+            ),
+        )

+
+
+

+[docs]
+    def find_network_by_entity_id_return_dict(
+        self,
+        entity_list: Union[str, Dict[Any, Any]],
+        max_degrees: int,
+        build_out_degree: int,
+        max_entities: int,
+        flags: int = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """TODO: document"""
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.find_network_by_entity_id(
+                    entity_list,
+                    max_degrees,
+                    build_out_degree,
+                    max_entities,
+                    flags,
+                    **kwargs,
+                )
+            ),
+        )

+
+
+

+[docs]
+    def find_network_by_record_id_return_dict(
+        self,
+        record_list: Union[str, Dict[Any, Any]],
+        max_degrees: int,
+        build_out_degree: int,
+        max_entities: int,
+        flags: int = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """TODO: document"""
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.find_network_by_record_id(
+                    record_list,
+                    max_degrees,
+                    build_out_degree,
+                    max_entities,
+                    flags,
+                    **kwargs,
+                )
+            ),
+        )

+
+
+

+[docs]
+    def find_path_by_entity_id_return_dict(
+        self,
+        start_entity_id: int,
+        end_entity_id: int,
+        max_degrees: int,
+        exclusions: Union[str, Dict[Any, Any]] = "",
+        required_data_sources: Union[str, Dict[Any, Any]] = "",
+        flags: int = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """TODO: document"""
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.find_path_by_entity_id(
+                    start_entity_id,
+                    end_entity_id,
+                    max_degrees,
+                    exclusions,
+                    required_data_sources,
+                    flags,
+                    **kwargs,
+                )
+            ),
+        )

+
+
+

+[docs]
+    def find_path_by_record_id_return_dict(
+        self,
+        start_data_source_code: str,
+        start_record_id: str,
+        end_data_source_code: str,
+        end_record_id: str,
+        max_degrees: int,
+        exclusions: Union[str, Dict[Any, Any]] = "",
+        required_data_sources: Union[str, Dict[Any, Any]] = "",
+        flags: int = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """ """
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.find_path_by_record_id(
+                    start_data_source_code,
+                    start_record_id,
+                    end_data_source_code,
+                    end_record_id,
+                    max_degrees,
+                    exclusions,
+                    required_data_sources,
+                    flags,
+                    **kwargs,
+                )
+            ),
+        )

+
+
+

+[docs]
+    def get_entity_by_entity_id_return_dict(
+        self,
+        entity_id: int,
+        flags: int = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """ """
+        return cast(
+            Dict[str, Any],
+            json.loads(self.get_entity_by_entity_id(entity_id, flags, **kwargs)),
+        )

+
+
+

+[docs]
+    def get_entity_by_record_id_return_dict(
+        self,
+        data_source_code: str,
+        record_id: str,
+        flags: int = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """ """
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.get_entity_by_record_id(
+                    data_source_code, record_id, flags, **kwargs
+                )
+            ),
+        )

+
+
+

+[docs]
+    def get_record_return_dict(
+        self,
+        data_source_code: str,
+        record_id: str,
+        flags: int = SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """ """
+        return cast(
+            Dict[str, Any],
+            json.loads(self.get_record(data_source_code, record_id, flags, **kwargs)),
+        )

+
+
+

+[docs]
+    def get_stats_return_dict(self, **kwargs: Any) -> Dict[str, Any]:
+        return cast(
+            Dict[str, Any],
+            json.loads(self.get_stats(**kwargs)),
+        )

+
+
+

+[docs]
+    def get_virtual_entity_by_record_id_return_dict(
+        self,
+        record_list: Union[str, Dict[Any, Any]],
+        flags: int = SzEngineFlags.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """ """
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.get_virtual_entity_by_record_id(record_list, flags, **kwargs)
+            ),
+        )

+
+
+

+[docs]
+    def how_entity_by_entity_id_return_dict(
+        self,
+        entity_id: int,
+        flags: int = SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """ """
+        return cast(
+            Dict[str, Any],
+            json.loads(self.how_entity_by_entity_id(entity_id, flags, **kwargs)),
+        )

+
+
+

+[docs]
+    def reevaluate_entity_return_dict(
+        self,
+        entity_id: int,
+        flags: int = 0,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """ """
+        return cast(
+            Dict[str, Any],
+            json.loads(self.reevaluate_entity(entity_id, flags, **kwargs)),
+        )

+
+
+

+[docs]
+    def reevaluate_record_return_dict(
+        self,
+        data_source_code: str,
+        record_id: str,
+        flags: int = 0,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """ """
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.reevaluate_record(data_source_code, record_id, flags, **kwargs)
+            ),
+        )

+
+
+

+[docs]
+    def search_by_attributes_return_dict(
+        self,
+        attributes: Union[str, Dict[Any, Any]],
+        search_profile: str = "SEARCH",
+        flags: int = SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """ """
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.search_by_attributes(attributes, search_profile, flags, **kwargs)
+            ),
+        )

+
+
+

+[docs]
+    def why_entities_return_dict(
+        self,
+        entity_id_1: int,
+        entity_id_2: int,
+        flags: int = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        return cast(
+            Dict[str, Any],
+            json.loads(self.why_entities(entity_id_1, entity_id_2, flags, **kwargs)),
+        )

+
+
+

+[docs]
+    def why_records_return_dict(
+        self,
+        data_source_code_1: str,
+        record_id_1: str,
+        data_source_code_2: str,
+        record_id_2: str,
+        flags: int = SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.why_records(
+                    data_source_code_1,
+                    record_id_1,
+                    data_source_code_2,
+                    record_id_2,
+                    flags,
+                    **kwargs,
+                )
+            ),
+        )

+
+
+

+[docs]
+    def why_record_in_entity_return_dict(
+        self,
+        data_source_code: str,
+        record_id: str,
+        flags: int = SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """ """
+        # TODO Is the cast needed?
+        return cast(
+            Dict[str, Any],
+            json.loads(
+                self.why_record_in_entity(data_source_code, record_id, flags, **kwargs)
+            ),
+        )

+

+
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/senzing_abstract/szengineflags.html b/_modules/senzing_abstract/szengineflags.html new file mode 100644 index 0000000..34f8d7d --- /dev/null +++ b/_modules/senzing_abstract/szengineflags.html @@ -0,0 +1,345 @@ + + + + + + senzing_abstract.szengineflags — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Module code
    • +
  • senzing_abstract.szengineflags
    • +
  • +
    • +
+
+
+
+
+ +

Source code for senzing_abstract.szengineflags

+#! /usr/bin/env python3
+
+"""
+TODO: szengineflags.py
+"""
+
+from enum import IntFlag
+from typing import Any, List
+
+# Metadata
+
+__all__ = ["SzEngineFlags"]
+__version__ = "0.0.1"  # See https://www.python.org/dev/peps/pep-0396/
+__date__ = "2023-10-30"
+__updated__ = "2023-10-30"
+
+# -----------------------------------------------------------------------------
+# SzEngineFlags class
+# -----------------------------------------------------------------------------
+
+
+

+[docs]
+class SzEngineFlags(IntFlag):
+    """Engine Flags ..."""
+
+

+[docs]
+    @classmethod
+    def combine_flags(
+        cls, list_of_strings: List[str], *args: Any, **kwargs: Any
+    ) -> int:
+        """OR together all strings in list_of_strings"""
+        # pylint: disable=unused-argument
+
+        result = 0
+        for string in list_of_strings:
+            result = result | SzEngineFlags[string]
+        return result

+
+
+    # Flags for exporting entity data.
+
+    SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES = 1 << 0
+    SZ_EXPORT_INCLUDE_POSSIBLY_SAME = 1 << 1
+    SZ_EXPORT_INCLUDE_POSSIBLY_RELATED = 1 << 2
+    SZ_EXPORT_INCLUDE_NAME_ONLY = 1 << 3
+    SZ_EXPORT_INCLUDE_DISCLOSED = 1 << 4
+    SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES = 1 << 5
+    SZ_EXPORT_INCLUDE_ALL_ENTITIES = (
+        SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES
+        | SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES
+    )
+    SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS = (
+        SZ_EXPORT_INCLUDE_POSSIBLY_SAME
+        | SZ_EXPORT_INCLUDE_POSSIBLY_RELATED
+        | SZ_EXPORT_INCLUDE_NAME_ONLY
+        | SZ_EXPORT_INCLUDE_DISCLOSED
+    )
+
+    # Flags for outputting entity relation data.
+
+    SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS = 1 << 6
+    SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS = 1 << 7
+    SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS = 1 << 8
+    SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS = 1 << 9
+    SZ_ENTITY_INCLUDE_ALL_RELATIONS = (
+        SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS
+        | SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS
+        | SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS
+        | SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS
+    )
+
+    # Flags for outputting entity feature data.
+
+    SZ_ENTITY_INCLUDE_ALL_FEATURES = 1 << 10
+    SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES = 1 << 11
+
+    # Flags for getting extra information about an entity.
+
+    SZ_ENTITY_INCLUDE_ENTITY_NAME = 1 << 12
+    SZ_ENTITY_INCLUDE_RECORD_SUMMARY = 1 << 13
+    SZ_ENTITY_INCLUDE_RECORD_TYPES = 1 << 28
+    SZ_ENTITY_INCLUDE_RECORD_DATA = 1 << 14
+    SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO = 1 << 15
+    SZ_ENTITY_INCLUDE_RECORD_JSON_DATA = 1 << 16
+    SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA = 1 << 31
+    SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS = 1 << 18
+    SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME = 1 << 19
+    SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO = 1 << 20
+    SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY = 1 << 21
+    SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA = 1 << 22
+
+    # Flags for extra feature data.
+
+    SZ_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES = 1 << 23
+    SZ_ENTITY_OPTION_INCLUDE_FEATURE_STATS = 1 << 24
+    SZ_ENTITY_OPTION_INCLUDE_FEATURE_ELEMENTS = 1 << 32
+
+    # Flags for extra matching data.
+
+    SZ_ENTITY_OPTION_INCLUDE_MATCH_KEY_DETAILS = 1 << 34
+
+    # Flags for finding entity path & network data.
+
+    SZ_FIND_PATH_PREFER_EXCLUDE = 1 << 25
+    SZ_FIND_PATH_MATCHING_INFO = 1 << 30
+    SZ_FIND_NETWORK_MATCHING_INFO = 1 << 33
+
+    # Flags for including search result information.
+
+    SZ_INCLUDE_FEATURE_SCORES = 1 << 26
+    SZ_SEARCH_INCLUDE_STATS = 1 << 27
+    SZ_SEARCH_INCLUDE_FEATURE_SCORES = SZ_INCLUDE_FEATURE_SCORES
+    SZ_SEARCH_INCLUDE_MATCH_KEY_DETAILS = SZ_ENTITY_OPTION_INCLUDE_MATCH_KEY_DETAILS
+
+    # Flag for returning with info responses.
+    SZ_WITH_INFO = 1 << 62
+
+    # Flags for exporting entity data.
+
+    SZ_SEARCH_INCLUDE_RESOLVED = SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES
+    SZ_SEARCH_INCLUDE_POSSIBLY_SAME = SZ_EXPORT_INCLUDE_POSSIBLY_SAME
+    SZ_SEARCH_INCLUDE_POSSIBLY_RELATED = SZ_EXPORT_INCLUDE_POSSIBLY_RELATED
+    SZ_SEARCH_INCLUDE_NAME_ONLY = SZ_EXPORT_INCLUDE_NAME_ONLY
+    SZ_SEARCH_INCLUDE_ALL_ENTITIES = (
+        SZ_SEARCH_INCLUDE_RESOLVED
+        | SZ_SEARCH_INCLUDE_POSSIBLY_SAME
+        | SZ_SEARCH_INCLUDE_POSSIBLY_RELATED
+        | SZ_SEARCH_INCLUDE_NAME_ONLY
+    )
+
+    # Recommended settings.
+
+    SZ_RECORD_DEFAULT_FLAGS = SZ_ENTITY_INCLUDE_RECORD_JSON_DATA
+
+    SZ_ENTITY_DEFAULT_FLAGS = (
+        SZ_ENTITY_INCLUDE_ALL_RELATIONS
+        | SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES
+        | SZ_ENTITY_INCLUDE_ENTITY_NAME
+        | SZ_ENTITY_INCLUDE_RECORD_SUMMARY
+        | SZ_ENTITY_INCLUDE_RECORD_DATA
+        | SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO
+        | SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME
+        | SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY
+        | SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO
+    )
+
+    SZ_ENTITY_BRIEF_DEFAULT_FLAGS = (
+        SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO
+        | SZ_ENTITY_INCLUDE_ALL_RELATIONS
+        | SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO
+    )
+
+    SZ_EXPORT_DEFAULT_FLAGS = (
+        SZ_EXPORT_INCLUDE_ALL_ENTITIES
+        # NOTE Check, was removed in 4.0.0.24095 - 2024_04_04__00_00
+        # NOTE There are changes in V4 to output messages and Jae is likely still working on them
+        # | SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS
+        | SZ_ENTITY_DEFAULT_FLAGS
+    )
+
+    SZ_FIND_PATH_DEFAULT_FLAGS = (
+        SZ_FIND_PATH_MATCHING_INFO
+        | SZ_ENTITY_INCLUDE_ENTITY_NAME
+        | SZ_ENTITY_INCLUDE_RECORD_SUMMARY
+    )
+
+    SZ_FIND_NETWORK_DEFAULT_FLAGS = (
+        SZ_FIND_NETWORK_MATCHING_INFO
+        | SZ_ENTITY_INCLUDE_ENTITY_NAME
+        | SZ_ENTITY_INCLUDE_RECORD_SUMMARY
+    )
+
+    SZ_WHY_ENTITIES_DEFAULT_FLAGS = (
+        SZ_ENTITY_DEFAULT_FLAGS
+        | SZ_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES
+        | SZ_ENTITY_OPTION_INCLUDE_FEATURE_STATS
+        | SZ_INCLUDE_FEATURE_SCORES
+    )
+
+    SZ_WHY_RECORDS_DEFAULT_FLAGS = (
+        SZ_ENTITY_DEFAULT_FLAGS
+        | SZ_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES
+        | SZ_ENTITY_OPTION_INCLUDE_FEATURE_STATS
+        | SZ_INCLUDE_FEATURE_SCORES
+    )
+
+    SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS = (
+        SZ_ENTITY_DEFAULT_FLAGS
+        | SZ_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES
+        | SZ_ENTITY_OPTION_INCLUDE_FEATURE_STATS
+        | SZ_INCLUDE_FEATURE_SCORES
+    )
+
+    SZ_HOW_ENTITY_DEFAULT_FLAGS = SZ_INCLUDE_FEATURE_SCORES
+
+    SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS = SZ_ENTITY_DEFAULT_FLAGS
+
+    SZ_SEARCH_BY_ATTRIBUTES_ALL = (
+        SZ_SEARCH_INCLUDE_ALL_ENTITIES
+        | SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES
+        | SZ_ENTITY_INCLUDE_ENTITY_NAME
+        | SZ_ENTITY_INCLUDE_RECORD_SUMMARY
+        | SZ_SEARCH_INCLUDE_FEATURE_SCORES
+    )
+
+    SZ_SEARCH_BY_ATTRIBUTES_STRONG = (
+        SZ_SEARCH_INCLUDE_RESOLVED
+        | SZ_SEARCH_INCLUDE_POSSIBLY_SAME
+        | SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES
+        | SZ_ENTITY_INCLUDE_ENTITY_NAME
+        | SZ_ENTITY_INCLUDE_RECORD_SUMMARY
+        | SZ_SEARCH_INCLUDE_FEATURE_SCORES
+    )
+
+    SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL = SZ_SEARCH_INCLUDE_ALL_ENTITIES
+
+    SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG = (
+        SZ_SEARCH_INCLUDE_RESOLVED | SZ_SEARCH_INCLUDE_POSSIBLY_SAME
+    )
+
+    SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS = SZ_SEARCH_BY_ATTRIBUTES_ALL
+
+    # -----------------------------------------------------------------------------
+    # non-SzEngineFlags flags
+    # -----------------------------------------------------------------------------
+
+    SZ_INITIALIZE_WITH_DEFAULT_CONFIGURATION = 0
+    SZ_NO_FLAGS = 0
+    SZ_NO_LOGGING = 0
+    SZ_VERBOSE_LOGGING = 1
+    SZ_WITHOUT_INFO = 0

+
+
+
+# -----------------------------------------------------------------------------
+# Additional default values
+# TODO:  Not sure if these values belong in this file.
+# -----------------------------------------------------------------------------
+
+SZ_NO_ATTRIBUTES = ""
+SZ_NO_EXCLUSIONS = ""
+SZ_NO_REQUIRED_DATASOURCES = ""
+SZ_NO_SEARCH_PROFILE = ""
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/senzing_abstract/szerror.html b/_modules/senzing_abstract/szerror.html new file mode 100644 index 0000000..a55c169 --- /dev/null +++ b/_modules/senzing_abstract/szerror.html @@ -0,0 +1,838 @@ + + + + + + senzing_abstract.szerror — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for senzing_abstract.szerror

+#! /usr/bin/env python3
+"""
+DO NOT EDIT.  This code is generated.
+Generated by: sz-sdk-errors/bin/generate_python.py
+Generated for: sz-sdk-python/src/senzing/szerrors.py
+Generated date: 2024-04-18T17:49:31.703116+00:00
+"""
+
+import datetime
+import json
+import threading
+import traceback
+from ctypes import c_char, create_string_buffer, sizeof
+from typing import Any, Callable, Dict
+
+# Metadata
+
+__all__ = [
+    "SzBadInputError",
+    "SzConfigurationError",
+    "SzDatabaseConnectionLostError",
+    "SzDatabaseError",
+    "SzError",
+    "SzLicenseError",
+    "SzNotFoundError",
+    "SzNotInitializedError",
+    "SzRetryableError",
+    "SzRetryTimeoutExceededError",
+    "SzUnhandledError",
+    "SzUnknownDataSourceError",
+    "SzUnrecoverableError",
+    "new_szexception",
+]
+__version__ = "0.0.1"  # See https://www.python.org/dev/peps/pep-0396/
+__date__ = "2023-10-30"
+__updated__ = "2023-10-30"
+
+
+# -----------------------------------------------------------------------------
+# Base SzError
+# -----------------------------------------------------------------------------
+
+
+

+[docs]
+class SzError(Exception):
+    """Base exception for Sz related python code."""

+
+
+
+# -----------------------------------------------------------------------------
+# Category exceptions
+# - These exceptions represent categories of actions that can be taken by
+#   the calling program.
+# -----------------------------------------------------------------------------
+
+
+

+[docs]
+class SzBadInputError(SzError):
+    """The user-supplied input contained an error."""

+
+
+
+

+[docs]
+class SzConfigurationError(SzError):
+    """The program can provide a remedy and continue."""

+
+
+
+

+[docs]
+class SzRetryableError(SzError):
+    """The program can provide a remedy and continue."""

+
+
+
+

+[docs]
+class SzUnrecoverableError(SzError):
+    """System failure, can't continue."""

+
+
+
+# -----------------------------------------------------------------------------
+# Detail exceptions for SzBadInputException
+# - Processing did not complete.
+# - These exceptions are "per record" exceptions.
+# - The record should be recorded as "bad".  (logged, queued as failure)
+# - Processing may continue.
+# -----------------------------------------------------------------------------
+
+
+

+[docs]
+class SzNotFoundError(SzBadInputError):
+    """Not found"""

+
+
+
+

+[docs]
+class SzUnknownDataSourceError(SzBadInputError):
+    """Unknown DataSource"""

+
+
+
+# -----------------------------------------------------------------------------
+# Detail exceptions for SzRetryableException
+# - Processing did not complete.
+# - These exceptions may be remedied programmatically.
+# - The call to the Senzing method should be retried.
+# - Processing may continue.
+# -----------------------------------------------------------------------------
+
+
+

+[docs]
+class SzDatabaseConnectionLostError(SzRetryableError):
+    """Database connection lost"""

+
+
+
+

+[docs]
+class SzRetryTimeoutExceededError(SzRetryableError):
+    """Retry timeout exceeded time limit"""

+
+
+
+# -----------------------------------------------------------------------------
+# Detail exceptions for SzUnrecoverableException
+# - Processing did not complete.
+# - These exceptions cannot be remedied programmatically.
+# - Processing cannot continue.
+# -----------------------------------------------------------------------------
+
+
+

+[docs]
+class SzDatabaseError(SzUnrecoverableError):
+    """Database exception"""

+
+
+
+

+[docs]
+class SzLicenseError(SzUnrecoverableError):
+    """Licence exception"""

+
+
+
+

+[docs]
+class SzNotInitializedError(SzUnrecoverableError):
+    """Not initialized"""

+
+
+
+

+[docs]
+class SzUnhandledError(SzUnrecoverableError):
+    """Could not handle exception"""

+
+
+
+# -----------------------------------------------------------------------------
+# Determine Exception based on Senzing reason code.
+# Reference: https://senzing.zendesk.com/hc/en-us/articles/360026678133-Engine-Error-codes
+# -----------------------------------------------------------------------------
+
+# fmt: off
+EXCEPTION_MAP = {
+    2: SzBadInputError,                     # EAS_ERR_INVALID_XML                                                                   "Invalid XML"
+    5: SzError,                             # EAS_ERR_EXCEEDED_MAX_RETRIES                                                          "Exceeded the Maximum Number of Retries Allowed"
+    7: SzBadInputError,                     # EAS_ERR_EMPTY_XML_MESSAGE                                                             "Empty XML Message"
+    10: SzRetryTimeoutExceededError,        # EAS_ERR_RETRY_TIMEOUT                                                                 "Retry timeout exceeded RES_ENT_ID locklist [{0}]"
+    14: SzConfigurationError,               # EAS_ERR_INVALID_DATASTORE_CONFIGURATION_TYPE                                          "Invalid Datastore Configuration Type"
+    19: SzConfigurationError,               # EAS_ERR_NO_CONFIGURATION_FOUND                                                        "Configuration not found"
+    20: SzConfigurationError,               # EAS_ERR_CONFIG_CANNOT_BE_NULL_DATABASE                                                "Configuration cannot be loaded from database connection"
+    21: SzConfigurationError,               # EAS_ERR_CONFIG_CANNOT_BE_NULL_CONFIG_FILE                                             "Configuration cannot be loaded from config file"
+    22: SzBadInputError,                    # EAS_ERR_INVALID_DOCTYPE                                                               "Invalid DocType {0}"
+    23: SzBadInputError,                    # EAS_ERR_CONFLICTING_DATA_SOURCE_VALUES                                                "Conflicting DATA_SOURCE values '{0}' and '{1}'"
+    24: SzBadInputError,                    # EAS_ERR_CONFLICTING_RECORD_ID_VALUES                                                  "Conflicting RECORD_ID values '{0}' and '{1}'"
+    26: SzBadInputError,                    # EAS_ERR_RESERVED_WORD_USED_IN_DOCUMENT                                                "Inbound data contains a reserved keyword '{0}'"
+    27: SzUnknownDataSourceError,           # EAS_ERR_UNKNOWN_DSRC_CODE_VALUE                                                       "Unknown DATA_SOURCE value '{0}'"
+    28: SzConfigurationError,               # EAS_ERR_INVALID_JSON_CONFIG_DOCUMENT                                                  "Invalid JSON config document"
+    29: SzError,                            # EAS_ERR_INVALID_HANDLE                                                                "Invalid Handle"
+    30: SzConfigurationError,               # EAS_ERR_INVALID_MATCH_LEVEL                                                           "Invalid match level '{0}'"
+    33: SzNotFoundError,                    # EAS_ERR_UNKNOWN_DSRC_RECORD_ID                                                        "Unknown record: dsrc[{0}], record[{1}]"
+    34: SzConfigurationError,               # EAS_ERR_AMBIGUOUS_ENTITY_FTYPE_MISSING                                                "AMBIGUOUS_ENTITY Feature Type is not configured"
+    35: SzConfigurationError,               # EAS_ERR_AMBIGUOUS_TIER_FELEM_MISSING                                                  "AMBIGUOUS_TIER Feature Element is not configured"
+    36: SzConfigurationError,               # EAS_ERR_AMBIGUOUS_FTYPE_ID_FELEM_MISSING                                              "AMBIGUOUS_FTYPE_ID Feature Element is not configured"
+    37: SzNotFoundError,                    # EAS_ERR_UNKNOWN_RESOLVED_ENTITY_VALUE                                                 "Unknown resolved entity value '{0}'"
+    38: SzError,                            # EAS_ERR_RECORD_HAS_NO_RESOLVED_ENTITY                                                 "Data source record has no resolved entity: dsrc[{0}], recordID[{1}]"
+    39: SzError,                            # EAS_ERR_NO_OBSERVED_ENTITY_FOR_DSRC_ENTITY_KEY                                        "No observed entity for entity key: dsrc[{0}], record_id[{1}], key[{2}]"
+    40: SzConfigurationError,               # EAS_ERR_CONFIG_COMPATIBILITY_MISMATCH                                                 "The engine configuration compatibility version [{0}] does not match the version of the provided config[{1}]."
+    41: SzError,                            # EAS_ERR_DOCUMENT_PREPROCESSING_FAILED                                                 "Document preprocessing failed"
+    42: SzError,                            # EAS_ERR_DOCUMENT_LOAD_PROCESSING_FAILED                                               "Document load processing failed"
+    43: SzError,                            # EAS_ERR_DOCUMENT_ER_PROCESSING_FAILED                                                 "Document ER processing failed"
+    44: SzError,                            # EAS_ERR_CHECK_ENTITY_PROCESSING_FAILED                                                "Check entity processing failed"
+    45: SzError,                            # EAS_ERR_INPUT_PROCEDURE_PROCESSING_FAILED                                             "Input procedure processing failed"
+    46: SzError,                            # EAS_ERR_DOCUMENT_HASHING_PROCESSING_FAILED                                            "Document hashing-processing failed"
+    47: SzError,                            # EAS_ERR_SESSION_IS_INVALID                                                            "Session is invalid"
+    48: SzNotInitializedError,              # EAS_ERR_G2_NOT_INITIALIZED                                                            "G2 is not initialized"
+    49: SzNotInitializedError,              # EAS_ERR_G2AUDIT_NOT_INITIALIZED                                                       "G2Audit is not initialized"
+    50: SzNotInitializedError,              # EAS_ERR_G2HASHER_NOT_INITIALIZED                                                      "G2Hasher is not initialized"
+    51: SzBadInputError,                    # EAS_ERR_BOTH_RECORD_ID_AND_ENT_SRC_KEY_SPECIFIED                                      "Cannot use both Record ID and Entity Source Key in record"
+    52: SzError,                            # EAS_ERR_UNKNOWN_RELATIONSHIP_ID_VALUE                                                 "Unknown relationship ID value '{0}'"
+    53: SzBadInputError,                    # EAS_ERR_G2DIAGNOSTIC_NOT_INITIALIZED                                                  "G2Diagnostic is not initialized"
+    54: SzDatabaseError,                    # EAS_ERR_G2_DATA_REPOSITORY_WAS_PURGED                                                 "Data repository was purged"
+    55: SzError,                            # EAS_ERR_NO_RESOLVED_ENTITY_FOR_DSRC_ENTITY_KEY                                        "No resolved entity for entity key: dsrc[{0}], record_id[{1}], key[{2}]"
+    56: SzError,                            # EAS_ERR_NO_RECORDS_EXIST_FOR_RESOLVED_ENTITY                                          "No data source records exist for entity ID: entityID[{0}]"
+    57: SzError,                            # EAS_ERR_UNKNOWN_FEATURE_ID_VALUE                                                      "Unknown feature ID value '{0}'"
+    58: SzError,                            # EAS_ERR_G2_INITIALIZATION_FAILURE                                                     "G2 initialization process has failed"
+    60: SzConfigurationError,               # EAS_ERR_CONFIG_DATABASE_MISMATCH                                                      "The engine configuration does not match the records loaded into the repository:  errors[{0}]."
+    61: SzConfigurationError,               # EAS_ERR_AMBIGUOUS_SUPPRESSED_LIBFEAT_FELEM_MISSING                                    "AMBIGUOUS_SUPRESSED_LIBFEAT Feature Element is not configured"
+    62: SzConfigurationError,               # EAS_ERR_AMBIGUOUS_TYPE_FELEM_MISSING                                                  "AMBIGUOUS_TYPE Feature Element is not configured"
+    63: SzNotInitializedError,              # EAS_ERR_G2CONFIGMGR_NOT_INITIALIZED                                                   "G2ConfigMgr is not initialized"
+    64: SzConfigurationError,               # EAS_ERR_CONFUSED_ENTITY_FTYPE_MISSING                                                 "CONFUSED_ENTITY Feature Type is not configured"
+    66: SzBadInputError,                    # EAS_ERR_UNKNOWN_GENERIC_PLAN_VALUE                                                    "Unknown generic plan value '{0}'"
+    67: SzConfigurationError,               # EAS_ERR_INVALID_GENERIC_PLAN_VALUE                                                    "Invalid Generic Plan ID [{0}] configured for the '{1}' retention level.'"
+    68: SzError,                            # EAS_ERR_UNKNOWN_ER_RESULT                                                             "Unknown ER-result."
+    69: SzError,                            # EAS_ERR_NO_CANDIDATES                                                                 "No candidates."
+    76: SzError,                            # EAS_ERR_INBOUND_FEATURE_VERSION_NEWER_THAN_CONFIG                                     "Inbound Feature Version [{0}] is newer than configured version [{1}] for feature type[{2}]."
+    77: SzError,                            # EAS_ERR_ERROR_WHEN_PRIMING_GNR                                                        "Error when priming GNR resources '{0}'"
+    78: SzError,                            # EAS_ERR_ERROR_WHEN_ENCRYPTING                                                         "Error when encrypting '{0}'"
+    79: SzError,                            # EAS_ERR_ERROR_WHEN_DECRYPTING                                                         "Error when decrypting '{0}'"
+    80: SzError,                            # EAS_ERR_ERROR_WHEN_VALIDATING_ENCRYPTION_SIGNATURE_COMPATIBILITY                      "Error when validating encryption signature compatibility '{0}'"
+    81: SzError,                            # EAS_ERR_ERROR_WHEN_CHECKING_DISTINCT_FEATURE_GENERALIZATION                           "Error when checking distinct feature generalization '{0}'"
+    82: SzError,                            # EAS_ERR_ERROR_WHEN_RUNNING_DQM                                                        "Error when running DQM '{0}'"
+    83: SzError,                            # EAS_ERR_ERROR_WHEN_CREATING_EFEATS                                                    "Error when creating EFEATS '{0}'"
+    84: SzError,                            # EAS_ERR_ERROR_WHEN_SIMPLE_SCORING                                                     "Error when simple scoring '{0}'"
+    85: SzError,                            # EAS_ERR_ERROR_WHEN_SCORING_PAIR                                                       "Error when scoring a pair '{0}'"
+    86: SzError,                            # EAS_ERR_ERROR_WHEN_SCORING_SET                                                        "Error when scoring a set '{0}'"
+    87: SzUnhandledError,                   # EAS_ERR_SRD_EXCEPTION                                                                 "SRD Exception '{0}'"
+    88: SzBadInputError,                    # EAS_ERR_UNKNOWN_SEARCH_PROFILE_VALUE                                                  "Unknown search profile value '{0}'"
+    89: SzConfigurationError,               # EAS_ERR_MISCONFIGURED_SEARCH_PROFILE_VALUE                                            "Misconfigured search profile value '{0}'"
+    90: SzConfigurationError,               # EAS_ERR_CANNOT_ADD_LIBRARY_FEATURES_TO_DATASTORE                                      "Cannot add library features to datastore:  '{0}'"
+    91: SzError,                            # EAS_ERR_TRUSTED_ID_FTYPE_MISSING                                                      "TRUSTED_ID Feature Type is not configured"
+    92: SzError,                            # EAS_ERR_RECORD_TYPE_FTYPE_MISSING                                                     "RECORD_TYPE Feature Type is not configured"
+    999: SzLicenseError,                    # EAS_ERR_LICENSE_HAS_EXPIRED                                                           "License has expired"
+    1000: SzDatabaseError,                  # EAS_ERR_UNHANDLED_DATABASE_ERROR                                                      "Unhandled Database Error '{0}'"
+    1001: SzDatabaseError,                  # EAS_ERR_CRITICAL_DATABASE_ERROR                                                       "Critical Database Error '{0}'"
+    1002: SzDatabaseError,                  # EAS_ERR_DATABASE_MEMORY_ERROR                                                         "Database Memory Error '{0}'"
+    1003: SzDatabaseError,                  # EAS_ERR_TABLE_SPACE_OR_LOG_VIOLATION                                                  "Table Space or Log Violation '{0}'"
+    1004: SzDatabaseError,                  # EAS_ERR_RESOURCE_CONTENTION                                                           "Resource Contention '{0}'"
+    1005: SzDatabaseError,                  # EAS_ERR_USER_DEFINED_PROC_ERROR                                                       "User Defined Procedure or Function Error '{0}'"
+    1006: SzDatabaseConnectionLostError,    # EAS_ERR_DATABASE_CONNECTION_FAILURE                                                   "Database Connection Failure '{0}'"
+    1007: SzDatabaseConnectionLostError,    # EAS_ERR_DATABASE_CONNECTION_LOST                                                      "Database Connection Lost '{0}'"
+    1008: SzDatabaseError,                  # EAS_ERR_DEADLOCK_ERROR                                                                "Deadlock Error '{0}'"
+    1009: SzDatabaseError,                  # EAS_ERR_INSUFFICIENT_PERMISSIONS                                                      "Insufficient Permissions '{0}'"
+    1010: SzDatabaseError,                  # EAS_ERR_TRANSACTION_ERROR                                                             "Transaction Error '{0}'"
+    1011: SzDatabaseError,                  # EAS_ERR_UNIQUE_CONSTRAINT_VIOLATION                                                   "Unique Constraint Violation '{0}'"
+    1012: SzDatabaseError,                  # EAS_ERR_CONSTRAINT_VIOLATION                                                          "Constraint Violation '{0}'"
+    1013: SzDatabaseError,                  # EAS_ERR_SYNTAX_ERROR                                                                  "Syntax Error '{0}'"
+    1014: SzDatabaseError,                  # EAS_ERR_CURSOR_ERROR                                                                  "Cursor Error '{0}'"
+    1015: SzDatabaseError,                  # EAS_ERR_DATATYPE_ERROR                                                                "Data Type Error '{0}'"
+    1016: SzDatabaseError,                  # EAS_ERR_TRANSACTION_ABORTED_ERROR                                                     "Transaction Aborted '{0}'"
+    1017: SzDatabaseError,                  # EAS_ERR_DATABASE_OPERATOR_NOT_SET                                                     "Database operator not set '{0}'"
+    1018: SzDatabaseError,                  # EAS_ERR_DATABASE_EXCEPTION_GENERATOR_NOT_SET                                          "Database exception generator not set '{0}'"
+    1019: SzConfigurationError,             # EAS_ERR_DATABASE_SCHEMA_TABLES_NOT_FOUND                                              "Datastore schema tables not found. [{0}]"
+    2001: SzConfigurationError,             # EAS_ERR_FEATURE_HAS_NO_FTYPE_CODE                                                     "Cannot process feature with no FTYPE_CODE[{0}]"
+    2002: SzError,                          # EAS_ERR_REQUESTED_CONFIG_FOR_INVALID_FTYPE_CODE                                       "Requested config for invalid FTYPE_CODE[{0}]"
+    2003: SzError,                          # EAS_ERR_NO_FELEM_CODE                                                                 "Cannot process OBS_FELEM with no FELEM_CODE[{0}]"
+    2005: SzError,                          # EAS_ERR_INVALID_FELEM_CODE                                                            "FELEM_CODE[{0}] is not configured for FTYPE_CODE[{1}]"
+    2006: SzError,                          # EAS_ERR_MISSING_ENT_SRC_KEY                                                           "OBS_ENT is missing ENT_SRC_KEY"
+    2012: SzConfigurationError,             # EAS_ERR_ERRULE_CONFIGURED_FOR_RESOLVE_AND_RELATE                                      "ER Rule [{0}] is configured for both resolve and relate."
+    2015: SzConfigurationError,             # EAS_ERR_INVALID_FTYPE_CODE                                                            "Invalid FTYPE_CODE[{0}]"
+    2027: SzError,                          # EAS_ERR_PLUGIN_INIT                                                                   "Plugin initialization error {0}"
+    2029: SzConfigurationError,             # EAS_ERR_REQUESTED_CONFIG_FOR_INVALID_PLUGIN                                           "Configuration not found for plugin type: {0}"
+    2034: SzConfigurationError,             # EAS_ERR_INVALID_CFRTN_VAL                                                             "CFRTN_ID[{0}]/FTYPE[{1}] is expecting CFRTN_VAL[{2}] which is not offered by CFUNC_ID[{3}][{4}]. Available scores are [{5}]"
+    2036: SzConfigurationError,             # EAS_ERR_FTYPE_HAS_NO_BOM                                                              "FType configured with no Feature Elements (Bill of Materials)  FTYPE_ID[{0}] FTYPE_CODE[{1}]"
+    2037: SzConfigurationError,             # EAS_ERR_FUNC_CALL_HAS_NO_BOM                                                          "Function call ({3}) configured with no Bill of Materials  {4}[{0}] FTYPE_ID[{1}] FTYPE_CODE[{2}]"
+    2038: SzConfigurationError,             # EAS_ERR_DISTINCT_FEATURE_HAS_NO_BOM                                                   "Distinct feature call configured with no Bill of Materials  DFCALL_ID[{0}]"
+    2041: SzConfigurationError,             # EAS_ERR_EFCALL_HAS_NO_BOM                                                             "EFeature creation call configured with no Bill of Materials  EFCALL_ID[{0}]"
+    2045: SzConfigurationError,             # EAS_ERR_CFRTN_REFERS_BAD_CFUNC_ID                                                     "CFG_CFRTN references CFUNC_ID[{0}] which is not configured"
+    2047: SzConfigurationError,             # EAS_ERR_MISSING_DSRC_CODE                                                             "Observation is missing DSRC_CODE tag which is required"
+    2048: SzConfigurationError,             # EAS_ERR_FEAT_FREQ_INVALID                                                             "FEATURE CODE[{0}] FEATURE FREQUENCY[{1}] is an invalid frequency"
+    2049: SzConfigurationError,             # EAS_ERR_FUNC_INVALID                                                                  "{2} [{0}] is invalid for {3}[{1}]"
+    2050: SzConfigurationError,             # EAS_ERR_QUAL_FRAG_NOT_FOUND                                                           "Rule[{0}] Qualifier Fragment[{1}]: Fragment not found"
+    2051: SzConfigurationError,             # EAS_ERR_DISQUAL_FRAG_NOT_FOUND                                                        "Rule[{0}] Disqualifier Fragment[{1}]: Fragment not found"
+    2057: SzBadInputError,                  # EAS_ERR_BAD_DSRC_ACTION                                                               "Observation has DSRC_ACTION[{0}] which is invalid.  Valid values are [A]dd, [C]hange, [D]elete or E[X]tensive Evaluation"
+    2061: SzConfigurationError,             # EAS_ERR_DUPLICATE_LOOKUP_IDENTIFIER                                                   "Duplicate [{0}] with identifier value [{1}].  Only unique values are allowed."
+    2062: SzConfigurationError,             # EAS_ERR_INVALID_LOOKUP_IDENTIFIER                                                     "Requested lookup of [{0}] using unknown value [{1}].  Value not found."
+    2065: SzConfigurationError,             # EAS_ERR_FTYPE_HAS_MULTIPLE_DEFINITIONS                                                "FType configured with multiple definitions. FTYPE_CODE[{0}] used in FTYPE_ID[{1}] and FTYPE_ID[{2}]"
+    2066: SzConfigurationError,             # EAS_ERR_FELEM_HAS_MULTIPLE_DEFINITIONS                                                "FElem configured with multiple definitions. FELEM_CODE[{0}] used in FELEM_ID[{1}] and FELEM_ID[{2}]"
+    2067: SzConfigurationError,             # EAS_ERR_ERFRAG_HAS_MULTIPLE_DEFINITIONS                                               "ER Fragment code configured with multiple definitions. ERFRAG_CODE[{0}] used in ERFRAG_ID[{1}] and ERFRAG_ID[{2}]"
+    2069: SzConfigurationError,             # EAS_ERR_BOM_CONFIG_INVALID_FOR_SIMPLE_PLUGIN                                          "Configured plugin for CFCALL_ID[{0}] requires exactly one value in BOM"
+    2070: SzConfigurationError,             # EAS_ERR_EFCALL_HAS_INVALID_FUNCTION                                                   "EFeature creation call configured with invalid function ID EFCALL_ID[{0}] EFUNC_ID[{1}]"
+    2071: SzConfigurationError,             # EAS_ERR_EFBOM_HAS_INVALID_EFCALL                                                      "EFeature BOM configured with invalid EFCALL_ID[{0}]"
+    2073: SzError,                          # EAS_ERR_LOADING_LIBRARY                                                               "Library loading error {0}"
+    2074: SzError,                          # EAS_ERR_SCORING_MANAGER_PLUGIN                                                        "Scoring manager: id {0} and {1} do not match"
+    2075: SzConfigurationError,             # EAS_ERR_TABLE_CONFIGURED_WITH_INVALID_FTYPE_CODE                                      "Table {0} configured with an invalid type FTYPE_CODE[{1}]"
+    2076: SzConfigurationError,             # EAS_ERR_TABLE_CONFIGURED_WITH_INVALID_FELEM_CODE                                      "Table {0} configured with an invalid type FELEM_CODE[{1}]"
+    2079: SzConfigurationError,             # EAS_ERR_EFBOM_CONFIGURED_WITH_INVALID_FTYPE_ID                                        "CFG_EFBOM configured with an invalid type FTYPE_ID[{0}]"
+    2080: SzConfigurationError,             # EAS_ERR_EFBOM_CONFIGURED_WITH_INVALID_FELEM_ID                                        "CFG_EFBOM configured with an invalid type FELEM_ID[{0}]"
+    2081: SzConfigurationError,             # EAS_ERR_FUNC_CALL_CONFIGURED_WITH_INVALID_FTYPE_ID                                    "{1} configured with an invalid type FTYPE_ID[{0}]"
+    2082: SzConfigurationError,             # EAS_ERR_FUNC_CALL_CONFIGURED_WITH_INVALID_FUNC_ID                                     "{1} configured with an invalid type {2}[{0}]"
+    2083: SzConfigurationError,             # EAS_ERR_FUNC_BOM_CONFIGURED_WITH_INVALID_FTYPE_ID                                     "{1} configured with an invalid type FTYPE_ID[{0}]"
+    2084: SzConfigurationError,             # EAS_ERR_FUNC_BOM_CONFIGURED_WITH_INVALID_FELEM_ID                                     "{1} configured with an invalid type FELEM_ID[{0}]"
+    2088: SzConfigurationError,             # EAS_ERR_TABLE_CONFIGURED_WITH_INVALID_RCLASS_ID                                       "Table {0} configured with an invalid RCLASS_ID[{1}]"
+    2089: SzConfigurationError,             # EAS_ERR_UNKNOWN_FCLASS_ID                                                             "UNKNOWN FCLASS ID[{0}]"
+    2090: SzConfigurationError,             # EAS_ERR_SFCALL_HAS_INVALID_FUNCTION                                                   "Feature standardization call configured with invalid function ID SFCALL_ID[{0}] SFUNC_ID[{1}]"
+    2091: SzConfigurationError,             # EAS_ERR_TABLE_CONFIGURED_WITH_BOTH_FTYPE_ID_AND_FELEM_ID                              "{0} configured with both an FTYPE_ID[{1}] and FELEM_ID[{2}]"
+    2092: SzConfigurationError,             # EAS_ERR_TABLE_CONFIGURED_WITH_NEITHER_FTYPE_ID_NOR_FELEM_ID                           "{0} configured with neither an FTYPE_ID nor an FELEM_ID"
+    2093: SzConfigurationError,             # EAS_ERR_TABLE_CONFIGURED_WITH_DUPLICATE_EXEC_ORDER_FOR_IDENTIFIER_LIST                "Table [{0}] configured with duplicate execution order value [{3}] for identifiers[{1}] with values [{2}]"
+    2094: SzConfigurationError,             # EAS_ERR_DUPLICATE_VALUE_FOR_FIELD_IN_TABLE                                            "Duplicate value [{2}] of field [{1}] in config [{0}]"
+    2095: SzConfigurationError,             # EAS_ERR_TABLE_CONFIGURED_WITH_INVALID_FTYPE_CODE_FELEM_CODE_PAIR                      "Table {0} configured with an invalid FTYPE_CODE[{1}]/FELEM_CODE[{2}] pair"
+    2099: SzConfigurationError,             # EAS_ERR_COUNTER_CONFIG_INVALID_THRESHOLD                                              "Next Threshold for a counter should be no less than 10, but has NEXT_THRESH{0}"
+    2101: SzConfigurationError,             # EAS_ERR_XPATH_OP_UNSUPPORTED                                                          "XPath operation unsupported [{0}]"
+    2102: SzConfigurationError,             # EAS_ERR_XPATH_AXIS_UNSUPPORTED                                                        "XPath axis unsupported [{0}]"
+    2103: SzConfigurationError,             # EAS_ERR_XPATH_TEST_UNSUPPORTED                                                        "XPath test unsupported [{0}]"
+    2104: SzConfigurationError,             # EAS_ERR_XPATH_TYPE_UNSUPPORTED                                                        "XPath type unsupported [{0}]"
+    2105: SzConfigurationError,             # EAS_ERR_XPATH_NODE_PREFIX_UNSUPPORTED                                                 "XPath node prefix unsupported [{0}]"
+    2106: SzConfigurationError,             # EAS_ERR_XPATH_NODE_NAME_UNSUPPORTED                                                   "XPath node name unsupported position[{0}], name[{1}]"
+    2107: SzConfigurationError,             # EAS_ERR_XPATH_BEHAVIOR_TYPE_UNSUPPORTED                                               "XPath behavior type unsupported [{0}]"
+    2108: SzConfigurationError,             # EAS_ERR_XPATH_BUCKET_UNSUPPORTED                                                      "XPath bucket type unsupported [{0}]"
+    2109: SzConfigurationError,             # EAS_ERR_XPATH_VALUE_TYPE_UNSUPPORTED                                                  "XPath value type unsupported [{0}]"
+    2110: SzConfigurationError,             # EAS_ERR_XPATH_PLUS_TYPE_UNSUPPORTED                                                   "XPath plus operand type unsupported [{0}]"
+    2111: SzConfigurationError,             # EAS_ERR_XPATH_FRAGMENT_NOT_EVALUATED                                                  "XPath fragment not evaluated[{0}]"
+    2112: SzConfigurationError,             # EAS_ERR_XPATH_FRAGMENT_NOT_CONFIGURED                                                 "XPath fragment not configured[{0}]"
+    2113: SzConfigurationError,             # EAS_ERR_XPATH_FUNCTION_UNSUPPORTED                                                    "XPath function unsupported [{0}]"
+    2114: SzConfigurationError,             # EAS_ERR_INVALID_FTYPE_SCORESET                                                        "Cannot set score for invalid FTYPE_ID [{0}]"
+    2116: SzError,                          # EAS_ERR_UNITIALIZED_AMBIGUOUS_CACHE                                                   "Uninitialized Ambiguous Test Cache"
+    2117: SzConfigurationError,             # EAS_ERR_SCORING_CALL_HAS_NO_BOM                                                       "Scoring call configured with no Bill of Materials  CFCALL_ID[{0}]."
+    2118: SzConfigurationError,             # EAS_ERR_BOM_CONFIG_INVALID_FOR_SCORING_PLUGIN                                         "Configured plugin for CFCALL_ID[{0}] has invalid BOM."
+    2120: SzConfigurationError,             # EAS_ERR_TABLE_CONFIGURED_WITH_INVALID_FTYPE_ID                                        "Table {0} configured with an invalid type FTYPE_ID[{1}]"
+    2121: SzConfigurationError,             # EAS_ERR_TABLE_CONFIGURED_WITH_INVALID_FELEM_ID                                        "Table {0} configured with an invalid type FELEM_ID[{1}]"
+    2123: SzConfigurationError,             # EAS_ERR_CFUNC_CONFIGURED_WITH_NO_CFRTN                                                "CFG_CFUNC [{0}] feature type [{1}] configured without any corresponding return values in CFG_CFRTN"
+    2131: SzConfigurationError,             # EAS_ERR_OBS_ENT_NOT_FOUND                                                             "Requested resolution of OBS_ENT_ID that is not loaded OBS_ENT_ID[{0}]"
+    2135: SzConfigurationError,             # EAS_ERR_INPUT_MAPPING_CONFIG_ERROR                                                    "Error in input mapping config[{0}]"
+    2136: SzConfigurationError,             # EAS_ERR_INPUT_MAPPING_MISSING_REQUIRED_FIELD                                          "Error in input mapping, missing required field[{0}]"
+    2137: SzConfigurationError,             # EAS_ERR_INPUT_MAPPING_MALFORMED_INPUT                                                 "Error in input mapping, input message is malformed[{0}]"
+    2138: SzConfigurationError,             # EAS_ERR_INVALID_CFRTN_INDEX                                                           "CFRTN_ID[{0}] is out of range. Valid range is 0-7"
+    2139: SzConfigurationError,             # EAS_ERR_DSRC_INTEREST_CONFIGURED_WITH_INVALID_DSRCID                                  "Data Source Interest configured with invalid Data Source ID DSRC_ID[{0}]"
+    2207: SzConfigurationError,             # EAS_ERR_DATA_SOURCE_CODE_DOES_NOT_EXIST                                               "Data source code [{0}] does not exist."
+    2209: SzConfigurationError,             # EAS_ERR_DATA_SOURCE_ID_ALREADY_EXISTS                                                 "Data source ID [{0}] already exists."
+    2210: SzConfigurationError,             # EAS_ERR_FELEM_CODE_DOES_NOT_EXIST                                                     "Feature element code [{0}] does not exist."
+    2211: SzConfigurationError,             # EAS_ERR_FELEM_CODE_ALREADY_EXISTS                                                     "Feature element code [{0}] already exists."
+    2212: SzConfigurationError,             # EAS_ERR_FELEM_ID_ALREADY_EXISTS                                                       "Feature element ID [{0}] already exists."
+    2213: SzConfigurationError,             # EAS_ERR_INVALID_FELEM_DATA_TYPE                                                       "Invalid feature element datatype [{0}] found.  Datatype must be in [{1}]."
+    2214: SzConfigurationError,             # EAS_ERR_FELEM_IS_CONFIGURED_FOR_USE_IN_FEATURES                                       "Feature element [{0}] is configured for use in feature(s) [{1}]."
+    2215: SzConfigurationError,             # EAS_ERR_FTYPE_CODE_DOES_NOT_EXIST                                                     "Feature type code [{0}] does not exist."
+    2216: SzConfigurationError,             # EAS_ERR_FTYPE_CODE_ALREADY_EXISTS                                                     "Feature type code [{0}] already exists."
+    2217: SzConfigurationError,             # EAS_ERR_FTYPE_ID_ALREADY_EXISTS                                                       "Feature type ID [{0}] already exists."
+    2218: SzConfigurationError,             # EAS_ERR_FEATURE_FREQUENCY_IS_INVALID                                                  "Feature type frequency [{0}] is invalid."
+    2219: SzConfigurationError,             # EAS_ERR_FEATURE_ELEMENT_LIST_IS_EMPTY                                                 "Feature element list is empty."
+    2220: SzConfigurationError,             # EAS_ERR_STANDARDIZATION_FUNCTION_DOES_NOT_EXIST                                       "Standardization function [{0}] does not exist."
+    2221: SzConfigurationError,             # EAS_ERR_FUNCTION_USES_BOTH_FTYPE_AND_FELEM_TRIGGER                                    "Function call requested uses both triggering feature type [{0}] and triggering feature element code [{1}].  Cannot use both triggering feature type and triggering feature element code."
+    2222: SzConfigurationError,             # EAS_ERR_EXPRESSION_FUNCTION_DOES_NOT_EXIST                                            "Expression function [{0}] does not exist."
+    2223: SzConfigurationError,             # EAS_ERR_EXPRESSION_FUNCTION_FEATURE_ELEMENT_LIST_IS_EMPTY                             "Expression function feature element list is empty."
+    2224: SzConfigurationError,             # EAS_ERR_COMPARISON_FUNCTION_DOES_NOT_EXIST                                            "Comparison function [{0}] does not exist."
+    2225: SzConfigurationError,             # EAS_ERR_COMPARISON_FUNCTION_FEATURE_ELEMENT_LIST_IS_EMPTY                             "Comparison function feature element list is empty."
+    2226: SzConfigurationError,             # EAS_ERR_DISTINCT_FUNCTION_DOES_NOT_EXIST                                              "Distinct feature function [{0}] does not exist."
+    2227: SzConfigurationError,             # EAS_ERR_DISTINCT_FUNCTION_FEATURE_ELEMENT_LIST_IS_EMPTY                               "Distinct feature function feature element list is empty."
+    2228: SzConfigurationError,             # EAS_ERR_FELEM_CODE_MUST_BE_UNIQUE_IN_FELEM_LIST                                       "Feature element code [{0}] must be unique in felem list."
+    2230: SzConfigurationError,             # EAS_ERR_FTYPE_CODE_AND_FELEM_CODE_MUST_BE_UNIQUE_IN_EXPRESSED_FUNCTION_CALL           "Feature type [{0}] and feature element [{1}] must be unique in expressed feature function call."
+    2231: SzConfigurationError,             # EAS_ERR_FTYPE_CODE_AND_FELEM_CODE_IN_EXPRESSED_FUNCTION_CALL_DO_NOT_EXIST_IN_FEATURE  "Feature type [{0}] and feature element [{1}] requested for expressed feature function call, but don't exist in feature [{0}]."
+    2232: SzConfigurationError,             # EAS_ERR_FELEM_CODE_MUST_BE_UNIQUE_IN_COMPARISON_FUNCTION_CALL                         "Feature element [{0}] must be unique in comparison feature function call."
+    2233: SzConfigurationError,             # EAS_ERR_FELEM_CODE_IN_COMPARISON_FUNCTION_CALL_DOES_NOT_EXIST_IN_FEATURE              "Feature element [{0}] requested for comparison feature function call, but doesn't exist in feature [{1}]."
+    2234: SzConfigurationError,             # EAS_ERR_FELEM_CODE_MUST_BE_UNIQUE_IN_DISTINCT_FUNCTION_CALL                           "Feature element [{0}] must be unique in distinct feature function call."
+    2235: SzConfigurationError,             # EAS_ERR_FELEM_CODE_IN_DISTINCT_FUNCTION_CALL_DOES_NOT_EXIST_IN_FEATURE                "Feature element [{0}] requested for distinct feature function call, but doesn't exist in feature [{1}]."
+    2236: SzConfigurationError,             # EAS_ERR_EXEC_ORDER_IS_NOT_SPECIFIED_FOR_FUNCTION                                      "Exec order not specified for function."
+    2237: SzConfigurationError,             # EAS_ERR_SFCALL_ID_ALREADY_EXISTS                                                      "Standardization function call ID [{0}] already exists."
+    2238: SzConfigurationError,             # EAS_ERR_EFCALL_ID_ALREADY_EXISTS                                                      "Expression function call ID [{0}] already exists."
+    2239: SzConfigurationError,             # EAS_ERR_CFCALL_ID_ALREADY_EXISTS                                                      "Comparison function call ID [{0}] already exists."
+    2240: SzConfigurationError,             # EAS_ERR_DFCALL_ID_ALREADY_EXISTS                                                      "Distinct feature function call ID [{0}] already exists."
+    2241: SzConfigurationError,             # EAS_ERR_FTYPE_CODE_REQUIRED_BY_SEPARATE_EXPRESSED_FUNCTION_CALL                       "Feature type [{0}] required for separate expressed feature function call [{1}]."
+    2242: SzConfigurationError,             # EAS_ERR_SFCALL_ID_DOES_NOT_EXIST                                                      "Standardization function call ID [{0}] does not exist."
+    2243: SzConfigurationError,             # EAS_ERR_EFCALL_ID_DOES_NOT_EXIST                                                      "Expression function call ID [{0}] does not exist."
+    2244: SzConfigurationError,             # EAS_ERR_CFCALL_ID_DOES_NOT_EXIST                                                      "Comparison function call ID [{0}] does not exist."
+    2245: SzConfigurationError,             # EAS_ERR_DFCALL_ID_DOES_NOT_EXIST                                                      "Distinct feature function call ID [{0}] does not exist."
+    2246: SzConfigurationError,             # EAS_ERR_BOM_EXEC_ORDER_ALREADY_EXISTS                                                 "BOM exec order value [{0}] already exists."
+    2247: SzConfigurationError,             # EAS_ERR_COMPARISON_FUNCTION_CALL_DOES_NOT_EXIST_FOR_FEATURE                           "Comparison function call does not exist for feature [{0}]."
+    2248: SzConfigurationError,             # EAS_ERR_DISTINCT_FUNCTION_CALL_DOES_NOT_EXIST_FOR_FEATURE                             "Distinct feature function call does not exist for feature [{0}]."
+    2249: SzConfigurationError,             # EAS_ERR_CONFLICTING_SPECIFIERS_FOR_FUNCTION_CALL                                      "Conflicting specifiers: Function call ID [{0}] does not match function call ID [{1}] from feature type."
+    2250: SzConfigurationError,             # EAS_ERR_ATTR_CODE_DOES_NOT_EXIST                                                      "Attribute code [{0}] does not exist."
+    2251: SzConfigurationError,             # EAS_ERR_ATTR_CODE_ALREADY_EXISTS                                                      "Attribute code [{0}] already exists."
+    2252: SzConfigurationError,             # EAS_ERR_ATTR_ID_ALREADY_EXISTS                                                        "Attribute ID [{0}] already exists."
+    2253: SzConfigurationError,             # EAS_ERR_ATTR_CLASS_CODE_DOES_NOT_EXIST                                                "Attribute class code [{0}] does not exist."
+    2254: SzConfigurationError,             # EAS_ERR_FUNCTION_USES_NEITHER_FTYPE_NOR_FELEM_TRIGGER                                 "Function call requested uses neither triggering feature type [{0}] nor triggering feature element code [{1}].  At least one trigger must be specified."
+    2255: SzConfigurationError,             # EAS_ERR_FEATURE_CLASS_CODE_DOES_NOT_EXIST                                             "Feature class code [{0}] does not exist."
+    2256: SzConfigurationError,             # EAS_ERR_RELATIONSHIP_TYPE_CODE_DOES_NOT_EXIST                                         "Relationship type code [{0}] does not exist."
+    2257: SzConfigurationError,             # EAS_ERR_FELEM_CODE_NOT_IN_FEATURE                                                     "Feature element code [{0}] not included in feature[{1}]."
+    2258: SzConfigurationError,             # EAS_ERR_ER_FRAGMENT_DOES_NOT_EXIST                                                    "ER fragment code [{0}] does not exist."
+    2259: SzConfigurationError,             # EAS_ERR_ER_RULE_DOES_NOT_EXIST                                                        "ER rule code [{0}] does not exist."
+    2260: SzConfigurationError,             # EAS_ERR_ERFRAG_ID_ALREADY_EXISTS                                                      "ER fragment ID [{0}] already exists."
+    2261: SzConfigurationError,             # EAS_ERR_ERRULE_ID_ALREADY_EXISTS                                                      "ER rule ID [{0}] already exists."
+    2262: SzConfigurationError,             # EAS_ERR_ERFRAG_CODE_ALREADY_EXISTS                                                    "ER fragment code [{0}] already exists."
+    2263: SzConfigurationError,             # EAS_ERR_ERRULE_CODE_ALREADY_EXISTS                                                    "ER rule code [{0}] already exists."
+    2264: SzConfigurationError,             # EAS_ERR_ERFRAG_CODE_DOES_NOT_EXIST                                                    "ER fragment code [{0}] does not exist."
+    2266: SzConfigurationError,             # EAS_ERR_ERFRAG_CODE_MUST_BE_UNIQUE_IN_DEPENDENCY_LIST                                 "ER fragment code [{0}] must be unique in dependency list."
+    2267: SzConfigurationError,             # EAS_ERR_SECTION_NAME_ALREADY_EXISTS                                                   "Section name [{0}] already exists."
+    2268: SzConfigurationError,             # EAS_ERR_SECTION_NAME_DOES_NOT_EXIST                                                   "Section name [{0}] does not exist."
+    2269: SzConfigurationError,             # EAS_ERR_SECTION_FIELD_NAME_ALREADY_EXISTS                                             "Section field name [{0}] already exists."
+    2270: SzConfigurationError,             # EAS_ERR_SFUNC_ID_ALREADY_EXISTS                                                       "Feature standardization function ID [{0}] already exists."
+    2271: SzConfigurationError,             # EAS_ERR_SFUNC_CODE_ALREADY_EXISTS                                                     "Feature standardization function code [{0}] already exists."
+    2272: SzConfigurationError,             # EAS_ERR_EFUNC_ID_ALREADY_EXISTS                                                       "Feature expression function ID [{0}] already exists."
+    2273: SzConfigurationError,             # EAS_ERR_EFUNC_CODE_ALREADY_EXISTS                                                     "Feature expression function code [{0}] already exists."
+    2274: SzConfigurationError,             # EAS_ERR_CFUNC_ID_ALREADY_EXISTS                                                       "Feature comparison function ID [{0}] already exists."
+    2275: SzConfigurationError,             # EAS_ERR_CFUNC_CODE_ALREADY_EXISTS                                                     "Feature comparison function code [{0}] already exists."
+    2276: SzConfigurationError,             # EAS_ERR_DFUNC_ID_ALREADY_EXISTS                                                       "Feature distinct function ID [{0}] already exists."
+    2277: SzConfigurationError,             # EAS_ERR_DFUNC_CODE_ALREADY_EXISTS                                                     "Feature distinct function code [{0}] already exists."
+    2278: SzConfigurationError,             # EAS_ERR_COMPATIBILITY_VERSION_NOT_FOUND_IN_CONFIG                                     "Compatibility version not found in document."
+    2279: SzConfigurationError,             # EAS_ERR_CFRTN_ID_ALREADY_EXISTS                                                       "Feature comparison function return ID [{0}] already exists."
+    2280: SzConfigurationError,             # EAS_ERR_CFUNC_CODE_DOES_NOT_EXIST                                                     "Feature comparison function code [{0}] does not exist."
+    2281: SzConfigurationError,             # EAS_ERR_CFRTN_VALUE_ALREADY_EXISTS                                                    "Feature comparison function return value [{0}] already exists for comparison function [{1}] ftype [{2}]."
+    2282: SzConfigurationError,             # EAS_ERR_CFUNC_EXEC_ORDER_ALREADY_EXISTS                                               "Feature comparison function exec order value [{0}] already exists for comparison function [{1}] ftype [{2}]."
+    2283: SzConfigurationError,             # EAS_ERR_EFUNC_CODE_DOES_NOT_EXIST                                                     "Feature expression function code [{0}] does not exist."
+    2285: SzError,                          # EAS_ERR_INVALID_FORMAT_FOR_ENTITIES                                                   "Invalid format for ENTITIES."
+    2286: SzError,                          # EAS_ERR_NO_ENTITY_ID_FOUND_FOR_ENTITY                                                 "No entity ID found for entity."
+    2287: SzError,                          # EAS_ERR_NO_DATA_SOURCE_FOUND                                                          "No data source found."
+    2288: SzError,                          # EAS_ERR_NO_RECORD_ID_FOUND                                                            "No record ID found."
+    2289: SzConfigurationError,             # EAS_ERR_INVALID_FEATURE_CLASS_FOR_FEATURE_TYPE                                        "Invalid feature class [{0}] for feature type [{1}]."
+    2290: SzConfigurationError,             # EAS_ERR_FRAGMENT_IS_CONFIGURED_FOR_USE_IN_RULES                                       "Rule fragment [{0}] is configured for use in rules(s) [{1}]."
+    2291: SzConfigurationError,             # EAS_ERR_FRAGMENT_IS_CONFIGURED_FOR_USE_IN_FRAGMENT                                    "Rule fragment [{0}] is configured for use in fragments(s) [{1}]."
+    2292: SzError,                          # EAS_ERR_CANT_RETRIEVE_OBS_FEATURE_DATA_FOR_OBS_ENT                                    "Could not retrieve observed feature data for observed entity [{0}]."
+    2293: SzError,                          # EAS_ERR_NO_RECORDS_SPECIFIED                                                          "No records specified."
+    2294: SzError,                          # EAS_ERR_DATA_SOURCE_ID_DOES_NOT_EXIST                                                 "Data source ID [{0}] does not exist."
+    7209: SzConfigurationError,             # EAS_ERR_DB_BAD_BACKEND_TYPE                                                           "Invalid [SQL] Backend Parameter. Valid values are SQL or HYBRID"
+    7211: SzConfigurationError,             # EAS_ERR_DB_BAD_CLUSTER_SIZE                                                           "Cluster [{0}] is configured with an invalid size. Size must be equal to 1."
+    7212: SzConfigurationError,             # EAS_ERR_DB_BAD_CLUSTER_NODE                                                           "Cluster [{0}] Node [{1}] is not configured."
+    7216: SzConfigurationError,             # EAS_ERR_DB_BAD_CLUSTER_DEFINITION                                                     "Cluster [{0}] is not properly configured"
+    7217: SzConfigurationError,             # EAS_ERR_DB_CONFLICTING_DEFAULT_SHARD_CONFIG                                           "Cannot specify both default backend database and default backend cluster"
+    7218: SzConfigurationError,             # EAS_ERR_DB_CLUSTER_DOES_NOT_EXIST                                                     "Cluster [{0}] does not exist"
+    7220: SzConfigurationError,             # EAS_ERR_NO_CONFIG_REGISTERED_IN_DATASTORE                                             "No engine configuration registered in datastore (see https://senzing.zendesk.com/hc/en-us/articles/360036587313)."
+    7221: SzConfigurationError,             # EAS_ERR_NO_CONFIG_REGISTERED_FOR_DATA_ID                                              "No engine configuration registered with data ID [{0}]."
+    7222: SzError,                          # EAS_ERR_FAILED_TO_SET_SYS_VAR_IN_DATASTORE                                            "Could not set system variable value in database for Group[{0}],Code[{1}],Value[{2}]."
+    7223: SzConfigurationError,             # EAS_ERR_INVALID_SCHEMA_VERSION_IN_DATASTORE                                           "Invalid version number for datastore schema [version '{0}']."
+    7224: SzConfigurationError,             # EAS_ERR_INVALID_SCHEMA_VERSION_IN_ENGINE                                              "Invalid version number for engine schema [version '{0}']."
+    7226: SzConfigurationError,             # EAS_ERR_INCOMPATIBLE_DATASTORE_SCHEMA_VERSION                                         "Incompatible datastore schema version: [Engine version '{0}'.  Datastore version '{1}' is installed, but must be between '{2}' and '{3}'.]"
+    7227: SzConfigurationError,             # EAS_ERR_CONFLICTING_SCHEMA_VERSIONS_IN_DATASTORE                                      "Conflicting version numbers for datastore schema [{0}]."
+    7228: SzConfigurationError,             # EAS_ERR_INVALID_SCHEMA_VERSION                                                        "Invalid schema version number [version '{0}']."
+    7230: SzConfigurationError,             # EAS_ERR_ENGINE_CONFIGURATION_FILE_NOT_FOUND                                           "Engine configuration file not found [{0}]."
+    7232: SzConfigurationError,             # EAS_ERR_ENGINE_CONFIGURATION_NOT_FOUND                                                "No engine configuration found."
+    7233: SzConfigurationError,             # EAS_ERR_DATASTORE_ENCRYPTION_SIGNATURE_IS_INCOMPATIBLE                                "Datastore encryption signature is not compatible."
+    7234: SzConfigurationError,             # EAS_ERR_FAILED_TO_GET_ENCRYPTION_SIGNATURE                                            "Failed to get encryption signature: '{0}'"
+    7235: SzConfigurationError,             # EAS_ERR_FTYPE_CONFIGURED_AS_REL_BUT_NO_RTYPE                                          "FTYPE_CODE[{0}] IS CONFIGURED AS A RELATIONSHIP FEATURE TYPE BUT RTYPE_ID IS NOT SET."
+    7236: SzConfigurationError,             # EAS_ERR_DUPLICATE_BEHAVIOR_OVERRIDE_KEY_IN_CFG_FBOVR                                  "Duplicate behavior override keys in CFG_FBOVR -- FTYPE_ID[{0}], UTYPE_CODE[{1}] referenced in CFG_FBOVR."
+    7237: SzConfigurationError,             # EAS_ERR_UNKNOWN_FTYPE_IN_TABLE                                                        "Unknown FTYPE_ID[{0}] referenced in {1}."
+    7238: SzError,                          # EAS_ERR_DATASTORE_ENCRYPTION_CONFIGURATION_DOES_NOT_MATCH_DATASTORE                   "Datastore encryption configuration does not match data store:  '{0}'"
+    7239: SzConfigurationError,             # EAS_ERR_INVALID_GENERIC_THRESHOLD_CANDIDATE_CAP                                       "Invalid generic threshold {0} cap [{1}] for [GPLAN_ID[{2}], BEHAVIOR[{3}], FTYPE_ID[{4}]]."
+    7240: SzConfigurationError,             # EAS_ERR_INCORRECT_BEHAVIOR_REFERENCED                                                 "Incorrect BEHAVIOR[{0}] referenced in CFG_GENERIC_THRESHOLD for [GPLAN_ID[{1}], FTYPE_ID[{2}]].  FType configured for behavior [{3}]"
+    7241: SzConfigurationError,             # EAS_ERR_UNKNOWN_GPLAN_IN_TABLE                                                        "Unknown GPLAN_ID[{0}] referenced in {1}."
+    7242: SzConfigurationError,             # EAS_ERR_MULTIPLE_GENERIC_THRESHOLD_DEFINITIONS                                        "Multiple Generic Threshold definitions for [GPLAN_ID[{0}], BEHAVIOR[{1}], FTYPE_ID[{2}]]."
+    7243: SzConfigurationError,             # EAS_ERR_ER_FRAGMENT_HAS_UNDEFINED_DEPENDENT_FRAGMENTS                                 "ER Fragment [{0}] configured with undefined dependent fragments. Fragment [{1}] undefined."
+    7244: SzConfigurationError,             # EAS_ERR_ER_RULE_FRAGMENT_LACKS_REQUIRED_FRAGMENT                                      "ER Rule Fragment configuration lacks the required {0} fragment."
+    7245: SzConfigurationError,             # EAS_ERR_CURRENT_CONFIG_REGISTERED_DOES_NOT_MATCH_DATA_ID                              "Current configuration ID does not match specified data ID [{0}]."
+    7246: SzConfigurationError,             # EAS_ERR_INVALID_MAXIMUM_DATASTORE_SCHEMA_VERSION                                      "Invalid maximum datastore version number for engine schema [version '{0}']."
+    7247: SzConfigurationError,             # EAS_ERR_INVALID_MINIMUM_DATASTORE_SCHEMA_VERSION                                      "Invalid minimum datastore version number for engine schema [version '{0}']."
+    7303: SzBadInputError,                  # EAS_ERR_MANDATORY_SEGMENT_WITH_MISSING_REQUIREMENTS                                   "Mandatory segment with missing requirements:"
+    7305: SzBadInputError,                  # EAS_ERR_MISSING_JSON_ROOT_ELEMENT                                                     "No root element name in json TEMPLATE"
+    7313: SzBadInputError,                  # EAS_ERR_REQUIRED_ELEMENT_WITH_EMPTY_FIELD                                             "A non-empty value for [{0}] must be specified."
+    7314: SzBadInputError,                  # EAS_ERR_REQUIRED_ELEMENT_NOT_FOUND                                                    "A value for [{0}] must be specified."
+    7317: SzConfigurationError,             # EAS_ERR_FAILED_TO_OPEN_FILE                                                           "Failed to open file: {0}"
+    7344: SzConfigurationError,             # EAS_ERR_UNKNOWN_MAPPING_DIRECTIVE                                                     "Invalid mapping directive [{0}] for attribute [{1}]."
+    7426: SzBadInputError,                  # EAS_ERR_XLITERATOR_FAILED                                                             "Transliteration failed"
+    7511: SzError,                          # EAS_ERR_ABORT_ER_AND_RETRY                                                            "Detected change in candidate entity[{0}].  Restarting ER evaluation."
+    8000: SzBadInputError,                  # EAS_ERR_GNRNP                                                                         "GNR NameParser Failure"
+    8410: SzError,                          # EAS_ERR_UNINITIALIZED_AMBIGUOUS_FEATURE                                               "Cannot use uninitialized ambiguous feature."
+    8501: SzConfigurationError,             # EAS_ERR_SALT_DIGEST_ALGORITHM_NOT_AVAILABLE                                           "Failed to get {0} digest algorithm from ICC."
+    8502: SzError,                          # EAS_ERR_SALT_DIGEST_CONTEXT_CREATE_FAILED                                             "Failed to create a digest context."
+    8503: SzError,                          # EAS_ERR_SALT_DIGEST_CONTEXT_INIT_FAILED                                               "Failed {0} to initialise a digest context."
+    8504: SzError,                          # EAS_ERR_SALT_DIGEST_FAILED                                                            "Failed {0} to digest block {1}."
+    8505: SzError,                          # EAS_ERR_SALT_DIGEST_FINAL_FAILED                                                      "Failed {0} to complete digest."
+    8508: SzError,                          # EAS_ERR_SALT_DIGEST_UNKNOWN_EXCEPTION                                                 "Unrecognized exception thrown generating digest."
+    8509: SzError,                          # EAS_ERR_SALT_DIGEST_ALGORITHM_REQUIRED                                                "Cannot generate a digest without a valid algorithm."
+    8514: SzError,                          # EAS_ERR_SALT_RANDOM_FAILED                                                            "Failed {0} to get random content"
+    8516: SzConfigurationError,             # EAS_ERR_SALT_MUST_BE_SIZE                                                             "A salt value must be {0} bytes long but the provided one is {1} bytes."
+    8517: SzConfigurationError,             # EAS_ERR_SALT_DOES_NOT_MATCH_CHECKSUM                                                  "The salt value does not match the recorded checksum."
+    8520: SzError,                          # EAS_ERR_SALT_G2SS_INIT_FAILED                                                         "Secure Store initialization failed."
+    8521: SzError,                          # EAS_ERR_SALT_G2SS_TOKEN_MUST_BE_INIT                                                  "Hashing with a named salt requires the Secure Store to be initialised."
+    8522: SzConfigurationError,             # EAS_ERR_SALT_G2SS_SOPIN_NOT_VALID                                                     "The Security Officer (SO) PIN is not correct."
+    8524: SzError,                          # EAS_ERR_SALT_G2SS_INIT_UNKNOWN_EXCEPTION                                              "Secure Store initialization failed with an unrecognised exception"
+    8525: SzConfigurationError,             # EAS_ERR_SALT_G2SS_REQUIRED_FOR_LOAD                                                   "Secure Store is required to load salt"
+    8526: SzConfigurationError,             # EAS_ERR_SALT_G2SS_REQUIRED_FOR_GENERATE                                               "Secure Store is required to generate salt"
+    8527: SzConfigurationError,             # EAS_ERR_SALT_G2SS_REQUIRED_FOR_IMPORT                                                 "Secure Store is required to import salt"
+    8528: SzConfigurationError,             # EAS_ERR_SALT_G2SS_REQUIRED_FOR_EXPORT                                                 "Secure Store is required to export salt"
+    8529: SzConfigurationError,             # EAS_ERR_SALT_G2SS_REQUIRED_FOR_DELETE                                                 "Secure Store is required to delete salt"
+    8530: SzError,                          # EAS_ERR_SALT_CANNOT_OVERWRITE                                                         "You cannot overwrite an existing salt called {0}"
+    8536: SzConfigurationError,             # EAS_ERR_SALT_G2SS_REQUIRED_FOR_LEGACY                                                 "Secure Store is required to add a legacy salt"
+    8538: SzConfigurationError,             # EAS_ERR_SALT_G2SS_REQUIRED_FOR_METHOD                                                 "Secure Store is required to change hashing method"
+    8539: SzError,                          # EAS_ERR_SALT_G2SS_ERROR_CHANGING_METHOD                                               "Secure Store error changing hashing method"
+    8540: SzConfigurationError,             # EAS_ERR_SALT_WRONG_SIZE                                                               "The object called {0} is not a salt"
+    8541: SzError,                          # EAS_ERR_SALT_BASE64_DECODE_ERROR                                                      "Base64 decoding error in salt {0} at character {1}"
+    8542: SzError,                          # EAS_ERR_SALT_UNINITIALISED                                                            "Must load a salt before using it."
+    8543: SzConfigurationError,             # EAS_ERR_SALT_NOT_FOUND                                                                "There is no salt called {0} in the Secure Store."
+    8544: SzConfigurationError,             # EAS_ERR_SALT_PASSWORD_NOT_STRONG_ENOUGH                                               "The password must be stronger: {0}"
+    8545: SzConfigurationError,             # EAS_ERR_SALT_ADMIN_NAME_REQUIRED                                                      "Specify -name and the name to use for the salt"
+    8556: SzConfigurationError,             # EAS_ERR_SALT_ADMIN_METHOD_NOT_RECOGNISED                                              "Hashing method {0} not supported."
+    8557: SzConfigurationError,             # EAS_ERR_SALT_METHOD_DOES_NOT_MATCH                                                    "The hashing method in the configuration ({1}) does not match the method ({2}) of the salt {0}"
+    8593: SzError,                          # EAS_ERR_SALT_HMAC_CONTEXT_INIT_FAILED                                                 "Failed {0} to initialise an HMAC context."
+    8594: SzError,                          # EAS_ERR_SALT_HMAC_FAILED                                                              "Failed {0} to HMAC block {1}."
+    8595: SzError,                          # EAS_ERR_SALT_HMAC_FINAL_FAILED                                                        "Failed {0} to complete HMAC."
+    8598: SzError,                          # EAS_ERR_SALT_HMAC_UNKNOWN_EXCEPTION                                                   "Unrecognized exception thrown generating HMAC."
+    8599: SzConfigurationError,             # EAS_ERR_SALT_UNKNOWN_HASHING_METHOD                                                   "Unrecognized hashing method ({0}) requested."
+    8601: SzConfigurationError,             # EAS_ERR_HASHER_REQUIRES_SECURE_STORE                                                  "Using a named salt requires the Secure Store configured and running"
+    8602: SzConfigurationError,             # EAS_ERR_HASHER_CHECKSUM_DOES_NOT_MATCH                                                "The hashing checksum configured ({1}) does not match the checksum ({2}) of the salt named {0}"
+    8603: SzError,                          # EAS_ERR_HASHER_UNABLE_TO_RECORD_SALT                                                  "Unable to record the configured salt"
+    8604: SzConfigurationError,             # EAS_ERR_HASHER_REQUIRES_FUNCTION                                                      "Using hashing requires a configured hashing function"
+    8605: SzConfigurationError,             # EAS_ERR_HASHER_EPHEMERAL_OR_NAMED_SALT                                                "Specify either a named salt or an ephemeral one. Can not have both"
+    8606: SzConfigurationError,             # EAS_ERR_HASHER_SALT_REQUIRED                                                          "Hashing requires a salt to be configured."
+    8607: SzConfigurationError,             # EAS_ERR_HASHER_INVALID_ARGS                                                           "Invalid arguments to hashing function. Either a parameter wasn't provided or a buffer was too small: location={0}, dataPtr={1}, dataLength={2}, outputPtr={3}, outputLength={4}, output={5}"
+    8608: SzConfigurationError,             # EAS_ERR_NO_SALT_VALUE_CONFIGURED                                                      "No salt value is configured. A salt value must be configured if you wish to export the token library."
+    8701: SzConfigurationError,             # EAS_ERR_PARAMETER_NOT_READABLE                                                        "The parameter store does not support a read interface"
+    8702: SzConfigurationError,             # EAS_ERR_PARAMETER_NOT_WRITABLE                                                        "The parameter store does not support a write interface"
+    9000: SzLicenseError,                   # EAS_LIMIT_MAX_OBS_ENT                                                                 "LIMIT: Maximum number of records ingested: {0}"
+    9107: SzConfigurationError,             # EAS_ERR_CANT_GET_PARAMETER_FROM_THE_STORE                                             "Cannot get parameter [{0}] from parameter store"
+    9110: SzConfigurationError,             # EAS_ERR_INSUFFICIENT_CONFIG                                                           "Insufficient configuration for the {0} table!"
+    9111: SzConfigurationError,             # EAS_ERR_PARSE_FRAGMENT                                                                "ERROR parsing FragmentID[{0}] FragmentName[{1}] : [{2}] is an invalid RuleID dependency"
+    9112: SzConfigurationError,             # EAS_ERR_FAILED_TO_OPEN_INI_FILE_FOR_WRITING                                           "Failed to open ini file for writing [{0}]"
+    9113: SzConfigurationError,             # EAS_ERR_FAILED_TO_OPEN_INI_FILE_FOR_READING                                           "Failed to open ini file for reading [{0}]"
+    9115: SzBadInputError,                  # EAS_ERR_INPUT_NOT_STANDARDIZED                                                        "Cannot process Observation that has not been standardized"
+    9116: SzConfigurationError,             # EAS_ERR_CONFIG_TABLE_NOT_FOUND                                                        "CONFIG information for {0} not found!"
+    9117: SzConfigurationError,             # EAS_ERR_CONFIG_TABLE_COLUMN_NOT_FOUND                                                 "CONFIG information for {0} not found in {1}!"
+    9118: SzConfigurationError,             # EAS_ERR_CONFIG_TABLE_COLUMN_INDEX_NOT_FOUND                                           "Invalid column index {0} queried from {1} container!"
+    9119: SzConfigurationError,             # EAS_ERR_CONFIG_TABLE_COLUMN_NAME_NOT_FOUND                                            "Invalid column name {0} queried from {1} container!"
+    9120: SzConfigurationError,             # EAS_ERR_CONFIG_TABLE_MALFORMED                                                        "CONFIG information for {0} is malformed!"
+    9210: SzConfigurationError,             # EAS_ERR_DIGEST_CONTEXT_INIT_FAILED                                                    "Unable to initialize Digest Context."
+    9220: SzConfigurationError,             # EAS_ERR_FTYPE_CANNOT_BE_HASHED                                                        "FType configured to be hashed, but cannot be scored.  FTYPE_ID[{0}] FTYPE_CODE[{1}]"
+    9222: SzConfigurationError,             # EAS_ERR_FTYPE_CONFIGURED_TO_BE_HASHED_MISSING_SALT                                    "A Feature Type is marked for hashing, but a valid salt value was not found.  FTYPE_ID[{0}] FTYPE_CODE[{1}]"
+    9224: SzConfigurationError,             # EAS_ERR_FTYPE_CONFIGURED_TO_BE_HASHED                                                 "FType configured to be hashed, but no hashable data found.  FTYPE_ID[{0}] FTYPE_CODE[{1}]"
+    9228: SzConfigurationError,             # EAS_ERR_UNEXPECTED_SALT_CHECKUM_LIST                                                  "The SALT checksum on the Observation does not match the EXPECTED SALT checksum: EXPECTED=[{0}] Observation=[{1}]"
+    9240: SzConfigurationError,             # EAS_ERR_CIPHER_CONTEXT_INIT_FAILED                                                    "Unable to initialize an ICC Context."
+    9241: SzConfigurationError,             # EAS_ERR_CIPHER_OP_FAILED                                                              "Unable to perform a required ICC operation."
+    9250: SzConfigurationError,             # EAS_ERR_G2SS_INVALID_LIB                                                              "Invalid ({1}) Secure Store plug-in library: {0}"
+    9251: SzConfigurationError,             # EAS_ERR_G2SS_INVALID_URL                                                              "Invalid Secure Store URL: {0}"
+    9252: SzConfigurationError,             # EAS_ERR_G2SS_INVALID_PIN                                                              "Invalid Secure Store credential specification: {0}"
+    9253: SzConfigurationError,             # EAS_ERR_G2SS_TOKEN_INIT_FAILED                                                        "Secure Store token initialization failed: {0}."
+    9254: SzConfigurationError,             # EAS_ERR_G2SS_TOKEN_UNINITIALISED                                                      "Cannot open a Secure Store session when the token is uninitialized."
+    9255: SzConfigurationError,             # EAS_ERR_G2SS_USER_PIN_UNINITIALISED                                                   "Secure Store credential is uninitialized."
+    9256: SzConfigurationError,             # EAS_ERR_G2SS_SESSION_OPEN                                                             "Cannot open a Secure Store session when one is already open."
+    9257: SzConfigurationError,             # EAS_ERR_G2SS_NO_SESSION                                                               "Cannot use Secure Store without a session."
+    9258: SzConfigurationError,             # EAS_ERR_G2SS_SESSION_OPEN_FAILED                                                      "Secure Store session could not be opened: {0}."
+    9259: SzConfigurationError,             # EAS_ERR_G2SS_ADMIN_LOGIN_FAILED                                                       "Secure Store admin login failed: {0}."
+    9260: SzConfigurationError,             # EAS_ERR_G2SS_USER_LOGIN_FAILED                                                        "Secure Store user login failed: {0}."
+    9261: SzConfigurationError,             # EAS_ERR_G2SS_PKCS11_ERROR                                                             "Secure Store function failed: {0}"
+    9264: SzConfigurationError,             # EAS_ERR_G2SS_LOGOUT_FAILED                                                            "Secure Store logout failed: {0}."
+    9265: SzConfigurationError,             # EAS_ERR_G2SS_NEED_RW_SESSION                                                          "Secure Store session must be read/write."
+    9266: SzConfigurationError,             # EAS_ERR_G2SS_UNABLE_TO_VERIFY_KEY                                                     "Secure Store key does not meet requirements."
+    9267: SzError,                          # EAS_ERR_G2SS_UNABLE_TO_CREATE_KEY                                                     "Secure Store key creation failed."
+    9268: SzError,                          # EAS_ERR_G2SS_UNABLE_TO_CHANGE_PIN                                                     "Secure Store password change failed: {0}."
+    9269: SzConfigurationError,             # EAS_ERR_G2SS_INVALID_OLD_CREDENTIAL                                                   "Secure Store old credential is invalid."
+    9270: SzConfigurationError,             # EAS_ERR_G2SS_INVALID_NEW_CREDENTIAL                                                   "Secure Store new credential is invalid."
+    9271: SzError,                          # EAS_ERR_G2SS_OUT_OF_MEMORY                                                            "Secure Store out of memory."
+    9272: SzError,                          # EAS_ERR_G2SS_FIND_INIT_FAILED                                                         "Secure Store object locating failed: {0}."
+    9273: SzError,                          # EAS_ERR_G2SS_FIND_FAILED                                                              "Secure Store object find failed: {0}."
+    9274: SzError,                          # EAS_ERR_G2SS_CRYPTO_SETUP_FAILED                                                      "Secure Store setup of encryption failed: {0}."
+    9275: SzError,                          # EAS_ERR_G2SS_ENCRYPT_START_FAILED                                                     "Secure Store unable to start encryption: {0}."
+    9276: SzError,                          # EAS_ERR_G2SS_ENCRYPT_SIZE_FAILED                                                      "Secure Store unable to get the size of encrypted data: {0}."
+    9277: SzError,                          # EAS_ERR_G2SS_ENCRYPT_FAILED                                                           "Secure Store encryption failed: {0}."
+    9278: SzError,                          # EAS_ERR_G2SS_DECRYPT_START_FAILED                                                     "Secure Store unable to start decryption: {0}."
+    9279: SzError,                          # EAS_ERR_G2SS_DECRYPT_FAILED                                                           "Secure Store decryption failed: {0}."
+    9280: SzError,                          # EAS_ERR_G2SS_OBJECT_SAVE_FAILED                                                       "Secure Store unable to save object: {0}."
+    9281: SzError,                          # EAS_ERR_G2SS_OBJECT_DELETE_FAILED                                                     "Secure Store unable to delete object: {0}."
+    9282: SzError,                          # EAS_ERR_G2SS_OBJECT_CHANGE_FAILED                                                     "Secure Store unable to modify object: {0}."
+    9283: SzError,                          # EAS_ERR_G2SS_UNINITIALISED                                                            "Secure Store has not been initialized"
+    9284: SzConfigurationError,             # EAS_ERR_G2SS_INVALID_SLOT_ID                                                          "Can not obtain info on specified slot. Possibly invalid slot ID specified in Secure Store URL: {0}"
+    9285: SzConfigurationError,             # EAS_ERR_G2SS_NO_TOKEN_IN_SLOT                                                         "No security token present in slot specified by Secure Store URL: slot ID = {0}"
+    9286: SzConfigurationError,             # EAS_ERR_G2SS_TOKEN_NOT_FOUND                                                          "Can not obtain info for security token. Possibly invalid token label and/or slot ID specified in Secure Store URL: {0}"
+    9287: SzError,                          # EAS_ERR_G2SS_TOKEN_IMPL_ERROR                                                         "An internal error occurred in the security token implementation library: Return Code = {0}"
+    9288: SzError,                          # EAS_ERR_G2SS_USER_PIN_PROMPT_FAILED                                                   "Was unable to prompt user for security token authentication."
+    9289: SzError,                          # EAS_ERR_G2SS_LABEL_CHANGED_SINCE_CONFIG_INIT                                          "Secure Store has been reconfigured since loading."
+    9290: SzError,                          # EAS_ERR_G2SS_OBJECT_NOT_FOUND                                                         "Secure Store does not have an object called {0}."
+    9292: SzConfigurationError,             # EAS_ERR_G2SS_NO_PASSWORD                                                              "No password supplied"
+    9293: SzConfigurationError,             # EAS_ERR_G2SS_NO_SEC_STORE_PREFIX                                                      "Secure Store expects a different format (starting with {0}) when a password is supplied"
+    9295: SzConfigurationError,             # EAS_ERR_G2SS_NO_DATA_OBJECTS                                                          "There are no Secure Store objects stored on the token"
+    9296: SzConfigurationError,             # EAS_ERR_G2SS_SEC_STORE_ARCHIVE_BAD                                                    "The exported archive appears to be corrupted around object {0}"
+    9297: SzConfigurationError,             # EAS_ERR_G2SS_FILE_NOT_FOUND                                                           "Secure Store failed to open {0}"
+    9298: SzConfigurationError,             # EAS_ERR_G2SS_FILE_CONTENTS_BAD                                                        "Secure Store contents of {0} not usable."
+    9299: SzError,                          # EAS_ERR_G2SS_CLASS_NOT_INIT                                                           "Secure Store internal error."
+    9300: SzConfigurationError,             # EAS_ERR_G2SS_PASSWORD_CHECK_ERROR                                                     "Secure Store internal error ({0}) checking password."
+    9301: SzConfigurationError,             # EAS_ERR_MISSING_SEQUENCE_ENTRY                                                        "Missing Sequence Entry[{0}] in the SYS_SEQUENCE table!"
+    9305: SzError,                          # EAS_ERR_SEQUENCE_RETRIES_FAILED                                                       "Retries failed to retrieve Sequence Entry[{0}] in the SYS_SEQUENCE table!  This may mean the CACHE_SIZE is too small."
+    9308: SzConfigurationError,             # EAS_ERR_MISSING_STATUS_ENTRY                                                          "Could not retrieve status entry[{0}] in the SYS_STATUS table!"
+    9309: SzConfigurationError,             # EAS_ERR_SEQUENCE_HAS_BEEN_RESET                                                       "Sequence entry[{0}] has been reset."
+    9310: SzConfigurationError,             # EAS_ERR_INVALID_STATUS_ENTRY_VALUE                                                    "Invalid value for status entry[{0}] in the SYS_STATUS table!"
+    9311: SzError,                          # EAS_ERR_COULD_NOT_RECORD_USAGE_TYPE                                                   "Could not record usage type [{0}] in the LIB_UTYPE table!"
+    9406: SzError,                          # EAS_ERR_G2SS_SESSION_MUST_NOT_BE_OPEN                                                 "Secure Store cannot fetch a value with sync if a session is already open."
+    9408: SzConfigurationError,             # EAS_ERR_G2SS_PASSWORD_INADEQUATE                                                      "The provided password is not strong enough: {0}"
+    9409: SzConfigurationError,             # EAS_ERR_G2SS_FUNCTION_LIST_NOT_SET                                                    "The security token interface is not yet set"
+    9410: SzError,                          # EAS_ERR_G2SS_PKCS_INIT_FAILED                                                         "Initializing token driver failed {0}"
+    9411: SzError,                          # EAS_ERR_G2SS_PKCS_FINAL_FAILED                                                        "Finalizing token driver failed {0}"
+    9413: SzConfigurationError,             # EAS_ERR_G2SS_INCORRECT_PASSWORD                                                       "The export file password appears to be incorrect."
+    9414: SzBadInputError,                  # EAS_ERR_STRING_IS_INVALID_UTF8                                                        "Invalid data string. Data must be in UTF-8."
+    9500: SzConfigurationError,             # EAS_ERR_TOKEN_LIBRARY_CHECKSUM_MISMATCH                                               "Cannot load token library. The checksum does not match the configuration of this node. Found: [{0}] Expected: [{1}]"
+    9501: SzError,                          # EAS_TOKEN_LIBRARY_ALREADY_HASHED                                                      "Cannot hash token library. The Token Library contains previous hashed data"
+    9701: SzError,                          # EAS_ERR_CANT_RETRIEVE_INDEX_FROM_MEMORY_ROW                                           "Cannot retrieve index[{0}] from memory row of key[{1}], out of range!"
+    9802: SzConfigurationError,             # EAS_ERR_INBOUND_OBS_CONFIG_CHECKSUM_MISMATCH                                          "Configuration checksum on inbound observation [{0}] does not match this nodes configuration checksum [{1}]. Cannot process."
+    9803: SzConfigurationError,             # EAS_ERR_CALC_CONFIGCHKSUM_AND_PARAMSTORE_CONFIGCHKSUM_DONT_MATCH                      "The calculated configuration checksum [{0}] does not match the CONFIGURATION_CHECKSUM value in the parameter store [{1}]."
+    30011: SzError,                         # EAS_ERR_DELETE_WITH_RESOLVE_ONLY                                                      "Cannot delete an entity with type RESOLVE_ONLY"
+    30101: SzError,                         # EAS_ERR_INVALID_SESSION_HANDLE                                                        "Invalid Session Handle [{0}]"
+    30102: SzError,                         # EAS_ERR_INVALID_REPORT_HANDLE                                                         "Invalid Report Handle [{0}]"
+    30103: SzError,                         # EAS_ERR_INVALID_EXPORT_HANDLE                                                         "Invalid Export Handle [{0}]"
+    30110: SzError,                         # EAS_ERR_RESPONSE_MESSAGE_SIZE_LARGER_THAN_BUFFER_SIZE                                 "Response message size [{0}] is larger than buffer size [{1}]"
+    30111: SzError,                         # EAS_ERR_RESPONSE_RESIZE_FUNCTION_IS_NOT_PROVIDED                                      "Resize function is not provided"
+    30112: SzError,                         # EAS_ERR_RESPONSE_RESIZE_FUNCTION_GAVE_INVALID_RESULT                                  "Resize function returned an invalid result"
+    30121: SzBadInputError,                 # EAS_ERR_JSON_PARSING_FAILURE                                                          "JSON Parsing Failure [code={0},offset={1}]"
+    30122: SzBadInputError,                 # EAS_ERR_JSON_PARSING_FAILURE_MUST_BE_OBJECT_OR_ARRAY                                  "JSON Parsing Failure.  JSON must be object or array."
+    30123: SzBadInputError,                 # EAS_ERR_JSON_PARSING_FAILURE_OBJECT_HAS_DUPLICATE_KEYS                                "Json object has duplicate keys."
+    30131: SzBadInputError,                 # EAS_ERR_UNKNOWN_COLUMN_REQUESTED_FOR_CSV_EXPORT                                       "Invalid column [{0}] requested for CSV export."
+}
+# fmt: on
+
+
+# -----------------------------------------------------------------------------
+# ErrorBuffer class
+# -----------------------------------------------------------------------------
+
+
+class ErrorBuffer(threading.local):
+    """Buffer to call C"""
+
+    # pylint: disable=R0903
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.string_buffer = create_string_buffer(65535)
+        self.string_buffer_size = sizeof(self.string_buffer)
+
+
+ERROR_BUFFER = ErrorBuffer()
+ERROR_BUFFER_TYPE = c_char * 65535
+
+
+# -----------------------------------------------------------------------------
+# Helper functions to create a senzing-specific Exception
+# -----------------------------------------------------------------------------
+
+
+def get_location() -> str:
+    """
+    Determine caller.
+
+    :meta private:
+    """
+    stack = traceback.format_stack()
+    return stack[0].replace("\n   ", "", 1).rstrip()
+
+
+def get_message_level(error_id: int) -> str:
+    """
+    Determine the severity of the error.
+
+    :meta private:
+    """
+    error_levels = {
+        6000: "PANIC",
+        5000: "FATAL",
+        4000: "ERROR",
+        3000: "WARN",
+        2000: "INFO",
+        1000: "DEBUG",
+        0: "TRACE",
+    }
+    for error_level, error_message in error_levels.items():
+        if error_id > error_level:
+            return error_message
+    return "PANIC"
+
+
+def get_message_text(error_id: int, id_messages: Dict[int, str], *args: Any) -> str:
+    """
+    Format the message text from a template and variables.
+
+    :meta private:
+    """
+    return id_messages.get(error_id, f"No message for index {error_id}.").format(*args)
+
+
+def get_senzing_error_code(error_text: str) -> int:
+    """
+    Given an exception string, find the exception code.
+
+    :meta private:
+    """
+    if len(error_text) == 0:
+        return 0
+    exception_message_splits = error_text.split("|", 1)
+    try:
+        result = int(exception_message_splits[0].strip().rstrip("EIW"))
+    except ValueError:
+        print("ERROR: Could not parse error text '{error_text}'")
+        result = 9999
+    assert isinstance(result, int)
+    return result
+
+
+def get_senzing_error_text(
+    get_last_exception: Callable[[ERROR_BUFFER_TYPE, int], str],  # type: ignore
+    clear_last_exception: Callable[[], None],
+) -> str:
+    """
+    Get the last exception from the Senzing engine.
+
+    :meta private:
+    """
+    get_last_exception(
+        ERROR_BUFFER.string_buffer,
+        sizeof(ERROR_BUFFER.string_buffer),
+    )
+    clear_last_exception()
+    result = ERROR_BUFFER.string_buffer.value.decode()
+    assert isinstance(result, str)
+    return result
+
+
+def new_szexception(
+    get_last_exception: Callable[[ERROR_BUFFER_TYPE, int], str],  # type: ignore
+    clear_last_exception: Callable[[], None],
+    product_id: str,
+    error_id: int,
+    id_messages: Dict[int, str],
+    *args: Any,
+) -> Exception:
+    """
+    Generate a new Senzing Exception based on the error_id.
+
+    :meta private:
+    """
+    senzing_error_text = get_senzing_error_text(
+        get_last_exception, clear_last_exception
+    )
+    senzing_error_code = get_senzing_error_code(senzing_error_text)
+    message = {
+        "time": datetime.datetime.utcnow().isoformat("T"),
+        "text": get_message_text(error_id, id_messages, *args),
+        "level": get_message_level(error_id),
+        "id": f"senzing-{product_id}{error_id:4d}",
+        "location": get_location(),
+        "errorCode": senzing_error_code,
+        "errorText": senzing_error_text,
+        "details": args,
+    }
+    senzing_error_class = EXCEPTION_MAP.get(senzing_error_code, SzError)
+    return senzing_error_class(json.dumps(message))
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/senzing_abstract/szhasher_abstract.html b/_modules/senzing_abstract/szhasher_abstract.html new file mode 100644 index 0000000..09324fe --- /dev/null +++ b/_modules/senzing_abstract/szhasher_abstract.html @@ -0,0 +1,194 @@ + + + + + + senzing_abstract.szhasher_abstract — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Module code
    • +
  • senzing_abstract.szhasher_abstract
    • +
  • +
    • +
+
+
+
+
+ +

Source code for senzing_abstract.szhasher_abstract

+#! /usr/bin/env python3
+
+"""
+TODO: szhasher_abstract.py
+"""
+
+from abc import ABC, abstractmethod
+from typing import Any
+
+# Metadata
+
+__all__ = ["SzHasherAbstract"]
+__version__ = "0.0.1"  # See https://www.python.org/dev/peps/pep-0396/
+__date__ = "2023-10-30"
+__updated__ = "2023-10-30"
+
+# -----------------------------------------------------------------------------
+# SzHasherAbstract
+# -----------------------------------------------------------------------------
+
+
+

+[docs]
+class SzHasherAbstract(ABC):
+    """
+    SzHasher module access library
+    """
+
+    # -------------------------------------------------------------------------
+    # Messages
+    # -------------------------------------------------------------------------
+
+    PREFIX = "szhasher."
+    ID_MESSAGES = {0: ""}
+
+    # -------------------------------------------------------------------------
+    # Interface definition
+    # -------------------------------------------------------------------------
+
+

+[docs]
+    @abstractmethod
+    def destroy(self, *args: Any, **kwargs: Any) -> None:
+        """TODO: document"""

+
+
+

+[docs]
+    @abstractmethod
+    def export_token_library(self, *args: Any, **kwargs: Any) -> str:
+        """TODO: document"""

+
+
+

+[docs]
+    @abstractmethod
+    def init(
+        self, module_name: str, ini_params: str, verbose_logging: int = 0, **kwargs: Any
+    ) -> None:
+        """TODO: document"""

+
+
+

+[docs]
+    @abstractmethod
+    def init_with_config_id(
+        self,
+        module_name: str,
+        ini_params: str,
+        init_config_id: int,
+        verbose_logging: int = 0,
+        **kwargs: Any
+    ) -> None:
+        """TODO: document"""

+
+
+

+[docs]
+    @abstractmethod
+    def process(self, record: str, *args: Any, **kwargs: Any) -> str:
+        """TODO: document"""

+
+
+

+[docs]
+    @abstractmethod
+    def reinit(self, init_config_id: int, *args: Any, **kwargs: Any) -> None:
+        """TODO: document"""

+

+
+
+    # -------------------------------------------------------------------------
+    # Convenience methods
+    # -------------------------------------------------------------------------
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/senzing_abstract/szproduct_abstract.html b/_modules/senzing_abstract/szproduct_abstract.html new file mode 100644 index 0000000..15d7b7b --- /dev/null +++ b/_modules/senzing_abstract/szproduct_abstract.html @@ -0,0 +1,288 @@ + + + + + + senzing_abstract.szproduct_abstract — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Module code
    • +
  • senzing_abstract.szproduct_abstract
    • +
  • +
    • +
+
+
+
+
+ +

Source code for senzing_abstract.szproduct_abstract

+#! /usr/bin/env python3
+
+"""
+szproduct_abstract.py is the abstract class for all implementations of szproduct.
+"""
+
+# TODO: Determine specific SzError, Errors for "Raises:" documentation.
+import json
+from abc import ABC, abstractmethod
+from typing import Any, Dict, Union, cast
+
+# Metadata
+
+__all__ = ["SzProductAbstract"]
+__version__ = "0.0.1"  # See https://www.python.org/dev/peps/pep-0396/
+__date__ = "2023-10-30"
+__updated__ = "2023-11-27"
+
+# -----------------------------------------------------------------------------
+# SzProductAbstract
+# -----------------------------------------------------------------------------
+
+
+

+[docs]
+class SzProductAbstract(ABC):
+    """
+    SzProductAbstract is the definition of the Senzing Python API that is
+    implemented by packages such as szproduct.py.
+    """
+
+    # -------------------------------------------------------------------------
+    # Messages
+    # -------------------------------------------------------------------------
+
+    PREFIX = "szproduct."
+    ID_MESSAGES = {
+        4001: PREFIX + "destroy() failed. Return code: {0}",
+        4002: PREFIX + "initialize({0}, {1}, {2}) failed. Return code: {3}",
+        4003: PREFIX
+        + "SzProduct({0}, {1}) failed. instance_name and settings must both be set or both be empty",
+    }
+
+    # -------------------------------------------------------------------------
+    # Interface definition
+    # -------------------------------------------------------------------------
+
+

+[docs]
+    @abstractmethod
+    def destroy(self, **kwargs: Any) -> None:
+        """
+        The `destroy` method will destroy and perform cleanup for the Senzing SzProduct object.
+        It should be called after all other calls are complete.
+
+        **Note:** If the `SzProduct` constructor was called with parameters,
+        the destructor will automatically call the destroy() method.
+        In this case, a separate call to `destroy()` is not needed.
+
+        Raises:
+            szexception.SzError:
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szproduct/szproduct_initialize_and_destroy.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def initialize(
+        self,
+        instance_name: str,
+        settings: Union[str, Dict[Any, Any]],
+        verbose_logging: int = 0,
+        **kwargs: Any
+    ) -> None:
+        """
+        The `initialize` method initializes the Senzing SzProduct object.
+        It must be called prior to any other calls.
+
+        **Note:** If the SzProduct constructor is called with parameters,
+        the constructor will automatically call the `initialize()` method.
+        In this case, a separate call to `initialize()` is not needed.
+
+        Args:
+            instance_name (str): A short name given to this instance of the SzProduct object, to help identify it within system logs.
+            settings (str): A JSON string containing configuration parameters.
+            verbose_logging (int): `Optional:` A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0
+
+        Raises:
+            TypeError: Incorrect datatype of input parameter.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szproduct/szproduct_initialize_and_destroy.py
+                :linenos:
+                :language: python
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_license(self, **kwargs: Any) -> str:
+        """
+        The `get_license` method retrieves information about the currently used license by the Senzing API.
+
+        Returns:
+            str: A JSON document containing Senzing license metadata.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szproduct/get_license.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szproduct/get_license.txt
+                :linenos:
+                :language: json
+        """

+
+
+

+[docs]
+    @abstractmethod
+    def get_version(self, **kwargs: Any) -> str:
+        """
+        The `get_version` method returns the version of the Senzing API.
+
+        Returns:
+            str: A JSON document containing metadata about the Senzing Engine version being used.
+
+        .. collapse:: Example:
+
+            .. literalinclude:: ../../examples/szproduct/get_version.py
+                :linenos:
+                :language: python
+
+            **Output:**
+
+            .. literalinclude:: ../../examples/szproduct/get_version.txt
+                :linenos:
+                :language: json
+        """

+
+
+    # -------------------------------------------------------------------------
+    # Convenience methods
+    # -------------------------------------------------------------------------
+
+

+[docs]
+    def license_as_dict(self, **kwargs: Any) -> Dict[str, Any]:
+        """
+        A convenience method for
+        :meth:`senzing_abstract.SzProductAbstract.get_license`
+
+        Returns:
+            Dict[str, Any]: A dictionary containing Senzing license metadata.
+        """
+        return cast(
+            Dict[str, Any],
+            json.loads(self.get_license(**kwargs)),
+        )

+
+
+

+[docs]
+    def version_as_dict(self, **kwargs: Any) -> Dict[str, Any]:
+        """
+        A convenience method for
+        :meth:`senzing_abstract.SzProductAbstract.get_version`
+
+        Returns:
+            Dict[str, Any]: A dictionary containing metadata about the Senzing Engine version being used.
+        """
+        return cast(
+            Dict[str, Any],
+            json.loads(self.get_version(**kwargs)),
+        )

+

+
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 0000000..cafb8d1 --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,20 @@ +.. sz-sdk-python-abstract documentation master file, created by + sphinx-quickstart on Thu Dec 14 15:35:47 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to sz-sdk-python-abstract's documentation! +================================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/_sources/modules.rst.txt b/_sources/modules.rst.txt new file mode 100644 index 0000000..dfb1f3a --- /dev/null +++ b/_sources/modules.rst.txt @@ -0,0 +1,7 @@ +senzing_abstract +================ + +.. toctree:: + :maxdepth: 4 + + senzing_abstract diff --git a/_sources/senzing_abstract.rst.txt b/_sources/senzing_abstract.rst.txt new file mode 100644 index 0000000..eadb168 --- /dev/null +++ b/_sources/senzing_abstract.rst.txt @@ -0,0 +1,69 @@ +senzing\_abstract package +========================= + +Submodules +---------- + +senzing\_abstract.szconfig\_abstract module +------------------------------------------- + +.. automodule:: senzing_abstract.szconfig_abstract + :members: + :undoc-members: + :show-inheritance: + +senzing\_abstract.szconfigmanager\_abstract module +-------------------------------------------------- + +.. automodule:: senzing_abstract.szconfigmanager_abstract + :members: + :undoc-members: + :show-inheritance: + +senzing\_abstract.szdiagnostic\_abstract module +----------------------------------------------- + +.. automodule:: senzing_abstract.szdiagnostic_abstract + :members: + :undoc-members: + :show-inheritance: + +senzing\_abstract.szengine\_abstract module +------------------------------------------- + +.. automodule:: senzing_abstract.szengine_abstract + :members: + :undoc-members: + :show-inheritance: + +senzing\_abstract.szengineflags module +-------------------------------------- + +.. automodule:: senzing_abstract.szengineflags + :members: + :undoc-members: + :show-inheritance: + +senzing\_abstract.szhasher\_abstract module +------------------------------------------- + +.. automodule:: senzing_abstract.szhasher_abstract + :members: + :undoc-members: + :show-inheritance: + +senzing\_abstract.szproduct\_abstract module +-------------------------------------------- + +.. automodule:: senzing_abstract.szproduct_abstract + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: senzing_abstract + :members: + :undoc-members: + :show-inheritance: diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8141580 --- /dev/null +++ b/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 0000000..f316efc --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/css/badge_only.css b/_static/css/badge_only.css new file mode 100644 index 0000000..c718cee --- /dev/null +++ b/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff b/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff2 b/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff b/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff2 b/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/_static/css/fonts/fontawesome-webfont.eot b/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/_static/css/fonts/fontawesome-webfont.svg b/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/css/fonts/fontawesome-webfont.ttf b/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/_static/css/fonts/fontawesome-webfont.woff b/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/_static/css/fonts/fontawesome-webfont.woff2 b/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/_static/css/fonts/lato-bold-italic.woff b/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff differ diff --git a/_static/css/fonts/lato-bold-italic.woff2 b/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/_static/css/fonts/lato-bold.woff b/_static/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff differ diff --git a/_static/css/fonts/lato-bold.woff2 b/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff2 differ diff --git a/_static/css/fonts/lato-normal-italic.woff b/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff differ diff --git a/_static/css/fonts/lato-normal-italic.woff2 b/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/_static/css/fonts/lato-normal.woff b/_static/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/_static/css/fonts/lato-normal.woff differ diff --git a/_static/css/fonts/lato-normal.woff2 b/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/_static/css/fonts/lato-normal.woff2 differ diff --git a/_static/css/theme.css b/_static/css/theme.css new file mode 100644 index 0000000..19a446a --- /dev/null +++ b/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 0000000..4d67807 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 0000000..7e4c114 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/jquery.js b/_static/jquery.js new file mode 100644 index 0000000..c4c6022 --- /dev/null +++ b/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/_static/js/html5shiv.min.js b/_static/js/html5shiv.min.js new file mode 100644 index 0000000..cd1c674 --- /dev/null +++ b/_static/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/_static/js/theme.js b/_static/js/theme.js new file mode 100644 index 0000000..1fddb6e --- /dev/null +++ b/_static/js/theme.js @@ -0,0 +1 @@ +!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 0000000..d96755f Binary files /dev/null and b/_static/minus.png differ diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 0000000..7107cec Binary files /dev/null and b/_static/plus.png differ diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 0000000..84ab303 --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 0000000..92da3f8 --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,619 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + "Search finished, found ${resultCount} page(s) matching the search query." + ).replace('${resultCount}', resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + for (const removalQuery of [".headerlinks", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/genindex.html b/genindex.html new file mode 100644 index 0000000..8b56e64 --- /dev/null +++ b/genindex.html @@ -0,0 +1,1330 @@ + + + + + + Index — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Index
    • +
  • +
    • +
+
+
+
+
+ + +

Index

+ +
+ A + | C + | D + | E + | F + | G + | H + | I + | L + | M + | P + | R + | S + | V + | W + +
+

A

+ + + +
+ +

C

+ + + +
+ +

D

+ + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

H

+ + + +
+ +

I

+ + + +
+ +

L

+ + +
+ +

M

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

V

+ + +
+ +

W

+ + + +
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..8248442 --- /dev/null +++ b/index.html @@ -0,0 +1,117 @@ + + + + + + + Welcome to sz-sdk-python-abstract’s documentation! — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Welcome to sz-sdk-python-abstract’s documentation!

+
+
+
+
+

Indices and tables

+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/modules.html b/modules.html new file mode 100644 index 0000000..a2e1b58 --- /dev/null +++ b/modules.html @@ -0,0 +1,523 @@ + + + + + + + senzing_abstract — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

senzing_abstract

+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 0000000..2bd1dd2 Binary files /dev/null and b/objects.inv differ diff --git a/py-modindex.html b/py-modindex.html new file mode 100644 index 0000000..eb33e0b --- /dev/null +++ b/py-modindex.html @@ -0,0 +1,154 @@ + + + + + + Python Module Index — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Python Module Index
    • +
  • +
    • +
+
+
+
+
+ + +

Python Module Index

+ +
+ s +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ s
+ senzing_abstract +
    + senzing_abstract.szconfig_abstract +
    + senzing_abstract.szconfigmanager_abstract +
    + senzing_abstract.szdiagnostic_abstract +
    + senzing_abstract.szengine_abstract +
    + senzing_abstract.szengineflags +
    + senzing_abstract.szhasher_abstract +
    + senzing_abstract.szproduct_abstract +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/search.html b/search.html new file mode 100644 index 0000000..ba05187 --- /dev/null +++ b/search.html @@ -0,0 +1,119 @@ + + + + + + Search — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 0000000..2e85f24 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"Indices and tables": [[0, "indices-and-tables"]], "Module contents": [[2, "module-senzing_abstract"]], "Submodules": [[2, "submodules"]], "Welcome to sz-sdk-python-abstract\u2019s documentation!": [[0, "welcome-to-sz-sdk-python-abstract-s-documentation"]], "senzing_abstract": [[1, "senzing-abstract"]], "senzing_abstract package": [[2, "senzing-abstract-package"]], "senzing_abstract.szconfig_abstract module": [[2, "module-senzing_abstract.szconfig_abstract"]], "senzing_abstract.szconfigmanager_abstract module": [[2, "module-senzing_abstract.szconfigmanager_abstract"]], "senzing_abstract.szdiagnostic_abstract module": [[2, "module-senzing_abstract.szdiagnostic_abstract"]], "senzing_abstract.szengine_abstract module": [[2, "module-senzing_abstract.szengine_abstract"]], "senzing_abstract.szengineflags module": [[2, "module-senzing_abstract.szengineflags"]], "senzing_abstract.szhasher_abstract module": [[2, "module-senzing_abstract.szhasher_abstract"]], "senzing_abstract.szproduct_abstract module": [[2, "module-senzing_abstract.szproduct_abstract"]]}, "docnames": ["index", "modules", "senzing_abstract"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst", "modules.rst", "senzing_abstract.rst"], "indexentries": {"add_config() (senzing_abstract.szconfigmanager_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract.add_config", false]], "add_config() (senzing_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.SzConfigManagerAbstract.add_config", false]], "add_data_source() (senzing_abstract.szconfig_abstract.szconfigabstract method)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract.add_data_source", false]], "add_data_source() (senzing_abstract.szconfigabstract method)": [[2, "senzing_abstract.SzConfigAbstract.add_data_source", false]], "add_record() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.add_record", false]], "add_record() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.add_record", false]], "add_record_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.add_record_return_dict", false]], "add_record_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.add_record_return_dict", false]], "check_datastore_performance() (senzing_abstract.szdiagnostic_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract.check_datastore_performance", false]], "check_datastore_performance() (senzing_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.SzDiagnosticAbstract.check_datastore_performance", false]], "close_config() (senzing_abstract.szconfig_abstract.szconfigabstract method)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract.close_config", false]], "close_config() (senzing_abstract.szconfigabstract method)": [[2, "senzing_abstract.SzConfigAbstract.close_config", false]], "close_export() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.close_export", false]], "close_export() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.close_export", false]], "combine_flags() (senzing_abstract.szengineflags class method)": [[2, "senzing_abstract.SzEngineFlags.combine_flags", false]], "combine_flags() (senzing_abstract.szengineflags.szengineflags class method)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.combine_flags", false]], "count_redo_records() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.count_redo_records", false]], "count_redo_records() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.count_redo_records", false]], "create_config() (senzing_abstract.szconfig_abstract.szconfigabstract method)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract.create_config", false]], "create_config() (senzing_abstract.szconfigabstract method)": [[2, "senzing_abstract.SzConfigAbstract.create_config", false]], "delete_data_source() (senzing_abstract.szconfig_abstract.szconfigabstract method)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract.delete_data_source", false]], "delete_data_source() (senzing_abstract.szconfigabstract method)": [[2, "senzing_abstract.SzConfigAbstract.delete_data_source", false]], "delete_record() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.delete_record", false]], "delete_record() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.delete_record", false]], "delete_record_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.delete_record_return_dict", false]], "delete_record_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.delete_record_return_dict", false]], "destroy() (senzing_abstract.szconfig_abstract.szconfigabstract method)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract.destroy", false]], "destroy() (senzing_abstract.szconfigabstract method)": [[2, "senzing_abstract.SzConfigAbstract.destroy", false]], "destroy() (senzing_abstract.szconfigmanager_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract.destroy", false]], "destroy() (senzing_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.SzConfigManagerAbstract.destroy", false]], "destroy() (senzing_abstract.szdiagnostic_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract.destroy", false]], "destroy() (senzing_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.SzDiagnosticAbstract.destroy", false]], "destroy() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.destroy", false]], "destroy() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.destroy", false]], "destroy() (senzing_abstract.szhasher_abstract.szhasherabstract method)": [[2, "senzing_abstract.szhasher_abstract.SzHasherAbstract.destroy", false]], "destroy() (senzing_abstract.szhasherabstract method)": [[2, "senzing_abstract.SzHasherAbstract.destroy", false]], "destroy() (senzing_abstract.szproduct_abstract.szproductabstract method)": [[2, "senzing_abstract.szproduct_abstract.SzProductAbstract.destroy", false]], "destroy() (senzing_abstract.szproductabstract method)": [[2, "senzing_abstract.SzProductAbstract.destroy", false]], "export_config() (senzing_abstract.szconfig_abstract.szconfigabstract method)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract.export_config", false]], "export_config() (senzing_abstract.szconfigabstract method)": [[2, "senzing_abstract.SzConfigAbstract.export_config", false]], "export_csv_entity_report() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.export_csv_entity_report", false]], "export_csv_entity_report() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.export_csv_entity_report", false]], "export_json_entity_report() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.export_json_entity_report", false]], "export_json_entity_report() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.export_json_entity_report", false]], "export_token_library() (senzing_abstract.szhasher_abstract.szhasherabstract method)": [[2, "senzing_abstract.szhasher_abstract.SzHasherAbstract.export_token_library", false]], "export_token_library() (senzing_abstract.szhasherabstract method)": [[2, "senzing_abstract.SzHasherAbstract.export_token_library", false]], "fetch_next() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.fetch_next", false]], "fetch_next() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.fetch_next", false]], "find_interesting_entities_by_entity_id() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_interesting_entities_by_entity_id", false]], "find_interesting_entities_by_entity_id() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_interesting_entities_by_entity_id", false]], "find_interesting_entities_by_entity_id_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_interesting_entities_by_entity_id_return_dict", false]], "find_interesting_entities_by_entity_id_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_interesting_entities_by_entity_id_return_dict", false]], "find_interesting_entities_by_record_id() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_interesting_entities_by_record_id", false]], "find_interesting_entities_by_record_id() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_interesting_entities_by_record_id", false]], "find_interesting_entities_by_record_id_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_interesting_entities_by_record_id_return_dict", false]], "find_interesting_entities_by_record_id_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_interesting_entities_by_record_id_return_dict", false]], "find_network_by_entity_id() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_network_by_entity_id", false]], "find_network_by_entity_id() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_network_by_entity_id", false]], "find_network_by_entity_id_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_network_by_entity_id_return_dict", false]], "find_network_by_entity_id_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_network_by_entity_id_return_dict", false]], "find_network_by_record_id() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_network_by_record_id", false]], "find_network_by_record_id() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_network_by_record_id", false]], "find_network_by_record_id_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_network_by_record_id_return_dict", false]], "find_network_by_record_id_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_network_by_record_id_return_dict", false]], "find_path_by_entity_id() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_path_by_entity_id", false]], "find_path_by_entity_id() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_path_by_entity_id", false]], "find_path_by_entity_id_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_path_by_entity_id_return_dict", false]], "find_path_by_entity_id_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_path_by_entity_id_return_dict", false]], "find_path_by_record_id() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_path_by_record_id", false]], "find_path_by_record_id() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_path_by_record_id", false]], "find_path_by_record_id_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.find_path_by_record_id_return_dict", false]], "find_path_by_record_id_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.find_path_by_record_id_return_dict", false]], "get_active_config_id() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_active_config_id", false]], "get_active_config_id() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_active_config_id", false]], "get_config() (senzing_abstract.szconfigmanager_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract.get_config", false]], "get_config() (senzing_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.SzConfigManagerAbstract.get_config", false]], "get_config_list() (senzing_abstract.szconfigmanager_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract.get_config_list", false]], "get_config_list() (senzing_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.SzConfigManagerAbstract.get_config_list", false]], "get_data_sources() (senzing_abstract.szconfig_abstract.szconfigabstract method)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract.get_data_sources", false]], "get_data_sources() (senzing_abstract.szconfigabstract method)": [[2, "senzing_abstract.SzConfigAbstract.get_data_sources", false]], "get_datastore_info() (senzing_abstract.szdiagnostic_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract.get_datastore_info", false]], "get_datastore_info() (senzing_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.SzDiagnosticAbstract.get_datastore_info", false]], "get_default_config_id() (senzing_abstract.szconfigmanager_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract.get_default_config_id", false]], "get_default_config_id() (senzing_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.SzConfigManagerAbstract.get_default_config_id", false]], "get_entity_by_entity_id() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_entity_by_entity_id", false]], "get_entity_by_entity_id() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_entity_by_entity_id", false]], "get_entity_by_entity_id_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_entity_by_entity_id_return_dict", false]], "get_entity_by_entity_id_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_entity_by_entity_id_return_dict", false]], "get_entity_by_record_id() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_entity_by_record_id", false]], "get_entity_by_record_id() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_entity_by_record_id", false]], "get_entity_by_record_id_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_entity_by_record_id_return_dict", false]], "get_entity_by_record_id_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_entity_by_record_id_return_dict", false]], "get_feature() (senzing_abstract.szdiagnostic_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract.get_feature", false]], "get_feature() (senzing_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.SzDiagnosticAbstract.get_feature", false]], "get_license() (senzing_abstract.szproduct_abstract.szproductabstract method)": [[2, "senzing_abstract.szproduct_abstract.SzProductAbstract.get_license", false]], "get_license() (senzing_abstract.szproductabstract method)": [[2, "senzing_abstract.SzProductAbstract.get_license", false]], "get_record() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_record", false]], "get_record() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_record", false]], "get_record_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_record_return_dict", false]], "get_record_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_record_return_dict", false]], "get_redo_record() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_redo_record", false]], "get_redo_record() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_redo_record", false]], "get_repository_last_modified_time() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_repository_last_modified_time", false]], "get_repository_last_modified_time() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_repository_last_modified_time", false]], "get_stats() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_stats", false]], "get_stats() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_stats", false]], "get_stats_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_stats_return_dict", false]], "get_stats_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_stats_return_dict", false]], "get_version() (senzing_abstract.szproduct_abstract.szproductabstract method)": [[2, "senzing_abstract.szproduct_abstract.SzProductAbstract.get_version", false]], "get_version() (senzing_abstract.szproductabstract method)": [[2, "senzing_abstract.SzProductAbstract.get_version", false]], "get_virtual_entity_by_record_id() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_virtual_entity_by_record_id", false]], "get_virtual_entity_by_record_id() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_virtual_entity_by_record_id", false]], "get_virtual_entity_by_record_id_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.get_virtual_entity_by_record_id_return_dict", false]], "get_virtual_entity_by_record_id_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.get_virtual_entity_by_record_id_return_dict", false]], "how_entity_by_entity_id() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.how_entity_by_entity_id", false]], "how_entity_by_entity_id() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.how_entity_by_entity_id", false]], "how_entity_by_entity_id_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.how_entity_by_entity_id_return_dict", false]], "how_entity_by_entity_id_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.how_entity_by_entity_id_return_dict", false]], "id_messages (senzing_abstract.szconfig_abstract.szconfigabstract attribute)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract.ID_MESSAGES", false]], "id_messages (senzing_abstract.szconfigabstract attribute)": [[2, "senzing_abstract.SzConfigAbstract.ID_MESSAGES", false]], "id_messages (senzing_abstract.szconfigmanager_abstract.szconfigmanagerabstract attribute)": [[2, "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract.ID_MESSAGES", false]], "id_messages (senzing_abstract.szconfigmanagerabstract attribute)": [[2, "senzing_abstract.SzConfigManagerAbstract.ID_MESSAGES", false]], "id_messages (senzing_abstract.szdiagnostic_abstract.szdiagnosticabstract attribute)": [[2, "senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract.ID_MESSAGES", false]], "id_messages (senzing_abstract.szdiagnosticabstract attribute)": [[2, "senzing_abstract.SzDiagnosticAbstract.ID_MESSAGES", false]], "id_messages (senzing_abstract.szhasher_abstract.szhasherabstract attribute)": [[2, "senzing_abstract.szhasher_abstract.SzHasherAbstract.ID_MESSAGES", false]], "id_messages (senzing_abstract.szhasherabstract attribute)": [[2, "senzing_abstract.SzHasherAbstract.ID_MESSAGES", false]], "id_messages (senzing_abstract.szproduct_abstract.szproductabstract attribute)": [[2, "senzing_abstract.szproduct_abstract.SzProductAbstract.ID_MESSAGES", false]], "id_messages (senzing_abstract.szproductabstract attribute)": [[2, "senzing_abstract.SzProductAbstract.ID_MESSAGES", false]], "import_config() (senzing_abstract.szconfig_abstract.szconfigabstract method)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract.import_config", false]], "import_config() (senzing_abstract.szconfigabstract method)": [[2, "senzing_abstract.SzConfigAbstract.import_config", false]], "init() (senzing_abstract.szhasher_abstract.szhasherabstract method)": [[2, "senzing_abstract.szhasher_abstract.SzHasherAbstract.init", false]], "init() (senzing_abstract.szhasherabstract method)": [[2, "senzing_abstract.SzHasherAbstract.init", false]], "init_with_config_id() (senzing_abstract.szhasher_abstract.szhasherabstract method)": [[2, "senzing_abstract.szhasher_abstract.SzHasherAbstract.init_with_config_id", false]], "init_with_config_id() (senzing_abstract.szhasherabstract method)": [[2, "senzing_abstract.SzHasherAbstract.init_with_config_id", false]], "initialize() (senzing_abstract.szconfig_abstract.szconfigabstract method)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract.initialize", false]], "initialize() (senzing_abstract.szconfigabstract method)": [[2, "senzing_abstract.SzConfigAbstract.initialize", false]], "initialize() (senzing_abstract.szconfigmanager_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract.initialize", false]], "initialize() (senzing_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.SzConfigManagerAbstract.initialize", false]], "initialize() (senzing_abstract.szdiagnostic_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract.initialize", false]], "initialize() (senzing_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.SzDiagnosticAbstract.initialize", false]], "initialize() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.initialize", false]], "initialize() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.initialize", false]], "initialize() (senzing_abstract.szproduct_abstract.szproductabstract method)": [[2, "senzing_abstract.szproduct_abstract.SzProductAbstract.initialize", false]], "initialize() (senzing_abstract.szproductabstract method)": [[2, "senzing_abstract.SzProductAbstract.initialize", false]], "license_as_dict() (senzing_abstract.szproduct_abstract.szproductabstract method)": [[2, "senzing_abstract.szproduct_abstract.SzProductAbstract.license_as_dict", false]], "license_as_dict() (senzing_abstract.szproductabstract method)": [[2, "senzing_abstract.SzProductAbstract.license_as_dict", false]], "module": [[2, "module-senzing_abstract", false], [2, "module-senzing_abstract.szconfig_abstract", false], [2, "module-senzing_abstract.szconfigmanager_abstract", false], [2, "module-senzing_abstract.szdiagnostic_abstract", false], [2, "module-senzing_abstract.szengine_abstract", false], [2, "module-senzing_abstract.szengineflags", false], [2, "module-senzing_abstract.szhasher_abstract", false], [2, "module-senzing_abstract.szproduct_abstract", false]], "prefix (senzing_abstract.szconfig_abstract.szconfigabstract attribute)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract.PREFIX", false]], "prefix (senzing_abstract.szconfigabstract attribute)": [[2, "senzing_abstract.SzConfigAbstract.PREFIX", false]], "prefix (senzing_abstract.szconfigmanager_abstract.szconfigmanagerabstract attribute)": [[2, "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract.PREFIX", false]], "prefix (senzing_abstract.szconfigmanagerabstract attribute)": [[2, "senzing_abstract.SzConfigManagerAbstract.PREFIX", false]], "prefix (senzing_abstract.szdiagnostic_abstract.szdiagnosticabstract attribute)": [[2, "senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract.PREFIX", false]], "prefix (senzing_abstract.szdiagnosticabstract attribute)": [[2, "senzing_abstract.SzDiagnosticAbstract.PREFIX", false]], "prefix (senzing_abstract.szhasher_abstract.szhasherabstract attribute)": [[2, "senzing_abstract.szhasher_abstract.SzHasherAbstract.PREFIX", false]], "prefix (senzing_abstract.szhasherabstract attribute)": [[2, "senzing_abstract.SzHasherAbstract.PREFIX", false]], "prefix (senzing_abstract.szproduct_abstract.szproductabstract attribute)": [[2, "senzing_abstract.szproduct_abstract.SzProductAbstract.PREFIX", false]], "prefix (senzing_abstract.szproductabstract attribute)": [[2, "senzing_abstract.SzProductAbstract.PREFIX", false]], "prime_engine() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.prime_engine", false]], "prime_engine() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.prime_engine", false]], "process() (senzing_abstract.szhasher_abstract.szhasherabstract method)": [[2, "senzing_abstract.szhasher_abstract.SzHasherAbstract.process", false]], "process() (senzing_abstract.szhasherabstract method)": [[2, "senzing_abstract.SzHasherAbstract.process", false]], "process_redo_record() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.process_redo_record", false]], "process_redo_record() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.process_redo_record", false]], "purge_repository() (senzing_abstract.szdiagnostic_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract.purge_repository", false]], "purge_repository() (senzing_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.SzDiagnosticAbstract.purge_repository", false]], "reevaluate_entity() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.reevaluate_entity", false]], "reevaluate_entity() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.reevaluate_entity", false]], "reevaluate_entity_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.reevaluate_entity_return_dict", false]], "reevaluate_entity_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.reevaluate_entity_return_dict", false]], "reevaluate_record() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.reevaluate_record", false]], "reevaluate_record() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.reevaluate_record", false]], "reevaluate_record_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.reevaluate_record_return_dict", false]], "reevaluate_record_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.reevaluate_record_return_dict", false]], "reinit() (senzing_abstract.szhasher_abstract.szhasherabstract method)": [[2, "senzing_abstract.szhasher_abstract.SzHasherAbstract.reinit", false]], "reinit() (senzing_abstract.szhasherabstract method)": [[2, "senzing_abstract.SzHasherAbstract.reinit", false]], "reinitialize() (senzing_abstract.szdiagnostic_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract.reinitialize", false]], "reinitialize() (senzing_abstract.szdiagnosticabstract method)": [[2, "senzing_abstract.SzDiagnosticAbstract.reinitialize", false]], "reinitialize() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.reinitialize", false]], "reinitialize() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.reinitialize", false]], "replace_default_config_id() (senzing_abstract.szconfigmanager_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract.replace_default_config_id", false]], "replace_default_config_id() (senzing_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.SzConfigManagerAbstract.replace_default_config_id", false]], "search_by_attributes() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.search_by_attributes", false]], "search_by_attributes() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.search_by_attributes", false]], "search_by_attributes_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.search_by_attributes_return_dict", false]], "search_by_attributes_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.search_by_attributes_return_dict", false]], "senzing_abstract": [[2, "module-senzing_abstract", false]], "senzing_abstract.szconfig_abstract": [[2, "module-senzing_abstract.szconfig_abstract", false]], "senzing_abstract.szconfigmanager_abstract": [[2, "module-senzing_abstract.szconfigmanager_abstract", false]], "senzing_abstract.szdiagnostic_abstract": [[2, "module-senzing_abstract.szdiagnostic_abstract", false]], "senzing_abstract.szengine_abstract": [[2, "module-senzing_abstract.szengine_abstract", false]], "senzing_abstract.szengineflags": [[2, "module-senzing_abstract.szengineflags", false]], "senzing_abstract.szhasher_abstract": [[2, "module-senzing_abstract.szhasher_abstract", false]], "senzing_abstract.szproduct_abstract": [[2, "module-senzing_abstract.szproduct_abstract", false]], "set_default_config_id() (senzing_abstract.szconfigmanager_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract.set_default_config_id", false]], "set_default_config_id() (senzing_abstract.szconfigmanagerabstract method)": [[2, "senzing_abstract.SzConfigManagerAbstract.set_default_config_id", false]], "sz_entity_brief_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_BRIEF_DEFAULT_FLAGS", false]], "sz_entity_brief_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_BRIEF_DEFAULT_FLAGS", false]], "sz_entity_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS", false]], "sz_entity_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS", false]], "sz_entity_include_all_features (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_ALL_FEATURES", false]], "sz_entity_include_all_features (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_ALL_FEATURES", false]], "sz_entity_include_all_relations (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_ALL_RELATIONS", false]], "sz_entity_include_all_relations (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_ALL_RELATIONS", false]], "sz_entity_include_disclosed_relations (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS", false]], "sz_entity_include_disclosed_relations (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS", false]], "sz_entity_include_entity_name (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_ENTITY_NAME", false]], "sz_entity_include_entity_name (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_ENTITY_NAME", false]], "sz_entity_include_name_only_relations (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS", false]], "sz_entity_include_name_only_relations (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS", false]], "sz_entity_include_possibly_related_relations (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS", false]], "sz_entity_include_possibly_related_relations (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS", false]], "sz_entity_include_possibly_same_relations (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS", false]], "sz_entity_include_possibly_same_relations (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS", false]], "sz_entity_include_record_data (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_DATA", false]], "sz_entity_include_record_data (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_DATA", false]], "sz_entity_include_record_feature_ids (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS", false]], "sz_entity_include_record_feature_ids (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS", false]], "sz_entity_include_record_json_data (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_JSON_DATA", false]], "sz_entity_include_record_json_data (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_JSON_DATA", false]], "sz_entity_include_record_matching_info (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO", false]], "sz_entity_include_record_matching_info (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO", false]], "sz_entity_include_record_summary (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_SUMMARY", false]], "sz_entity_include_record_summary (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_SUMMARY", false]], "sz_entity_include_record_types (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_TYPES", false]], "sz_entity_include_record_types (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_TYPES", false]], "sz_entity_include_record_unmapped_data (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA", false]], "sz_entity_include_record_unmapped_data (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA", false]], "sz_entity_include_related_entity_name (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME", false]], "sz_entity_include_related_entity_name (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME", false]], "sz_entity_include_related_matching_info (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO", false]], "sz_entity_include_related_matching_info (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO", false]], "sz_entity_include_related_record_data (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA", false]], "sz_entity_include_related_record_data (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA", false]], "sz_entity_include_related_record_summary (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY", false]], "sz_entity_include_related_record_summary (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY", false]], "sz_entity_include_representative_features (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES", false]], "sz_entity_include_representative_features (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES", false]], "sz_entity_option_include_feature_elements (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_OPTION_INCLUDE_FEATURE_ELEMENTS", false]], "sz_entity_option_include_feature_elements (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_OPTION_INCLUDE_FEATURE_ELEMENTS", false]], "sz_entity_option_include_feature_stats (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_OPTION_INCLUDE_FEATURE_STATS", false]], "sz_entity_option_include_feature_stats (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_OPTION_INCLUDE_FEATURE_STATS", false]], "sz_entity_option_include_internal_features (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES", false]], "sz_entity_option_include_internal_features (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES", false]], "sz_entity_option_include_match_key_details (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_ENTITY_OPTION_INCLUDE_MATCH_KEY_DETAILS", false]], "sz_entity_option_include_match_key_details (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_ENTITY_OPTION_INCLUDE_MATCH_KEY_DETAILS", false]], "sz_export_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS", false]], "sz_export_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS", false]], "sz_export_include_all_entities (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_EXPORT_INCLUDE_ALL_ENTITIES", false]], "sz_export_include_all_entities (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_EXPORT_INCLUDE_ALL_ENTITIES", false]], "sz_export_include_all_having_relationships (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS", false]], "sz_export_include_all_having_relationships (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS", false]], "sz_export_include_disclosed (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_EXPORT_INCLUDE_DISCLOSED", false]], "sz_export_include_disclosed (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_EXPORT_INCLUDE_DISCLOSED", false]], "sz_export_include_multi_record_entities (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES", false]], "sz_export_include_multi_record_entities (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES", false]], "sz_export_include_name_only (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_EXPORT_INCLUDE_NAME_ONLY", false]], "sz_export_include_name_only (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_EXPORT_INCLUDE_NAME_ONLY", false]], "sz_export_include_possibly_related (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_EXPORT_INCLUDE_POSSIBLY_RELATED", false]], "sz_export_include_possibly_related (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_EXPORT_INCLUDE_POSSIBLY_RELATED", false]], "sz_export_include_possibly_same (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_EXPORT_INCLUDE_POSSIBLY_SAME", false]], "sz_export_include_possibly_same (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_EXPORT_INCLUDE_POSSIBLY_SAME", false]], "sz_export_include_single_record_entities (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES", false]], "sz_export_include_single_record_entities (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES", false]], "sz_find_network_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS", false]], "sz_find_network_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS", false]], "sz_find_network_matching_info (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_FIND_NETWORK_MATCHING_INFO", false]], "sz_find_network_matching_info (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_FIND_NETWORK_MATCHING_INFO", false]], "sz_find_path_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS", false]], "sz_find_path_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS", false]], "sz_find_path_matching_info (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_FIND_PATH_MATCHING_INFO", false]], "sz_find_path_matching_info (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_FIND_PATH_MATCHING_INFO", false]], "sz_find_path_prefer_exclude (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_FIND_PATH_PREFER_EXCLUDE", false]], "sz_find_path_prefer_exclude (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_FIND_PATH_PREFER_EXCLUDE", false]], "sz_how_entity_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS", false]], "sz_how_entity_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS", false]], "sz_include_feature_scores (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_INCLUDE_FEATURE_SCORES", false]], "sz_include_feature_scores (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_INCLUDE_FEATURE_SCORES", false]], "sz_initialize_with_default_configuration (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_INITIALIZE_WITH_DEFAULT_CONFIGURATION", false]], "sz_initialize_with_default_configuration (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_INITIALIZE_WITH_DEFAULT_CONFIGURATION", false]], "sz_no_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_NO_FLAGS", false]], "sz_no_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_NO_FLAGS", false]], "sz_no_logging (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_NO_LOGGING", false]], "sz_no_logging (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_NO_LOGGING", false]], "sz_record_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS", false]], "sz_record_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS", false]], "sz_search_by_attributes_all (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_ALL", false]], "sz_search_by_attributes_all (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_ALL", false]], "sz_search_by_attributes_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS", false]], "sz_search_by_attributes_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS", false]], "sz_search_by_attributes_minimal_all (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL", false]], "sz_search_by_attributes_minimal_all (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL", false]], "sz_search_by_attributes_minimal_strong (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG", false]], "sz_search_by_attributes_minimal_strong (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG", false]], "sz_search_by_attributes_strong (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_STRONG", false]], "sz_search_by_attributes_strong (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_STRONG", false]], "sz_search_include_all_entities (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_INCLUDE_ALL_ENTITIES", false]], "sz_search_include_all_entities (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_INCLUDE_ALL_ENTITIES", false]], "sz_search_include_feature_scores (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_INCLUDE_FEATURE_SCORES", false]], "sz_search_include_feature_scores (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_INCLUDE_FEATURE_SCORES", false]], "sz_search_include_match_key_details (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_INCLUDE_MATCH_KEY_DETAILS", false]], "sz_search_include_match_key_details (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_INCLUDE_MATCH_KEY_DETAILS", false]], "sz_search_include_name_only (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_INCLUDE_NAME_ONLY", false]], "sz_search_include_name_only (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_INCLUDE_NAME_ONLY", false]], "sz_search_include_possibly_related (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_INCLUDE_POSSIBLY_RELATED", false]], "sz_search_include_possibly_related (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_INCLUDE_POSSIBLY_RELATED", false]], "sz_search_include_possibly_same (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_INCLUDE_POSSIBLY_SAME", false]], "sz_search_include_possibly_same (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_INCLUDE_POSSIBLY_SAME", false]], "sz_search_include_resolved (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_INCLUDE_RESOLVED", false]], "sz_search_include_resolved (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_INCLUDE_RESOLVED", false]], "sz_search_include_stats (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_SEARCH_INCLUDE_STATS", false]], "sz_search_include_stats (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_SEARCH_INCLUDE_STATS", false]], "sz_verbose_logging (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_VERBOSE_LOGGING", false]], "sz_verbose_logging (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_VERBOSE_LOGGING", false]], "sz_virtual_entity_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS", false]], "sz_virtual_entity_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS", false]], "sz_why_entities_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS", false]], "sz_why_entities_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS", false]], "sz_why_record_in_entity_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS", false]], "sz_why_record_in_entity_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS", false]], "sz_why_records_default_flags (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS", false]], "sz_why_records_default_flags (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS", false]], "sz_with_info (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_WITH_INFO", false]], "sz_with_info (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_WITH_INFO", false]], "sz_without_info (senzing_abstract.szengineflags attribute)": [[2, "senzing_abstract.SzEngineFlags.SZ_WITHOUT_INFO", false]], "sz_without_info (senzing_abstract.szengineflags.szengineflags attribute)": [[2, "senzing_abstract.szengineflags.SzEngineFlags.SZ_WITHOUT_INFO", false]], "szbadinputerror": [[2, "senzing_abstract.SzBadInputError", false]], "szconfigabstract (class in senzing_abstract)": [[2, "senzing_abstract.SzConfigAbstract", false]], "szconfigabstract (class in senzing_abstract.szconfig_abstract)": [[2, "senzing_abstract.szconfig_abstract.SzConfigAbstract", false]], "szconfigmanagerabstract (class in senzing_abstract)": [[2, "senzing_abstract.SzConfigManagerAbstract", false]], "szconfigmanagerabstract (class in senzing_abstract.szconfigmanager_abstract)": [[2, "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract", false]], "szconfigurationerror": [[2, "senzing_abstract.SzConfigurationError", false]], "szdatabaseconnectionlosterror": [[2, "senzing_abstract.SzDatabaseConnectionLostError", false]], "szdatabaseerror": [[2, "senzing_abstract.SzDatabaseError", false]], "szdiagnosticabstract (class in senzing_abstract)": [[2, "senzing_abstract.SzDiagnosticAbstract", false]], "szdiagnosticabstract (class in senzing_abstract.szdiagnostic_abstract)": [[2, "senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract", false]], "szengineabstract (class in senzing_abstract)": [[2, "senzing_abstract.SzEngineAbstract", false]], "szengineabstract (class in senzing_abstract.szengine_abstract)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract", false]], "szengineflags (class in senzing_abstract)": [[2, "senzing_abstract.SzEngineFlags", false]], "szengineflags (class in senzing_abstract.szengineflags)": [[2, "senzing_abstract.szengineflags.SzEngineFlags", false]], "szerror": [[2, "senzing_abstract.SzError", false]], "szhasherabstract (class in senzing_abstract)": [[2, "senzing_abstract.SzHasherAbstract", false]], "szhasherabstract (class in senzing_abstract.szhasher_abstract)": [[2, "senzing_abstract.szhasher_abstract.SzHasherAbstract", false]], "szlicenseerror": [[2, "senzing_abstract.SzLicenseError", false]], "sznotfounderror": [[2, "senzing_abstract.SzNotFoundError", false]], "sznotinitializederror": [[2, "senzing_abstract.SzNotInitializedError", false]], "szproductabstract (class in senzing_abstract)": [[2, "senzing_abstract.SzProductAbstract", false]], "szproductabstract (class in senzing_abstract.szproduct_abstract)": [[2, "senzing_abstract.szproduct_abstract.SzProductAbstract", false]], "szretryableerror": [[2, "senzing_abstract.SzRetryableError", false]], "szretrytimeoutexceedederror": [[2, "senzing_abstract.SzRetryTimeoutExceededError", false]], "szunhandlederror": [[2, "senzing_abstract.SzUnhandledError", false]], "szunknowndatasourceerror": [[2, "senzing_abstract.SzUnknownDataSourceError", false]], "szunrecoverableerror": [[2, "senzing_abstract.SzUnrecoverableError", false]], "version_as_dict() (senzing_abstract.szproduct_abstract.szproductabstract method)": [[2, "senzing_abstract.szproduct_abstract.SzProductAbstract.version_as_dict", false]], "version_as_dict() (senzing_abstract.szproductabstract method)": [[2, "senzing_abstract.SzProductAbstract.version_as_dict", false]], "why_entities() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.why_entities", false]], "why_entities() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.why_entities", false]], "why_entities_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.why_entities_return_dict", false]], "why_entities_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.why_entities_return_dict", false]], "why_record_in_entity() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.why_record_in_entity", false]], "why_record_in_entity() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.why_record_in_entity", false]], "why_record_in_entity_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.why_record_in_entity_return_dict", false]], "why_record_in_entity_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.why_record_in_entity_return_dict", false]], "why_records() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.why_records", false]], "why_records() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.why_records", false]], "why_records_return_dict() (senzing_abstract.szengine_abstract.szengineabstract method)": [[2, "senzing_abstract.szengine_abstract.SzEngineAbstract.why_records_return_dict", false]], "why_records_return_dict() (senzing_abstract.szengineabstract method)": [[2, "senzing_abstract.SzEngineAbstract.why_records_return_dict", false]]}, "objects": {"": [[2, 0, 0, "-", "senzing_abstract"]], "senzing_abstract": [[2, 1, 1, "", "SzBadInputError"], [2, 2, 1, "", "SzConfigAbstract"], [2, 2, 1, "", "SzConfigManagerAbstract"], [2, 1, 1, "", "SzConfigurationError"], [2, 1, 1, "", "SzDatabaseConnectionLostError"], [2, 1, 1, "", "SzDatabaseError"], [2, 2, 1, "", "SzDiagnosticAbstract"], [2, 2, 1, "", "SzEngineAbstract"], [2, 2, 1, "", "SzEngineFlags"], [2, 1, 1, "", "SzError"], [2, 2, 1, "", "SzHasherAbstract"], [2, 1, 1, "", "SzLicenseError"], [2, 1, 1, "", "SzNotFoundError"], [2, 1, 1, "", "SzNotInitializedError"], [2, 2, 1, "", "SzProductAbstract"], [2, 1, 1, "", "SzRetryTimeoutExceededError"], [2, 1, 1, "", "SzRetryableError"], [2, 1, 1, "", "SzUnhandledError"], [2, 1, 1, "", "SzUnknownDataSourceError"], [2, 1, 1, "", "SzUnrecoverableError"], [2, 0, 0, "-", "szconfig_abstract"], [2, 0, 0, "-", "szconfigmanager_abstract"], [2, 0, 0, "-", "szdiagnostic_abstract"], [2, 0, 0, "-", "szengine_abstract"], [2, 0, 0, "-", "szengineflags"], [2, 0, 0, "-", "szhasher_abstract"], [2, 0, 0, "-", "szproduct_abstract"]], "senzing_abstract.SzConfigAbstract": [[2, 3, 1, "", "ID_MESSAGES"], [2, 3, 1, "", "PREFIX"], [2, 4, 1, "", "add_data_source"], [2, 4, 1, "", "close_config"], [2, 4, 1, "", "create_config"], [2, 4, 1, "", "delete_data_source"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "export_config"], [2, 4, 1, "", "get_data_sources"], [2, 4, 1, "", "import_config"], [2, 4, 1, "", "initialize"]], "senzing_abstract.SzConfigManagerAbstract": [[2, 3, 1, "", "ID_MESSAGES"], [2, 3, 1, "", "PREFIX"], [2, 4, 1, "", "add_config"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "get_config"], [2, 4, 1, "", "get_config_list"], [2, 4, 1, "", "get_default_config_id"], [2, 4, 1, "", "initialize"], [2, 4, 1, "", "replace_default_config_id"], [2, 4, 1, "", "set_default_config_id"]], "senzing_abstract.SzDiagnosticAbstract": [[2, 3, 1, "", "ID_MESSAGES"], [2, 3, 1, "", "PREFIX"], [2, 4, 1, "", "check_datastore_performance"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "get_datastore_info"], [2, 4, 1, "", "get_feature"], [2, 4, 1, "", "initialize"], [2, 4, 1, "", "purge_repository"], [2, 4, 1, "", "reinitialize"]], "senzing_abstract.SzEngineAbstract": [[2, 4, 1, "", "add_record"], [2, 4, 1, "", "add_record_return_dict"], [2, 4, 1, "", "close_export"], [2, 4, 1, "", "count_redo_records"], [2, 4, 1, "", "delete_record"], [2, 4, 1, "", "delete_record_return_dict"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "export_csv_entity_report"], [2, 4, 1, "", "export_json_entity_report"], [2, 4, 1, "", "fetch_next"], [2, 4, 1, "", "find_interesting_entities_by_entity_id"], [2, 4, 1, "", "find_interesting_entities_by_entity_id_return_dict"], [2, 4, 1, "", "find_interesting_entities_by_record_id"], [2, 4, 1, "", "find_interesting_entities_by_record_id_return_dict"], [2, 4, 1, "", "find_network_by_entity_id"], [2, 4, 1, "", "find_network_by_entity_id_return_dict"], [2, 4, 1, "", "find_network_by_record_id"], [2, 4, 1, "", "find_network_by_record_id_return_dict"], [2, 4, 1, "", "find_path_by_entity_id"], [2, 4, 1, "", "find_path_by_entity_id_return_dict"], [2, 4, 1, "", "find_path_by_record_id"], [2, 4, 1, "", "find_path_by_record_id_return_dict"], [2, 4, 1, "", "get_active_config_id"], [2, 4, 1, "", "get_entity_by_entity_id"], [2, 4, 1, "", "get_entity_by_entity_id_return_dict"], [2, 4, 1, "", "get_entity_by_record_id"], [2, 4, 1, "", "get_entity_by_record_id_return_dict"], [2, 4, 1, "", "get_record"], [2, 4, 1, "", "get_record_return_dict"], [2, 4, 1, "", "get_redo_record"], [2, 4, 1, "", "get_repository_last_modified_time"], [2, 4, 1, "", "get_stats"], [2, 4, 1, "", "get_stats_return_dict"], [2, 4, 1, "", "get_virtual_entity_by_record_id"], [2, 4, 1, "", "get_virtual_entity_by_record_id_return_dict"], [2, 4, 1, "", "how_entity_by_entity_id"], [2, 4, 1, "", "how_entity_by_entity_id_return_dict"], [2, 4, 1, "", "initialize"], [2, 4, 1, "", "prime_engine"], [2, 4, 1, "", "process_redo_record"], [2, 4, 1, "", "reevaluate_entity"], [2, 4, 1, "", "reevaluate_entity_return_dict"], [2, 4, 1, "", "reevaluate_record"], [2, 4, 1, "", "reevaluate_record_return_dict"], [2, 4, 1, "", "reinitialize"], [2, 4, 1, "", "search_by_attributes"], [2, 4, 1, "", "search_by_attributes_return_dict"], [2, 4, 1, "", "why_entities"], [2, 4, 1, "", "why_entities_return_dict"], [2, 4, 1, "", "why_record_in_entity"], [2, 4, 1, "", "why_record_in_entity_return_dict"], [2, 4, 1, "", "why_records"], [2, 4, 1, "", "why_records_return_dict"]], "senzing_abstract.SzEngineFlags": [[2, 3, 1, "", "SZ_ENTITY_BRIEF_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_ENTITY_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_ALL_FEATURES"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_ALL_RELATIONS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_ENTITY_NAME"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_DATA"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_JSON_DATA"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_SUMMARY"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_TYPES"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES"], [2, 3, 1, "", "SZ_ENTITY_OPTION_INCLUDE_FEATURE_ELEMENTS"], [2, 3, 1, "", "SZ_ENTITY_OPTION_INCLUDE_FEATURE_STATS"], [2, 3, 1, "", "SZ_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES"], [2, 3, 1, "", "SZ_ENTITY_OPTION_INCLUDE_MATCH_KEY_DETAILS"], [2, 3, 1, "", "SZ_EXPORT_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_ALL_ENTITIES"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_DISCLOSED"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_NAME_ONLY"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_POSSIBLY_RELATED"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_POSSIBLY_SAME"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES"], [2, 3, 1, "", "SZ_FIND_NETWORK_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_FIND_NETWORK_MATCHING_INFO"], [2, 3, 1, "", "SZ_FIND_PATH_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_FIND_PATH_MATCHING_INFO"], [2, 3, 1, "", "SZ_FIND_PATH_PREFER_EXCLUDE"], [2, 3, 1, "", "SZ_HOW_ENTITY_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_INCLUDE_FEATURE_SCORES"], [2, 3, 1, "", "SZ_INITIALIZE_WITH_DEFAULT_CONFIGURATION"], [2, 3, 1, "", "SZ_NO_FLAGS"], [2, 3, 1, "", "SZ_NO_LOGGING"], [2, 3, 1, "", "SZ_RECORD_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_SEARCH_BY_ATTRIBUTES_ALL"], [2, 3, 1, "", "SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL"], [2, 3, 1, "", "SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG"], [2, 3, 1, "", "SZ_SEARCH_BY_ATTRIBUTES_STRONG"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_ALL_ENTITIES"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_FEATURE_SCORES"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_MATCH_KEY_DETAILS"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_NAME_ONLY"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_POSSIBLY_RELATED"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_POSSIBLY_SAME"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_RESOLVED"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_STATS"], [2, 3, 1, "", "SZ_VERBOSE_LOGGING"], [2, 3, 1, "", "SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_WHY_ENTITIES_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_WHY_RECORDS_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_WITHOUT_INFO"], [2, 3, 1, "", "SZ_WITH_INFO"], [2, 4, 1, "", "combine_flags"]], "senzing_abstract.SzHasherAbstract": [[2, 3, 1, "", "ID_MESSAGES"], [2, 3, 1, "", "PREFIX"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "export_token_library"], [2, 4, 1, "", "init"], [2, 4, 1, "", "init_with_config_id"], [2, 4, 1, "", "process"], [2, 4, 1, "", "reinit"]], "senzing_abstract.SzProductAbstract": [[2, 3, 1, "", "ID_MESSAGES"], [2, 3, 1, "", "PREFIX"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "get_license"], [2, 4, 1, "", "get_version"], [2, 4, 1, "", "initialize"], [2, 4, 1, "", "license_as_dict"], [2, 4, 1, "", "version_as_dict"]], "senzing_abstract.szconfig_abstract": [[2, 2, 1, "", "SzConfigAbstract"]], "senzing_abstract.szconfig_abstract.SzConfigAbstract": [[2, 3, 1, "", "ID_MESSAGES"], [2, 3, 1, "", "PREFIX"], [2, 4, 1, "", "add_data_source"], [2, 4, 1, "", "close_config"], [2, 4, 1, "", "create_config"], [2, 4, 1, "", "delete_data_source"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "export_config"], [2, 4, 1, "", "get_data_sources"], [2, 4, 1, "", "import_config"], [2, 4, 1, "", "initialize"]], "senzing_abstract.szconfigmanager_abstract": [[2, 2, 1, "", "SzConfigManagerAbstract"]], "senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract": [[2, 3, 1, "", "ID_MESSAGES"], [2, 3, 1, "", "PREFIX"], [2, 4, 1, "", "add_config"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "get_config"], [2, 4, 1, "", "get_config_list"], [2, 4, 1, "", "get_default_config_id"], [2, 4, 1, "", "initialize"], [2, 4, 1, "", "replace_default_config_id"], [2, 4, 1, "", "set_default_config_id"]], "senzing_abstract.szdiagnostic_abstract": [[2, 2, 1, "", "SzDiagnosticAbstract"]], "senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract": [[2, 3, 1, "", "ID_MESSAGES"], [2, 3, 1, "", "PREFIX"], [2, 4, 1, "", "check_datastore_performance"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "get_datastore_info"], [2, 4, 1, "", "get_feature"], [2, 4, 1, "", "initialize"], [2, 4, 1, "", "purge_repository"], [2, 4, 1, "", "reinitialize"]], "senzing_abstract.szengine_abstract": [[2, 2, 1, "", "SzEngineAbstract"]], "senzing_abstract.szengine_abstract.SzEngineAbstract": [[2, 4, 1, "", "add_record"], [2, 4, 1, "", "add_record_return_dict"], [2, 4, 1, "", "close_export"], [2, 4, 1, "", "count_redo_records"], [2, 4, 1, "", "delete_record"], [2, 4, 1, "", "delete_record_return_dict"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "export_csv_entity_report"], [2, 4, 1, "", "export_json_entity_report"], [2, 4, 1, "", "fetch_next"], [2, 4, 1, "", "find_interesting_entities_by_entity_id"], [2, 4, 1, "", "find_interesting_entities_by_entity_id_return_dict"], [2, 4, 1, "", "find_interesting_entities_by_record_id"], [2, 4, 1, "", "find_interesting_entities_by_record_id_return_dict"], [2, 4, 1, "", "find_network_by_entity_id"], [2, 4, 1, "", "find_network_by_entity_id_return_dict"], [2, 4, 1, "", "find_network_by_record_id"], [2, 4, 1, "", "find_network_by_record_id_return_dict"], [2, 4, 1, "", "find_path_by_entity_id"], [2, 4, 1, "", "find_path_by_entity_id_return_dict"], [2, 4, 1, "", "find_path_by_record_id"], [2, 4, 1, "", "find_path_by_record_id_return_dict"], [2, 4, 1, "", "get_active_config_id"], [2, 4, 1, "", "get_entity_by_entity_id"], [2, 4, 1, "", "get_entity_by_entity_id_return_dict"], [2, 4, 1, "", "get_entity_by_record_id"], [2, 4, 1, "", "get_entity_by_record_id_return_dict"], [2, 4, 1, "", "get_record"], [2, 4, 1, "", "get_record_return_dict"], [2, 4, 1, "", "get_redo_record"], [2, 4, 1, "", "get_repository_last_modified_time"], [2, 4, 1, "", "get_stats"], [2, 4, 1, "", "get_stats_return_dict"], [2, 4, 1, "", "get_virtual_entity_by_record_id"], [2, 4, 1, "", "get_virtual_entity_by_record_id_return_dict"], [2, 4, 1, "", "how_entity_by_entity_id"], [2, 4, 1, "", "how_entity_by_entity_id_return_dict"], [2, 4, 1, "", "initialize"], [2, 4, 1, "", "prime_engine"], [2, 4, 1, "", "process_redo_record"], [2, 4, 1, "", "reevaluate_entity"], [2, 4, 1, "", "reevaluate_entity_return_dict"], [2, 4, 1, "", "reevaluate_record"], [2, 4, 1, "", "reevaluate_record_return_dict"], [2, 4, 1, "", "reinitialize"], [2, 4, 1, "", "search_by_attributes"], [2, 4, 1, "", "search_by_attributes_return_dict"], [2, 4, 1, "", "why_entities"], [2, 4, 1, "", "why_entities_return_dict"], [2, 4, 1, "", "why_record_in_entity"], [2, 4, 1, "", "why_record_in_entity_return_dict"], [2, 4, 1, "", "why_records"], [2, 4, 1, "", "why_records_return_dict"]], "senzing_abstract.szengineflags": [[2, 2, 1, "", "SzEngineFlags"]], "senzing_abstract.szengineflags.SzEngineFlags": [[2, 3, 1, "", "SZ_ENTITY_BRIEF_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_ENTITY_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_ALL_FEATURES"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_ALL_RELATIONS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_ENTITY_NAME"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_DATA"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_JSON_DATA"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_SUMMARY"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_TYPES"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY"], [2, 3, 1, "", "SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES"], [2, 3, 1, "", "SZ_ENTITY_OPTION_INCLUDE_FEATURE_ELEMENTS"], [2, 3, 1, "", "SZ_ENTITY_OPTION_INCLUDE_FEATURE_STATS"], [2, 3, 1, "", "SZ_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES"], [2, 3, 1, "", "SZ_ENTITY_OPTION_INCLUDE_MATCH_KEY_DETAILS"], [2, 3, 1, "", "SZ_EXPORT_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_ALL_ENTITIES"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_DISCLOSED"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_NAME_ONLY"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_POSSIBLY_RELATED"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_POSSIBLY_SAME"], [2, 3, 1, "", "SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES"], [2, 3, 1, "", "SZ_FIND_NETWORK_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_FIND_NETWORK_MATCHING_INFO"], [2, 3, 1, "", "SZ_FIND_PATH_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_FIND_PATH_MATCHING_INFO"], [2, 3, 1, "", "SZ_FIND_PATH_PREFER_EXCLUDE"], [2, 3, 1, "", "SZ_HOW_ENTITY_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_INCLUDE_FEATURE_SCORES"], [2, 3, 1, "", "SZ_INITIALIZE_WITH_DEFAULT_CONFIGURATION"], [2, 3, 1, "", "SZ_NO_FLAGS"], [2, 3, 1, "", "SZ_NO_LOGGING"], [2, 3, 1, "", "SZ_RECORD_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_SEARCH_BY_ATTRIBUTES_ALL"], [2, 3, 1, "", "SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL"], [2, 3, 1, "", "SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG"], [2, 3, 1, "", "SZ_SEARCH_BY_ATTRIBUTES_STRONG"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_ALL_ENTITIES"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_FEATURE_SCORES"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_MATCH_KEY_DETAILS"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_NAME_ONLY"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_POSSIBLY_RELATED"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_POSSIBLY_SAME"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_RESOLVED"], [2, 3, 1, "", "SZ_SEARCH_INCLUDE_STATS"], [2, 3, 1, "", "SZ_VERBOSE_LOGGING"], [2, 3, 1, "", "SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_WHY_ENTITIES_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_WHY_RECORDS_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS"], [2, 3, 1, "", "SZ_WITHOUT_INFO"], [2, 3, 1, "", "SZ_WITH_INFO"], [2, 4, 1, "", "combine_flags"]], "senzing_abstract.szhasher_abstract": [[2, 2, 1, "", "SzHasherAbstract"]], "senzing_abstract.szhasher_abstract.SzHasherAbstract": [[2, 3, 1, "", "ID_MESSAGES"], [2, 3, 1, "", "PREFIX"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "export_token_library"], [2, 4, 1, "", "init"], [2, 4, 1, "", "init_with_config_id"], [2, 4, 1, "", "process"], [2, 4, 1, "", "reinit"]], "senzing_abstract.szproduct_abstract": [[2, 2, 1, "", "SzProductAbstract"]], "senzing_abstract.szproduct_abstract.SzProductAbstract": [[2, 3, 1, "", "ID_MESSAGES"], [2, 3, 1, "", "PREFIX"], [2, 4, 1, "", "destroy"], [2, 4, 1, "", "get_license"], [2, 4, 1, "", "get_version"], [2, 4, 1, "", "initialize"], [2, 4, 1, "", "license_as_dict"], [2, 4, 1, "", "version_as_dict"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "exception", "Python exception"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:exception", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "terms": {"": 2, "0": 2, "00000": 2, "00am": 2, "01": 2, "02": 2, "03": 2, "09": 2, "1": 2, "10": 2, "1001": 2, "1024": 2, "1048576": 2, "1073741824": 2, "1073754112": 2, "1082304": 2, "11": 2, "12": 2, "128": 2, "13": 2, "134217728": 2, "15": 2, "16": 2, "16384": 2, "16777216": 2, "17179869184": 2, "19": 2, "1970": 2, "2": 2, "200000": 2, "2022": 2, "2023": 2, "2023_10_30__10_45": 2, "2024": 2, "2048": 2, "2097152": 2, "2147483648": 2, "23303": 2, "256": 2, "262144": 2, "268435456": 2, "29": 2, "3": 2, "30": 2, "3000": 2, "32": 2, "32768": 2, "33": 2, "33554432": 2, "338": 2, "3734464": 2, "3734497": 2, "4": 2, "40": 2, "4001": 2, "4002": 2, "4003": 2, "4004": 2, "4005": 2, "4006": 2, "4007": 2, "4008": 2, "4009": 2, "4010": 2, "4096": 2, "41320074": 2, "4194304": 2, "4294967296": 2, "4611686018427387904": 2, "490826130": 2, "50000": 2, "512": 2, "524288": 2, "64": 2, "65536": 2, "67108864": 2, "67123203": 2, "67123215": 2, "8": 2, "8192": 2, "8388608": 2, "8589934592": 2, "8589946880": 2, "923": 2, "960": 2, "96009152": 2, "99": 2, "A": 2, "If": 2, "In": 2, "It": 2, "Not": 2, "OR": 2, "The": 2, "These": 2, "To": 2, "_description_": 2, "abc": 2, "about": 2, "abstract": 2, "accept": 2, "access": 2, "activ": 2, "ad": 2, "add": 2, "add_config": [1, 2], "add_data_sourc": [1, 2], "add_record": [1, 2], "add_record_return_dict": [1, 2], "after": 2, "all": 2, "an": 2, "ani": 2, "api": 2, "ar": 2, "arg": 2, "around": 2, "attribut": 2, "audit": 2, "automat": 2, "avail": 2, "base": 2, "batch": 2, "been": 2, "befor": 2, "being": 2, "between": 2, "bill": 2, "bin": 2, "both": 2, "build_dat": 2, "build_numb": 2, "build_out_degre": 2, "build_vers": 2, "call": 2, "can": 2, "cannot": 2, "case": 2, "caus": 2, "cfg_attr": 2, "cfg_cfbom": 2, "cfg_cfcall": 2, "cfg_cfrtn": 2, "cfg_cfunc": 2, "cfg_dfbom": 2, "cfg_dfcall": 2, "cfg_dfunc": 2, "cfg_dsrc": 2, "cfg_dsrc_interest": 2, "cfg_eclass": 2, "cfg_efbom": 2, "cfg_efcal": 2, "cfg_efunc": 2, "cfg_erfrag": 2, "cfg_errul": 2, "cfg_etyp": 2, "cfg_fbom": 2, "cfg_fbovr": 2, "cfg_fclass": 2, "cfg_felem": 2, "cfg_ftype": 2, "cfg_generic_threshold": 2, "cfg_gplan": 2, "cfg_len": 2, "cfg_lensrl": 2, "cfg_rclass": 2, "cfg_rtype": 2, "cfg_sfcall": 2, "cfg_sfunc": 2, "check_datastore_perform": [1, 2], "class": 2, "classmethod": 2, "clean": 2, "cleanup": 2, "close": 2, "close_config": [1, 2], "close_export": [1, 2], "code": 2, "column": 2, "com": 2, "combine_flag": [1, 2], "comma": 2, "comment": 2, "compar": 2, "compatibility_vers": 2, "complet": 2, "compon": 2, "compos": 2, "concurr": 2, "config": 2, "config_base_vers": 2, "config_com": 2, "config_definit": 2, "config_handl": 2, "config_id": 2, "config_vers": 2, "configur": 2, "connect": 2, "constructor": 2, "consumpt": 2, "contain": 2, "content": 1, "continu": 2, "contract": 2, "control": 2, "conveni": 2, "could": 2, "count_redo_record": [1, 2], "creat": 2, "create_config": [1, 2], "csv": 2, "csv_column_list": 2, "current": 2, "current_default_config_id": 2, "cursor": 2, "custom": 2, "data": 2, "data_sourc": 2, "data_source_cod": 2, "data_source_code_1": 2, "data_source_code_2": 2, "databas": 2, "datasourc": 2, "datatyp": 2, "db": 2, "deeper": 2, "default": 2, "definit": 2, "degre": 2, "delet": 2, "delete_data_sourc": [1, 2], "delete_record": [1, 2], "delete_record_return_dict": [1, 2], "describ": 2, "desir": 2, "destroi": [1, 2], "destructor": 2, "detail": 2, "determin": 2, "diagnosi": 2, "diagnost": 2, "dict": 2, "dictionari": 2, "did": 2, "differ": 2, "discov": 2, "distinguish": 2, "do": 2, "document": 2, "doe": 2, "ds1": 2, "ds2": 2, "dsrc_code": 2, "dsrc_id": 2, "durat": 2, "each": 2, "easier": 2, "edit": 2, "effici": 2, "empti": 2, "enabl": 2, "end": 2, "end_data_source_cod": 2, "end_entity_id": 2, "end_record_id": 2, "engin": 2, "engine_schema_vers": 2, "entiti": 2, "entity_id": 2, "entity_id_1": 2, "entity_id_2": 2, "entity_list": 2, "entity_path": 2, "env": 2, "epoch": 2, "error": 2, "eval": 2, "evalu": 2, "everi": 2, "exampl": 2, "exceed": 2, "except": 2, "exclus": 2, "exist": 2, "expired": 2, "export": 2, "export_config": [1, 2], "export_csv_entity_report": [1, 2], "export_handl": 2, "export_json_entity_report": [1, 2], "export_token_librari": [1, 2], "fail": 2, "failur": 2, "fals": 2, "featur": 2, "feature_id": 2, "fetch_next": [1, 2], "file": 2, "find": 2, "find_interesting_entities_by_entity_id": [1, 2], "find_interesting_entities_by_entity_id_return_dict": [1, 2], "find_interesting_entities_by_record_id": [1, 2], "find_interesting_entities_by_record_id_return_dict": [1, 2], "find_network_by_entity_id": [1, 2], "find_network_by_entity_id_return_dict": [1, 2], "find_network_by_record_id": [1, 2], "find_network_by_record_id_return_dict": [1, 2], "find_path_by_entity_id": [1, 2], "find_path_by_entity_id_return_dict": [1, 2], "find_path_by_record_id": [1, 2], "find_path_by_record_id_return_dict": [1, 2], "first": 2, "flag": 2, "form": 2, "format": 2, "found": 2, "free": 2, "from": 2, "function": 2, "g2_config": 2, "g2c": 2, "g2config": 2, "get_active_config_id": [1, 2], "get_config": [1, 2], "get_config_list": [1, 2], "get_data_sourc": [1, 2], "get_datastore_info": [1, 2], "get_default_config_id": [1, 2], "get_entity_by_entity_id": [1, 2], "get_entity_by_entity_id_return_dict": [1, 2], "get_entity_by_record_id": [1, 2], "get_entity_by_record_id_return_dict": [1, 2], "get_featur": [1, 2], "get_licens": [1, 2], "get_record": [1, 2], "get_record_return_dict": [1, 2], "get_redo_record": [1, 2], "get_repository_last_modified_tim": [1, 2], "get_stat": [1, 2], "get_stats_return_dict": [1, 2], "get_vers": [1, 2], "get_virtual_entity_by_record_id": [1, 2], "get_virtual_entity_by_record_id_return_dict": [1, 2], "given": 2, "gmt": 2, "ha": 2, "handl": 2, "he": 2, "help": 2, "high": 2, "how": 2, "how_entity_by_entity_id": [1, 2], "how_entity_by_entity_id_return_dict": [1, 2], "hybrid": 2, "i": 2, "id": 2, "id_messag": [1, 2], "ident": 2, "identifi": 2, "implement": 2, "import": 2, "import_config": [1, 2], "includ": 2, "incorrect": 2, "index": 0, "inform": 2, "ing": 2, "ini_param": 2, "init": [1, 2], "init_config_id": 2, "init_with_config_id": [1, 2], "initi": [1, 2], "input": 2, "insert": 2, "inserttim": 2, "instanc": 2, "instance_nam": 2, "instruct": 2, "int": 2, "intern": 2, "intflag": 2, "issued": 2, "januari": 2, "json": 2, "just": 2, "known": 2, "kwarg": 2, "larg": 2, "larger": 2, "last": 2, "librari": 2, "licenc": 2, "licens": 2, "license_as_dict": [1, 2], "licenselevel": 2, "licensetyp": 2, "lifecycl": 2, "like": 2, "limit": 2, "list": 2, "list_data_sourc": 2, "list_of_str": 2, "load": 2, "load_id": 2, "locat": 2, "log": 2, "long": 2, "longer": 2, "lost": 2, "made": 2, "mai": 2, "mani": 2, "max_degre": 2, "max_ent": 2, "maximum": 2, "maximum_required_schema_vers": 2, "measur": 2, "member": 2, "memori": 2, "metadata": 2, "method": 2, "mileag": 2, "minimum_required_schema_vers": 2, "mode": 2, "modifi": 2, "modul": [0, 1], "module_nam": 2, "monthli": 2, "more": 2, "most": 2, "multipl": 2, "must": 2, "name": 2, "nearbi": 2, "need": 2, "network": 2, "new": 2, "new_default_config_id": 2, "newli": 2, "next": 2, "node": 2, "non": 2, "none": 2, "note": 2, "number": 2, "numrecordsinsert": 2, "object": 2, "old": 2, "one": 2, "onli": 2, "oper": 2, "option": 2, "other": 2, "otherwis": 2, "output": 2, "over": 2, "packag": 1, "page": 0, "pair": 2, "paramet": 2, "part": 2, "path": 2, "perform": 2, "pipelin": 2, "point": 2, "pointer": 2, "prefix": [1, 2], "prime_engin": [1, 2], "prior": 2, "process": [1, 2], "process_redo_record": [1, 2], "process_redo_record_with_info": 2, "product": 2, "product_nam": 2, "profil": 2, "program": 2, "proven": 2, "provid": 2, "prune": 2, "public": 2, "purge_repositori": [1, 2], "py": 2, "python": 2, "python3": 2, "queu": 2, "queue": 2, "r1": 2, "r2": 2, "rais": 2, "rate": 2, "re": 2, "read": 2, "real": 2, "recommend": 2, "record": 2, "record_definit": 2, "record_id": 2, "record_id_1": 2, "record_id_2": 2, "record_list": 2, "recordlimit": 2, "redo": 2, "redo_record": 2, "reevalu": 2, "reevaluate_ent": [1, 2], "reevaluate_entity_return_dict": [1, 2], "reevaluate_record": [1, 2], "reevaluate_record_return_dict": [1, 2], "reinit": [1, 2], "reiniti": [1, 2], "relat": 2, "relationship": 2, "releas": 2, "remedi": 2, "remov": 2, "replac": 2, "replace_default_config_id": [1, 2], "replic": 2, "repositori": 2, "represent": 2, "request": 2, "requir": 2, "required_data_sourc": 2, "reset": 2, "resolut": 2, "resolv": 2, "resourc": 2, "resourcepath": 2, "respons": 2, "response_handl": 2, "retri": 2, "retriev": 2, "return": 2, "row": 2, "same": 2, "save": 2, "scale": 2, "schema_vers": 2, "scroll": 2, "search": [0, 2], "search_by_attribut": [1, 2], "search_by_attributes_return_dict": [1, 2], "search_profil": 2, "second": 2, "seconds_to_run": 2, "section": 2, "see": 2, "senz": 2, "separ": 2, "serial": 2, "session": 2, "set": 2, "set_default_config_id": [1, 2], "short": 2, "should": 2, "show": 2, "shutdown": 2, "simpli": 2, "singl": 2, "size": 2, "sole": 2, "some": 2, "sourc": 2, "specif": 2, "specifi": 2, "sqlite": 2, "sqlite3": 2, "standard": 2, "start": 2, "start_data_source_cod": 2, "start_entity_id": 2, "start_record_id": 2, "statist": 2, "step": 2, "str": 2, "string": 2, "submodul": 1, "success": 2, "suppli": 2, "support": 2, "surround": 2, "swap": 2, "sys_create_dt": 2, "sys_oom": 2, "system": 2, "sz": 2, "sz_entity_brief_default_flag": [1, 2], "sz_entity_default_flag": [1, 2], "sz_entity_include_all_featur": [1, 2], "sz_entity_include_all_rel": [1, 2], "sz_entity_include_disclosed_rel": [1, 2], "sz_entity_include_entity_nam": [1, 2], "sz_entity_include_name_only_rel": [1, 2], "sz_entity_include_possibly_related_rel": [1, 2], "sz_entity_include_possibly_same_rel": [1, 2], "sz_entity_include_record_data": [1, 2], "sz_entity_include_record_feature_id": [1, 2], "sz_entity_include_record_json_data": [1, 2], "sz_entity_include_record_matching_info": [1, 2], "sz_entity_include_record_summari": [1, 2], "sz_entity_include_record_typ": [1, 2], "sz_entity_include_record_unmapped_data": [1, 2], "sz_entity_include_related_entity_nam": [1, 2], "sz_entity_include_related_matching_info": [1, 2], "sz_entity_include_related_record_data": [1, 2], "sz_entity_include_related_record_summari": [1, 2], "sz_entity_include_representative_featur": [1, 2], "sz_entity_option_include_feature_el": [1, 2], "sz_entity_option_include_feature_stat": [1, 2], "sz_entity_option_include_internal_featur": [1, 2], "sz_entity_option_include_match_key_detail": [1, 2], "sz_export_default_flag": [1, 2], "sz_export_include_all_ent": [1, 2], "sz_export_include_all_having_relationship": [1, 2], "sz_export_include_disclos": [1, 2], "sz_export_include_multi_record_ent": [1, 2], "sz_export_include_name_onli": [1, 2], "sz_export_include_possibly_rel": [1, 2], "sz_export_include_possibly_sam": [1, 2], "sz_export_include_single_record_ent": [1, 2], "sz_find_network_default_flag": [1, 2], "sz_find_network_matching_info": [1, 2], "sz_find_path_default_flag": [1, 2], "sz_find_path_matching_info": [1, 2], "sz_find_path_prefer_exclud": [1, 2], "sz_how_entity_default_flag": [1, 2], "sz_include_feature_scor": [1, 2], "sz_initialize_with_default_configur": [1, 2], "sz_no_flag": [1, 2], "sz_no_log": [1, 2], "sz_record_default_flag": [1, 2], "sz_search_by_attributes_al": [1, 2], "sz_search_by_attributes_default_flag": [1, 2], "sz_search_by_attributes_minimal_al": [1, 2], "sz_search_by_attributes_minimal_strong": [1, 2], "sz_search_by_attributes_strong": [1, 2], "sz_search_include_all_ent": [1, 2], "sz_search_include_feature_scor": [1, 2], "sz_search_include_match_key_detail": [1, 2], "sz_search_include_name_onli": [1, 2], "sz_search_include_possibly_rel": [1, 2], "sz_search_include_possibly_sam": [1, 2], "sz_search_include_resolv": [1, 2], "sz_search_include_stat": [1, 2], "sz_verbose_log": [1, 2], "sz_virtual_entity_default_flag": [1, 2], "sz_why_entities_default_flag": [1, 2], "sz_why_entity_default_flag": 2, "sz_why_record_in_entity_default_flag": [1, 2], "sz_why_records_default_flag": [1, 2], "sz_with_info": [1, 2], "sz_without_info": [1, 2], "szbadinputerror": [1, 2], "szconfig": 2, "szconfig_abstract": 1, "szconfigabstract": [1, 2], "szconfigmanag": 2, "szconfigmanager_abstract": 1, "szconfigmanagerabstract": [1, 2], "szconfigurationerror": [1, 2], "szdatabaseconnectionlosterror": [1, 2], "szdatabaseerror": [1, 2], "szdiagnosi": 2, "szdiagnost": 2, "szdiagnostic_abstract": 1, "szdiagnosticabstract": [1, 2], "szengin": 2, "szengine_abstract": 1, "szengineabstract": [1, 2], "szengineflag": 1, "szerror": [1, 2], "szexcept": 2, "szhasher": 2, "szhasher_abstract": 1, "szhasherabstract": [1, 2], "szlicenseerror": [1, 2], "sznotfounderror": [1, 2], "sznotinitializederror": [1, 2], "szproduct": 2, "szproduct_abstract": 1, "szproductabstract": [1, 2], "szretryableerror": [1, 2], "szretrytimeoutexceedederror": [1, 2], "szunhandlederror": [1, 2], "szunknowndatasourceerror": [1, 2], "szunrecoverableerror": [1, 2], "t": 2, "templat": 2, "termin": 2, "test": 2, "than": 2, "thei": 2, "them": 2, "thi": 2, "those": 2, "thread": 2, "through": 2, "time": 2, "timeout": 2, "timestamp": 2, "tmp": 2, "todo": 2, "togeth": 2, "two": 2, "type": 2, "typeerror": 2, "union": 2, "uniqu": 2, "unix": 2, "unknown": 2, "until": 2, "unusu": 2, "up": 2, "us": 2, "user": 2, "usr": 2, "usual": 2, "valu": 2, "vari": 2, "verbose_log": 2, "version": 2, "version_as_dict": [1, 2], "view": 2, "virtual": 2, "wa": 2, "warehous": 2, "warn": 2, "which": 2, "why": 2, "why_ent": [1, 2], "why_entities_return_dict": [1, 2], "why_record": [1, 2], "why_record_in_ent": [1, 2], "why_record_in_entity_return_dict": [1, 2], "why_records_return_dict": [1, 2], "with_info": 2, "within": 2, "workload": 2, "your": 2}, "titles": ["Welcome to sz-sdk-python-abstract\u2019s documentation!", "senzing_abstract", "senzing_abstract package"], "titleterms": {"": 0, "abstract": 0, "content": 2, "document": 0, "indic": 0, "modul": 2, "packag": 2, "python": 0, "sdk": 0, "senzing_abstract": [1, 2], "submodul": 2, "sz": 0, "szconfig_abstract": 2, "szconfigmanager_abstract": 2, "szdiagnostic_abstract": 2, "szengine_abstract": 2, "szengineflag": 2, "szhasher_abstract": 2, "szproduct_abstract": 2, "tabl": 0, "welcom": 0}}) \ No newline at end of file diff --git a/senzing_abstract.html b/senzing_abstract.html new file mode 100644 index 0000000..ff9fda7 --- /dev/null +++ b/senzing_abstract.html @@ -0,0 +1,5227 @@ + + + + + + + senzing_abstract package — sz-sdk-python-abstract documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

senzing_abstract package

+
+

Submodules

+
+
+

senzing_abstract.szconfig_abstract module

+

szconfig_abstract.py is the abstract class for all implementations of szconfig.

+
+
+class senzing_abstract.szconfig_abstract.SzConfigAbstract[source]
+

Bases: ABC

+

SzConfigAbstract is the definition of the Senzing Python API that is +implemented by packages such as szconfig.py.

+
+
+ID_MESSAGES = {4001: 'szconfig.add_data_source({0}) failed. Return code: {1}', 4002: 'szconfig.close_config() failed. Return code: {0}', 4003: 'szconfig.create_config() failed. Return code: {0}', 4004: 'szconfig.delete_data_source({0}) failed. Return code: {1}', 4005: 'szconfig.destroy() failed. Return code: {0}', 4006: 'szconfig.export_config() failed. Return code: {0}', 4007: 'szconfig.get_data_sources() failed. Return code: {0}', 4008: 'szconfig.initialize({0}, {1}, {2}) failed. Return code: {3}', 4009: 'szconfig.import_config({0}) failed. Return code: {1}', 4010: 'szconfig.SzConfig({0}, {1}) failed. instance_name and settings must both be set or both be empty'}
+
+ +
+
+PREFIX = 'szconfig.'
+
+ +
+
+abstract add_data_source(config_handle: int, data_source_code: str, **kwargs: Any) → str[source]
+

The add_data_source method adds a data source to an existing in-memory configuration.

+
+
Parameters:
+
    +

  • config_handle (int) – An identifier of an in-memory configuration. Usually created by the create or load methods.

    • +

  • data_source_code (str) – Name of data source code to add.

    • +
+
+
Returns:
+

A string containing a JSON document listing the newly created data source.

+
+
Return type:
+

str

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1// Output has been formatted for easier reading.
+2
+3{
+4    "DSRC_ID": 1001
+5}
+
+
+
+ +
+
+abstract close_config(config_handle: int, **kwargs: Any) → None[source]
+

The close_config method cleans up the Senzing SzConfig object pointed to by the config_handle.

+
+
Parameters:
+

config_handle (int) – An identifier of an in-memory configuration. Usually created by the create_config or import_config methods.

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract create_config(**kwargs: Any) → int[source]
+

The create_config method creates an in-memory Senzing configuration +from the g2config.json template configuration file located +in the PIPELINE.RESOURCEPATH path. +A handle is returned to identify the in-memory configuration. +The handle is used by the add_data_source, list_data_sources, +delete_data_source, and export_config methods. +The handle is terminated by the close_config method.

+
+
Returns:
+

A pointer to an in-memory Senzing configuration.

+
+
Return type:
+

int

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract delete_data_source(config_handle: int, data_source_code: str, **kwargs: Any) → None[source]
+

The delete_data_source method removes a data source from an existing in-memory configuration.

+
+
Parameters:
+
    +

  • config_handle (int) – An identifier of an in-memory configuration. Usually created by the create or load methods

    • +

  • data_source_code (str) – Name of data source code to delete.

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract destroy(**kwargs: Any) → None[source]
+

The destroy method will destroy and perform cleanup for the Senzing SzConfig object. +It should be called after all other calls are complete.

+

Note: If the SzConfig constructor was called with parameters, +the destructor will automatically call the destroy() method. +In this case, a separate call to destroy() is not needed.

+
+
Raises:
+

szerror.SzError –

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract export_config(config_handle: int, **kwargs: Any) → str[source]
+

The export_config method creates a JSON string representation of the Senzing SzConfig object.

+
+
Parameters:
+

config_handle (int) – An identifier of an in-memory configuration. Usually created by the create or load methods

+
+
Returns:
+

A string containing a JSON Document representation of the Senzing SzConfig object.

+
+
Return type:
+

str

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted and pruned for easier reading.
+ 2
+ 3{
+ 4    "G2_CONFIG": {
+ 5        "CFG_ATTR": [],
+ 6        "CFG_CFBOM": [],
+ 7        "CFG_CFCALL": [],
+ 8        "CFG_CFRTN": [],
+ 9        "CFG_CFUNC": [],
+10        "CFG_DFBOM": [],
+11        "CFG_DFCALL": [],
+12        "CFG_DFUNC": [],
+13        "CFG_DSRC": [],
+14        "CFG_DSRC_INTEREST": [],
+15        "CFG_ECLASS": [],
+16        "CFG_EFBOM": [],
+17        "CFG_EFCALL": [],
+18        "CFG_EFUNC": [],
+19        "CFG_ERFRAG": [],
+20        "CFG_ERRULE": [],
+21        "CFG_ETYPE": [],
+22        "CFG_FBOM": [],
+23        "CFG_FBOVR": []
+24        "CFG_FCLASS": [],
+25        "CFG_FELEM": [],
+26        "CFG_FTYPE": [],
+27        "CFG_GENERIC_THRESHOLD": [],
+28        "CFG_GPLAN": [],
+29        "CFG_LENS": [],
+30        "CFG_LENSRL": [],
+31        "CFG_RCLASS": [],
+32        "CFG_RTYPE": [],
+33        "CFG_SFCALL": [],
+34        "CFG_SFUNC": [],
+35        "SYS_OOM": [],
+36        "CONFIG_BASE_VERSION": {
+37            "VERSION": "4.0.0",
+38            "BUILD_VERSION": "4.0.0.00000",
+39            "BUILD_DATE": "2024-01-01",
+40            "BUILD_NUMBER": "00000",
+41            "COMPATIBILITY_VERSION": {
+42                "CONFIG_VERSION": "10"
+43            }
+44        }
+45    }
+46}
+
+
+

Create, export, import, and close example

+
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract get_data_sources(config_handle: int, **kwargs: Any) → str[source]
+

The get_data_sources method returns a JSON document of data sources +contained in an in-memory configuration.

+
+
Parameters:
+

config_handle (int) – An identifier of an in-memory configuration. Usually created by the create or load methods

+
+
Returns:
+

A string containing a JSON document listing all of the data sources.

+
+
Return type:
+

str

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted for easier reading.
+ 2
+ 3{
+ 4    "DATA_SOURCES": [
+ 5        {
+ 6            "DSRC_ID": 1,
+ 7            "DSRC_CODE": "TEST"
+ 8        },
+ 9        {
+10            "DSRC_ID": 2,
+11            "DSRC_CODE": "SEARCH"
+12        }
+13    ]
+14}
+
+
+
+ +
+
+abstract import_config(config_definition: str | Dict[Any, Any], **kwargs: Any) → int[source]
+

The import_config method initializes an in-memory Senzing SzConfig object from a JSON string. +A handle is returned to identify the in-memory configuration. +The handle is used by the add_data_source, get_data_sources, +delete_data_source, and save methods. +The handle is terminated by the close method.

+
+
Parameters:
+

config_definition (Union[str, Dict[Any, Any]]) – A JSON document containing the Senzing configuration.

+
+
Returns:
+

An identifier (config_handle) of an in-memory configuration.

+
+
Return type:
+

int

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Create, save, load, and close

+
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract initialize(instance_name: str, settings: str | Dict[Any, Any], verbose_logging: int = 0, **kwargs: Any) → None[source]
+

The initialize method initializes the Senzing SzConfig object. +It must be called prior to any other calls.

+

Note: If the SzConfig constructor is called with parameters, +the constructor will automatically call the initialize() method. +In this case, a separate call to initialize() is not needed.

+
+
Parameters:
+
    +

  • instance_name (str) – A short name given to this instance of the SzConfig object, to help identify it within system logs.

    • +

  • settings (Union[str, Dict[Any, Any]]) – A JSON string containing configuration parameters.

    • +

  • verbose_logging (int) – Optional: A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+ +
+
+

senzing_abstract.szconfigmanager_abstract module

+

szconfigmanager_abstract.py is the abstract class for all implementations of szconfigmanager.

+
+
+class senzing_abstract.szconfigmanager_abstract.SzConfigManagerAbstract[source]
+

Bases: ABC

+

SzConfigManagerAbstract is the definition of the Senzing Python API that is +implemented by packages such as szconfigmanager.py.

+
+
+ID_MESSAGES = {4001: 'szconfigmanager.add_config({0}, {1}) failed. Return code: {2}', 4002: 'szconfigmanager.destroy() failed. Return code: {0}', 4003: 'szconfigmanager.get_config({0}) failed. Return code: {1}', 4004: 'szconfigmanager.get_config_list() failed. Return code: {0}', 4005: 'szconfigmanager.get_default_config_id() failed. Return code: {0}', 4006: 'szconfigmanager.initialize({0}, {1}, {2}) failed. Return code: {3}', 4007: 'szconfigmanager.replace_default_config_id({0}, {1}) failed. Return code: {2}', 4008: 'szconfigmanager.set_default_config_id({0}) failed. Return code: {1}', 4009: 'szconfigmanager.SzConfigManager({0}, {1}) failed. instance_name and settings must both be set or both be empty'}
+
+ +
+
+PREFIX = 'szconfigmanager.'
+
+ +
+
+abstract add_config(config_definition: str | Dict[Any, Any], config_comment: str, **kwargs: Any) → int[source]
+

The add_config method adds a Senzing configuration JSON document to the Senzing database.

+
+
Parameters:
+
    +

  • config_definition (Union[str, Dict[Any, Any]]) – The Senzing configuration JSON document.

    • +

  • config_comment (str) – free-form string of comments describing the configuration document.

    • +
+
+
Returns:
+

A configuration identifier.

+
+
Return type:
+

int

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract destroy(**kwargs: Any) → None[source]
+

The destroy method will destroy and perform cleanup for the Senzing SzConfigManager object. +It should be called after all other calls are complete.

+

Note: If the SzConfigManager constructor was called with parameters, +the destructor will automatically call the destroy() method. +In this case, a separate call to destroy() is not needed.

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract get_config(config_id: int, **kwargs: Any) → str[source]
+

The get_config method retrieves a specific Senzing configuration JSON document from the Senzing database.

+
+
Parameters:
+

config_id (int) – The configuration identifier of the desired Senzing Engine configuration JSON document to retrieve.

+
+
Returns:
+

A JSON document containing the Senzing configuration.

+
+
Return type:
+

str

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted and pruned for easier reading.
+ 2
+ 3{
+ 4    "G2_CONFIG": {
+ 5        "CFG_ATTR": [],
+ 6        "CFG_CFBOM": [],
+ 7        "CFG_CFCALL": [],
+ 8        "CFG_CFRTN": [],
+ 9        "CFG_CFUNC": [],
+10        "CFG_DFBOM": [],
+11        "CFG_DFCALL": [],
+12        "CFG_DFUNC": [],
+13        "CFG_DSRC": [],
+14        "CFG_DSRC_INTEREST": [],
+15        "CFG_ECLASS": [],
+16        "CFG_EFBOM": [],
+17        "CFG_EFCALL": [],
+18        "CFG_EFUNC": [],
+19        "CFG_ERFRAG": [],
+20        "CFG_ERRULE": [],
+21        "CFG_ETYPE": [],
+22        "CFG_FBOM": [],
+23        "CFG_FBOVR": []
+24        "CFG_FCLASS": [],
+25        "CFG_FELEM": [],
+26        "CFG_FTYPE": [],
+27        "CFG_GENERIC_THRESHOLD": [],
+28        "CFG_GPLAN": [],
+29        "CFG_LENS": [],
+30        "CFG_LENSRL": [],
+31        "CFG_RCLASS": [],
+32        "CFG_RTYPE": [],
+33        "CFG_SFCALL": [],
+34        "CFG_SFUNC": [],
+35        "SYS_OOM": [],
+36        "CONFIG_BASE_VERSION": {
+37            "VERSION": "4.0.0",
+38            "BUILD_VERSION": "4.0.0.00000",
+39            "BUILD_DATE": "2024-01-01",
+40            "BUILD_NUMBER": "00000",
+41            "COMPATIBILITY_VERSION": {
+42                "CONFIG_VERSION": "10"
+43            }
+44        }
+45    }
+46}
+
+
+
+ +
+
+abstract get_config_list(**kwargs: Any) → str[source]
+

The get_config_list method retrieves a list of Senzing configurations from the Senzing database.

+
+
Returns:
+

A JSON document containing Senzing configurations.

+
+
Return type:
+

str

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted for easier reading.
+ 2
+ 3{
+ 4    "CONFIGS": [
+ 5        {
+ 6            "CONFIG_ID": 41320074,
+ 7            "CONFIG_COMMENTS": "Default Senzing configuration",
+ 8            "SYS_CREATE_DT": "2023-02-16 16:03:40.338"
+ 9        },
+10        {
+11            "CONFIG_ID": 490826130,
+12            "CONFIG_COMMENTS": "Test",
+13            "SYS_CREATE_DT": "2023-11-09 19:13:30.923"
+14        }
+15    ]
+16}
+
+
+
+ +
+
+abstract get_default_config_id(**kwargs: Any) → int[source]
+

The get_default_config_id method retrieves from the Senzing database the configuration identifier of the default Senzing configuration.

+
+
Returns:
+

A configuration identifier which identifies the current configuration in use.

+
+
Return type:
+

int

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract initialize(instance_name: str, settings: str | Dict[Any, Any], verbose_logging: int = 0, **kwargs: Any) → None[source]
+

The initialize method initializes the Senzing SzConfigManager object. +It must be called prior to any other calls.

+

Note: If the SzConfigManager constructor is called with parameters, +the constructor will automatically call the initialize() method. +In this case, a separate call to initialize() is not needed.

+
+
Parameters:
+
    +

  • instance_name (str) – A short name given to this instance of the SzProduct object, to help identify it within system logs.

    • +

  • settings (Union[str, Dict[Any, Any]]) – A JSON string containing configuration parameters.

    • +

  • verbose_logging (int) – Optional: A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract replace_default_config_id(current_default_config_id: int, new_default_config_id: int, **kwargs: Any) → None[source]
+

The replace_default_config_id method replaces the old configuration identifier with a new configuration identifier in the Senzing database. +It is like a “compare-and-swap” instruction to serialize concurrent editing of configuration. +If current_default_config_id is no longer the “current configuration identifier”, the operation will fail. +To simply set the default configuration ID, use set_default_config_id.

+
+
Parameters:
+
    +

  • current_default_config_id (int) – The configuration identifier to replace.

    • +

  • new_default_config_id (int) – The configuration identifier to use as the default.

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract set_default_config_id(config_id: int, **kwargs: Any) → None[source]
+

The set_default_config_id method replaces the sets a new configuration identifier in the Senzing database. +To serialize modifying of the configuration identifier, see replace_default_config_id.

+
+
Parameters:
+

config_id (int) – The configuration identifier of the Senzing Engine configuration to use as the default.

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+ +
+
+

senzing_abstract.szdiagnostic_abstract module

+

TODO: szdiagnostic_abstract.py

+
+
+class senzing_abstract.szdiagnostic_abstract.SzDiagnosticAbstract[source]
+

Bases: ABC

+

Senzing diagnostic module access library

+
+
+ID_MESSAGES = {4001: 'szdiagnostic.check_datastore_performance({0}) failed. Return code: {1}', 4002: 'szdiagnostic.destroy() failed. Return code: {0}', 4003: 'szdiagnostic.get_datastore_info() failed. Return code: {0}', 4004: 'szdiagnostic.get_feature({0}) failed. Return code: {1}', 4005: 'szdiagnostic.initialize({0}, {1}, {2}, {3}) failed. Return code: {4}', 4006: 'szdiagnostic.purge_repository() failed. Return code: {0}', 4007: 'szdiagnostic.reinitialize({0}) failed. Return Code: {1}', 4008: 'szdiagnostic.SzDiagnostic({0}, {1}) failed. instance_name and settings must both be set or both be empty'}
+
+ +
+
+PREFIX = 'szdiagnostic.'
+
+ +
+
+abstract check_datastore_performance(seconds_to_run: int, **kwargs: Any) → str[source]
+

The check_datastore_performance method performs inserts to determine rate of insertion.

+
+
Parameters:
+

seconds_to_run (int) – Duration of the test in seconds.

+
+
Returns:
+

A string containing a JSON document.

+
+
Return type:
+

str

+
+
Raises:
+
    +

  • TypeError – Incorrect datatype of input parameter.

    • +

  • szexception.SzError –

    • +
+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1// Just example numbers. Your mileage may vary.
+2
+3{
+4    "numRecordsInserted": 200000,
+5    "insertTime": 3000
+6}
+
+
+
+ +
+
+abstract destroy(**kwargs: Any) → None[source]
+

The destroy method will destroy and perform cleanup for the Senzing SzDiagnostic object. +It should be called after all other calls are complete.

+

Note: If the SzDiagnostic constructor was called with parameters, +the destructor will automatically call the destroy() method. +In this case, a separate call to destroy() is not needed.

+
+
Raises:
+

szexception.SzError –

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract get_datastore_info(**kwargs: Any) → str[source]
+

The get_datastore_info method will…

+
+
Raises:
+

szexception.SzError –

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1{
+2    "Hybrid Mode": false,
+3    "Database Details": [
+4        {
+5            "Name": "/tmp/sqlite/G2C.db",
+6            "Type": "sqlite3"
+7        }
+8    ]
+9}
+
+
+
+ +
+
+abstract get_feature(feature_id: int, **kwargs: Any) → str[source]
+
+ +
+
+abstract initialize(instance_name: str, settings: str | Dict[Any, Any], config_id: int | None = None, verbose_logging: int = 0, **kwargs: Any) → None[source]
+

The initialize method initializes the Senzing SzDiagnosis object. +It must be called prior to any other calls.

+

Note: If the Sz Diagnosis constructor is called with parameters, +the constructor will automatically call the initialize() method. +In this case, a separate call to initialize() is not needed.

+
+
Parameters:
+
    +

  • instance_name (str) – A name for the auditing node, to help identify it within system logs.

    • +

  • settings (Union[str, Dict[Any, Any]]) – A JSON string containing configuration parameters.

    • +

  • config_id (int) – Optional: Initialize with a specific configuration ID and not the current default.

    • +

  • verbose_logging (int) – Optional: A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0

    • +
+
+
Raises:
+
    +

  • TypeError – Incorrect datatype of input parameter.

    • +

  • szexception.SzError –

    • +
+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract purge_repository(**kwargs: Any) → None[source]
+

Warning: +The purge_repository method removes every record in the Senzing repository.

+

Before calling purge_repository all other instances of the Senzing API +MUST be destroyed or shutdown.

+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract reinitialize(config_id: int, **kwargs: Any) → None[source]
+

The reinitialize method re-initializes the Senzing SzDiagnostic object.

+
+
Parameters:
+

config_id (int) – The configuration ID used for the initialization

+
+
Raises:
+
    +

  • TypeError – Incorrect datatype of input parameter.

    • +

  • szexception.SzError – config_id does not exist.

    • +
+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+ +
+
+

senzing_abstract.szengine_abstract module

+

TODO: szengine_abstract.py

+
+
+class senzing_abstract.szengine_abstract.SzEngineAbstract[source]
+

Bases: ABC

+

Senzing engine module access library

+
+
+abstract add_record(data_source_code: str, record_id: str, record_definition: str | Dict[Any, Any], flags: int = 0, **kwargs: Any) → str[source]
+

The add_record method adds a record into the Senzing repository. +Can be called as many times as desired and from multiple threads at the same time.

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • record_definition (str | Dict) – A JSON document containing the record to be added to the Senzing repository.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to 0.

    • +
+
+
Returns:
+

If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+add_record_return_dict(data_source_code: str, record_id: str, record_definition: str | Dict[Any, Any], flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract close_export(export_handle: int, **kwargs: Any) → None[source]
+

The close_export method closes the exported document created by export_json_entity_report. +It is part of the export_json_entity_report, fetch_next, close_export +lifecycle of a list of sized entities.

+
+
Parameters:
+

export_handle (int) – A handle created by export_json_entity_report or export_csv_entity_report.

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract count_redo_records(**kwargs: Any) → int[source]
+

The count_redo_records method returns the number of records in need of redo-ing.

+
+
Returns:
+

The number of redo records in Senzing’s redo queue.

+
+
Return type:
+

int

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
+ +
+
+abstract delete_record(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → str[source]
+

The delete_record method deletes a record from the Senzing repository. +Can be called as many times as desired and from multiple threads at the same time.

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • load_id (str, optional) – An identifier used to distinguish different load batches/sessions. An empty string is acceptable. Defaults to “”.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to 0.

    • +
+
+
Returns:
+

If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+delete_record_return_dict(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract destroy(**kwargs: Any) → None[source]
+

The destroy method releases resources and performs cleanup for the SzEngine object and any in-memory configurations. +It should be called after all other calls are complete.

+

Note: If the SzEngine constructor was called with parameters, +the destructor will automatically call the destroy() method. +In this case, a separate call to destroy() is not needed.

+
+
Raises:
+

szexception.SzError –

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract export_csv_entity_report(csv_column_list: str, flags: int = <SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS: 3734497>, **kwargs: ~typing.Any) → int[source]
+

Warning: export_csv_entity_report is not recommended for large systems as it does not scale. +It is recommended larger systems implement real-time replication to a data warehouse.

+

The export_csv_entity_report method initializes a cursor over a document of exported entities. +It is part of the export_csv_entity_report, fetch_next, close_export +lifecycle of a list of entities to export.

+
+
Parameters:
+
    +

  • csv_column_list (str) – A comma-separated list of column names for the CSV export.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A handle that identifies the document to be scrolled through using fetch_next.

+
+
Return type:
+

int

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract export_json_entity_report(flags: int = <SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS: 3734497>, **kwargs: ~typing.Any) → int[source]
+

Warning: export_json_entity_report is not recommended for large systems as it does not scale. +It is recommended larger systems implement real-time replication to a data warehouse.

+

The export_json_entity_report method initializes a cursor over a document of exported entities. +It is part of the export_json_entity_report, fetch_next, close_export +lifecycle of a list of entities to export.

+
+
Parameters:
+

flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS.

+
+
Returns:
+

A handle that identifies the document to be scrolled through using fetch_next.

+
+
Return type:
+

int

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract fetch_next(export_handle: int, **kwargs: Any) → str[source]
+

The fetch_next method is used to scroll through an exported document one entity at a time. +Successive calls of fetch_next will export successive rows of entity data until there is no more. +It is part of the export_json_entity_report or export_json_entity_report, fetch_next, close_export +lifecycle of a list of exported entities.

+
+
Parameters:
+

response_handle (int) – A handle created by export_json_entity_report or export_json_entity_report.

+
+
Returns:
+

TODO:

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract find_interesting_entities_by_entity_id(entity_id: int, flags: int = 0, **kwargs: Any) → str[source]
+
+ +
+
+find_interesting_entities_by_entity_id_return_dict(entity_id: int, flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract find_interesting_entities_by_record_id(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → str[source]
+
+ +
+
+find_interesting_entities_by_record_id_return_dict(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+

T

+
+ +
+
+abstract find_network_by_entity_id(entity_list: str | ~typing.Dict[str, ~typing.List[~typing.Dict[str, int]]], max_degrees: int, build_out_degree: int, max_entities: int, flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → str[source]
+

The find_network_by_entity_id method finds all entities surrounding a requested set of entities. +This includes the requested entities, paths between them, and relations to other nearby entities. +Returns a JSON document that identifies the path between the each set of search entities (if the path exists), +and the information for the entities in the path.

+
+
Parameters:
+
    +

  • entity_list (str) – A JSON document listing entities.

    • +

  • max_degrees (int) – The maximum number of degrees in paths between search entities.

    • +

  • build_out_degree (int) – The number of degrees of relationships to show around each search entity.

    • +

  • max_entities (int) – The maximum number of entities to return in the discovered network.

    • +

  • flags (int, optional) – The maximum number of entities to return in the discovered network. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+find_network_by_entity_id_return_dict(entity_list: str | ~typing.Dict[~typing.Any, ~typing.Any], max_degrees: int, build_out_degree: int, max_entities: int, flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+

TODO: document

+
+ +
+
+abstract find_network_by_record_id(record_list: str | ~typing.Dict[str, ~typing.List[~typing.Dict[str, str]]], max_degrees: int, build_out_degree: int, max_entities: int, flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → str[source]
+

The find_network_by_record_id method finds all entities surrounding a requested set of entities by their RECORD_ID values. +This includes the requested entities, paths between them, and relations to other nearby entities. +Returns a JSON document that identifies the path between the each set of search entities (if the path exists), +and the information for the entities in the path.

+
+
Parameters:
+
    +

  • record_list (str) – A JSON document listing records.

    • +

  • max_degrees (int) – The maximum number of degrees in paths between search entities.

    • +

  • build_out_degree (int) – The number of degrees of relationships to show around each search entity.

    • +

  • max_entities (int) – The maximum number of entities to return in the discovered network.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+find_network_by_record_id_return_dict(record_list: str | ~typing.Dict[~typing.Any, ~typing.Any], max_degrees: int, build_out_degree: int, max_entities: int, flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+

TODO: document

+
+ +
+
+abstract find_path_by_entity_id(start_entity_id: int, end_entity_id: int, max_degrees: int, exclusions: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', required_data_sources: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → str[source]
+

The find_path_by_entity_id method finds the most efficient relationship between two entities path based on the parameters +and returns a JSON document with an ENTITY_PATHS section that details the path between the entities. +The ENTITIES sections details information on the entities. Paths are found using known relationships with other entities. +Paths are found using known relationships with other entities.

+
+
Parameters:
+
    +

  • start_entity_id (int) – The entity ID for the starting entity of the search path.

    • +

  • end_entity_id (int) – The entity ID for the ending entity of the search path.

    • +

  • max_degrees (int) – The maximum number of degrees in paths between search entities.

    • +

  • exclusions (str) – TODO

    • +

  • required_data_sources (str) – TODO

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document with an ENTITY_PATHS section that details the path between the entities.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+find_path_by_entity_id_return_dict(start_entity_id: int, end_entity_id: int, max_degrees: int, exclusions: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', required_data_sources: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+

TODO: document

+
+ +
+
+abstract find_path_by_record_id(start_data_source_code: str, start_record_id: str, end_data_source_code: str, end_record_id: str, max_degrees: int, exclusions: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', required_data_sources: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → str[source]
+

The find_path_by_record_id method finds the most efficient relationship between +two entities path based on the parameters by RECORD_ID values +and returns a JSON document with an ENTITY_PATHS section that details the path between the entities. +The ENTITIES sections details information on the entities. +Paths are found using known relationships with other entities. +The entities are identified by starting and ending records.

+
+
Parameters:
+
    +

  • start_data_source_code (str) – Identifies the provenance of the record for the starting entity of the search path.

    • +

  • start_record_id (str) – The unique identifier within the records of the same data source for the starting entity of the search path.

    • +

  • end_data_source_code (str) – Identifies the provenance of the record for the ending entity of the search path.

    • +

  • end_record_id (str) – The unique identifier within the records of the same data source for the ending entity of the search path.

    • +

  • max_degrees (int) – The maximum number of degrees in paths between search entities.

    • +

  • exclusions (str) – TODO

    • +

  • required_data_sources (str) – TODO

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+find_path_by_record_id_return_dict(start_data_source_code: str, start_record_id: str, end_data_source_code: str, end_record_id: str, max_degrees: int, exclusions: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', required_data_sources: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract get_active_config_id(**kwargs: Any) → int[source]
+

The get_active_config_id method returns the identifier of the currently active Senzing engine configuration.

+
+
Returns:
+

The identifier of the active Senzing Engine configuration.

+
+
Return type:
+

int

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract get_entity_by_entity_id(entity_id: int, flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → str[source]
+

The get_entity_by_entity_id method returns entity data based on the ID of a resolved identity.

+
+
Parameters:
+
    +

  • entity_id (int) – The unique identifier of an entity.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+get_entity_by_entity_id_return_dict(entity_id: int, flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract get_entity_by_record_id(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → str[source]
+

The get_entity_by_record_id method returns entity data based on the ID of a record which is a member of the entity.

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+get_entity_by_record_id_return_dict(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract get_record(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_JSON_DATA: 65536>, **kwargs: ~typing.Any) → str[source]
+

The get_record method returns a JSON document of a single record from the Senzing repository. +Can be called as many times as desired and from multiple threads at the same time.

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document of a single record.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+get_record_return_dict(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_JSON_DATA: 65536>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract get_redo_record(**kwargs: Any) → str[source]
+

The get_redo_record method returns the next internally queued redo record from the Senzing repository. +Usually, the process_redo_record or process_redo_record_with_info method is called to process the redo record +retrieved by get_redo_record.

+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract get_repository_last_modified_time(**kwargs: Any) → int[source]
+

The get_repository_last_modified_time method retrieves the last modified time of the Senzing repository, +measured in the number of seconds between the last modified time and January 1, 1970 12:00am GMT (epoch time).

+
+
Returns:
+

A Unix Timestamp.

+
+
Return type:
+

int

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract get_stats(**kwargs: Any) → str[source]
+

The get_stats method retrieves workload statistics for the current process. +These statistics will automatically reset after retrieval.

+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+get_stats_return_dict(**kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract get_virtual_entity_by_record_id(record_list: str | ~typing.Dict[~typing.Any, ~typing.Any], flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → str[source]
+

The get_virtual_entity_by_record_id method creates a view of a virtual entity +using a list of existing loaded records. +The virtual entity is composed of only those records and their features. +Entity resolution is not performed.

+
+
Parameters:
+
    +

  • record_list (str) – A JSON document of one or more records by DATA_SOURCE and RECORD_ID pairs, formatted as {“RECORDS”:[{“DATA_SOURCE”:”DS1”,”RECORD_ID”:”R1”},{“DATA_SOURCE”:”DS2”,”RECORD_ID”:”R2”}]}.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+get_virtual_entity_by_record_id_return_dict(record_list: str | ~typing.Dict[~typing.Any, ~typing.Any], flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract how_entity_by_entity_id(entity_id: int, flags: int = <SzEngineFlags.SZ_INCLUDE_FEATURE_SCORES: 67108864>, **kwargs: ~typing.Any) → str[source]
+

The how_entity_by_entity_id method determines and details steps-by-step how records resolved to an ENTITY_ID.

+

In most cases, how provides more detailed information than why as the resolution is detailed step-by-step.

+
+
Parameters:
+
    +

  • entity_id (int) – The unique identifier of an entity.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+how_entity_by_entity_id_return_dict(entity_id: int, flags: int = <SzEngineFlags.SZ_INCLUDE_FEATURE_SCORES: 67108864>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract initialize(instance_name: str, settings: str | Dict[Any, Any], config_id: int | None = None, verbose_logging: int = 0, **kwargs: Any) → None[source]
+

he initialize method initializes the Senzing SzEngine object. +It must be called prior to any other calls.

+

Note: If the SzEngine constructor is called with parameters, +the constructor will automatically call the initialize() method. +In this case, a separate call to initialize() is not needed.

+
+
Parameters:
+
    +

  • instance_name (str) – A short name given to this instance of the SzEngine object, to help identify it within system logs.

    • +

  • settings (str) – A JSON string containing configuration parameters.

    • +

  • config_id (int)

    • +

  • verbose_logging (int) – Optional: A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract prime_engine(**kwargs: Any) → None[source]
+

The prime_engine method initializes high resource consumption components of Senzing +used in some functions. If this call is not made, these resources are initialized the +first time they are needed and can cause unusually long processing times the first time +a function is called that requires these resources.

+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract process_redo_record(redo_record: str, flags: int, **kwargs: Any) → str[source]
+

#TODO The process_redo_record method…

+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract reevaluate_entity(entity_id: int, flags: int = 0, **kwargs: Any) → str[source]
+

The reevaluate_entity method reevaluates the specified entity.

+
+
Parameters:
+
    +

  • entity_id (int) – The unique identifier of an entity.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to 0.

    • +
+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+reevaluate_entity_return_dict(entity_id: int, flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract reevaluate_record(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → str[source]
+

The reevaluate_record method reevaluates a specific record.

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to 0.

    • +
+
+
Returns:
+

If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+reevaluate_record_return_dict(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract reinitialize(config_id: int, **kwargs: Any) → None[source]
+

The reinitialize method reinitializes the Senzing SzEngine object using a specific configuration +identifier. A list of available configuration identifiers can be retrieved using +szconfigmanager.get_config_list.

+
+
Parameters:
+

config_id (int) – The configuration ID used for the initialization

+
+
Raises:
+
    +

  • TypeError – Incorrect datatype of input parameter.

    • +

  • szexception.SzError – config_id does not exist.

    • +
+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract search_by_attributes(attributes: str | ~typing.Dict[~typing.Any, ~typing.Any], search_profile: str = '', flags: int = <SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_ALL: 67123215>, **kwargs: ~typing.Any) → str[source]
+

The search_by_attributes method retrieves entity data based on a user-specified set of entity attributes.

+
+
Parameters:
+
    +

  • attributes (str) – A JSON document with the attribute data to search for.

    • +

  • search_profile (str) – The name of a configured search profile. Defaults to SEARCH.

    • +

  • flags (int, optional) – _description_. Defaults to SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+search_by_attributes_return_dict(attributes: str | ~typing.Dict[~typing.Any, ~typing.Any], search_profile: str = 'SEARCH', flags: int = <SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_ALL: 67123215>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract why_entities(entity_id_1: int, entity_id_2: int, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → str[source]
+

The why_entities method determines why entities did not resolve or why they do relate.

+
+
Parameters:
+
    +

  • entity_id_1 (int) – The entity ID for the starting entity of the search path.

    • +

  • entity_id_2 (int) – The entity ID for the ending entity of the search path.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+why_entities_return_dict(entity_id_1: int, entity_id_2: int, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract why_record_in_entity(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → str[source]
+

The why_record_in_entity … TODO:

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+why_record_in_entity_return_dict(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract why_records(data_source_code_1: str, record_id_1: str, data_source_code_2: str, record_id_2: str, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → str[source]
+

The why_records determines if any two records can or cannot resolve together, or if they relate.

+
+
Parameters:
+
    +

  • data_source_code_1 (str) – Identifies the provenance of the data.

    • +

  • record_id_1 (str) – The unique identifier within the records of the same data source.

    • +

  • data_source_code_2 (str) – Identifies the provenance of the data.

    • +

  • record_id_2 (str) – The unique identifier within the records of the same data source.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+why_records_return_dict(data_source_code_1: str, record_id_1: str, data_source_code_2: str, record_id_2: str, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+ +
+
+

senzing_abstract.szengineflags module

+

TODO: szengineflags.py

+
+
+class senzing_abstract.szengineflags.SzEngineFlags(value)[source]
+

Bases: IntFlag

+

Engine Flags …

+
+
+SZ_ENTITY_BRIEF_DEFAULT_FLAGS = 1082304
+
+ +
+
+SZ_ENTITY_DEFAULT_FLAGS = 3734464
+
+ +
+
+SZ_ENTITY_INCLUDE_ALL_FEATURES = 1024
+
+ +
+
+SZ_ENTITY_INCLUDE_ALL_RELATIONS = 960
+
+ +
+
+SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS = 512
+
+ +
+
+SZ_ENTITY_INCLUDE_ENTITY_NAME = 4096
+
+ +
+
+SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS = 256
+
+ +
+ +
+ +
+
+SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS = 64
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_DATA = 16384
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS = 262144
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_JSON_DATA = 65536
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO = 32768
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_SUMMARY = 8192
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_TYPES = 268435456
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA = 2147483648
+
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+
+SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES = 2048
+
+ +
+
+SZ_ENTITY_OPTION_INCLUDE_FEATURE_ELEMENTS = 4294967296
+
+ +
+
+SZ_ENTITY_OPTION_INCLUDE_FEATURE_STATS = 16777216
+
+ +
+
+SZ_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES = 8388608
+
+ +
+
+SZ_ENTITY_OPTION_INCLUDE_MATCH_KEY_DETAILS = 17179869184
+
+ +
+
+SZ_EXPORT_DEFAULT_FLAGS = 3734497
+
+ +
+
+SZ_EXPORT_INCLUDE_ALL_ENTITIES = 33
+
+ +
+
+SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS = 30
+
+ +
+
+SZ_EXPORT_INCLUDE_DISCLOSED = 16
+
+ +
+
+SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES = 1
+
+ +
+
+SZ_EXPORT_INCLUDE_NAME_ONLY = 8
+
+ +
+ +
+ +
+
+SZ_EXPORT_INCLUDE_POSSIBLY_SAME = 2
+
+ +
+
+SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES = 32
+
+ +
+
+SZ_FIND_NETWORK_DEFAULT_FLAGS = 8589946880
+
+ +
+
+SZ_FIND_NETWORK_MATCHING_INFO = 8589934592
+
+ +
+
+SZ_FIND_PATH_DEFAULT_FLAGS = 1073754112
+
+ +
+
+SZ_FIND_PATH_MATCHING_INFO = 1073741824
+
+ +
+
+SZ_FIND_PATH_PREFER_EXCLUDE = 33554432
+
+ +
+
+SZ_HOW_ENTITY_DEFAULT_FLAGS = 67108864
+
+ +
+
+SZ_INCLUDE_FEATURE_SCORES = 67108864
+
+ +
+
+SZ_INITIALIZE_WITH_DEFAULT_CONFIGURATION = 0
+
+ +
+
+SZ_NO_FLAGS = 0
+
+ +
+
+SZ_NO_LOGGING = 0
+
+ +
+
+SZ_RECORD_DEFAULT_FLAGS = 65536
+
+ +
+
+SZ_SEARCH_BY_ATTRIBUTES_ALL = 67123215
+
+ +
+
+SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS = 67123215
+
+ +
+
+SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL = 15
+
+ +
+
+SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG = 3
+
+ +
+
+SZ_SEARCH_BY_ATTRIBUTES_STRONG = 67123203
+
+ +
+
+SZ_SEARCH_INCLUDE_ALL_ENTITIES = 15
+
+ +
+
+SZ_SEARCH_INCLUDE_FEATURE_SCORES = 67108864
+
+ +
+
+SZ_SEARCH_INCLUDE_MATCH_KEY_DETAILS = 17179869184
+
+ +
+
+SZ_SEARCH_INCLUDE_NAME_ONLY = 8
+
+ +
+ +
+ +
+
+SZ_SEARCH_INCLUDE_POSSIBLY_SAME = 2
+
+ +
+
+SZ_SEARCH_INCLUDE_RESOLVED = 1
+
+ +
+
+SZ_SEARCH_INCLUDE_STATS = 134217728
+
+ +
+
+SZ_VERBOSE_LOGGING = 1
+
+ +
+
+SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS = 3734464
+
+ +
+
+SZ_WHY_ENTITIES_DEFAULT_FLAGS = 96009152
+
+ +
+
+SZ_WHY_RECORDS_DEFAULT_FLAGS = 96009152
+
+ +
+
+SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS = 96009152
+
+ +
+
+SZ_WITHOUT_INFO = 0
+
+ +
+
+SZ_WITH_INFO = 4611686018427387904
+
+ +
+
+classmethod combine_flags(list_of_strings: List[str], *args: Any, **kwargs: Any) → int[source]
+

OR together all strings in list_of_strings

+
+ +
+ +
+
+

senzing_abstract.szhasher_abstract module

+

TODO: szhasher_abstract.py

+
+
+class senzing_abstract.szhasher_abstract.SzHasherAbstract[source]
+

Bases: ABC

+

SzHasher module access library

+
+
+ID_MESSAGES = {0: ''}
+
+ +
+
+PREFIX = 'szhasher.'
+
+ +
+
+abstract destroy(*args: Any, **kwargs: Any) → None[source]
+

TODO: document

+
+ +
+
+abstract export_token_library(*args: Any, **kwargs: Any) → str[source]
+

TODO: document

+
+ +
+
+abstract init(module_name: str, ini_params: str, verbose_logging: int = 0, **kwargs: Any) → None[source]
+

TODO: document

+
+ +
+
+abstract init_with_config_id(module_name: str, ini_params: str, init_config_id: int, verbose_logging: int = 0, **kwargs: Any) → None[source]
+

TODO: document

+
+ +
+
+abstract process(record: str, *args: Any, **kwargs: Any) → str[source]
+

TODO: document

+
+ +
+
+abstract reinit(init_config_id: int, *args: Any, **kwargs: Any) → None[source]
+

TODO: document

+
+ +
+ +
+
+

senzing_abstract.szproduct_abstract module

+

szproduct_abstract.py is the abstract class for all implementations of szproduct.

+
+
+class senzing_abstract.szproduct_abstract.SzProductAbstract[source]
+

Bases: ABC

+

SzProductAbstract is the definition of the Senzing Python API that is +implemented by packages such as szproduct.py.

+
+
+ID_MESSAGES = {4001: 'szproduct.destroy() failed. Return code: {0}', 4002: 'szproduct.initialize({0}, {1}, {2}) failed. Return code: {3}', 4003: 'szproduct.SzProduct({0}, {1}) failed. instance_name and settings must both be set or both be empty'}
+
+ +
+
+PREFIX = 'szproduct.'
+
+ +
+
+abstract destroy(**kwargs: Any) → None[source]
+

The destroy method will destroy and perform cleanup for the Senzing SzProduct object. +It should be called after all other calls are complete.

+

Note: If the SzProduct constructor was called with parameters, +the destructor will automatically call the destroy() method. +In this case, a separate call to destroy() is not needed.

+
+
Raises:
+

szexception.SzError –

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract get_license(**kwargs: Any) → str[source]
+

The get_license method retrieves information about the currently used license by the Senzing API.

+
+
Returns:
+

A JSON document containing Senzing license metadata.

+
+
Return type:
+

str

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted for easier reading.
+ 2
+ 3{
+ 4    "customer": "Senzing Public Test License",
+ 5    "contract": "EVALUATION - support@senzing.com",
+ 6    "issueDate": "2022-11-29",
+ 7    "licenseType": "EVAL (Solely for non-productive use)",
+ 8    "licenseLevel": "STANDARD",
+ 9    "billing": "MONTHLY",
+10    "expireDate": "2023-11-29",
+11    "recordLimit": 50000
+12}
+
+
+
+ +
+
+abstract get_version(**kwargs: Any) → str[source]
+

The get_version method returns the version of the Senzing API.

+
+
Returns:
+

A JSON document containing metadata about the Senzing Engine version being used.

+
+
Return type:
+

str

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted for easier reading.
+ 2
+ 3{
+ 4    "PRODUCT_NAME": "Senzing API",
+ 5    "VERSION": "3.8.0",
+ 6    "BUILD_VERSION": "3.8.0.23303",
+ 7    "BUILD_DATE": "2023-10-30",
+ 8    "BUILD_NUMBER": "2023_10_30__10_45",
+ 9    "COMPATIBILITY_VERSION": {
+10        "CONFIG_VERSION": "10"
+11    },
+12    "SCHEMA_VERSION": {
+13        "ENGINE_SCHEMA_VERSION": "3.8",
+14        "MINIMUM_REQUIRED_SCHEMA_VERSION": "3.0",
+15        "MAXIMUM_REQUIRED_SCHEMA_VERSION": "3.99"
+16    }
+17}
+
+
+
+ +
+
+abstract initialize(instance_name: str, settings: str | Dict[Any, Any], verbose_logging: int = 0, **kwargs: Any) → None[source]
+

The initialize method initializes the Senzing SzProduct object. +It must be called prior to any other calls.

+

Note: If the SzProduct constructor is called with parameters, +the constructor will automatically call the initialize() method. +In this case, a separate call to initialize() is not needed.

+
+
Parameters:
+
    +

  • instance_name (str) – A short name given to this instance of the SzProduct object, to help identify it within system logs.

    • +

  • settings (str) – A JSON string containing configuration parameters.

    • +

  • verbose_logging (int) – Optional: A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+license_as_dict(**kwargs: Any) → Dict[str, Any][source]
+

A convenience method for +senzing_abstract.SzProductAbstract.get_license()

+
+
Returns:
+

A dictionary containing Senzing license metadata.

+
+
Return type:
+

Dict[str, Any]

+
+
+
+ +
+
+version_as_dict(**kwargs: Any) → Dict[str, Any][source]
+

A convenience method for +senzing_abstract.SzProductAbstract.get_version()

+
+
Returns:
+

A dictionary containing metadata about the Senzing Engine version being used.

+
+
Return type:
+

Dict[str, Any]

+
+
+
+ +
+ +
+
+

Module contents

+
+
+exception senzing_abstract.SzBadInputError[source]
+

Bases: SzError

+

The user-supplied input contained an error.

+
+ +
+
+class senzing_abstract.SzConfigAbstract[source]
+

Bases: ABC

+

SzConfigAbstract is the definition of the Senzing Python API that is +implemented by packages such as szconfig.py.

+
+
+ID_MESSAGES = {4001: 'szconfig.add_data_source({0}) failed. Return code: {1}', 4002: 'szconfig.close_config() failed. Return code: {0}', 4003: 'szconfig.create_config() failed. Return code: {0}', 4004: 'szconfig.delete_data_source({0}) failed. Return code: {1}', 4005: 'szconfig.destroy() failed. Return code: {0}', 4006: 'szconfig.export_config() failed. Return code: {0}', 4007: 'szconfig.get_data_sources() failed. Return code: {0}', 4008: 'szconfig.initialize({0}, {1}, {2}) failed. Return code: {3}', 4009: 'szconfig.import_config({0}) failed. Return code: {1}', 4010: 'szconfig.SzConfig({0}, {1}) failed. instance_name and settings must both be set or both be empty'}
+
+ +
+
+PREFIX = 'szconfig.'
+
+ +
+
+abstract add_data_source(config_handle: int, data_source_code: str, **kwargs: Any) → str[source]
+

The add_data_source method adds a data source to an existing in-memory configuration.

+
+
Parameters:
+
    +

  • config_handle (int) – An identifier of an in-memory configuration. Usually created by the create or load methods.

    • +

  • data_source_code (str) – Name of data source code to add.

    • +
+
+
Returns:
+

A string containing a JSON document listing the newly created data source.

+
+
Return type:
+

str

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1// Output has been formatted for easier reading.
+2
+3{
+4    "DSRC_ID": 1001
+5}
+
+
+
+ +
+
+abstract close_config(config_handle: int, **kwargs: Any) → None[source]
+

The close_config method cleans up the Senzing SzConfig object pointed to by the config_handle.

+
+
Parameters:
+

config_handle (int) – An identifier of an in-memory configuration. Usually created by the create_config or import_config methods.

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract create_config(**kwargs: Any) → int[source]
+

The create_config method creates an in-memory Senzing configuration +from the g2config.json template configuration file located +in the PIPELINE.RESOURCEPATH path. +A handle is returned to identify the in-memory configuration. +The handle is used by the add_data_source, list_data_sources, +delete_data_source, and export_config methods. +The handle is terminated by the close_config method.

+
+
Returns:
+

A pointer to an in-memory Senzing configuration.

+
+
Return type:
+

int

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract delete_data_source(config_handle: int, data_source_code: str, **kwargs: Any) → None[source]
+

The delete_data_source method removes a data source from an existing in-memory configuration.

+
+
Parameters:
+
    +

  • config_handle (int) – An identifier of an in-memory configuration. Usually created by the create or load methods

    • +

  • data_source_code (str) – Name of data source code to delete.

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract destroy(**kwargs: Any) → None[source]
+

The destroy method will destroy and perform cleanup for the Senzing SzConfig object. +It should be called after all other calls are complete.

+

Note: If the SzConfig constructor was called with parameters, +the destructor will automatically call the destroy() method. +In this case, a separate call to destroy() is not needed.

+
+
Raises:
+

szerror.SzError –

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract export_config(config_handle: int, **kwargs: Any) → str[source]
+

The export_config method creates a JSON string representation of the Senzing SzConfig object.

+
+
Parameters:
+

config_handle (int) – An identifier of an in-memory configuration. Usually created by the create or load methods

+
+
Returns:
+

A string containing a JSON Document representation of the Senzing SzConfig object.

+
+
Return type:
+

str

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted and pruned for easier reading.
+ 2
+ 3{
+ 4    "G2_CONFIG": {
+ 5        "CFG_ATTR": [],
+ 6        "CFG_CFBOM": [],
+ 7        "CFG_CFCALL": [],
+ 8        "CFG_CFRTN": [],
+ 9        "CFG_CFUNC": [],
+10        "CFG_DFBOM": [],
+11        "CFG_DFCALL": [],
+12        "CFG_DFUNC": [],
+13        "CFG_DSRC": [],
+14        "CFG_DSRC_INTEREST": [],
+15        "CFG_ECLASS": [],
+16        "CFG_EFBOM": [],
+17        "CFG_EFCALL": [],
+18        "CFG_EFUNC": [],
+19        "CFG_ERFRAG": [],
+20        "CFG_ERRULE": [],
+21        "CFG_ETYPE": [],
+22        "CFG_FBOM": [],
+23        "CFG_FBOVR": []
+24        "CFG_FCLASS": [],
+25        "CFG_FELEM": [],
+26        "CFG_FTYPE": [],
+27        "CFG_GENERIC_THRESHOLD": [],
+28        "CFG_GPLAN": [],
+29        "CFG_LENS": [],
+30        "CFG_LENSRL": [],
+31        "CFG_RCLASS": [],
+32        "CFG_RTYPE": [],
+33        "CFG_SFCALL": [],
+34        "CFG_SFUNC": [],
+35        "SYS_OOM": [],
+36        "CONFIG_BASE_VERSION": {
+37            "VERSION": "4.0.0",
+38            "BUILD_VERSION": "4.0.0.00000",
+39            "BUILD_DATE": "2024-01-01",
+40            "BUILD_NUMBER": "00000",
+41            "COMPATIBILITY_VERSION": {
+42                "CONFIG_VERSION": "10"
+43            }
+44        }
+45    }
+46}
+
+
+

Create, export, import, and close example

+
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract get_data_sources(config_handle: int, **kwargs: Any) → str[source]
+

The get_data_sources method returns a JSON document of data sources +contained in an in-memory configuration.

+
+
Parameters:
+

config_handle (int) – An identifier of an in-memory configuration. Usually created by the create or load methods

+
+
Returns:
+

A string containing a JSON document listing all of the data sources.

+
+
Return type:
+

str

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted for easier reading.
+ 2
+ 3{
+ 4    "DATA_SOURCES": [
+ 5        {
+ 6            "DSRC_ID": 1,
+ 7            "DSRC_CODE": "TEST"
+ 8        },
+ 9        {
+10            "DSRC_ID": 2,
+11            "DSRC_CODE": "SEARCH"
+12        }
+13    ]
+14}
+
+
+
+ +
+
+abstract import_config(config_definition: str | Dict[Any, Any], **kwargs: Any) → int[source]
+

The import_config method initializes an in-memory Senzing SzConfig object from a JSON string. +A handle is returned to identify the in-memory configuration. +The handle is used by the add_data_source, get_data_sources, +delete_data_source, and save methods. +The handle is terminated by the close method.

+
+
Parameters:
+

config_definition (Union[str, Dict[Any, Any]]) – A JSON document containing the Senzing configuration.

+
+
Returns:
+

An identifier (config_handle) of an in-memory configuration.

+
+
Return type:
+

int

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Create, save, load, and close

+
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract initialize(instance_name: str, settings: str | Dict[Any, Any], verbose_logging: int = 0, **kwargs: Any) → None[source]
+

The initialize method initializes the Senzing SzConfig object. +It must be called prior to any other calls.

+

Note: If the SzConfig constructor is called with parameters, +the constructor will automatically call the initialize() method. +In this case, a separate call to initialize() is not needed.

+
+
Parameters:
+
    +

  • instance_name (str) – A short name given to this instance of the SzConfig object, to help identify it within system logs.

    • +

  • settings (Union[str, Dict[Any, Any]]) – A JSON string containing configuration parameters.

    • +

  • verbose_logging (int) – Optional: A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+ +
+
+class senzing_abstract.SzConfigManagerAbstract[source]
+

Bases: ABC

+

SzConfigManagerAbstract is the definition of the Senzing Python API that is +implemented by packages such as szconfigmanager.py.

+
+
+ID_MESSAGES = {4001: 'szconfigmanager.add_config({0}, {1}) failed. Return code: {2}', 4002: 'szconfigmanager.destroy() failed. Return code: {0}', 4003: 'szconfigmanager.get_config({0}) failed. Return code: {1}', 4004: 'szconfigmanager.get_config_list() failed. Return code: {0}', 4005: 'szconfigmanager.get_default_config_id() failed. Return code: {0}', 4006: 'szconfigmanager.initialize({0}, {1}, {2}) failed. Return code: {3}', 4007: 'szconfigmanager.replace_default_config_id({0}, {1}) failed. Return code: {2}', 4008: 'szconfigmanager.set_default_config_id({0}) failed. Return code: {1}', 4009: 'szconfigmanager.SzConfigManager({0}, {1}) failed. instance_name and settings must both be set or both be empty'}
+
+ +
+
+PREFIX = 'szconfigmanager.'
+
+ +
+
+abstract add_config(config_definition: str | Dict[Any, Any], config_comment: str, **kwargs: Any) → int[source]
+

The add_config method adds a Senzing configuration JSON document to the Senzing database.

+
+
Parameters:
+
    +

  • config_definition (Union[str, Dict[Any, Any]]) – The Senzing configuration JSON document.

    • +

  • config_comment (str) – free-form string of comments describing the configuration document.

    • +
+
+
Returns:
+

A configuration identifier.

+
+
Return type:
+

int

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract destroy(**kwargs: Any) → None[source]
+

The destroy method will destroy and perform cleanup for the Senzing SzConfigManager object. +It should be called after all other calls are complete.

+

Note: If the SzConfigManager constructor was called with parameters, +the destructor will automatically call the destroy() method. +In this case, a separate call to destroy() is not needed.

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract get_config(config_id: int, **kwargs: Any) → str[source]
+

The get_config method retrieves a specific Senzing configuration JSON document from the Senzing database.

+
+
Parameters:
+

config_id (int) – The configuration identifier of the desired Senzing Engine configuration JSON document to retrieve.

+
+
Returns:
+

A JSON document containing the Senzing configuration.

+
+
Return type:
+

str

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted and pruned for easier reading.
+ 2
+ 3{
+ 4    "G2_CONFIG": {
+ 5        "CFG_ATTR": [],
+ 6        "CFG_CFBOM": [],
+ 7        "CFG_CFCALL": [],
+ 8        "CFG_CFRTN": [],
+ 9        "CFG_CFUNC": [],
+10        "CFG_DFBOM": [],
+11        "CFG_DFCALL": [],
+12        "CFG_DFUNC": [],
+13        "CFG_DSRC": [],
+14        "CFG_DSRC_INTEREST": [],
+15        "CFG_ECLASS": [],
+16        "CFG_EFBOM": [],
+17        "CFG_EFCALL": [],
+18        "CFG_EFUNC": [],
+19        "CFG_ERFRAG": [],
+20        "CFG_ERRULE": [],
+21        "CFG_ETYPE": [],
+22        "CFG_FBOM": [],
+23        "CFG_FBOVR": []
+24        "CFG_FCLASS": [],
+25        "CFG_FELEM": [],
+26        "CFG_FTYPE": [],
+27        "CFG_GENERIC_THRESHOLD": [],
+28        "CFG_GPLAN": [],
+29        "CFG_LENS": [],
+30        "CFG_LENSRL": [],
+31        "CFG_RCLASS": [],
+32        "CFG_RTYPE": [],
+33        "CFG_SFCALL": [],
+34        "CFG_SFUNC": [],
+35        "SYS_OOM": [],
+36        "CONFIG_BASE_VERSION": {
+37            "VERSION": "4.0.0",
+38            "BUILD_VERSION": "4.0.0.00000",
+39            "BUILD_DATE": "2024-01-01",
+40            "BUILD_NUMBER": "00000",
+41            "COMPATIBILITY_VERSION": {
+42                "CONFIG_VERSION": "10"
+43            }
+44        }
+45    }
+46}
+
+
+
+ +
+
+abstract get_config_list(**kwargs: Any) → str[source]
+

The get_config_list method retrieves a list of Senzing configurations from the Senzing database.

+
+
Returns:
+

A JSON document containing Senzing configurations.

+
+
Return type:
+

str

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted for easier reading.
+ 2
+ 3{
+ 4    "CONFIGS": [
+ 5        {
+ 6            "CONFIG_ID": 41320074,
+ 7            "CONFIG_COMMENTS": "Default Senzing configuration",
+ 8            "SYS_CREATE_DT": "2023-02-16 16:03:40.338"
+ 9        },
+10        {
+11            "CONFIG_ID": 490826130,
+12            "CONFIG_COMMENTS": "Test",
+13            "SYS_CREATE_DT": "2023-11-09 19:13:30.923"
+14        }
+15    ]
+16}
+
+
+
+ +
+
+abstract get_default_config_id(**kwargs: Any) → int[source]
+

The get_default_config_id method retrieves from the Senzing database the configuration identifier of the default Senzing configuration.

+
+
Returns:
+

A configuration identifier which identifies the current configuration in use.

+
+
Return type:
+

int

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract initialize(instance_name: str, settings: str | Dict[Any, Any], verbose_logging: int = 0, **kwargs: Any) → None[source]
+

The initialize method initializes the Senzing SzConfigManager object. +It must be called prior to any other calls.

+

Note: If the SzConfigManager constructor is called with parameters, +the constructor will automatically call the initialize() method. +In this case, a separate call to initialize() is not needed.

+
+
Parameters:
+
    +

  • instance_name (str) – A short name given to this instance of the SzProduct object, to help identify it within system logs.

    • +

  • settings (Union[str, Dict[Any, Any]]) – A JSON string containing configuration parameters.

    • +

  • verbose_logging (int) – Optional: A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract replace_default_config_id(current_default_config_id: int, new_default_config_id: int, **kwargs: Any) → None[source]
+

The replace_default_config_id method replaces the old configuration identifier with a new configuration identifier in the Senzing database. +It is like a “compare-and-swap” instruction to serialize concurrent editing of configuration. +If current_default_config_id is no longer the “current configuration identifier”, the operation will fail. +To simply set the default configuration ID, use set_default_config_id.

+
+
Parameters:
+
    +

  • current_default_config_id (int) – The configuration identifier to replace.

    • +

  • new_default_config_id (int) – The configuration identifier to use as the default.

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract set_default_config_id(config_id: int, **kwargs: Any) → None[source]
+

The set_default_config_id method replaces the sets a new configuration identifier in the Senzing database. +To serialize modifying of the configuration identifier, see replace_default_config_id.

+
+
Parameters:
+

config_id (int) – The configuration identifier of the Senzing Engine configuration to use as the default.

+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+ +
+
+exception senzing_abstract.SzConfigurationError[source]
+

Bases: SzError

+

The program can provide a remedy and continue.

+
+ +
+
+exception senzing_abstract.SzDatabaseConnectionLostError[source]
+

Bases: SzRetryableError

+

Database connection lost

+
+ +
+
+exception senzing_abstract.SzDatabaseError[source]
+

Bases: SzUnrecoverableError

+

Database exception

+
+ +
+
+class senzing_abstract.SzDiagnosticAbstract[source]
+

Bases: ABC

+

Senzing diagnostic module access library

+
+
+ID_MESSAGES = {4001: 'szdiagnostic.check_datastore_performance({0}) failed. Return code: {1}', 4002: 'szdiagnostic.destroy() failed. Return code: {0}', 4003: 'szdiagnostic.get_datastore_info() failed. Return code: {0}', 4004: 'szdiagnostic.get_feature({0}) failed. Return code: {1}', 4005: 'szdiagnostic.initialize({0}, {1}, {2}, {3}) failed. Return code: {4}', 4006: 'szdiagnostic.purge_repository() failed. Return code: {0}', 4007: 'szdiagnostic.reinitialize({0}) failed. Return Code: {1}', 4008: 'szdiagnostic.SzDiagnostic({0}, {1}) failed. instance_name and settings must both be set or both be empty'}
+
+ +
+
+PREFIX = 'szdiagnostic.'
+
+ +
+
+abstract check_datastore_performance(seconds_to_run: int, **kwargs: Any) → str[source]
+

The check_datastore_performance method performs inserts to determine rate of insertion.

+
+
Parameters:
+

seconds_to_run (int) – Duration of the test in seconds.

+
+
Returns:
+

A string containing a JSON document.

+
+
Return type:
+

str

+
+
Raises:
+
    +

  • TypeError – Incorrect datatype of input parameter.

    • +

  • szexception.SzError –

    • +
+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1// Just example numbers. Your mileage may vary.
+2
+3{
+4    "numRecordsInserted": 200000,
+5    "insertTime": 3000
+6}
+
+
+
+ +
+
+abstract destroy(**kwargs: Any) → None[source]
+

The destroy method will destroy and perform cleanup for the Senzing SzDiagnostic object. +It should be called after all other calls are complete.

+

Note: If the SzDiagnostic constructor was called with parameters, +the destructor will automatically call the destroy() method. +In this case, a separate call to destroy() is not needed.

+
+
Raises:
+

szexception.SzError –

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract get_datastore_info(**kwargs: Any) → str[source]
+

The get_datastore_info method will…

+
+
Raises:
+

szexception.SzError –

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1{
+2    "Hybrid Mode": false,
+3    "Database Details": [
+4        {
+5            "Name": "/tmp/sqlite/G2C.db",
+6            "Type": "sqlite3"
+7        }
+8    ]
+9}
+
+
+
+ +
+
+abstract get_feature(feature_id: int, **kwargs: Any) → str[source]
+
+ +
+
+abstract initialize(instance_name: str, settings: str | Dict[Any, Any], config_id: int | None = None, verbose_logging: int = 0, **kwargs: Any) → None[source]
+

The initialize method initializes the Senzing SzDiagnosis object. +It must be called prior to any other calls.

+

Note: If the Sz Diagnosis constructor is called with parameters, +the constructor will automatically call the initialize() method. +In this case, a separate call to initialize() is not needed.

+
+
Parameters:
+
    +

  • instance_name (str) – A name for the auditing node, to help identify it within system logs.

    • +

  • settings (Union[str, Dict[Any, Any]]) – A JSON string containing configuration parameters.

    • +

  • config_id (int) – Optional: Initialize with a specific configuration ID and not the current default.

    • +

  • verbose_logging (int) – Optional: A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0

    • +
+
+
Raises:
+
    +

  • TypeError – Incorrect datatype of input parameter.

    • +

  • szexception.SzError –

    • +
+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract purge_repository(**kwargs: Any) → None[source]
+

Warning: +The purge_repository method removes every record in the Senzing repository.

+

Before calling purge_repository all other instances of the Senzing API +MUST be destroyed or shutdown.

+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract reinitialize(config_id: int, **kwargs: Any) → None[source]
+

The reinitialize method re-initializes the Senzing SzDiagnostic object.

+
+
Parameters:
+

config_id (int) – The configuration ID used for the initialization

+
+
Raises:
+
    +

  • TypeError – Incorrect datatype of input parameter.

    • +

  • szexception.SzError – config_id does not exist.

    • +
+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+ +
+
+class senzing_abstract.SzEngineAbstract[source]
+

Bases: ABC

+

Senzing engine module access library

+
+
+abstract add_record(data_source_code: str, record_id: str, record_definition: str | Dict[Any, Any], flags: int = 0, **kwargs: Any) → str[source]
+

The add_record method adds a record into the Senzing repository. +Can be called as many times as desired and from multiple threads at the same time.

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • record_definition (str | Dict) – A JSON document containing the record to be added to the Senzing repository.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to 0.

    • +
+
+
Returns:
+

If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+add_record_return_dict(data_source_code: str, record_id: str, record_definition: str | Dict[Any, Any], flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract close_export(export_handle: int, **kwargs: Any) → None[source]
+

The close_export method closes the exported document created by export_json_entity_report. +It is part of the export_json_entity_report, fetch_next, close_export +lifecycle of a list of sized entities.

+
+
Parameters:
+

export_handle (int) – A handle created by export_json_entity_report or export_csv_entity_report.

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract count_redo_records(**kwargs: Any) → int[source]
+

The count_redo_records method returns the number of records in need of redo-ing.

+
+
Returns:
+

The number of redo records in Senzing’s redo queue.

+
+
Return type:
+

int

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
+ +
+
+abstract delete_record(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → str[source]
+

The delete_record method deletes a record from the Senzing repository. +Can be called as many times as desired and from multiple threads at the same time.

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • load_id (str, optional) – An identifier used to distinguish different load batches/sessions. An empty string is acceptable. Defaults to “”.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to 0.

    • +
+
+
Returns:
+

If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+delete_record_return_dict(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract destroy(**kwargs: Any) → None[source]
+

The destroy method releases resources and performs cleanup for the SzEngine object and any in-memory configurations. +It should be called after all other calls are complete.

+

Note: If the SzEngine constructor was called with parameters, +the destructor will automatically call the destroy() method. +In this case, a separate call to destroy() is not needed.

+
+
Raises:
+

szexception.SzError –

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract export_csv_entity_report(csv_column_list: str, flags: int = <SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS: 3734497>, **kwargs: ~typing.Any) → int[source]
+

Warning: export_csv_entity_report is not recommended for large systems as it does not scale. +It is recommended larger systems implement real-time replication to a data warehouse.

+

The export_csv_entity_report method initializes a cursor over a document of exported entities. +It is part of the export_csv_entity_report, fetch_next, close_export +lifecycle of a list of entities to export.

+
+
Parameters:
+
    +

  • csv_column_list (str) – A comma-separated list of column names for the CSV export.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A handle that identifies the document to be scrolled through using fetch_next.

+
+
Return type:
+

int

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract export_json_entity_report(flags: int = <SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS: 3734497>, **kwargs: ~typing.Any) → int[source]
+

Warning: export_json_entity_report is not recommended for large systems as it does not scale. +It is recommended larger systems implement real-time replication to a data warehouse.

+

The export_json_entity_report method initializes a cursor over a document of exported entities. +It is part of the export_json_entity_report, fetch_next, close_export +lifecycle of a list of entities to export.

+
+
Parameters:
+

flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS.

+
+
Returns:
+

A handle that identifies the document to be scrolled through using fetch_next.

+
+
Return type:
+

int

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract fetch_next(export_handle: int, **kwargs: Any) → str[source]
+

The fetch_next method is used to scroll through an exported document one entity at a time. +Successive calls of fetch_next will export successive rows of entity data until there is no more. +It is part of the export_json_entity_report or export_json_entity_report, fetch_next, close_export +lifecycle of a list of exported entities.

+
+
Parameters:
+

response_handle (int) – A handle created by export_json_entity_report or export_json_entity_report.

+
+
Returns:
+

TODO:

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract find_interesting_entities_by_entity_id(entity_id: int, flags: int = 0, **kwargs: Any) → str[source]
+
+ +
+
+find_interesting_entities_by_entity_id_return_dict(entity_id: int, flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract find_interesting_entities_by_record_id(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → str[source]
+
+ +
+
+find_interesting_entities_by_record_id_return_dict(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+

T

+
+ +
+
+abstract find_network_by_entity_id(entity_list: str | ~typing.Dict[str, ~typing.List[~typing.Dict[str, int]]], max_degrees: int, build_out_degree: int, max_entities: int, flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → str[source]
+

The find_network_by_entity_id method finds all entities surrounding a requested set of entities. +This includes the requested entities, paths between them, and relations to other nearby entities. +Returns a JSON document that identifies the path between the each set of search entities (if the path exists), +and the information for the entities in the path.

+
+
Parameters:
+
    +

  • entity_list (str) – A JSON document listing entities.

    • +

  • max_degrees (int) – The maximum number of degrees in paths between search entities.

    • +

  • build_out_degree (int) – The number of degrees of relationships to show around each search entity.

    • +

  • max_entities (int) – The maximum number of entities to return in the discovered network.

    • +

  • flags (int, optional) – The maximum number of entities to return in the discovered network. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+find_network_by_entity_id_return_dict(entity_list: str | ~typing.Dict[~typing.Any, ~typing.Any], max_degrees: int, build_out_degree: int, max_entities: int, flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+

TODO: document

+
+ +
+
+abstract find_network_by_record_id(record_list: str | ~typing.Dict[str, ~typing.List[~typing.Dict[str, str]]], max_degrees: int, build_out_degree: int, max_entities: int, flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → str[source]
+

The find_network_by_record_id method finds all entities surrounding a requested set of entities by their RECORD_ID values. +This includes the requested entities, paths between them, and relations to other nearby entities. +Returns a JSON document that identifies the path between the each set of search entities (if the path exists), +and the information for the entities in the path.

+
+
Parameters:
+
    +

  • record_list (str) – A JSON document listing records.

    • +

  • max_degrees (int) – The maximum number of degrees in paths between search entities.

    • +

  • build_out_degree (int) – The number of degrees of relationships to show around each search entity.

    • +

  • max_entities (int) – The maximum number of entities to return in the discovered network.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+find_network_by_record_id_return_dict(record_list: str | ~typing.Dict[~typing.Any, ~typing.Any], max_degrees: int, build_out_degree: int, max_entities: int, flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+

TODO: document

+
+ +
+
+abstract find_path_by_entity_id(start_entity_id: int, end_entity_id: int, max_degrees: int, exclusions: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', required_data_sources: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → str[source]
+

The find_path_by_entity_id method finds the most efficient relationship between two entities path based on the parameters +and returns a JSON document with an ENTITY_PATHS section that details the path between the entities. +The ENTITIES sections details information on the entities. Paths are found using known relationships with other entities. +Paths are found using known relationships with other entities.

+
+
Parameters:
+
    +

  • start_entity_id (int) – The entity ID for the starting entity of the search path.

    • +

  • end_entity_id (int) – The entity ID for the ending entity of the search path.

    • +

  • max_degrees (int) – The maximum number of degrees in paths between search entities.

    • +

  • exclusions (str) – TODO

    • +

  • required_data_sources (str) – TODO

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document with an ENTITY_PATHS section that details the path between the entities.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+find_path_by_entity_id_return_dict(start_entity_id: int, end_entity_id: int, max_degrees: int, exclusions: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', required_data_sources: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+

TODO: document

+
+ +
+
+abstract find_path_by_record_id(start_data_source_code: str, start_record_id: str, end_data_source_code: str, end_record_id: str, max_degrees: int, exclusions: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', required_data_sources: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → str[source]
+

The find_path_by_record_id method finds the most efficient relationship between +two entities path based on the parameters by RECORD_ID values +and returns a JSON document with an ENTITY_PATHS section that details the path between the entities. +The ENTITIES sections details information on the entities. +Paths are found using known relationships with other entities. +The entities are identified by starting and ending records.

+
+
Parameters:
+
    +

  • start_data_source_code (str) – Identifies the provenance of the record for the starting entity of the search path.

    • +

  • start_record_id (str) – The unique identifier within the records of the same data source for the starting entity of the search path.

    • +

  • end_data_source_code (str) – Identifies the provenance of the record for the ending entity of the search path.

    • +

  • end_record_id (str) – The unique identifier within the records of the same data source for the ending entity of the search path.

    • +

  • max_degrees (int) – The maximum number of degrees in paths between search entities.

    • +

  • exclusions (str) – TODO

    • +

  • required_data_sources (str) – TODO

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+find_path_by_record_id_return_dict(start_data_source_code: str, start_record_id: str, end_data_source_code: str, end_record_id: str, max_degrees: int, exclusions: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', required_data_sources: str | ~typing.Dict[~typing.Any, ~typing.Any] = '', flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract get_active_config_id(**kwargs: Any) → int[source]
+

The get_active_config_id method returns the identifier of the currently active Senzing engine configuration.

+
+
Returns:
+

The identifier of the active Senzing Engine configuration.

+
+
Return type:
+

int

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract get_entity_by_entity_id(entity_id: int, flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → str[source]
+

The get_entity_by_entity_id method returns entity data based on the ID of a resolved identity.

+
+
Parameters:
+
    +

  • entity_id (int) – The unique identifier of an entity.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+get_entity_by_entity_id_return_dict(entity_id: int, flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract get_entity_by_record_id(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → str[source]
+

The get_entity_by_record_id method returns entity data based on the ID of a record which is a member of the entity.

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+get_entity_by_record_id_return_dict(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract get_record(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_JSON_DATA: 65536>, **kwargs: ~typing.Any) → str[source]
+

The get_record method returns a JSON document of a single record from the Senzing repository. +Can be called as many times as desired and from multiple threads at the same time.

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document of a single record.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+get_record_return_dict(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_JSON_DATA: 65536>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract get_redo_record(**kwargs: Any) → str[source]
+

The get_redo_record method returns the next internally queued redo record from the Senzing repository. +Usually, the process_redo_record or process_redo_record_with_info method is called to process the redo record +retrieved by get_redo_record.

+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract get_repository_last_modified_time(**kwargs: Any) → int[source]
+

The get_repository_last_modified_time method retrieves the last modified time of the Senzing repository, +measured in the number of seconds between the last modified time and January 1, 1970 12:00am GMT (epoch time).

+
+
Returns:
+

A Unix Timestamp.

+
+
Return type:
+

int

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract get_stats(**kwargs: Any) → str[source]
+

The get_stats method retrieves workload statistics for the current process. +These statistics will automatically reset after retrieval.

+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+get_stats_return_dict(**kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract get_virtual_entity_by_record_id(record_list: str | ~typing.Dict[~typing.Any, ~typing.Any], flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → str[source]
+

The get_virtual_entity_by_record_id method creates a view of a virtual entity +using a list of existing loaded records. +The virtual entity is composed of only those records and their features. +Entity resolution is not performed.

+
+
Parameters:
+
    +

  • record_list (str) – A JSON document of one or more records by DATA_SOURCE and RECORD_ID pairs, formatted as {“RECORDS”:[{“DATA_SOURCE”:”DS1”,”RECORD_ID”:”R1”},{“DATA_SOURCE”:”DS2”,”RECORD_ID”:”R2”}]}.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+get_virtual_entity_by_record_id_return_dict(record_list: str | ~typing.Dict[~typing.Any, ~typing.Any], flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract how_entity_by_entity_id(entity_id: int, flags: int = <SzEngineFlags.SZ_INCLUDE_FEATURE_SCORES: 67108864>, **kwargs: ~typing.Any) → str[source]
+

The how_entity_by_entity_id method determines and details steps-by-step how records resolved to an ENTITY_ID.

+

In most cases, how provides more detailed information than why as the resolution is detailed step-by-step.

+
+
Parameters:
+
    +

  • entity_id (int) – The unique identifier of an entity.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+how_entity_by_entity_id_return_dict(entity_id: int, flags: int = <SzEngineFlags.SZ_INCLUDE_FEATURE_SCORES: 67108864>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract initialize(instance_name: str, settings: str | Dict[Any, Any], config_id: int | None = None, verbose_logging: int = 0, **kwargs: Any) → None[source]
+

he initialize method initializes the Senzing SzEngine object. +It must be called prior to any other calls.

+

Note: If the SzEngine constructor is called with parameters, +the constructor will automatically call the initialize() method. +In this case, a separate call to initialize() is not needed.

+
+
Parameters:
+
    +

  • instance_name (str) – A short name given to this instance of the SzEngine object, to help identify it within system logs.

    • +

  • settings (str) – A JSON string containing configuration parameters.

    • +

  • config_id (int)

    • +

  • verbose_logging (int) – Optional: A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract prime_engine(**kwargs: Any) → None[source]
+

The prime_engine method initializes high resource consumption components of Senzing +used in some functions. If this call is not made, these resources are initialized the +first time they are needed and can cause unusually long processing times the first time +a function is called that requires these resources.

+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract process_redo_record(redo_record: str, flags: int, **kwargs: Any) → str[source]
+

#TODO The process_redo_record method…

+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+abstract reevaluate_entity(entity_id: int, flags: int = 0, **kwargs: Any) → str[source]
+

The reevaluate_entity method reevaluates the specified entity.

+
+
Parameters:
+
    +

  • entity_id (int) – The unique identifier of an entity.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to 0.

    • +
+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+reevaluate_entity_return_dict(entity_id: int, flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract reevaluate_record(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → str[source]
+

The reevaluate_record method reevaluates a specific record.

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to 0.

    • +
+
+
Returns:
+

If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+reevaluate_record_return_dict(data_source_code: str, record_id: str, flags: int = 0, **kwargs: Any) → Dict[str, Any][source]
+
+ +
+
+abstract reinitialize(config_id: int, **kwargs: Any) → None[source]
+

The reinitialize method reinitializes the Senzing SzEngine object using a specific configuration +identifier. A list of available configuration identifiers can be retrieved using +szconfigmanager.get_config_list.

+
+
Parameters:
+

config_id (int) – The configuration ID used for the initialization

+
+
Raises:
+
    +

  • TypeError – Incorrect datatype of input parameter.

    • +

  • szexception.SzError – config_id does not exist.

    • +
+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract search_by_attributes(attributes: str | ~typing.Dict[~typing.Any, ~typing.Any], search_profile: str = '', flags: int = <SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_ALL: 67123215>, **kwargs: ~typing.Any) → str[source]
+

The search_by_attributes method retrieves entity data based on a user-specified set of entity attributes.

+
+
Parameters:
+
    +

  • attributes (str) – A JSON document with the attribute data to search for.

    • +

  • search_profile (str) – The name of a configured search profile. Defaults to SEARCH.

    • +

  • flags (int, optional) – _description_. Defaults to SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+search_by_attributes_return_dict(attributes: str | ~typing.Dict[~typing.Any, ~typing.Any], search_profile: str = 'SEARCH', flags: int = <SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_ALL: 67123215>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract why_entities(entity_id_1: int, entity_id_2: int, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → str[source]
+

The why_entities method determines why entities did not resolve or why they do relate.

+
+
Parameters:
+
    +

  • entity_id_1 (int) – The entity ID for the starting entity of the search path.

    • +

  • entity_id_2 (int) – The entity ID for the ending entity of the search path.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+why_entities_return_dict(entity_id_1: int, entity_id_2: int, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract why_record_in_entity(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → str[source]
+

The why_record_in_entity … TODO:

+
+
Parameters:
+
    +

  • data_source_code (str) – Identifies the provenance of the data.

    • +

  • record_id (str) – The unique identifier within the records of the same data source.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+why_record_in_entity_return_dict(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+
+abstract why_records(data_source_code_1: str, record_id_1: str, data_source_code_2: str, record_id_2: str, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → str[source]
+

The why_records determines if any two records can or cannot resolve together, or if they relate.

+
+
Parameters:
+
    +

  • data_source_code_1 (str) – Identifies the provenance of the data.

    • +

  • record_id_1 (str) – The unique identifier within the records of the same data source.

    • +

  • data_source_code_2 (str) – Identifies the provenance of the data.

    • +

  • record_id_2 (str) – The unique identifier within the records of the same data source.

    • +

  • flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.

    • +
+
+
Returns:
+

A JSON document.

+
+
Return type:
+

str

+
+
+

Raises:

+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
1
+
+
+
+ +
+
+why_records_return_dict(data_source_code_1: str, record_id_1: str, data_source_code_2: str, record_id_2: str, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>, **kwargs: ~typing.Any) → Dict[str, Any][source]
+
+ +
+ +
+
+class senzing_abstract.SzEngineFlags(value)[source]
+

Bases: IntFlag

+

Engine Flags …

+
+
+SZ_ENTITY_BRIEF_DEFAULT_FLAGS = 1082304
+
+ +
+
+SZ_ENTITY_DEFAULT_FLAGS = 3734464
+
+ +
+
+SZ_ENTITY_INCLUDE_ALL_FEATURES = 1024
+
+ +
+
+SZ_ENTITY_INCLUDE_ALL_RELATIONS = 960
+
+ +
+
+SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS = 512
+
+ +
+
+SZ_ENTITY_INCLUDE_ENTITY_NAME = 4096
+
+ +
+
+SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS = 256
+
+ +
+ +
+ +
+
+SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS = 64
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_DATA = 16384
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS = 262144
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_JSON_DATA = 65536
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO = 32768
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_SUMMARY = 8192
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_TYPES = 268435456
+
+ +
+
+SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA = 2147483648
+
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+
+SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES = 2048
+
+ +
+
+SZ_ENTITY_OPTION_INCLUDE_FEATURE_ELEMENTS = 4294967296
+
+ +
+
+SZ_ENTITY_OPTION_INCLUDE_FEATURE_STATS = 16777216
+
+ +
+
+SZ_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES = 8388608
+
+ +
+
+SZ_ENTITY_OPTION_INCLUDE_MATCH_KEY_DETAILS = 17179869184
+
+ +
+
+SZ_EXPORT_DEFAULT_FLAGS = 3734497
+
+ +
+
+SZ_EXPORT_INCLUDE_ALL_ENTITIES = 33
+
+ +
+
+SZ_EXPORT_INCLUDE_ALL_HAVING_RELATIONSHIPS = 30
+
+ +
+
+SZ_EXPORT_INCLUDE_DISCLOSED = 16
+
+ +
+
+SZ_EXPORT_INCLUDE_MULTI_RECORD_ENTITIES = 1
+
+ +
+
+SZ_EXPORT_INCLUDE_NAME_ONLY = 8
+
+ +
+ +
+ +
+
+SZ_EXPORT_INCLUDE_POSSIBLY_SAME = 2
+
+ +
+
+SZ_EXPORT_INCLUDE_SINGLE_RECORD_ENTITIES = 32
+
+ +
+
+SZ_FIND_NETWORK_DEFAULT_FLAGS = 8589946880
+
+ +
+
+SZ_FIND_NETWORK_MATCHING_INFO = 8589934592
+
+ +
+
+SZ_FIND_PATH_DEFAULT_FLAGS = 1073754112
+
+ +
+
+SZ_FIND_PATH_MATCHING_INFO = 1073741824
+
+ +
+
+SZ_FIND_PATH_PREFER_EXCLUDE = 33554432
+
+ +
+
+SZ_HOW_ENTITY_DEFAULT_FLAGS = 67108864
+
+ +
+
+SZ_INCLUDE_FEATURE_SCORES = 67108864
+
+ +
+
+SZ_INITIALIZE_WITH_DEFAULT_CONFIGURATION = 0
+
+ +
+
+SZ_NO_FLAGS = 0
+
+ +
+
+SZ_NO_LOGGING = 0
+
+ +
+
+SZ_RECORD_DEFAULT_FLAGS = 65536
+
+ +
+
+SZ_SEARCH_BY_ATTRIBUTES_ALL = 67123215
+
+ +
+
+SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS = 67123215
+
+ +
+
+SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_ALL = 15
+
+ +
+
+SZ_SEARCH_BY_ATTRIBUTES_MINIMAL_STRONG = 3
+
+ +
+
+SZ_SEARCH_BY_ATTRIBUTES_STRONG = 67123203
+
+ +
+
+SZ_SEARCH_INCLUDE_ALL_ENTITIES = 15
+
+ +
+
+SZ_SEARCH_INCLUDE_FEATURE_SCORES = 67108864
+
+ +
+
+SZ_SEARCH_INCLUDE_MATCH_KEY_DETAILS = 17179869184
+
+ +
+
+SZ_SEARCH_INCLUDE_NAME_ONLY = 8
+
+ +
+ +
+ +
+
+SZ_SEARCH_INCLUDE_POSSIBLY_SAME = 2
+
+ +
+
+SZ_SEARCH_INCLUDE_RESOLVED = 1
+
+ +
+
+SZ_SEARCH_INCLUDE_STATS = 134217728
+
+ +
+
+SZ_VERBOSE_LOGGING = 1
+
+ +
+
+SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS = 3734464
+
+ +
+
+SZ_WHY_ENTITIES_DEFAULT_FLAGS = 96009152
+
+ +
+
+SZ_WHY_RECORDS_DEFAULT_FLAGS = 96009152
+
+ +
+
+SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS = 96009152
+
+ +
+
+SZ_WITHOUT_INFO = 0
+
+ +
+
+SZ_WITH_INFO = 4611686018427387904
+
+ +
+
+classmethod combine_flags(list_of_strings: List[str], *args: Any, **kwargs: Any) → int[source]
+

OR together all strings in list_of_strings

+
+ +
+ +
+
+exception senzing_abstract.SzError[source]
+

Bases: Exception

+

Base exception for Sz related python code.

+
+ +
+
+class senzing_abstract.SzHasherAbstract[source]
+

Bases: ABC

+

SzHasher module access library

+
+
+ID_MESSAGES = {0: ''}
+
+ +
+
+PREFIX = 'szhasher.'
+
+ +
+
+abstract destroy(*args: Any, **kwargs: Any) → None[source]
+

TODO: document

+
+ +
+
+abstract export_token_library(*args: Any, **kwargs: Any) → str[source]
+

TODO: document

+
+ +
+
+abstract init(module_name: str, ini_params: str, verbose_logging: int = 0, **kwargs: Any) → None[source]
+

TODO: document

+
+ +
+
+abstract init_with_config_id(module_name: str, ini_params: str, init_config_id: int, verbose_logging: int = 0, **kwargs: Any) → None[source]
+

TODO: document

+
+ +
+
+abstract process(record: str, *args: Any, **kwargs: Any) → str[source]
+

TODO: document

+
+ +
+
+abstract reinit(init_config_id: int, *args: Any, **kwargs: Any) → None[source]
+

TODO: document

+
+ +
+ +
+
+exception senzing_abstract.SzLicenseError[source]
+

Bases: SzUnrecoverableError

+

Licence exception

+
+ +
+
+exception senzing_abstract.SzNotFoundError[source]
+

Bases: SzBadInputError

+

Not found

+
+ +
+
+exception senzing_abstract.SzNotInitializedError[source]
+

Bases: SzUnrecoverableError

+

Not initialized

+
+ +
+
+class senzing_abstract.SzProductAbstract[source]
+

Bases: ABC

+

SzProductAbstract is the definition of the Senzing Python API that is +implemented by packages such as szproduct.py.

+
+
+ID_MESSAGES = {4001: 'szproduct.destroy() failed. Return code: {0}', 4002: 'szproduct.initialize({0}, {1}, {2}) failed. Return code: {3}', 4003: 'szproduct.SzProduct({0}, {1}) failed. instance_name and settings must both be set or both be empty'}
+
+ +
+
+PREFIX = 'szproduct.'
+
+ +
+
+abstract destroy(**kwargs: Any) → None[source]
+

The destroy method will destroy and perform cleanup for the Senzing SzProduct object. +It should be called after all other calls are complete.

+

Note: If the SzProduct constructor was called with parameters, +the destructor will automatically call the destroy() method. +In this case, a separate call to destroy() is not needed.

+
+
Raises:
+

szexception.SzError –

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+abstract get_license(**kwargs: Any) → str[source]
+

The get_license method retrieves information about the currently used license by the Senzing API.

+
+
Returns:
+

A JSON document containing Senzing license metadata.

+
+
Return type:
+

str

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted for easier reading.
+ 2
+ 3{
+ 4    "customer": "Senzing Public Test License",
+ 5    "contract": "EVALUATION - support@senzing.com",
+ 6    "issueDate": "2022-11-29",
+ 7    "licenseType": "EVAL (Solely for non-productive use)",
+ 8    "licenseLevel": "STANDARD",
+ 9    "billing": "MONTHLY",
+10    "expireDate": "2023-11-29",
+11    "recordLimit": 50000
+12}
+
+
+
+ +
+
+abstract get_version(**kwargs: Any) → str[source]
+

The get_version method returns the version of the Senzing API.

+
+
Returns:
+

A JSON document containing metadata about the Senzing Engine version being used.

+
+
Return type:
+

str

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+

Output:

+
 1// Output has been formatted for easier reading.
+ 2
+ 3{
+ 4    "PRODUCT_NAME": "Senzing API",
+ 5    "VERSION": "3.8.0",
+ 6    "BUILD_VERSION": "3.8.0.23303",
+ 7    "BUILD_DATE": "2023-10-30",
+ 8    "BUILD_NUMBER": "2023_10_30__10_45",
+ 9    "COMPATIBILITY_VERSION": {
+10        "CONFIG_VERSION": "10"
+11    },
+12    "SCHEMA_VERSION": {
+13        "ENGINE_SCHEMA_VERSION": "3.8",
+14        "MINIMUM_REQUIRED_SCHEMA_VERSION": "3.0",
+15        "MAXIMUM_REQUIRED_SCHEMA_VERSION": "3.99"
+16    }
+17}
+
+
+
+ +
+
+abstract initialize(instance_name: str, settings: str | Dict[Any, Any], verbose_logging: int = 0, **kwargs: Any) → None[source]
+

The initialize method initializes the Senzing SzProduct object. +It must be called prior to any other calls.

+

Note: If the SzProduct constructor is called with parameters, +the constructor will automatically call the initialize() method. +In this case, a separate call to initialize() is not needed.

+
+
Parameters:
+
    +

  • instance_name (str) – A short name given to this instance of the SzProduct object, to help identify it within system logs.

    • +

  • settings (str) – A JSON string containing configuration parameters.

    • +

  • verbose_logging (int) – Optional: A flag to enable deeper logging of the Senzing processing. 0 for no Senzing logging; 1 for logging. Default: 0

    • +
+
+
Raises:
+

TypeError – Incorrect datatype of input parameter.

+
+
+
+Example:
1#! /usr/bin/env python3
+
+
+
+ +
+
+license_as_dict(**kwargs: Any) → Dict[str, Any][source]
+

A convenience method for +senzing_abstract.SzProductAbstract.get_license()

+
+
Returns:
+

A dictionary containing Senzing license metadata.

+
+
Return type:
+

Dict[str, Any]

+
+
+
+ +
+
+version_as_dict(**kwargs: Any) → Dict[str, Any][source]
+

A convenience method for +senzing_abstract.SzProductAbstract.get_version()

+
+
Returns:
+

A dictionary containing metadata about the Senzing Engine version being used.

+
+
Return type:
+

Dict[str, Any]

+
+
+
+ +
+ +
+
+exception senzing_abstract.SzRetryTimeoutExceededError[source]
+

Bases: SzRetryableError

+

Retry timeout exceeded time limit

+
+ +
+
+exception senzing_abstract.SzRetryableError[source]
+

Bases: SzError

+

The program can provide a remedy and continue.

+
+ +
+
+exception senzing_abstract.SzUnhandledError[source]
+

Bases: SzUnrecoverableError

+

Could not handle exception

+
+ +
+
+exception senzing_abstract.SzUnknownDataSourceError[source]
+

Bases: SzBadInputError

+

Unknown DataSource

+
+ +
+
+exception senzing_abstract.SzUnrecoverableError[source]
+

Bases: SzError

+

System failure, can’t continue.

+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file