Revamp project folder structure to introduce modules (#41)

* Change project structure to different modules

Author: VarinThakur01

langchain_hana/__init__.py

@@ -1,9 +1,10 @@
 from importlib import metadata
 
-from langchain_hana.chains.graph_qa import HanaSparqlQAChain
+from langchain_hana.chains import HanaSparqlQAChain
 from langchain_hana.embeddings import HanaInternalEmbeddings
 from langchain_hana.graphs import HanaRdfGraph
 from langchain_hana.vectorstores import HanaDB
+from langchain_hana.structured_query import HanaTranslator
 
 try:
     __version__ = metadata.version(__package__)
@@ -14,6 +15,7 @@
 
 __all__ = [
     "HanaDB",
+    "HanaTranslator"
     "HanaInternalEmbeddings",
     "HanaRdfGraph",
     "HanaSparqlQAChain",

langchain_hana/chains/__init__.py

@@ -1,3 +1,3 @@
-from .graph_qa.sparql_qa_chain import HanaSparqlQAChain
+from .graph_qa import HanaSparqlQAChain
 
 __all__ = ["HanaSparqlQAChain"]

langchain_hana/chains/graph_qa/__init__.py

@@ -1,3 +1,3 @@
-from .sparql_qa_chain import HanaSparqlQAChain
+from .hana_sparql_qa_chain import HanaSparqlQAChain
 
 __all__ = ["HanaSparqlQAChain"]

langchain_hana/chains/graph_qa/sparql_qa_chain.py renamed to langchain_hana/chains/graph_qa/hana_sparql_qa_chain.py

@@ -0,0 +1,3 @@
+from .hana_internal_embeddings import HanaInternalEmbeddings
+
+__all__ = ["HanaInternalEmbeddings"]

langchain_hana/embeddings/__init__.py

@@ -0,0 +1,3 @@
+from .hana_translator import HanaTranslator
+
+__all__ = ["HanaTranslator"]

langchain_hana/embeddings.py renamed to langchain_hana/embeddings/hana_internal_embeddings.py

@@ -0,0 +1,56 @@
+from typing import Dict, Tuple, Union
+
+from langchain_core.structured_query import (
+    Comparator,
+    Comparison,
+    Operation,
+    Operator,
+    StructuredQuery,
+    Visitor,
+)
+
+
+class HanaTranslator(Visitor):
+    """
+    Translate internal query language elements to valid filters params for
+    HANA vectorstore.
+    """
+
+    allowed_operators = [Operator.AND, Operator.OR]
+    """Subset of allowed logical operators."""
+    allowed_comparators = [
+        Comparator.EQ,
+        Comparator.NE,
+        Comparator.GT,
+        Comparator.LT,
+        Comparator.GTE,
+        Comparator.LTE,
+        Comparator.IN,
+        Comparator.NIN,
+        Comparator.CONTAIN,
+        Comparator.LIKE,
+    ]
+
+    def _format_func(self, func: Union[Operator, Comparator]) -> str:
+        self._validate_func(func)
+        return f"${'contains' if func == Comparator.CONTAIN else func.value}"
+
+    def visit_operation(self, operation: Operation) -> Dict:
+        args = [arg.accept(self) for arg in operation.arguments]
+        return {self._format_func(operation.operator): args}
+
+    def visit_comparison(self, comparison: Comparison) -> Dict:
+        return {
+            comparison.attribute: {
+                self._format_func(comparison.comparator): comparison.value
+            }
+        }
+
+    def visit_structured_query(
+        self, structured_query: StructuredQuery
+    ) -> Tuple[str, dict]:
+        if structured_query.filter is None:
+            kwargs = {}
+        else:
+            kwargs = {"filter": structured_query.filter.accept(self)}
+        return structured_query.query, kwargs

langchain_hana/structured_query/__init__.py

@@ -0,0 +1,3 @@
+from .hana_db import HanaDB
+
+__all__ = ["HanaDB"]

langchain_hana/structured_query/hana_translator.py

@@ -1,15 +1,5 @@
-# HANA Translator/query constructor
 import logging
-from typing import Any, Dict, List, Tuple, Union
-
-from langchain_core.structured_query import (
-    Comparator,
-    Comparison,
-    Operation,
-    Operator,
-    StructuredQuery,
-    Visitor,
-)
+from typing import List, Tuple, Any
 
 logger = logging.getLogger(__name__)
 
@@ -49,53 +39,6 @@ def __repr__(self) -> None:  # type: ignore[override]
 
 LOGICAL_OPERATORS_TO_SQL = {"$and": "AND", "$or": "OR"}
 
-
-class HanaTranslator(Visitor):
-    """
-    Translate internal query language elements to valid filters params for
-    HANA vectorstore.
-    """
-
-    allowed_operators = [Operator.AND, Operator.OR]
-    """Subset of allowed logical operators."""
-    allowed_comparators = [
-        Comparator.EQ,
-        Comparator.NE,
-        Comparator.GT,
-        Comparator.LT,
-        Comparator.GTE,
-        Comparator.LTE,
-        Comparator.IN,
-        Comparator.NIN,
-        Comparator.CONTAIN,
-        Comparator.LIKE,
-    ]
-
-    def _format_func(self, func: Union[Operator, Comparator]) -> str:
-        self._validate_func(func)
-        return f"${'contains' if func == Comparator.CONTAIN else func.value}"
-
-    def visit_operation(self, operation: Operation) -> Dict:
-        args = [arg.accept(self) for arg in operation.arguments]
-        return {self._format_func(operation.operator): args}
-
-    def visit_comparison(self, comparison: Comparison) -> Dict:
-        return {
-            comparison.attribute: {
-                self._format_func(comparison.comparator): comparison.value
-            }
-        }
-
-    def visit_structured_query(
-        self, structured_query: StructuredQuery
-    ) -> Tuple[str, dict]:
-        if structured_query.filter is None:
-            kwargs = {}
-        else:
-            kwargs = {"filter": structured_query.filter.accept(self)}
-        return structured_query.query, kwargs
-
-
 class CreateWhereClause:
     def __init__(self, hanaDb: Any) -> None:
         self.specific_metadata_columns = hanaDb.specific_metadata_columns