chatlas 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

chatlas/_content_pdf.py

@@ -0,0 +1,94 @@
+import os
+import tempfile
+from typing import Union
+
+import requests
+
+from ._content import ContentPDF
+
+__all__ = (
+    "content_pdf_url",
+    "content_pdf_file",
+)
+
+
+def content_pdf_file(path: Union[str, os.PathLike]) -> ContentPDF:
+    """
+    Prepare a local PDF for input to a chat.
+
+    Not all providers support PDF input, so check the documentation for the
+    provider you are using.
+
+    Parameters
+    ----------
+    path
+        A path to a local PDF file.
+
+    Returns
+    -------
+    [](`~chatlas.types.Content`)
+        Content suitable for a [](`~chatlas.Turn`) object.
+    """
+
+    if not os.path.isfile(path):
+        raise FileNotFoundError(f"PDF file not found: {path}")
+
+    with open(path, "rb") as f:
+        data = f.read()
+
+    return ContentPDF(data=data)
+
+
+def content_pdf_url(url: str) -> ContentPDF:
+    """
+    Use a remote PDF for input to a chat.
+
+    Not all providers support PDF input, so check the documentation for the
+    provider you are using.
+
+    Parameters
+    ----------
+    url
+        A URL to a remote PDF file.
+
+    Returns
+    -------
+    [](`~chatlas.types.Content`)
+        Content suitable for a [](`~chatlas.Turn`) object.
+    """
+
+    if url.startswith("data:"):
+        content_type, base64_data = parse_data_url(url)
+        if content_type != "application/pdf":
+            raise ValueError(f"Unsupported PDF content type: {content_type}")
+        return ContentPDF(data=base64_data.encode("utf-8"))
+    # TODO: need separate ContentPDFRemote type so we can use file upload
+    # apis where they exist. Might need some kind of mutable state so can
+    # record point to uploaded file.
+    data = download_pdf_bytes(url)
+    return ContentPDF(data=data)
+
+
+def parse_data_url(url: str) -> tuple[str, str]:
+    parts = url[5:].split(";", 1)
+    if len(parts) != 2 or not parts[1].startswith("base64,"):
+        raise ValueError("url is not a valid data URL.")
+    return (parts[0], parts[1][7:])
+
+
+def download_pdf_bytes(url):
+    with tempfile.NamedTemporaryFile(suffix=".pdf", delete=True) as temp_file:
+        try:
+            response = requests.get(url, stream=True)
+            response.raise_for_status()
+
+            for chunk in response.iter_content(chunk_size=8192):
+                temp_file.write(chunk)
+
+            temp_file.flush()
+            temp_file.seek(0)
+
+            return temp_file.read()
+
+        except Exception as e:
+            raise e

chatlas/_display.py

@@ -6,6 +6,7 @@ from uuid import uuid4
 from rich.live import Live
 from rich.logging import RichHandler
 
+from ._live_render import LiveRender
 from ._logging import logger
 from ._typing_extensions import TypedDict
 
@@ -44,13 +45,22 @@ class LiveMarkdownDisplay(MarkdownDisplay):
         from rich.console import Console
 
         self.content: str = ""
-        self.live = Live(
+        live = Live(
             auto_refresh=False,
-            vertical_overflow="visible",
             console=Console(
                 **echo_options["rich_console"],
             ),
         )
+
+        # Monkeypatch LiveRender() with our own version that add "crop_above"
+        # https://github.com/Textualize/rich/blob/43d3b047/rich/live.py#L87-L89
+        live.vertical_overflow = "crop_above"
+        live._live_render = LiveRender(  # pyright: ignore[reportAttributeAccessIssue]
+            live.get_renderable(), vertical_overflow="crop_above"
+        )
+
+        self.live = live
+
         self._markdown_options = echo_options["rich_markdown"]
 
     def update(self, content: str):

chatlas/_github.py

@@ -43,7 +43,7 @@ def ChatGithub(
     ::: {.callout-note}
     ## Python requirements
 
-    `ChatGithub` requires the `openai` package (e.g., `pip install openai`).
+    `ChatGithub` requires the `openai` package: `pip install "chatlas[github]"`.
     :::
 
 

chatlas/_google.py

@@ -12,6 +12,7 @@ from ._content import (
     ContentImageInline,
     ContentImageRemote,
     ContentJson,
+    ContentPDF,
     ContentText,
     ContentToolRequest,
     ContentToolResult,
@@ -61,8 +62,7 @@ def ChatGoogle(
     ::: {.callout-note}
     ## Python requirements
 
-    `ChatGoogle` requires the `google-genai` package
-    (e.g., `pip install google-genai`).
+    `ChatGoogle` requires the `google-genai` package: `pip install "chatlas[google]"`.
     :::
 
     Examples
@@ -400,10 +400,19 @@ class GoogleProvider(
             return Part.from_text(text=content.text)
         elif isinstance(content, ContentJson):
             return Part.from_text(text="<structured data/>")
+        elif isinstance(content, ContentPDF):
+            from google.genai.types import Blob
+
+            return Part(
+                inline_data=Blob(
+                    data=content.data,
+                    mime_type="application/pdf",
+                )
+            )
         elif isinstance(content, ContentImageInline) and content.data:
             return Part.from_bytes(
                 data=base64.b64decode(content.data),
-                mime_type=content.content_type,
+                mime_type=content.image_content_type,
             )
         elif isinstance(content, ContentImageRemote):
             raise NotImplementedError(
@@ -413,7 +422,7 @@ class GoogleProvider(
         elif isinstance(content, ContentToolRequest):
             return Part(
                 function_call=FunctionCall(
-                    id=content.id,
+                    id=content.id if content.name != content.id else None,
                     name=content.name,
                     # Goes in a dict, so should come out as a dict
                     args=cast(dict[str, Any], content.arguments),
@@ -428,7 +437,7 @@ class GoogleProvider(
                 # TODO: seems function response parts might need role='tool'???
                 # https://github.com/googleapis/python-genai/blame/c8cfef85c/README.md#L344
                 function_response=FunctionResponse(
-                    id=content.id,
+                    id=content.id if content.name != content.id else None,
                     name=content.name,
                     response=resp,
                 )
@@ -461,9 +470,9 @@ class GoogleProvider(
             text = part.get("text")
             if text:
                 if has_data_model:
-                    contents.append(ContentJson(json.loads(text)))
+                    contents.append(ContentJson(value=json.loads(text)))
                 else:
-                    contents.append(ContentText(text))
+                    contents.append(ContentText(text=text))
             function_call = part.get("function_call")
             if function_call:
                 # Seems name is required but id is optional?
@@ -530,8 +539,7 @@ def ChatVertex(
     ::: {.callout-note}
     ## Python requirements
 
-    `ChatGoogle` requires the `google-genai` package
-    (e.g., `pip install google-genai`).
+    `ChatGoogle` requires the `google-genai` package: `pip install "chatlas[vertex]"`.
     :::
 
     ::: {.callout-note}

chatlas/_groq.py

@@ -41,7 +41,7 @@ def ChatGroq(
     ::: {.callout-note}
     ## Python requirements
 
-    `ChatGroq` requires the `openai` package (e.g., `pip install openai`).
+    `ChatGroq` requires the `openai` package: `pip install "chatlas[groq]"`.
     :::
 
     Examples

chatlas/_live_render.py

@@ -0,0 +1,116 @@
+# A 'patched' version of LiveRender that adds the 'crop_above' vertical overflow method.
+# Derives from https://github.com/Textualize/rich/pull/3637
+import sys
+from typing import Optional, Tuple
+
+if sys.version_info >= (3, 8):
+    from typing import Literal
+else:
+    from typing_extensions import Literal  # pragma: no cover
+
+from rich._loop import loop_last
+from rich.console import Console, ConsoleOptions, RenderableType, RenderResult
+from rich.control import Control
+from rich.segment import ControlType, Segment
+from rich.style import StyleType
+from rich.text import Text
+
+VerticalOverflowMethod = Literal["crop", "crop_above", "ellipsis", "visible"]
+
+
+class LiveRender:
+    """Creates a renderable that may be updated.
+
+    Args:
+        renderable (RenderableType): Any renderable object.
+        style (StyleType, optional): An optional style to apply to the renderable. Defaults to "".
+    """
+
+    def __init__(
+        self,
+        renderable: RenderableType,
+        style: StyleType = "",
+        vertical_overflow: VerticalOverflowMethod = "ellipsis",
+    ) -> None:
+        self.renderable = renderable
+        self.style = style
+        self.vertical_overflow = vertical_overflow
+        self._shape: Optional[Tuple[int, int]] = None
+
+    def set_renderable(self, renderable: RenderableType) -> None:
+        """Set a new renderable.
+
+        Args:
+            renderable (RenderableType): Any renderable object, including str.
+        """
+        self.renderable = renderable
+
+    def position_cursor(self) -> Control:
+        """Get control codes to move cursor to beginning of live render.
+
+        Returns:
+            Control: A control instance that may be printed.
+        """
+        if self._shape is not None:
+            _, height = self._shape
+            return Control(
+                ControlType.CARRIAGE_RETURN,
+                (ControlType.ERASE_IN_LINE, 2),
+                *(
+                    (
+                        (ControlType.CURSOR_UP, 1),
+                        (ControlType.ERASE_IN_LINE, 2),
+                    )
+                    * (height - 1)
+                ),
+            )
+        return Control()
+
+    def restore_cursor(self) -> Control:
+        """Get control codes to clear the render and restore the cursor to its previous position.
+
+        Returns:
+            Control: A Control instance that may be printed.
+        """
+        if self._shape is not None:
+            _, height = self._shape
+            return Control(
+                ControlType.CARRIAGE_RETURN,
+                *((ControlType.CURSOR_UP, 1), (ControlType.ERASE_IN_LINE, 2)) * height,
+            )
+        return Control()
+
+    def __rich_console__(
+        self, console: Console, options: ConsoleOptions
+    ) -> RenderResult:
+        renderable = self.renderable
+        style = console.get_style(self.style)
+        lines = console.render_lines(renderable, options, style=style, pad=False)
+        shape = Segment.get_shape(lines)
+
+        _, height = shape
+        if height > options.size.height:
+            if self.vertical_overflow == "crop":
+                lines = lines[: options.size.height]
+                shape = Segment.get_shape(lines)
+            elif self.vertical_overflow == "crop_above":
+                lines = lines[-(options.size.height) :]
+                shape = Segment.get_shape(lines)
+            elif self.vertical_overflow == "ellipsis":
+                lines = lines[: (options.size.height - 1)]
+                overflow_text = Text(
+                    "...",
+                    overflow="crop",
+                    justify="center",
+                    end="",
+                    style="live.ellipsis",
+                )
+                lines.append(list(console.render(overflow_text)))
+                shape = Segment.get_shape(lines)
+        self._shape = shape
+
+        new_line = Segment.line()
+        for last, line in loop_last(lines):
+            yield from line
+            if not last:
+                yield new_line

chatlas/_ollama.py

@@ -51,7 +51,7 @@ def ChatOllama(
     ::: {.callout-note}
     ## Python requirements
 
-    `ChatOllama` requires the `openai` package (e.g., `pip install openai`).
+    `ChatOllama` requires the `openai` package: `pip install "chatlas[ollama]"`.
     :::
 
 

chatlas/_openai.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import base64
 import json
 from typing import TYPE_CHECKING, Any, Literal, Optional, cast, overload
 
@@ -12,6 +13,7 @@ from ._content import (
     ContentImageInline,
     ContentImageRemote,
     ContentJson,
+    ContentPDF,
     ContentText,
     ContentToolRequest,
     ContentToolResult,
@@ -79,7 +81,7 @@ def ChatOpenAI(
     ::: {.callout-note}
     ## Python requirements
 
-    `ChatOpenAI` requires the `openai` package (e.g., `pip install openai`).
+    `ChatOpenAI` requires the `openai` package: `pip install "chatlas[openai]"`.
     :::
 
     Examples
@@ -461,6 +463,19 @@ class OpenAIProvider(Provider[ChatCompletion, ChatCompletionChunk, ChatCompletio
                         contents.append({"type": "text", "text": x.text})
                     elif isinstance(x, ContentJson):
                         contents.append({"type": "text", "text": ""})
+                    elif isinstance(x, ContentPDF):
+                        contents.append(
+                            {
+                                "type": "file",
+                                "file": {
+                                    "filename": "",
+                                    "file_data": (
+                                        "data:application/pdf;base64,"
+                                        f"{base64.b64encode(x.data).decode('utf-8')}"
+                                    ),
+                                },
+                            }
+                        )
                     elif isinstance(x, ContentImageRemote):
                         contents.append(
                             {
@@ -476,7 +491,7 @@ class OpenAIProvider(Provider[ChatCompletion, ChatCompletionChunk, ChatCompletio
                             {
                                 "type": "image_url",
                                 "image_url": {
-                                    "url": f"data:{x.content_type};base64,{x.data}"
+                                    "url": f"data:{x.image_content_type};base64,{x.data}"
                                 },
                             }
                         )
@@ -514,9 +529,9 @@ class OpenAIProvider(Provider[ChatCompletion, ChatCompletionChunk, ChatCompletio
         if message.content is not None:
             if has_data_model:
                 data = json.loads(message.content)
-                contents = [ContentJson(data)]
+                contents = [ContentJson(value=data)]
             else:
-                contents = [ContentText(message.content)]
+                contents = [ContentText(text=message.content)]
 
         tool_calls = message.tool_calls
 
@@ -540,7 +555,7 @@ class OpenAIProvider(Provider[ChatCompletion, ChatCompletionChunk, ChatCompletio
 
                 contents.append(
                     ContentToolRequest(
-                        call.id,
+                        id=call.id,
                         name=func.name,
                         arguments=args,
                     )
@@ -592,7 +607,8 @@ def ChatAzureOpenAI(
     ::: {.callout-note}
     ## Python requirements
 
-    `ChatAzureOpenAI` requires the `openai` package (e.g., `pip install openai`).
+    `ChatAzureOpenAI` requires the `openai` package:
+    `pip install "chatlas[azure-openai]"`.
     :::
 
     Examples

chatlas/_perplexity.py

@@ -43,7 +43,7 @@ def ChatPerplexity(
     ::: {.callout-note}
     ## Python requirements
 
-    `ChatPerplexity` requires the `openai` package (e.g., `pip install openai`).
+    `ChatPerplexity` requires the `openai` package: `pip install "chatlas[perplexity]"`.
     :::