mirascope 1.25.7__py3-none-any.whl → 2.0.0__py3-none-any.whl

mirascope/core/base/dynamic_config.py

@@ -1,82 +0,0 @@
-"""The base type in a function as an LLM call to return for dynamic configuration."""
-
-from collections.abc import Callable, Sequence
-from typing import Any, Generic, TypeVar
-
-from typing_extensions import NotRequired, TypedDict
-
-from .call_params import BaseCallParams
-from .metadata import Metadata
-from .tool import BaseTool
-
-_MessageParamT = TypeVar("_MessageParamT", bound=Any)
-_CallParamsT = TypeVar("_CallParamsT", bound=BaseCallParams)
-_ClientT = TypeVar("_ClientT", bound=object)
-
-
-class DynamicConfigBase(TypedDict):
-    metadata: NotRequired[Metadata]
-    computed_fields: NotRequired[dict[str, Any | list[Any] | list[list[Any]]]]
-    tools: NotRequired[Sequence[type[BaseTool] | Callable]]
-
-
-class DynamicConfigMessages(DynamicConfigBase, Generic[_MessageParamT]):
-    messages: NotRequired[Sequence[_MessageParamT]]
-
-
-class DynamicConfigCallParams(DynamicConfigBase, Generic[_CallParamsT]):
-    call_params: NotRequired[_CallParamsT]
-
-
-class DynamicConfigClient(DynamicConfigBase, Generic[_ClientT]):
-    client: NotRequired[_ClientT | None]
-
-
-class DynamicConfigMessagesCallParams(
-    DynamicConfigBase, Generic[_MessageParamT, _CallParamsT]
-):
-    messages: NotRequired[Sequence[_MessageParamT]]
-    call_params: NotRequired[_CallParamsT]
-
-
-class DynamicConfigMessagesClient(DynamicConfigBase, Generic[_MessageParamT, _ClientT]):
-    messages: NotRequired[Sequence[_MessageParamT]]
-    client: NotRequired[_ClientT | None]
-
-
-class DynamicConfigCallParamsClient(DynamicConfigBase, Generic[_CallParamsT, _ClientT]):
-    call_params: NotRequired[_CallParamsT]
-    client: NotRequired[_ClientT | None]
-
-
-class DynamicConfigFull(
-    DynamicConfigBase, Generic[_MessageParamT, _CallParamsT, _ClientT]
-):
-    messages: NotRequired[Sequence[_MessageParamT]]
-    call_params: NotRequired[_CallParamsT]
-    client: NotRequired[_ClientT | None]
-
-
-BaseDynamicConfig = (
-    DynamicConfigBase
-    | DynamicConfigMessages[_MessageParamT]
-    | DynamicConfigCallParams[_CallParamsT]
-    | DynamicConfigClient[_ClientT]
-    | DynamicConfigMessagesCallParams[_MessageParamT, _CallParamsT]
-    | DynamicConfigMessagesClient[_MessageParamT, _ClientT]
-    | DynamicConfigCallParamsClient[_CallParamsT, _ClientT]
-    | DynamicConfigFull[_MessageParamT, _CallParamsT, _ClientT]
-    | None
-)
-"""The base type in a function as an LLM call to return for dynamic configuration.
-
-Attributes:
-    metadata: Any metadata to include in call responses.
-    computed_fields: Fields to be computed and injected into the prompt template at
-        runtime.
-    tools: Tools to be provided to the LLM API call at runtime.
-    messages: Custom message parameters, which will override any other form of writing
-        prompts when used.
-    call_params: Call parameters to use when making the LLM API call.
-    client: A custom client to use in place of the default client.
-"""

mirascope/core/base/from_call_args.py

@@ -1,30 +0,0 @@
-from pydantic.fields import FieldInfo
-
-
-class FromCallArgs:
-    """Use this metadata to pass function arguments through to the response model.
-
-    Example:
-
-    ```python
-    from typing import Annotated
-    from pydantic import BaseModel, Field
-    from mirascope.core import openai, prompt_template
-    from mirascope.core.base import FromCallArgs
-
-    class BookRecommendation(BaseModel):
-        genre: Annotated[str, FromCallArgs()]
-        title: str = Field(..., description="The title of the recommended book")
-        author: str = Field(..., description="The author of the recommended book")
-
-    @openai.call(model="gpt-4o-mini", response_model=BookRecommendation)
-    def recommend_book(genre: str) -> str:
-        return f"Recommend a {genre} book."
-    ```
-    """
-
-    pass
-
-
-def is_from_call_args(field: FieldInfo) -> bool:
-    return any(isinstance(m, FromCallArgs) for m in field.metadata)

mirascope/core/base/merge_decorators.py

@@ -1,59 +0,0 @@
-from collections.abc import Callable
-from functools import reduce, wraps
-from typing import Any, ParamSpec, TypeVar
-
-_P = ParamSpec("_P")
-_R = TypeVar("_R")
-
-_WP = ParamSpec("_WP")
-_WR = TypeVar("_WR")
-
-
-def merge_decorators(
-    decorator: Callable[[Callable[_P, _R]], Callable[_WP, _WR]],
-    *additional_decorators: Callable[[Callable], Callable],
-) -> Callable[[], Callable[[Callable[_P, _R]], Callable[_WP, _WR]]]:
-    """Combines multiple decorators into a single decorator factory.
-
-    This function allows you to merge multiple decorators into a single decorator factory.
-    The decorators are applied in the order they are passed to the function.
-    All function metadata (e.g. docstrings, function name) is preserved through the decoration chain.
-
-    Args:
-        decorator: The base decorator that determines the type signature of the decorated function.
-        *additional_decorators: Additional decorators to be merged with the base decorator.
-
-    Returns:
-        A decorator factory function that applies all decorators in the specified order.
-
-    Example:
-        ```python
-        # Combine multiple decorators
-        merged = merge_decorators(
-            retry(),
-            with_logging(),
-            handle_errors()
-        )
-
-        # Apply the merged decorators
-        @merged()
-        def my_function():
-            pass
-        ```
-    """
-    decorators = [decorator] + list(additional_decorators)
-
-    def decorator_factory() -> Callable[[Callable[_P, _R]], Callable[_WP, _WR]]:
-        def inner(func: Callable[_P, _R]) -> Callable[_WP, _WR]:
-            def compose(f: Callable, d: Callable) -> Callable:
-                @wraps(f)
-                def wrapped(*args: Any, **kwargs: Any) -> Any:  # noqa: ANN401
-                    return d(f)(*args, **kwargs)
-
-                return wrapped
-
-            return reduce(compose, reversed(decorators), func)  # pyright: ignore [reportReturnType]
-
-        return inner
-
-    return decorator_factory

mirascope/core/base/message_param.py

@@ -1,175 +0,0 @@
-"""This module contains the base class for message parameters."""
-
-from collections.abc import Sequence
-from typing import Literal
-
-from pydantic import BaseModel
-
-
-class TextPart(BaseModel):
-    """A content part for text.
-
-    Attributes:
-        type: Always "text"
-        text: The text content
-    """
-
-    type: Literal["text"]
-    text: str
-
-
-class CacheControlPart(BaseModel):
-    """A part for marking cache control.
-
-    This part is currently only available with Anthropic. For more details, see:
-    https://docs.anthropic.com/en/docs/build-with-claude/prompt-caching
-
-    Attributes:
-        type: Always "cache_control"
-        cache_type: Currently only "ephemeral" is available.
-    """
-
-    type: Literal["cache_control"]
-    cache_type: str
-
-
-class ImagePart(BaseModel):
-    """A content part for images.
-
-    Attributes:
-        type: Always "image"
-        media_type: The media type (e.g. image/jpeg)
-        image: The raw image bytes
-        detail: (Optional) The detail to use for the image (supported by OpenAI)
-    """
-
-    type: Literal["image"]
-    media_type: str
-    image: bytes
-    detail: str | None
-
-
-class ImageURLPart(BaseModel):
-    """A content part for images with a URL or base64 encoded image data.
-
-    Attributes:
-        type: Always "image_url"
-        url: The URL to the image
-        detail: (Optional) The detail to use for the image (supported by OpenAI)
-    """
-
-    type: Literal["image_url"]
-    url: str
-    detail: str | None
-
-
-class AudioPart(BaseModel):
-    """A content part for audio.
-
-    Attributes:
-        type: Always "audio"
-        media_type: The media type (e.g. audio/wav)
-        audio: The raw audio bytes or base64 encoded audio data
-    """
-
-    type: Literal["audio"]
-    media_type: str
-    audio: bytes | str
-
-
-class AudioURLPart(BaseModel):
-    """A content part for audio with a URL or base64 encoded audio data.
-
-    Attributes:
-        type: Always "audio_url"
-        url: The URL to the audio
-    """
-
-    type: Literal["audio_url"]
-    url: str
-
-
-class DocumentPart(BaseModel):
-    """A content part for pdf.
-
-    Attributes:
-        type: Always "document"
-        media_type: The media type (e.g. application/pdf)
-        document: document data
-    """
-
-    type: Literal["document"]
-    media_type: str
-    document: bytes
-
-
-class DocumentURLPart(BaseModel):
-    """A content part for documents with a URL.
-
-    Attributes:
-        type: Always "document_url"
-        url: The URL to the document
-    """
-
-    type: Literal["document_url"]
-    url: str
-
-
-class ToolCallPart(BaseModel):
-    """A content part for tool.
-
-    Attributes:
-        type: Always "tool"
-        name: The name of the tool
-        id: The id of the tool
-    """
-
-    type: Literal["tool_call"]
-    name: str
-    args: dict | None = None
-    id: str | None = None
-
-
-class ToolResultPart(BaseModel):
-    """A content part for tool.
-
-    Attributes:
-        type: Always "tool"
-        name: The name of the tool
-        id: The id of the tool
-    """
-
-    type: Literal["tool_result"]
-    name: str = ""
-    content: str
-    id: str | None = None
-    is_error: bool = False
-
-
-class BaseMessageParam(BaseModel):
-    """A base class for message parameters.
-
-    usage docs: learn/prompts.md#prompt-templates-messages
-
-    Attributes:
-        role: The role of the message (e.g. "system", "user", "assistant", "tool")
-        content: The content of the message
-        tool_name: The name of the tool, if any
-    """
-
-    role: str
-    content: (
-        str
-        | Sequence[
-            TextPart
-            | ImagePart
-            | ImageURLPart
-            | AudioPart
-            | AudioURLPart
-            | CacheControlPart
-            | DocumentPart
-            | DocumentURLPart
-            | ToolCallPart
-            | ToolResultPart
-        ]
-    )

mirascope/core/base/messages.py

@@ -1,116 +0,0 @@
-from __future__ import annotations
-
-from collections.abc import Sequence
-from typing import Any
-from wave import Wave_read
-
-from ._utils._convert_messages_to_message_params import (
-    Image,
-    convert_message_content_to_message_param_content,
-)
-from .message_param import (
-    AudioPart,
-    AudioURLPart,
-    BaseMessageParam,
-    CacheControlPart,
-    DocumentPart,
-    DocumentURLPart,
-    ImagePart,
-    ImageURLPart,
-    TextPart,
-)
-from .types import AudioSegment
-
-
-class Messages:
-    Type = (
-        str
-        | Sequence[
-            str
-            | TextPart
-            | CacheControlPart
-            | ImagePart
-            | ImageURLPart
-            | Image.Image
-            | AudioPart
-            | AudioURLPart
-            | AudioSegment
-            | Wave_read
-            | DocumentPart
-            | DocumentURLPart
-        ]
-        | list[BaseMessageParam | Any]
-        | BaseMessageParam
-    )
-
-    @classmethod
-    def System(
-        cls,
-        content: str
-        | Sequence[
-            str
-            | TextPart
-            | CacheControlPart
-            | ImagePart
-            | ImageURLPart
-            | Image.Image
-            | AudioPart
-            | AudioURLPart
-            | AudioSegment
-            | Wave_read
-            | DocumentPart
-            | DocumentURLPart
-        ],
-    ) -> BaseMessageParam:
-        return BaseMessageParam(
-            role="system",
-            content=convert_message_content_to_message_param_content(content),
-        )
-
-    @classmethod
-    def User(
-        cls,
-        content: str
-        | Sequence[
-            str
-            | TextPart
-            | CacheControlPart
-            | ImagePart
-            | ImageURLPart
-            | Image.Image
-            | AudioPart
-            | AudioURLPart
-            | AudioSegment
-            | Wave_read
-            | DocumentPart
-            | DocumentURLPart
-        ],
-    ) -> BaseMessageParam:
-        return BaseMessageParam(
-            role="user",
-            content=convert_message_content_to_message_param_content(content),
-        )
-
-    @classmethod
-    def Assistant(
-        cls,
-        content: str
-        | Sequence[
-            str
-            | TextPart
-            | CacheControlPart
-            | ImagePart
-            | ImageURLPart
-            | Image.Image
-            | AudioPart
-            | AudioURLPart
-            | AudioSegment
-            | Wave_read
-            | DocumentPart
-            | DocumentURLPart
-        ],
-    ) -> BaseMessageParam:
-        return BaseMessageParam(
-            role="assistant",
-            content=convert_message_content_to_message_param_content(content),
-        )

mirascope/core/base/metadata.py

@@ -1,13 +0,0 @@
-"""The `Metadata` typed dictionary for including general metadata."""
-
-from typing_extensions import NotRequired, TypedDict
-
-
-class Metadata(TypedDict, total=False):
-    """The `Metadata` typed dictionary for including general metadata.
-
-    Attributes:
-        tags: A set of strings for tagging calls (e.g. versioning, categorizing, etc.)
-    """
-
-    tags: NotRequired[set[str]]