mirascope 2.0.0a2__tar.gz → 2.0.0a4__tar.gz

mirascope-2.0.0a4/.coveragerc

@@ -0,0 +1,49 @@
+[run]
+# Exclude modules from coverage tracking until they have full test coverage
+# Remove items from this list as we add comprehensive tests for each module
+# Goal: When this exclude list is empty, we have 100% coverage across the entire codebase
+omit = 
+    # LLM modules to exclude (remove as we add full test coverage)
+    mirascope/llm/mcp/__init__.py
+    mirascope/llm/mcp/client.py
+    mirascope/llm/formatting/partial.py
+
+    # NOTE: MLX modules are excluded because the `mlx` package is macOS-only (Apple Silicon).
+    # CI runs on Linux where `mlx` is not available, so these modules cannot be tested there.
+    # TODO: Add a macOS CI job to run MLX tests and restore coverage for these modules.
+    mirascope/llm/providers/mlx/*
+
+    # Exclude Fern generated code
+    mirascope/api/_generated/*
+
+    # Exclude other top-level modules for now
+    mirascope/graphs/*
+    
+    # Exclude examples, tests, and scripts from coverage
+    examples/*
+    tests/*
+    scripts/*
+
+[report]
+# Show lines that weren't covered
+show_missing = True
+
+# Fail if coverage is below 100% for tracked files
+fail_under = 100
+
+# Exclude patterns from coverage analysis
+exclude_also =
+    pragma: no cover
+    def __repr__
+    if self.debug:
+    if settings.DEBUG
+    raise AssertionError
+    raise NotImplementedError
+    if __name__ == .__main__.:
+    class .*\bProtocol\):
+    @(abc\.)?abstractmethod
+    if TYPE_CHECKING:
+    @overload
+
+[html]
+directory = htmlcov

mirascope-2.0.0a4/.gitignore

@@ -0,0 +1,179 @@
+# pyenv
+.python-version
+.python-versions
+
+# Claude
+CLAUDE.md
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Mac
+.DS_Store
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+docs/**/*.html.md
+docs/llms.txt
+build/snippets/
+mkdocs.dev.yml
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+#sqlite
+database.db
+
+node_modules

mirascope-2.0.0a4/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.4
+Name: mirascope
+Version: 2.0.0a4
+Summary: LLM abstractions that aren't obstructions
+Project-URL: Homepage, https://mirascope.com
+Project-URL: Documentation, https://mirascope.com/docs/mirascope/v2
+Project-URL: Repository, https://github.com/Mirascope/mirascope/tree/v2
+Project-URL: Issues, https://github.com/Mirascope/mirascope/issues
+Project-URL: Changelog, https://github.com/Mirascope/mirascope/releases
+Author-email: William Bakst <william@mirascope.com>, Dandelion Mané <dandelion@mirascope.com>
+Maintainer-email: William Bakst <william@mirascope.com>, Dandelion Mané <dandelion@mirascope.com>
+License: MIT License
+        
+        Copyright (c) 2023 Mirascope, Inc.
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: agents,artificial intelligence,developer tools,llm,llm tools,prompt engineering
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: File Formats :: JSON
+Classifier: Topic :: File Formats :: JSON :: JSON Schema
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Requires-Dist: docstring-parser>=0.17.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: typing-extensions>=4.10.0
+Provides-Extra: all
+Requires-Dist: anthropic<1.0,>=0.75.0; extra == 'all'
+Requires-Dist: google-genai<2,>=1.48.0; extra == 'all'
+Requires-Dist: libcst>=1.8.6; extra == 'all'
+Requires-Dist: mcp<2,>=1.0.0; extra == 'all'
+Requires-Dist: mlx-lm<1,>=0.28.4; extra == 'all'
+Requires-Dist: openai<3,>=2.7.1; extra == 'all'
+Requires-Dist: opentelemetry-api<2,>=1.38.0; extra == 'all'
+Requires-Dist: opentelemetry-exporter-otlp<2,>=1.38.0; extra == 'all'
+Requires-Dist: opentelemetry-instrumentation<1,>=0.59b0; extra == 'all'
+Requires-Dist: opentelemetry-propagator-b3<2,>=1.38.0; extra == 'all'
+Requires-Dist: opentelemetry-propagator-b3>=1.38.0; extra == 'all'
+Requires-Dist: opentelemetry-propagator-jaeger>=1.38.0; extra == 'all'
+Requires-Dist: opentelemetry-sdk<2,>=1.38.0; extra == 'all'
+Requires-Dist: orjson>=3.11.4; extra == 'all'
+Requires-Dist: packaging>=25.0; extra == 'all'
+Requires-Dist: pillow<11,>=10.4.0; extra == 'all'
+Requires-Dist: proto-plus>=1.24.0; extra == 'all'
+Requires-Dist: pydantic-settings>=2.12.0; extra == 'all'
+Provides-Extra: anthropic
+Requires-Dist: anthropic<1.0,>=0.75.0; extra == 'anthropic'
+Provides-Extra: api
+Requires-Dist: pydantic-settings>=2.12.0; extra == 'api'
+Provides-Extra: google
+Requires-Dist: google-genai<2,>=1.48.0; extra == 'google'
+Requires-Dist: pillow<11,>=10.4.0; extra == 'google'
+Requires-Dist: proto-plus>=1.24.0; extra == 'google'
+Provides-Extra: mcp
+Requires-Dist: mcp<2,>=1.0.0; extra == 'mcp'
+Provides-Extra: mlx
+Requires-Dist: mlx-lm<1,>=0.28.4; extra == 'mlx'
+Provides-Extra: openai
+Requires-Dist: openai<3,>=2.7.1; extra == 'openai'
+Provides-Extra: ops
+Requires-Dist: libcst>=1.8.6; extra == 'ops'
+Requires-Dist: opentelemetry-api<2,>=1.38.0; extra == 'ops'
+Requires-Dist: opentelemetry-exporter-otlp<2,>=1.38.0; extra == 'ops'
+Requires-Dist: opentelemetry-instrumentation<1,>=0.59b0; extra == 'ops'
+Requires-Dist: opentelemetry-propagator-b3<2,>=1.38.0; extra == 'ops'
+Requires-Dist: opentelemetry-propagator-b3>=1.38.0; extra == 'ops'
+Requires-Dist: opentelemetry-propagator-jaeger>=1.38.0; extra == 'ops'
+Requires-Dist: opentelemetry-sdk<2,>=1.38.0; extra == 'ops'
+Requires-Dist: orjson>=3.11.4; extra == 'ops'
+Requires-Dist: packaging>=25.0; extra == 'ops'
+Description-Content-Type: text/markdown
+
+## Mirascope v2 Python
+
+This directory contains the Python implementation of Mirascope.
+
+## Development Setup
+
+1. **Environment Variables**: Copy `.env.example` to `.env` and fill in your API keys:
+   ```bash
+   cp .env.example .env
+   # Edit .env with your API keys
+   ```
+
+2. **Install Dependencies**:
+
+   ```bash
+   uv sync --all-extras --dev
+   ```
+
+3. **Run Tests**:
+   ```bash
+   uv run pytest
+   ```
+
+## `ops.span` and Session Tracing
+
+`mirascope.ops` provides tracing helpers to trace any Python function, not just
+`llm.Model` calls.
+
+1. Install the OTEL extra and set up a tracer provider exactly as shown above.
+   `ops.span` automatically reuses the active provider, so spans from manual
+   instrumentation and GenAI instrumentation end up in the same trace tree.
+2. Use `ops.session` to group related spans and attach metadata:
+   ```python
+   from mirascope import ops
+
+   with ops.session(id="req-42", attributes={"team": "core"}):
+       with ops.span("load-data") as span:
+           span.set(stage="ingest")
+           # expensive work here
+   ```
+3. The span exposes `span_id`/`trace_id`, logging helpers, and graceful no-op
+   behavior when OTEL is not configured. When OTEL is active, session metadata is
+   attached to every span, and additional tools like `ops.trace`/`ops.version`
+   (planned) can build on the same context.
+
+## `ops.trace` Decorator
+
+`@ops.trace` adds span instrumentation to any Python callable (including
+`llm.Model` helpers) so you can capture argument/return metadata alongside the
+GenAI spans emitted by `llm.instrument_opentelemetry`.
+
+```python
+from mirascope import ops
+
+@ops.trace(tags=["ingest"])
+def normalize(record: dict[str, str]) -> dict[str, str]:
+    return {k: v.strip() for k, v in record.items()}
+
+result = normalize({"foo": " bar "})
+wrapped = normalize.wrapped({"foo": " bar "})
+print(wrapped.span_id, wrapped.trace_id)
+```
+
+- The decorator automatically handles sync/async functions and reuses `ops.span`
+  serialization logic for arguments/results.
+- Combine with `ops.session` to tag spans with contextual metadata, and with
+  `ops.instrument_opentelemetry` to obtain both model-level GenAI spans
+  and method-level spans like `recommend_book.__call__`.
+- For now we focus on Mirascope-layer entry points (e.g., decorated functions or
+  `llm.Model` wrappers) and do not auto-instrument underlying provider SDK calls.
+
+## Testing
+
+### VCR Cassettes
+
+The project uses [VCR.py](https://vcrpy.readthedocs.io/) to record and replay HTTP interactions with LLM APIs. This allows tests to run quickly and consistently without making actual API calls.
+
+- **Cassettes Location**: Test cassettes are stored in `tests/llm/clients/*/cassettes/`
+- **Recording Mode**: Tests use `"once"` mode - records new interactions if no cassette exists, replays existing cassettes otherwise
+- **CI/CD**: In CI environments, tests use existing cassettes and never make real API calls
+
+### Inline Snapshots
+
+The project uses [inline-snapshot](https://15r10nk.github.io/inline-snapshot/) to capture expected test outputs directly in the test code.
+
+- **Update Snapshots**: Run `uv run pytest --inline-snapshot=fix` to update all snapshots with actual values
+- **Review Changes**: Run `uv run pytest --inline-snapshot=review` to preview what would change
+- **Formatted Output**: Snapshots are automatically formatted with `ruff` for consistency
+
+Example:
+```python
+def test_api_response():
+    response = client.call(messages=[user("Hello")])
+    assert response.content == snapshot([Text(text="Hi there!")])
+```
+
+### Recording New Test Interactions
+
+To record new test interactions:
+
+1. Ensure your API keys are set in `.env`
+2. Delete the relevant cassette file (if updating an existing test)
+3. Run the specific test: `uv run pytest tests/path/to/test.py::test_name`
+4. The cassette will be automatically created/updated

mirascope-2.0.0a4/README.md

@@ -0,0 +1,104 @@
+## Mirascope v2 Python
+
+This directory contains the Python implementation of Mirascope.
+
+## Development Setup
+
+1. **Environment Variables**: Copy `.env.example` to `.env` and fill in your API keys:
+   ```bash
+   cp .env.example .env
+   # Edit .env with your API keys
+   ```
+
+2. **Install Dependencies**:
+
+   ```bash
+   uv sync --all-extras --dev
+   ```
+
+3. **Run Tests**:
+   ```bash
+   uv run pytest
+   ```
+
+## `ops.span` and Session Tracing
+
+`mirascope.ops` provides tracing helpers to trace any Python function, not just
+`llm.Model` calls.
+
+1. Install the OTEL extra and set up a tracer provider exactly as shown above.
+   `ops.span` automatically reuses the active provider, so spans from manual
+   instrumentation and GenAI instrumentation end up in the same trace tree.
+2. Use `ops.session` to group related spans and attach metadata:
+   ```python
+   from mirascope import ops
+
+   with ops.session(id="req-42", attributes={"team": "core"}):
+       with ops.span("load-data") as span:
+           span.set(stage="ingest")
+           # expensive work here
+   ```
+3. The span exposes `span_id`/`trace_id`, logging helpers, and graceful no-op
+   behavior when OTEL is not configured. When OTEL is active, session metadata is
+   attached to every span, and additional tools like `ops.trace`/`ops.version`
+   (planned) can build on the same context.
+
+## `ops.trace` Decorator
+
+`@ops.trace` adds span instrumentation to any Python callable (including
+`llm.Model` helpers) so you can capture argument/return metadata alongside the
+GenAI spans emitted by `llm.instrument_opentelemetry`.
+
+```python
+from mirascope import ops
+
+@ops.trace(tags=["ingest"])
+def normalize(record: dict[str, str]) -> dict[str, str]:
+    return {k: v.strip() for k, v in record.items()}
+
+result = normalize({"foo": " bar "})
+wrapped = normalize.wrapped({"foo": " bar "})
+print(wrapped.span_id, wrapped.trace_id)
+```
+
+- The decorator automatically handles sync/async functions and reuses `ops.span`
+  serialization logic for arguments/results.
+- Combine with `ops.session` to tag spans with contextual metadata, and with
+  `ops.instrument_opentelemetry` to obtain both model-level GenAI spans
+  and method-level spans like `recommend_book.__call__`.
+- For now we focus on Mirascope-layer entry points (e.g., decorated functions or
+  `llm.Model` wrappers) and do not auto-instrument underlying provider SDK calls.
+
+## Testing
+
+### VCR Cassettes
+
+The project uses [VCR.py](https://vcrpy.readthedocs.io/) to record and replay HTTP interactions with LLM APIs. This allows tests to run quickly and consistently without making actual API calls.
+
+- **Cassettes Location**: Test cassettes are stored in `tests/llm/clients/*/cassettes/`
+- **Recording Mode**: Tests use `"once"` mode - records new interactions if no cassette exists, replays existing cassettes otherwise
+- **CI/CD**: In CI environments, tests use existing cassettes and never make real API calls
+
+### Inline Snapshots
+
+The project uses [inline-snapshot](https://15r10nk.github.io/inline-snapshot/) to capture expected test outputs directly in the test code.
+
+- **Update Snapshots**: Run `uv run pytest --inline-snapshot=fix` to update all snapshots with actual values
+- **Review Changes**: Run `uv run pytest --inline-snapshot=review` to preview what would change
+- **Formatted Output**: Snapshots are automatically formatted with `ruff` for consistency
+
+Example:
+```python
+def test_api_response():
+    response = client.call(messages=[user("Hello")])
+    assert response.content == snapshot([Text(text="Hi there!")])
+```
+
+### Recording New Test Interactions
+
+To record new test interactions:
+
+1. Ensure your API keys are set in `.env`
+2. Delete the relevant cassette file (if updating an existing test)
+3. Run the specific test: `uv run pytest tests/path/to/test.py::test_name`
+4. The cassette will be automatically created/updated

mirascope-2.0.0a4/examples/intro/context/decorator.py

@@ -0,0 +1,40 @@
+from mirascope import llm
+
+
+class Library:
+    available_books: list[str]
+    detailed_book_info: dict[str, str]
+
+
+@llm.tool()
+# [!code highlight:2]
+def get_book_info(ctx: llm.Context[Library], book: str) -> str:
+    return ctx.deps.detailed_book_info.get(book, "Book not found")
+
+
+@llm.call("openai/gpt-5", tools=[get_book_info])
+# [!code highlight:2]
+def librarian(ctx: llm.Context[Library], query: str):
+    book_list = "\n".join(ctx.deps.available_books)
+    return [
+        llm.messages.system(
+            f"You are a librarian, with access to these books: ${book_list}"
+        ),
+        llm.messages.user(query),
+    ]
+
+
+def main():
+    library = Library()
+    query = "Please recommend a mind-bending book from the library."
+    ctx = llm.Context(deps=library)  # [!code highlight]
+    response: llm.ContextResponse[Library] = librarian(ctx, query)  # [!code highlight]
+
+    while response.tool_calls:
+        tool_outputs = response.execute_tools(ctx)  # [!code highlight]
+        response = response.resume(ctx, tool_outputs)  # [!code highlight]
+
+    print(response.pretty())
+
+
+main()

mirascope-2.0.0a4/examples/intro/context/model.py

@@ -0,0 +1,41 @@
+from mirascope import llm
+
+
+class Library:
+    available_books: list[str]
+    detailed_book_info: dict[str, str]
+
+
+@llm.tool()
+# [!code highlight:2]
+def get_book_info(ctx: llm.Context[Library], book: str) -> str:
+    return ctx.deps.detailed_book_info.get(book, "Book not found")
+
+
+# [!code highlight:2]
+def librarian(ctx: llm.Context[Library], query: str):
+    model = llm.use_model("openai/gpt-5")
+    book_list = "\n".join(ctx.deps.available_books)
+    messages = [
+        llm.messages.system(
+            f"You are a librarian, with access to these books: ${book_list}"
+        ),
+        llm.messages.user(query),
+    ]
+    # [!code highlight:2]
+    return model.context_call(ctx=ctx, messages=messages, tools=[get_book_info])
+
+
+def main():
+    query = "Please recommend a mind-bending book from the library."
+    ctx = llm.Context(deps=Library())  # [!code highlight]
+    response: llm.ContextResponse[Library] = librarian(ctx, query)  # [!code highlight]
+
+    while response.tool_calls:
+        tool_outputs = response.execute_tools(ctx)  # [!code highlight]
+        response = response.resume(ctx, tool_outputs)  # [!code highlight]
+
+    print(response.pretty())
+
+
+main()

mirascope-2.0.0a4/examples/intro/decorator/async.py

@@ -0,0 +1,17 @@
+import asyncio
+
+from mirascope import llm
+
+
+@llm.call("openai/gpt-5")
+async def recommend_book(genre: str):
+    return f"Please recommend a book in {genre}."
+
+
+async def main():
+    response: llm.AsyncResponse = await recommend_book("fantasy")
+    print(response.pretty())
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

mirascope-2.0.0a4/examples/intro/decorator/async_stream.py

@@ -0,0 +1,18 @@
+import asyncio
+
+from mirascope import llm
+
+
+@llm.call("openai/gpt-5")
+async def recommend_book(genre: str):
+    return f"Please recommend a book in {genre}."
+
+
+async def main():
+    response: llm.AsyncStreamResponse = await recommend_book.stream("fantasy")
+    async for chunk in response.pretty_stream():
+        print(chunk, flush=True, end="")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

mirascope-2.0.0a4/examples/intro/decorator/stream.py

@@ -0,0 +1,15 @@
+from mirascope import llm
+
+
+@llm.call("openai/gpt-5")
+def recommend_book(genre: str):
+    return f"Please recommend a book in {genre}."
+
+
+def main():
+    response: llm.StreamResponse = recommend_book.stream("fantasy")
+    for chunk in response.pretty_stream():
+        print(chunk, flush=True, end="")
+
+
+main()

mirascope-2.0.0a4/examples/intro/decorator/sync.py

@@ -0,0 +1,14 @@
+from mirascope import llm
+
+
+@llm.call("openai/gpt-5")
+def recommend_book(genre: str):
+    return f"Please recommend a book in {genre}."
+
+
+def main():
+    response: llm.Response = recommend_book("fantasy")
+    print(response.pretty())
+
+
+main()