prompty 0.1.39__tar.gz → 0.1.44__tar.gz

{prompty-0.1.39 → prompty-0.1.44}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prompty
-Version: 0.1.39
+Version: 0.1.44
 Summary: Prompty is a new asset class and format for LLM prompts that aims to provide observability, understandability, and portability for developers. It includes spec, tooling, and a runtime. This Prompty runtime supports Python
 Author-Email: Seth Juarez <seth.juarez@microsoft.com>
 License: MIT

{prompty-0.1.39 → prompty-0.1.44}/prompty/__init__.py

@@ -1,8 +1,8 @@
 import traceback
+import typing
 from pathlib import Path
-from typing import Dict, List, Union
-from .tracer import trace
-from .invoker import InvokerFactory, NoOp
+from typing import Union
+
 from .core import (
     ModelSettings,
     Prompty,
@@ -10,23 +10,27 @@ from .core import (
     TemplateSettings,
     param_hoisting,
 )
+from .invoker import InvokerFactory
+from .parsers import PromptyChatParser
+from .renderers import Jinja2Renderer
+from .tracer import trace
 from .utils import (
     load_global_config,
     load_global_config_async,
-    load_prompty_async,
     load_prompty,
+    load_prompty_async,
 )
 
-from .renderers import *
-from .parsers import *
+InvokerFactory.add_renderer("jinja2", Jinja2Renderer)
+InvokerFactory.add_parser("prompty.chat", PromptyChatParser)
 
 
 @trace(description="Create a headless prompty object for programmatic use.")
 def headless(
     api: str,
-    content: str | List[str] | dict,
-    configuration: Dict[str, any] = {},
-    parameters: Dict[str, any] = {},
+    content: Union[str, list[str], dict],
+    configuration: dict[str, typing.Any] = {},
+    parameters: dict[str, typing.Any] = {},
     connection: str = "default",
 ) -> Prompty:
     """Create a headless prompty object for programmatic use.
@@ -81,9 +85,9 @@ def headless(
 @trace(description="Create a headless prompty object for programmatic use.")
 async def headless_async(
     api: str,
-    content: str | List[str] | dict,
-    configuration: Dict[str, any] = {},
-    parameters: Dict[str, any] = {},
+    content: Union[str, list[str], dict],
+    configuration: dict[str, typing.Any] = {},
+    parameters: dict[str, typing.Any] = {},
     connection: str = "default",
 ) -> Prompty:
     """Create a headless prompty object for programmatic use.
@@ -188,17 +192,17 @@ def _load_raw_prompty(attributes: dict, content: str, p: Path, global_config: di
     else:
         outputs = {}
 
-    p = Prompty(
-        **attributes,
+    prompty = Prompty(
         model=model,
         inputs=inputs,
         outputs=outputs,
         template=template,
         content=content,
         file=p,
+        **attributes
     )
 
-    return p
+    return prompty
 
 
 @trace(description="Load a prompty file.")
@@ -311,7 +315,7 @@ async def load_async(prompty_file: str, configuration: str = "default") -> Promp
 @trace(description="Prepare the inputs for the prompt.")
 def prepare(
     prompt: Prompty,
-    inputs: Dict[str, any] = {},
+    inputs: dict[str, typing.Any] = {},
 ):
     """Prepare the inputs for the prompt.
 
@@ -345,7 +349,7 @@ def prepare(
 @trace(description="Prepare the inputs for the prompt.")
 async def prepare_async(
     prompt: Prompty,
-    inputs: Dict[str, any] = {},
+    inputs: dict[str, typing.Any] = {},
 ):
     """Prepare the inputs for the prompt.
 
@@ -379,9 +383,9 @@ async def prepare_async(
 @trace(description="Run the prepared Prompty content against the model.")
 def run(
     prompt: Prompty,
-    content: dict | list | str,
-    configuration: Dict[str, any] = {},
-    parameters: Dict[str, any] = {},
+    content: Union[dict, list, str],
+    configuration: dict[str, typing.Any] = {},
+    parameters: dict[str, typing.Any] = {},
     raw: bool = False,
 ):
     """Run the prepared Prompty content.
@@ -431,9 +435,9 @@ def run(
 @trace(description="Run the prepared Prompty content against the model.")
 async def run_async(
     prompt: Prompty,
-    content: dict | list | str,
-    configuration: Dict[str, any] = {},
-    parameters: Dict[str, any] = {},
+    content: Union[dict, list, str],
+    configuration: dict[str, typing.Any] = {},
+    parameters: dict[str, typing.Any] = {},
     raw: bool = False,
 ):
     """Run the prepared Prompty content.
@@ -483,9 +487,9 @@ async def run_async(
 @trace(description="Execute a prompty")
 def execute(
     prompt: Union[str, Prompty],
-    configuration: Dict[str, any] = {},
-    parameters: Dict[str, any] = {},
-    inputs: Dict[str, any] = {},
+    configuration: dict[str, typing.Any] = {},
+    parameters: dict[str, typing.Any] = {},
+    inputs: dict[str, typing.Any] = {},
     raw: bool = False,
     config_name: str = "default",
 ):
@@ -517,7 +521,7 @@ def execute(
     >>> inputs = {"name": "John Doe"}
     >>> result = prompty.execute("prompts/basic.prompty", inputs=inputs)
     """
-    if isinstance(prompt, str):
+    if isinstance(prompt, (str, Path)):
         path = Path(prompt)
         if not path.is_absolute():
             # get caller's path (take into account trace frame)
@@ -537,9 +541,9 @@ def execute(
 @trace(description="Execute a prompty")
 async def execute_async(
     prompt: Union[str, Prompty],
-    configuration: Dict[str, any] = {},
-    parameters: Dict[str, any] = {},
-    inputs: Dict[str, any] = {},
+    configuration: dict[str, typing.Any] = {},
+    parameters: dict[str, typing.Any] = {},
+    inputs: dict[str, typing.Any] = {},
     raw: bool = False,
     config_name: str = "default",
 ):
@@ -571,7 +575,7 @@ async def execute_async(
     >>> inputs = {"name": "John Doe"}
     >>> result = await prompty.execute_async("prompts/basic.prompty", inputs=inputs)
     """
-    if isinstance(prompt, str):
+    if isinstance(prompt, (str, Path)):
         path = Path(prompt)
         if not path.is_absolute():
             # get caller's path (take into account trace frame)

{prompty-0.1.39 → prompty-0.1.44}/prompty/azure/__init__.py

@@ -2,8 +2,8 @@
 from prompty.invoker import InvokerException
 
 try:
-    from .executor import AzureOpenAIExecutor
-    from .processor import AzureOpenAIProcessor
+    from .executor import AzureOpenAIExecutor # noqa
+    from .processor import AzureOpenAIProcessor # noqa
 except ImportError:
     raise InvokerException(
         "Error registering AzureOpenAIExecutor and AzureOpenAIProcessor", "azure"

{prompty-0.1.39 → prompty-0.1.44}/prompty/azure/executor.py

@@ -1,12 +1,14 @@
-import json
-import azure.identity
 import importlib.metadata
-from typing import AsyncIterator, Iterator
-from openai import APIResponse, AzureOpenAI, AsyncAzureOpenAI
+import typing
+from collections.abc import AsyncIterator, Iterator
 
-from prompty.tracer import Tracer, sanitize
-from ..core import AsyncPromptyStream, Prompty, PromptyStream
+import azure.identity
+from openai import APIResponse, AsyncAzureOpenAI, AzureOpenAI
 from openai.types.chat.chat_completion import ChatCompletion
+
+from prompty.tracer import Tracer
+
+from ..core import AsyncPromptyStream, Prompty, PromptyStream
 from ..invoker import Invoker, InvokerFactory
 
 VERSION = importlib.metadata.version("prompty")
@@ -29,7 +31,10 @@ class AzureOpenAIExecutor(Invoker):
         if "api_key" not in self.kwargs:
             # managed identity if client id
             if "client_id" in self.kwargs:
-                default_credential = azure.identity.ManagedIdentityCredential(
+                default_credential: typing.Union[
+                    azure.identity.ManagedIdentityCredential,
+                    azure.identity.DefaultAzureCredential,
+                ] = azure.identity.ManagedIdentityCredential(
                     client_id=self.kwargs.pop("client_id"),
                 )
             # default credential
@@ -48,7 +53,7 @@ class AzureOpenAIExecutor(Invoker):
         self.deployment = self.prompty.model.configuration["azure_deployment"]
         self.parameters = self.prompty.model.parameters
 
-    def invoke(self, data: any) -> any:
+    def invoke(self, data: typing.Any) -> typing.Union[str, PromptyStream]:
         """Invoke the Azure OpenAI API
 
         Parameters
@@ -89,12 +94,11 @@ class AzureOpenAIExecutor(Invoker):
                 }
                 trace("inputs", args)
 
-                if "stream" in args and args["stream"] == True:
+                if "stream" in args and args["stream"]:
                     response = client.chat.completions.create(**args)
                 else:
-                    raw: APIResponse = client.chat.completions.with_raw_response.create(
-                        **args
-                    )
+                    raw = client.chat.completions.with_raw_response.create(**args)
+
                     response = ChatCompletion.model_validate_json(raw.text)
 
                     for k, v in raw.headers.raw:
@@ -135,7 +139,7 @@ class AzureOpenAIExecutor(Invoker):
                     **self.parameters,
                 }
                 trace("inputs", args)
-                response = client.images.generate.create(**args)
+                response = client.images.generate(**args)
                 trace("result", response)
 
         # stream response
@@ -148,7 +152,7 @@ class AzureOpenAIExecutor(Invoker):
         else:
             return response
 
-    async def invoke_async(self, data: str) -> str:
+    async def invoke_async(self, data: str) -> typing.Union[str, AsyncPromptyStream]:
         """Invoke the Prompty Chat Parser (Async)
 
         Parameters
@@ -188,13 +192,13 @@ class AzureOpenAIExecutor(Invoker):
                 }
                 trace("inputs", args)
 
-                if "stream" in args and args["stream"] == True:
+                if "stream" in args and args["stream"]:
                     response = await client.chat.completions.create(**args)
                 else:
-                    raw: APIResponse = await client.chat.completions.with_raw_response.create(
-                        **args
+                    raw: APIResponse = (
+                        await client.chat.completions.with_raw_response.create(**args)
                     )
-                    response = ChatCompletion.model_validate_json(raw.text)
+                    response = ChatCompletion.model_validate_json(raw.text())
                     for k, v in raw.headers.raw:
                         trace(k.decode("utf-8"), v.decode("utf-8"))
 
@@ -234,7 +238,7 @@ class AzureOpenAIExecutor(Invoker):
                     **self.parameters,
                 }
                 trace("inputs", args)
-                response = await client.images.generate.create(**args)
+                response = await client.images.generate(**args)
                 trace("result", response)
 
         # stream response

{prompty-0.1.39 → prompty-0.1.44}/prompty/azure/processor.py

@@ -1,10 +1,13 @@
-from typing import AsyncIterator, Iterator
+import typing
+from collections.abc import AsyncIterator, Iterator
+
+from openai.types.chat.chat_completion import ChatCompletion
 from openai.types.completion import Completion
+from openai.types.create_embedding_response import CreateEmbeddingResponse
 from openai.types.images_response import ImagesResponse
-from openai.types.chat.chat_completion import ChatCompletion
+
 from ..core import AsyncPromptyStream, Prompty, PromptyStream, ToolCall
 from ..invoker import Invoker, InvokerFactory
-from openai.types.create_embedding_response import CreateEmbeddingResponse
 
 
 @InvokerFactory.register_processor("azure")
@@ -17,7 +20,15 @@ class AzureOpenAIProcessor(Invoker):
     def __init__(self, prompty: Prompty) -> None:
         super().__init__(prompty)
 
-    def invoke(self, data: any) -> any:
+    def invoke(self, data: typing.Any) -> typing.Union[
+        str,
+        list[typing.Union[str, None]],
+        list[ToolCall],
+        list[float],
+        list[list[float]],
+        PromptyStream,
+        None,
+    ]:
         """Invoke the OpenAI/Azure API
 
         Parameters
@@ -71,7 +82,7 @@ class AzureOpenAIProcessor(Invoker):
                 for chunk in data:
                     if (
                         len(chunk.choices) == 1
-                        and chunk.choices[0].delta.content != None
+                        and chunk.choices[0].delta.content is not None
                     ):
                         content = chunk.choices[0].delta.content
                         yield content
@@ -80,7 +91,7 @@ class AzureOpenAIProcessor(Invoker):
         else:
             return data
 
-    async def invoke_async(self, data: str) -> str:
+    async def invoke_async(self, data: str) -> typing.Union[str, AsyncPromptyStream]:
         """Invoke the Prompty Chat Parser (Async)
 
         Parameters
@@ -134,7 +145,7 @@ class AzureOpenAIProcessor(Invoker):
                 async for chunk in data:
                     if (
                         len(chunk.choices) == 1
-                        and chunk.choices[0].delta.content != None
+                        and chunk.choices[0].delta.content is not None
                     ):
                         content = chunk.choices[0].delta.content
                         yield content

{prompty-0.1.39 → prompty-0.1.44}/prompty/azure_beta/__init__.py

@@ -2,9 +2,9 @@
 from prompty.invoker import InvokerException
 
 try:
-    from .executor import AzureOpenAIBetaExecutor
     # Reuse the common Azure OpenAI Processor
-    from ..azure.processor import AzureOpenAIProcessor
+    from ..azure.processor import AzureOpenAIProcessor # noqa
+    from .executor import AzureOpenAIBetaExecutor # noqa
 except ImportError:
     raise InvokerException(
         "Error registering AzureOpenAIBetaExecutor and AzureOpenAIProcessor", "azure_beta"

{prompty-0.1.39 → prompty-0.1.44}/prompty/azure_beta/executor.py

@@ -1,15 +1,19 @@
-import azure.identity
 import importlib.metadata
-from typing import AsyncIterator, Iterator
-from openai import AzureOpenAI, AsyncAzureOpenAI
+import re
+import typing
+from collections.abc import AsyncIterator, Iterator
+from datetime import datetime
+
+import azure.identity
+from openai import AsyncAzureOpenAI, AzureOpenAI
 
 from prompty.tracer import Tracer
+
 from ..core import AsyncPromptyStream, Prompty, PromptyStream
 from ..invoker import Invoker, InvokerFactory
-import re
-from datetime import datetime
 
-def extract_date(data: str) -> datetime:
+
+def extract_date(data: str) -> typing.Union[datetime, None]:
     """Extract date from a string
 
     Parameters
@@ -24,17 +28,18 @@ def extract_date(data: str) -> datetime:
     """
 
     # Regular expression to find dates in the format YYYY-MM-DD
-    date_pattern = re.compile(r'\b\d{4}-\d{2}-\d{2}\b')
+    date_pattern = re.compile(r"\b\d{4}-\d{2}-\d{2}\b")
     match = date_pattern.search(data)
     if match:
         date_str = match.group(0)
         # Validate the date format
         try:
-            return datetime.strptime(date_str, '%Y-%m-%d')
+            return datetime.strptime(date_str, "%Y-%m-%d")
         except ValueError:
             pass
     return None
 
+
 def is_structured_output_available(api_version: str) -> bool:
     """Check if the structured output API is available for the given API version
 
@@ -55,10 +60,11 @@ def is_structured_output_available(api_version: str) -> bool:
     api_version_date = extract_date(api_version)
 
     # Check if the API version are on or after the threshold date
-    if api_version_date >= threshold_api_version_date:
+    if api_version_date is not None and api_version_date >= threshold_api_version_date:
         return True
     return False
 
+
 VERSION = importlib.metadata.version("prompty")
 
 
@@ -79,7 +85,10 @@ class AzureOpenAIBetaExecutor(Invoker):
         if "api_key" not in self.kwargs:
             # managed identity if client id
             if "client_id" in self.kwargs:
-                default_credential = azure.identity.ManagedIdentityCredential(
+                default_credential: typing.Union[
+                    azure.identity.ManagedIdentityCredential,
+                    azure.identity.DefaultAzureCredential,
+                ] = azure.identity.ManagedIdentityCredential(
                     client_id=self.kwargs.pop("client_id"),
                 )
             # default credential
@@ -99,7 +108,7 @@ class AzureOpenAIBetaExecutor(Invoker):
         self.deployment = self.prompty.model.configuration["azure_deployment"]
         self.parameters = self.prompty.model.parameters
 
-    def invoke(self, data: any) -> any:
+    def invoke(self, data: typing.Any) -> typing.Any:
         """Invoke the Azure OpenAI API
 
         Parameters
@@ -133,13 +142,13 @@ class AzureOpenAIBetaExecutor(Invoker):
 
             if self.api == "chat":
                 # We can only verify the API version as the model and its version are not part of prompty configuration
-                # Should be gpt-4o and 2024-08-06 or later    
+                # Should be gpt-4o and 2024-08-06 or later
                 choose_beta = is_structured_output_available(self.api_version)
                 if choose_beta:
                     trace("signature", "AzureOpenAI.beta.chat.completions.parse")
                 else:
                     trace("signature", "AzureOpenAI.chat.completions.create")
-                
+
                 args = {
                     "model": self.deployment,
                     "messages": data if isinstance(data, list) else [data],
@@ -147,7 +156,7 @@ class AzureOpenAIBetaExecutor(Invoker):
                 }
                 trace("inputs", args)
                 if choose_beta:
-                    response = client.beta.chat.completions.parse(**args)
+                    response: typing.Any = client.beta.chat.completions.parse(**args)
                 else:
                     response = client.chat.completions.create(**args)
                 trace("result", response)
@@ -182,7 +191,7 @@ class AzureOpenAIBetaExecutor(Invoker):
                     **self.parameters,
                 }
                 trace("inputs", args)
-                response = client.images.generate.create(**args)
+                response = client.images.generate(**args)
                 trace("result", response)
 
         # stream response
@@ -195,7 +204,7 @@ class AzureOpenAIBetaExecutor(Invoker):
         else:
             return response
 
-    async def invoke_async(self, data: str) -> str:
+    async def invoke_async(self, data: str) -> typing.Union[str, AsyncPromptyStream]:
         """Invoke the Prompty Chat Parser (Async)
 
         Parameters
@@ -267,7 +276,7 @@ class AzureOpenAIBetaExecutor(Invoker):
                     **self.parameters,
                 }
                 trace("inputs", args)
-                response = await client.images.generate.create(**args)
+                response = await client.images.generate(**args)
                 trace("result", response)
 
         # stream response

{prompty-0.1.39 → prompty-0.1.44}/prompty/cli.py

@@ -1,14 +1,15 @@
-import os
-import json
-import click
 import importlib
-
+import json
+import os
 from pathlib import Path
+from typing import Any, Optional
+
+import click
+from dotenv import load_dotenv
 from pydantic import BaseModel
 
 import prompty
-from prompty.tracer import trace, PromptyTracer, console_tracer, Tracer
-from dotenv import load_dotenv
+from prompty.tracer import PromptyTracer, Tracer, console_tracer, trace
 
 
 def normalize_path(p, create_dir=False) -> Path:
@@ -32,6 +33,8 @@ def dynamic_import(module: str):
         t = "prompty.azure"
     elif module == "serverless":
         t = "prompty.serverless"
+    elif module == "openai":
+        t = "prompty.openai"
     else:
         t = module
 
@@ -44,9 +47,9 @@ def chat_mode(prompt_path: str):
     W = "\033[0m"  # white (normal)
     R = "\033[31m"  # red
     G = "\033[32m"  # green
-    O = "\033[33m"  # orange
+    #O = "\033[33m"  # orange
     B = "\033[34m"  # blue
-    P = "\033[35m"  # purple
+    #P = "\033[35m"  # purple
     print(f"Executing {str(prompt_path)} in chat mode...")
     p = prompty.load(str(prompt_path))
     if "chat_history" not in p.sample:
@@ -78,14 +81,16 @@ def chat_mode(prompt_path: str):
 
 
 @trace
-def execute(prompt_path: str, raw=False):
+def execute(prompt_path: str, inputs: Optional[dict[str, Any]] = None, raw=False):
     p = prompty.load(prompt_path)
 
+    inputs = inputs or {}
+
     try:
         # load executor / processor types
         dynamic_import(p.model.configuration["type"])
 
-        result = prompty.execute(p, raw=raw)
+        result = prompty.execute(p, inputs=inputs, raw=raw)
         if issubclass(type(result), BaseModel):
             print("\n", json.dumps(result.model_dump(), indent=4), "\n")
         elif isinstance(result, list):
@@ -98,13 +103,42 @@ def execute(prompt_path: str, raw=False):
         print(f"{type(e).__qualname__}: {e}", "\n")
 
 
-@click.command()
+def _attributes_to_dict(
+    ctx: click.Context, attribute: click.Option, attributes: tuple[str, ...]
+) -> dict[str, str]:
+    """Click callback that converts attributes specified in the form `key=value` to a
+    dictionary"""
+    result = {}
+    for arg in attributes:
+        k, v = arg.split("=")
+        if k in result:
+            raise click.BadParameter(f"Attribute {k!r} is specified twice")
+        if v == "@-":
+            v = click.get_text_stream("stdin").read()
+        if v.startswith("@"):
+            v = Path(v[1:]).read_text()
+        result[k] = v
+
+    return result
+
+
+@click.command(epilog="""
+\b
+INPUTS: key=value pairs
+    The values can come from:
+    - plain strings - e.g.: question="Does it have windows?"
+    - files - e.g.: question=@question.txt
+    - stdin - e.g.: question=@-
+
+For more information, visit https://prompty.ai/
+""")
 @click.option("--source", "-s", required=True)
 @click.option("--env", "-e", required=False)
 @click.option("--verbose", "-v", is_flag=True)
 @click.option("--chat", "-c", is_flag=True)
+@click.argument("inputs", nargs=-1, callback=_attributes_to_dict)
 @click.version_option()
-def run(source, env, verbose, chat):
+def run(source, env, verbose, chat, inputs):
     # load external env file
     if env:
         print(f"Loading environment variables from {env}")
@@ -124,7 +158,7 @@ def run(source, env, verbose, chat):
     if chat:
         chat_mode(str(prompt_path))
     else:
-        execute(str(prompt_path), raw=verbose)
+        execute(str(prompt_path), inputs=inputs, raw=verbose)
 
 
 if __name__ == "__main__":