remove all previous formatters

buster/formatter/__init__.py

@@ -1,17 +0,0 @@
-# from .base import Response, ResponseFormatter, Source
-# from .factory import response_formatter_factory
-# from .gradio import GradioResponseFormatter
-# from .html import HTMLResponseFormatter
-# from .markdown import MarkdownResponseFormatter
-# from .slack import SlackResponseFormatter
-
-__all__ = [
-    # Source,
-    # Response,
-    # ResponseFormatter,
-    # HTMLResponseFormatter,
-    # MarkdownResponseFormatter,
-    # SlackResponseFormatter,
-    # GradioResponseFormatter,
-    # response_formatter_factory,
-]

buster/formatter/base.py

@@ -1,56 +0,0 @@
-# from dataclasses import dataclass
-# from typing import Iterable, NamedTuple
-
-# import pandas as pd
-
-# from buster.completers.base import Completion
-
-
-
-# @dataclass
-# class ResponseFormatter:
-#     response_footnote: str
-#     source_template: str = "{source.title} (relevance: {source.question_similarity:2.1f})"
-#     error_msg_template: str = """Something went wrong:\n{response.error_msg}"""
-#     error_fallback_template: str = "Something went very wrong."
-#     sourced_answer_template: str = (
-#         """{response.text}\n\n"""
-#         """📝 Here are the sources I used to answer your question:\n"""
-#         """{sources}\n\n"""
-#         """{footnote}"""
-#     )
-#     unsourced_answer_template: str = "{response.text}\n\n{footnote}"
-
-#     def source_item(self, source: Source) -> str:
-#         """Format a single source item."""
-#         return self.source_template.format(source=source)
-
-#     def sources_list(self, sources: Iterable[Source]) -> str | None:
-#         """Format sources into a list."""
-#         items = [self.source_item(source) for source in sources]
-#         if not items:
-#             return None  # No list needed.
-
-#         return "\n".join(f"{ind}. {item}" for ind, item in enumerate(items, 1))
-
-#     def error(self, response: Response) -> str:
-#         """Format an error message."""
-#         if response.error_msg:
-#             return self.error_msg_template.format(response=response)
-#         return self.error_fallback_template.format(response=response)
-
-#     def answer(self, response: Response, sources: Iterable[Source]) -> str:
-#         """Format an answer and its sources."""
-#         sources_list = self.sources_list(sources)
-#         if sources_list:
-#             return self.sourced_answer_template.format(
-#                 response=response, sources=sources_list, footnote=self.response_footnote
-#             )
-
-#         return self.unsourced_answer_template.format(response=response, footnote=self.response_footnote)
-
-#     def __call__(self, response: Response, sources: Iterable[Source]) -> str:
-#         """Format an answer and its sources, or an error message."""
-#         if response.error:
-#             return self.error(response)
-#         return self.answer(response, sources)

buster/formatter/factory.py

@@ -1,23 +0,0 @@
-import logging
-
-import buster.formatter as F
-
-logger = logging.getLogger(__name__)
-logging.basicConfig(level=logging.INFO)
-
-
-def response_formatter_factory(format: str, **kwargs):
-    pass
-    # logger.info(f"Using formatter: {format}")
-    # if format == "text":
-    #     return F.ResponseFormatter(**kwargs)
-    # elif format == "slack":
-    #     return F.SlackResponseFormatter(**kwargs)
-    # elif format == "HTML":
-    #     return F.HTMLResponseFormatter(**kwargs)
-    # elif format == "gradio":
-    #     return F.GradioResponseFormatter(**kwargs)
-    # elif format == "markdown":
-    #     return F.MarkdownResponseFormatter(**kwargs)
-    # else:
-    #     raise ValueError(f"Undefined {format=}")

buster/formatter/gradio.py

@@ -1,28 +0,0 @@
-from dataclasses import dataclass
-from typing import Iterable
-
-from buster.formatter import ResponseFormatter, Source
-
-
-@dataclass
-class GradioResponseFormatter(ResponseFormatter):
-    """Format the answer for gradio chat interface."""
-
-    error_msg_template: str = """Something went wrong:<br>{response.error_msg}"""
-    error_fallback_template: str = "Something went very wrong."
-    sourced_answer_template: str = (
-        """{response.text}<br><br>"""
-        """📝 Here are the sources I used to answer your question:<br>"""
-        """{sources}<br><br>"""
-        """{footnote}"""
-    )
-    unsourced_answer_template: str = "{response.text}<br><br>{footnote}"
-    source_template: str = """[🔗 {source.title}]({source.url}), relevance: {source.question_similarity:2.1f} %"""
-
-    def sources_list(self, sources: Iterable[Source]) -> str | None:
-        """Format sources into a list."""
-        items = [self.source_item(source) for source in sources]
-        if not items:
-            return None  # No list needed.
-
-        return "<br>".join(items)

buster/formatter/html.py

@@ -1,41 +0,0 @@
-import html
-from dataclasses import dataclass
-from typing import Iterable
-
-from buster.formatter.base import Response, ResponseFormatter, Source
-
-
-@dataclass
-class HTMLResponseFormatter(ResponseFormatter):
-    """Format the answer in HTML."""
-
-    source_template: str = """<li><a href='{source.url}'>🔗 {source.source}</a></li>"""
-    error_msg_template: str = """<div class="error">Something went wrong:\n<p>{response.error_msg}</p></div>"""
-    error_fallback_template: str = """<div class="error">Something went very wrong.</div>"""
-    sourced_answer_template: str = (
-        """<div class="answer"><p>{response.text}</p></div>\n"""
-        """<div class="sources>📝 Here are the sources I used to answer your question:\n"""
-        """<ol>\n{sources}</ol></div>\n"""
-        """<div class="footer">I'm a chatbot, bleep bloop.</div>"""
-    )
-    unsourced_answer_template: str = (
-        """<div class="answer">{response.text}</div>\n<div class="footer">I'm a chatbot, bleep bloop.</div>"""
-    )
-
-    def sources_list(self, sources: Iterable[Source]) -> str | None:
-        """Format sources into a list."""
-        items = [self.source_item(source) for source in sources]
-        if not items:
-            return None  # No list needed.
-
-        return "\n".join(items)
-
-    def __call__(self, response: Response, sources: Iterable[Source]) -> str:
-        # Escape any html in the text.
-        response = Response(
-            html.escape(response.text) if response.text else response.text,
-            response.error,
-            html.escape(response.error_msg) if response.error_msg else response.error_msg,
-        )
-        sources = (Source(html.escape(source.title), source.url, source.question_similarity) for source in sources)
-        return super().__call__(response, sources)

buster/formatter/markdown.py

@@ -1,19 +0,0 @@
-from dataclasses import dataclass
-from typing import Iterable
-
-from buster.formatter.base import ResponseFormatter, Source
-
-
-@dataclass
-class MarkdownResponseFormatter(ResponseFormatter):
-    """Format the answer in markdown."""
-
-    source_template: str = """[🔗 {source.title}]({source.url}), relevance: {source.question_similarity:2.3f}"""
-
-    def sources_list(self, sources: Iterable[Source]) -> str | None:
-        """Format sources into a list."""
-        items = [self.source_item(source) for source in sources]
-        if not items:
-            return None  # No list needed.
-
-        return "\n".join(f"{ind}. {item}" for ind, item in enumerate(items, 1))

buster/formatter/slack.py

@@ -1,19 +0,0 @@
-from dataclasses import dataclass
-from typing import Iterable
-
-from buster.formatter import ResponseFormatter, Source
-
-
-@dataclass
-class SlackResponseFormatter(ResponseFormatter):
-    """Format the answer for Slack."""
-
-    source_template: str = """<{source.url}|🔗 {source.title}>, relevance: {source.question_similarity:2.3f}"""
-
-    def sources_list(self, sources: Iterable[Source]) -> str | None:
-        """Format sources into a list."""
-        items = [self.source_item(source) for source in sources]
-        if not items:
-            return None  # No list needed.
-
-        return "\n".join(items)