tabpy.tabpy_tools.custom_query_object

Complexity

Total Complexity

9

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Test Coverage

Coverage

60.61%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	CustomQueryObject.__init__()	0	18	1
A	CustomQueryObject.query()	0	43	3
A	CustomQueryObject.get_doc_string()	0	10	3
A	CustomQueryObject.get_methods()	0	2	1
A	CustomQueryObject.get_query_method()	0	2	1

import inspect
import logging
import platform
import sys
from .query_object import QueryObject as _QueryObject


logger = logging.getLogger(__name__)


class CustomQueryObject(_QueryObject):
    def __init__(self, query, description=""):
        """Create a new CustomQueryObject.

        Parameters
        -----------

        query : function
            Function that defines a custom query method. The query can have any
            signature, but input and output of the query needs to be JSON
            serializable.

        description : str
            The description of the custom query object

        """
        super().__init__(description)

        self.custom_query = query

    def query(self, *args, **kwargs):
        """Query the custom defined query method using the given input.

        Parameters
        ----------
        args : list
            positional arguments to the query

        kwargs : dict
            keyword arguments to the query

        Returns
        -------
        out: object.
            The results depends on the implementation of the query method.
            Typically the return value will be whatever that function returns.

        See Also
        --------
        QueryObject
        """
        # include the dependent files in sys path so that the query can run
        # correctly

        try:
            logger.debug(
                "Running custom query with arguments " f"({args}, {kwargs})..."
            )
            ret = self.custom_query(*args, **kwargs)
        except Exception as e:
            logger.exception(
                "Exception hit when running custom query, error: " f"{str(e)}"
            )
            raise

        logger.debug(f"Received response {ret}")
        try:
            return self._make_serializable(ret)
        except Exception as e:
            logger.exception(
                "Cannot properly serialize custom query result, " f"error: {str(e)}"
            )
            raise

    def get_doc_string(self):
        """Get doc string from customized query"""
        default_docstring = "-- no docstring found in query function --"

        # TODO: fix docstring parsing on Windows systems
        if sys.platform == 'win32':
            return default_docstring

        ds = getattr(self.custom_query, '__doc__', None)
        return ds if ds and isinstance(ds, str) else default_docstring

    def get_methods(self):
        return [self.get_query_method()]

    def get_query_method(self):
        return {"method": "query"}