prompty 0.1.8__py3-none-any.whl → 0.1.9__py3-none-any.whl

prompty/core.py

@@ -6,9 +6,9 @@ import yaml
 import json
 import abc
 from pathlib import Path
+from .tracer import Tracer, trace, to_dict
 from pydantic import BaseModel, Field, FilePath
-from typing import List, Literal, Dict, Callable, Set, TypeVar
-from .tracer import trace
+from typing import Iterator, List, Literal, Dict, Callable, Set
 
 
 class PropertySettings(BaseModel):
@@ -449,3 +449,33 @@ class Frontmatter:
             "body": body,
             "frontmatter": fmatter,
         }
+
+
+class PromptyStream(Iterator):
+    """PromptyStream class to iterate over LLM stream.
+    Necessary for Prompty to handle streaming data when tracing."""
+
+    def __init__(self, name: str, iterator: Iterator):
+        self.name = name
+        self.iterator = iterator
+        self.items: List[any] = []
+        self.__name__ = "PromptyStream"
+
+    def __iter__(self):
+        return self
+
+    def __next__(self):
+        try:
+            # enumerate but add to list
+            o = self.iterator.__next__()
+            self.items.append(o)
+            return o
+
+        except StopIteration:
+            # StopIteration is raised
+            # contents are exhausted
+            if len(self.items) > 0:     
+                with Tracer.start(f"{self.name}.PromptyStream") as trace:
+                    trace("items", [to_dict(s) for s in self.items])
+
+            raise StopIteration

prompty/executors.py

@@ -1,8 +1,8 @@
 import azure.identity
-from .tracer import Trace
-from openai import AzureOpenAI
-from .core import Invoker, InvokerFactory, Prompty
 import importlib.metadata
+from typing import Iterator
+from openai import AzureOpenAI
+from .core import Invoker, InvokerFactory, Prompty, PromptyStream
 
 VERSION = importlib.metadata.version("prompty")
 
@@ -87,9 +87,8 @@ class AzureOpenAIExecutor(Invoker):
         elif self.api == "image":
             raise NotImplementedError("Azure OpenAI Image API is not implemented yet")
 
-        if hasattr(response, "usage") and response.usage:
-            Trace.add("completion_tokens", response.usage.completion_tokens)
-            Trace.add("prompt_tokens", response.usage.prompt_tokens)
-            Trace.add("total_tokens", response.usage.total_tokens)
-
-        return response
+        # stream response
+        if isinstance(response, Iterator):
+            return PromptyStream("AzureOpenAIExecutor", response)
+        else:
+            return response

prompty/processors.py

@@ -1,10 +1,8 @@
-from .tracer import Trace
-from openai import Stream
 from typing import Iterator
 from pydantic import BaseModel
 from openai.types.completion import Completion
-from .core import Invoker, InvokerFactory, Prompty
 from openai.types.chat.chat_completion import ChatCompletion
+from .core import Invoker, InvokerFactory, Prompty, PromptyStream
 from openai.types.create_embedding_response import CreateEmbeddingResponse
 
 
@@ -66,9 +64,8 @@ class OpenAIProcessor(Invoker):
                 for chunk in data:
                     if len(chunk.choices) == 1 and chunk.choices[0].delta.content != None:
                         content = chunk.choices[0].delta.content
-                        Trace.add("stream", content)
                         yield content
 
-            return generator()
+            return PromptyStream("OpenAIProcessor", generator())
         else:
             return data

prompty/tracer.py

@@ -1,92 +1,64 @@
-import abc
+import os
 import json
 import inspect
-import datetime
+import contextlib
+from pathlib import Path
 from numbers import Number
-import os
 from datetime import datetime
-from pathlib import Path
 from pydantic import BaseModel
 from functools import wraps, partial
-from typing import Any, Callable, Dict, List
-
-
-class Tracer(abc.ABC):
-
-    @abc.abstractmethod
-    def start(self, name: str) -> None:
-        pass
-
-    @abc.abstractmethod
-    def add(self, key: str, value: Any) -> None:
-        pass
+from typing import Any, Callable, Dict, Iterator, List
 
-    @abc.abstractmethod
-    def end(self) -> None:
-        pass
 
-
-class Trace:
-    _tracers: Dict[str, Tracer] = {}
+class Tracer:
+    _tracers: Dict[str, Callable[[str], Iterator[Callable[[str, Any], None]]]] = {}
 
     @classmethod
-    def add_tracer(cls, name: str, tracer: Tracer) -> None:
+    def add(
+        cls, name: str, tracer: Callable[[str], Iterator[Callable[[str, Any], None]]]
+    ) -> None:
         cls._tracers[name] = tracer
 
-    @classmethod
-    def start(cls, name: str) -> None:
-        for tracer in cls._tracers.values():
-            tracer.start(name)
-
-    @classmethod
-    def add(cls, name: str, value: Any) -> None:
-        for tracer in cls._tracers.values():
-            tracer.add(name, value)
-
-    @classmethod
-    def end(cls) -> None:
-        for tracer in cls._tracers.values():
-            tracer.end()
-
     @classmethod
     def clear(cls) -> None:
         cls._tracers = {}
 
     @classmethod
-    def register(cls, name: str):
-        def inner_wrapper(wrapped_class: Tracer) -> Callable:
-            cls._tracers[name] = wrapped_class()
-            return wrapped_class
-
-        return inner_wrapper
-
-    @classmethod
-    def to_dict(cls, obj: Any) -> Dict[str, Any]:
-        # simple json types
-        if isinstance(obj, str) or isinstance(obj, Number) or isinstance(obj, bool):
-            return obj
-        # datetime
-        elif isinstance(obj, datetime):
-            return obj.isoformat()
-        # safe Prompty obj serialization
-        elif type(obj).__name__ == "Prompty":
-            return obj.to_safe_dict()
-        # pydantic models have their own json serialization
-        elif isinstance(obj, BaseModel):
-            return obj.model_dump()
-        # recursive list and dict
-        elif isinstance(obj, list):
-            return [Trace.to_dict(item) for item in obj]
-        elif isinstance(obj, dict):
-            return {
-                k: v if isinstance(v, str) else Trace.to_dict(v)
-                for k, v in obj.items()
-            }
-        elif isinstance(obj, Path):
-            return str(obj)
-        # cast to string otherwise...
-        else:
-            return str(obj)
+    @contextlib.contextmanager
+    def start(cls, name: str) -> Iterator[Callable[[str, Any], None]]:
+        with contextlib.ExitStack() as stack:
+            traces = [
+                stack.enter_context(tracer(name)) for tracer in cls._tracers.values()
+            ]
+            yield lambda key, value: [trace(key, value) for trace in traces]
+
+
+def to_dict(obj: Any) -> Dict[str, Any]:
+    # simple json types
+    if isinstance(obj, str) or isinstance(obj, Number) or isinstance(obj, bool):
+        return obj
+    # datetime
+    elif isinstance(obj, datetime):
+        return obj.isoformat()
+    # safe Prompty obj serialization
+    elif type(obj).__name__ == "Prompty":
+        return obj.to_safe_dict()
+    # safe PromptyStream obj serialization
+    elif type(obj).__name__ == "PromptyStream":
+        return "PromptyStream"
+    # pydantic models have their own json serialization
+    elif isinstance(obj, BaseModel):
+        return obj.model_dump()
+    # recursive list and dict
+    elif isinstance(obj, list):
+        return [to_dict(item) for item in obj]
+    elif isinstance(obj, dict):
+        return {k: v if isinstance(v, str) else to_dict(v) for k, v in obj.items()}
+    elif isinstance(obj, Path):
+        return str(obj)
+    # cast to string otherwise...
+    else:
+        return str(obj)
 
 
 def _name(func: Callable, args):
@@ -110,14 +82,14 @@ def _inputs(func: Callable, args, kwargs) -> dict:
     ba = inspect.signature(func).bind(*args, **kwargs)
     ba.apply_defaults()
 
-    inputs = {k: Trace.to_dict(v) for k, v in ba.arguments.items() if k != "self"}
+    inputs = {k: to_dict(v) for k, v in ba.arguments.items() if k != "self"}
 
     return inputs
 
+
 def _results(result: Any) -> dict:
-    return {
-        "result": Trace.to_dict(result) if result is not None else "None",
-    }
+    return to_dict(result) if result is not None else "None"
+
 
 def _trace_sync(func: Callable = None, *, description: str = None) -> Callable:
     description = description or ""
@@ -125,107 +97,104 @@ def _trace_sync(func: Callable = None, *, description: str = None) -> Callable:
     @wraps(func)
     def wrapper(*args, **kwargs):
         name, signature = _name(func, args)
-        Trace.start(name)
-        Trace.add("signature", signature)
-        if description and description != "":
-            Trace.add("description", description)
+        with Tracer.start(name) as trace:
+            trace("signature", signature)
+            if description and description != "":
+                trace("description", description)
 
-        inputs = _inputs(func, args, kwargs)
-        Trace.add("inputs", inputs)
+            inputs = _inputs(func, args, kwargs)
+            trace("inputs", inputs)
 
-        result = func(*args, **kwargs)
-        Trace.add("result", _results(result))
+            result = func(*args, **kwargs)
+            trace("result", _results(result))
 
-        Trace.end()
+            return result
 
-        return result
-    
     return wrapper
 
+
 def _trace_async(func: Callable = None, *, description: str = None) -> Callable:
     description = description or ""
 
     @wraps(func)
     async def wrapper(*args, **kwargs):
         name, signature = _name(func, args)
-        Trace.start(name)
-        Trace.add("signature", signature)
-        if description and description != "":
-            Trace.add("description", description)
+        with Tracer.start(name) as trace:
+            trace("signature", signature)
+            if description and description != "":
+                trace("description", description)
 
-        inputs = _inputs(func, args, kwargs)
-        Trace.add("inputs", inputs)
+            inputs = _inputs(func, args, kwargs)
+            trace("inputs", inputs)
 
-        result = await func(*args, **kwargs)
-        Trace.add("result", _results(result))
+            result = await func(*args, **kwargs)
+            trace("result", _results(result))
 
-        Trace.end()
+            return result
 
-        return result
-    
     return wrapper
 
+
 def trace(func: Callable = None, *, description: str = None) -> Callable:
     if func is None:
         return partial(trace, description=description)
-    
-    wrapped_method = (
-        _trace_async if inspect.iscoroutinefunction(func) else _trace_sync
-    )
 
-    return wrapped_method(func, description=description)
+    wrapped_method = _trace_async if inspect.iscoroutinefunction(func) else _trace_sync
 
+    return wrapped_method(func, description=description)
 
-class PromptyTracer(Tracer):
-    _stack: List[Dict[str, Any]] = []
-    _name: str = None
 
+class PromptyTracer:
     def __init__(self, output_dir: str = None) -> None:
-        super().__init__()
         if output_dir:
-            self.root = Path(output_dir).resolve().absolute()
+            self.output = Path(output_dir).resolve().absolute()
         else:
-            self.root = Path(Path(os.getcwd()) / ".runs").resolve().absolute()
-
-        if not self.root.exists():
-            self.root.mkdir(parents=True, exist_ok=True)
-
-    def start(self, name: str) -> None:
-        self._stack.append({"name": name})
-        # first entry frame
-        if self._name is None:
-            self._name = name
-
-    def add(self, name: str, value: Any) -> None:
-        frame = self._stack[-1]
-        if name not in frame:
-            frame[name] = value
-        # multiple values creates list
-        else:
-            if isinstance(frame[name], list):
-                frame[name].append(value)
+            self.output = Path(Path(os.getcwd()) / ".runs").resolve().absolute()
+
+        if not self.output.exists():
+            self.output.mkdir(parents=True, exist_ok=True)
+
+        self.stack: List[Dict[str, Any]] = []
+
+    @contextlib.contextmanager
+    def tracer(self, name: str) -> Iterator[Callable[[str, Any], None]]:
+        try:
+            self.stack.append({"name": name})
+            frame = self.stack[-1]
+
+            def add(key: str, value: Any) -> None:
+                if key not in frame:
+                    frame[key] = value
+                # multiple values creates list
+                else:
+                    if isinstance(frame[key], list):
+                        frame[key].append(value)
+                    else:
+                        frame[key] = [frame[key], value]
+
+            yield add
+        finally:
+            frame = self.stack.pop()
+            # if stack is empty, dump the frame
+            if len(self.stack) == 0:
+                trace_file = (
+                    self.output
+                    / f"{frame['name']}.{datetime.now().strftime('%Y%m%d.%H%M%S')}.ptrace"
+                )
+
+                with open(trace_file, "w") as f:
+                    json.dump(frame, f, indent=4)
+            # otherwise, append the frame to the parent
             else:
-                frame[name] = [frame[name], value]
-
-
-    def end(self) -> None:
-        # pop the current stack
-        frame = self._stack.pop()
-
-        # if stack is empty, dump the frame
-        if len(self._stack) == 0:
-            self.flush(frame)
-        # otherwise, append the frame to the parent
-        else:
-            if "__frames" not in self._stack[-1]:
-                self._stack[-1]["__frames"] = []
-            self._stack[-1]["__frames"].append(frame)
-
-    def flush(self, frame: Dict[str, Any]) -> None:
-        
-        trace_file = (
-            self.root / f"{self._name}.{datetime.now().strftime('%Y%m%d.%H%M%S')}.ptrace"
-        )
-        
-        with open(trace_file, "w") as f:
-            json.dump(frame, f, indent=4)
+                if "__frames" not in self.stack[-1]:
+                    self.stack[-1]["__frames"] = []
+                self.stack[-1]["__frames"].append(frame)
+
+
+@contextlib.contextmanager
+def console_tracer(name: str) -> Iterator[Callable[[str, Any], None]]:
+    try:
+        print(f"Starting {name}")
+        yield lambda key, value: print(f"{key}:\n{json.dumps(value, indent=4)}")
+    finally:
+        print(f"Ending {name}")

{prompty-0.1.8.dist-info → prompty-0.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prompty
-Version: 0.1.8
+Version: 0.1.9
 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
@@ -15,7 +15,7 @@ Requires-Dist: click>=8.1.7
 Description-Content-Type: text/markdown
 
 
-Prompty is an asset class and format for LLM prompts designed to enhance observability, understandability, and portability for developers. The primary goal is to accelerate the developer inner loop of prompt engineering and prompt source management in a cross-language and cross-platform implentation.
+Prompty is an asset class and format for LLM prompts designed to enhance observability, understandability, and portability for developers. The primary goal is to accelerate the developer inner loop of prompt engineering and prompt source management in a cross-language and cross-platform implementation.
 
 The file format has a supporting toolchain with a VS Code extension and runtimes in multiple programming languages to simplify and accelerate your AI application development.
 
@@ -133,4 +133,4 @@ prompty -s path/to/prompty/file
 This will execute the prompt and print the response to the console. It also has default tracing enabled.
 
 ## Contributing
-We welcome contributions to the Prompty project! This community led project is open to all contributors. The project cvan be found on [GitHub](https://github.com/Microsoft/prompty).
+We welcome contributions to the Prompty project! This community led project is open to all contributors. The project cvan be found on [GitHub](https://github.com/Microsoft/prompty).

prompty-0.1.9.dist-info/RECORD

@@ -0,0 +1,12 @@
+prompty-0.1.9.dist-info/METADATA,sha256=6YLGAUn8xPP0LW4VEGKpsYesMAIrx5usRw7ToD8CvkI,4668
+prompty-0.1.9.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
+prompty-0.1.9.dist-info/licenses/LICENSE,sha256=KWSC4z9cfML_t0xThoQYjzTdcZQj86Y_mhXdatzU-KM,1052
+prompty/__init__.py,sha256=Msp8eiKdrDq0wyl6G5DFDH8r5BxM2_E60uzzL7_MJ5w,11183
+prompty/cli.py,sha256=_bx_l5v7OGhtAn4d_73b8tyfEw7OOkjCqGMQPu0YP5A,2489
+prompty/core.py,sha256=N6BTwLzmGovUVPBRp0Gg9YJa2Uo-5Q7SQnEBGU0czI8,14432
+prompty/executors.py,sha256=z_SXF-i2qBbxmsBexQ4Ouiqwil6L0lU2wWfwIeSN-eE,3083
+prompty/parsers.py,sha256=4mmIn4SVNs8B0R1BufanqUJk8v4r0OEEo8yx6UOxQpA,4670
+prompty/processors.py,sha256=VaB7fGyaeIPRGuAZ9KTwktx7MIkfCtPALLQgNko1-Gk,2310
+prompty/renderers.py,sha256=RSHFQFx7AtKLUfsMLCXR0a56Mb7DL1NJNgjUqgg3IqU,776
+prompty/tracer.py,sha256=GRHsm6661K8eyA7FkgU2ell0lw8pl2QCZXtjLboR-PY,6244
+prompty-0.1.9.dist-info/RECORD,,

prompty-0.1.8.dist-info/RECORD

@@ -1,12 +0,0 @@
-prompty-0.1.8.dist-info/METADATA,sha256=1sVPpxf3pjHAhCIJoXa-v02zF6P5w4aCdBcQZV3kEm4,4665
-prompty-0.1.8.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
-prompty-0.1.8.dist-info/licenses/LICENSE,sha256=KWSC4z9cfML_t0xThoQYjzTdcZQj86Y_mhXdatzU-KM,1052
-prompty/__init__.py,sha256=Msp8eiKdrDq0wyl6G5DFDH8r5BxM2_E60uzzL7_MJ5w,11183
-prompty/cli.py,sha256=_bx_l5v7OGhtAn4d_73b8tyfEw7OOkjCqGMQPu0YP5A,2489
-prompty/core.py,sha256=WYSvognjMUl08FT0_mkcqZfymb_guKcp3sK8_RO4Kq0,13528
-prompty/executors.py,sha256=TankDTAEBTZkvnPfNUw2KNb1TnNuWhyY8TkWOogUXKs,3185
-prompty/parsers.py,sha256=4mmIn4SVNs8B0R1BufanqUJk8v4r0OEEo8yx6UOxQpA,4670
-prompty/processors.py,sha256=GmReygLx2XW1UuanlX71HG3rTZL86y0yAGyNdbGWkcg,2366
-prompty/renderers.py,sha256=RSHFQFx7AtKLUfsMLCXR0a56Mb7DL1NJNgjUqgg3IqU,776
-prompty/tracer.py,sha256=XMS4aJD_Tp76wm2UFB8amtXn7ioGmPBUy11LmklSUFQ,6490
-prompty-0.1.8.dist-info/RECORD,,