monty-haystack 1.0.0__py3-none-any.whl

haystack_integrations/tools/monty/__init__.py

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.tools.monty.python_tool import MontyPythonTool
+
+__all__ = ["MontyPythonTool"]

haystack_integrations/tools/monty/python_tool.py

@@ -0,0 +1,223 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import threading
+from typing import Any
+
+from haystack.core.serialization import generate_qualified_class_name
+from haystack.tools import Tool
+from pydantic_monty import (
+    CollectString,
+    Monty,
+    MontyCrashedError,
+    MontyRuntimeError,
+    MontySyntaxError,
+    MontyTypingError,
+    ResourceLimits,
+)
+
+_DEFAULT_RESOURCE_LIMITS: ResourceLimits = {"max_feed_duration_secs": 30.0, "max_memory": 256 * 1024 * 1024}
+
+_DEFAULT_DESCRIPTION = (
+    "Run Python code in an isolated sandbox and get back what it printed and the value of its last expression. "
+    "Use it for calculations, data processing, and anything else that is more reliable to compute than to guess.\n"
+    "- Every call starts a fresh interpreter: variables, functions, and imports from earlier calls are gone, so each "
+    "snippet must be self-contained.\n"
+    "- The sandbox has no file system, network, environment variables, or subprocesses, and no third-party packages. "
+    "Only these standard library modules can be imported, some of them partially: asyncio, base64, binascii, "
+    "collections, copy, dataclasses, datetime, functools, itertools, json, math, random, re, sys, time, typing, "
+    "unicodedata.\n"
+    "- The interpreter supports a subset of Python: functions, lambdas, closures, comprehensions, simple classes, "
+    "dataclasses, try/except, f-strings, and async/await. Class inheritance (including custom exception classes), "
+    "generators (`yield`), `match`, `del`, and method decorators such as `@property` or `@staticmethod` are not "
+    "supported.\n"
+    "- Use `print()` for intermediate output. Errors come back as a traceback, so you can fix the code and retry."
+)
+
+
+def _truncate(text: str, max_chars: int, *, keep_tail: bool = False) -> str:
+    if len(text) <= max_chars:
+        return text
+    note = f"[... {len(text) - max_chars} characters truncated]"
+    if keep_tail:
+        return f"{note}\n{text[-max_chars:]}"
+    return f"{text[:max_chars]}\n{note}"
+
+
+def _format_output(*, output: str, result: Any, error: str | None, max_chars: int) -> str:
+    """Render the printed output, the final expression value, and any error as text for the LLM."""
+    sections = []
+    if output:
+        sections.append(f"output:\n{_truncate(output.rstrip(), max_chars)}")
+    if result is not None:
+        sections.append(f"result:\n{_truncate(repr(result), max_chars)}")
+    if error is not None:
+        # The exception type and message are on the last line of a traceback, so keep the tail
+        sections.append(f"error:\n{_truncate(error, max_chars, keep_tail=True)}")
+    return "\n\n".join(sections) or "The code ran successfully and produced no output."
+
+
+class MontyPythonTool(Tool):
+    """
+    A Haystack `Tool` that lets an `Agent` run Python code in a [Monty](https://pydantic.dev/docs/monty/) sandbox.
+
+    Monty is a minimal Python interpreter written in Rust. The tool keeps a pool of Monty worker processes and runs
+    every call in a fresh interpreter, so nothing leaks between calls, users, or concurrent tool invocations. The
+    tool returns what the code printed, the `repr()` of its last expression, and any error as a traceback, so the
+    LLM can read the result and fix its code.
+
+    ### Security model
+
+    Monty is a language-level sandbox: its interpreter implements no operation that reaches the host, so code has
+    no access to files, the network, environment variables, or subprocesses. It runs in worker subprocesses started
+    with an empty environment, so a crash never takes down the host process. The tool mounts no directories and
+    exposes no host functions to the sandbox. Execution time and heap memory are capped by `resource_limits`.
+
+    ### Usage example
+
+    ```python
+    from haystack.components.agents import Agent
+    from haystack.components.generators.chat import OpenAIChatGenerator
+    from haystack.dataclasses import ChatMessage
+    from haystack_integrations.tools.monty import MontyPythonTool
+
+    # Requires the OPENAI_API_KEY environment variable
+    agent = Agent(chat_generator=OpenAIChatGenerator(), tools=[MontyPythonTool()])
+    result = agent.run(messages=[ChatMessage.from_user("What is the sum of the first 100 prime numbers?")])
+    print(result["last_message"].text)
+    # >> The sum of the first 100 prime numbers is 24133.
+    ```
+    """
+
+    def __init__(
+        self,
+        *,
+        name: str = "run_python",
+        description: str | None = None,
+        resource_limits: ResourceLimits | None = None,
+        type_check: bool = False,
+        max_output_chars: int = 20_000,
+    ) -> None:
+        """
+        Create a MontyPythonTool.
+
+        :param name: Tool name exposed to the LLM.
+        :param description: Tool description exposed to the LLM. If `None`, a description of the sandbox and the
+            supported Python subset is used.
+        :param resource_limits: Monty resource limits for each call, merged over the defaults of 30 seconds of
+            execution time (`max_feed_duration_secs`) and 256 MiB of heap memory (`max_memory`). Set a key to `None`
+            to disable that limit. See `pydantic_monty.ResourceLimits` for the available keys.
+        :param type_check: If `True`, type-check the code with Monty's bundled type checker before running it, and
+            return type errors to the LLM instead of executing the code.
+        :param max_output_chars: Maximum number of characters kept from each of the printed output, the result, and
+            the error before they are returned to the LLM. The output and the result keep their beginning, the error
+            keeps its end, where the exception is.
+        :raises ValueError: If `resource_limits` contains a key that Monty doesn't support, or `max_output_chars` is
+            less than 1.
+        """
+        unknown_limits = set(resource_limits or {}) - set(ResourceLimits.__annotations__)
+        if unknown_limits:
+            msg = (
+                f"Unknown resource limits: {sorted(unknown_limits)}. "
+                f"Supported keys are: {sorted(ResourceLimits.__annotations__)}."
+            )
+            raise ValueError(msg)
+        if max_output_chars < 1:
+            msg = f"max_output_chars must be at least 1, got {max_output_chars}."
+            raise ValueError(msg)
+
+        self._resource_limits: ResourceLimits = {**_DEFAULT_RESOURCE_LIMITS}
+        self._resource_limits.update(resource_limits or {})
+        self._type_check = type_check
+        self._max_output_chars = max_output_chars
+        self._pool: Monty | None = None
+        self._pool_lock = threading.Lock()
+
+        parameters = {
+            "type": "object",
+            "properties": {
+                "code": {
+                    "type": "string",
+                    "description": "The Python code to run. The value of the last expression is returned.",
+                }
+            },
+            "required": ["code"],
+        }
+        super().__init__(
+            name=name,
+            description=description or _DEFAULT_DESCRIPTION,
+            parameters=parameters,
+            function=self._invoke,
+        )
+
+    def warm_up(self) -> None:
+        """Start the pool of Monty worker processes. Called by `Agent.warm_up()`; safe to call more than once."""
+        self._get_pool()
+
+    def close(self) -> None:
+        """
+        Shut down the pool of Monty worker processes.
+
+        Safe to call more than once. The tool starts a new pool if it is invoked again.
+        """
+        with self._pool_lock:
+            if self._pool is not None:
+                self._pool.__exit__(None, None, None)
+                self._pool = None
+
+    def _get_pool(self) -> Monty:
+        with self._pool_lock:
+            if self._pool is None:
+                pool = Monty()
+                # Monty only exposes its pool lifecycle as a context manager. The tool keeps the pool open across
+                # calls, so it enters the context here and exits it in `close()`.
+                pool.__enter__()
+                self._pool = pool
+            return self._pool
+
+    def _invoke(self, code: str) -> str:
+        pool = self._get_pool()
+        collector = CollectString()
+        result = None
+        error = None
+        try:
+            with pool.checkout(limits=self._resource_limits, type_check=self._type_check) as session:
+                result = session.feed_run(code, print_callback=collector)
+        except (MontySyntaxError, MontyRuntimeError, MontyTypingError) as e:
+            error = e.display()
+        except MontyCrashedError as e:
+            # Code stuck inside a long-running builtin, such as a huge integer power, can't be interrupted by the
+            # sandbox's own time limit; the pool then kills the worker and replaces it.
+            if e.timed_out:
+                error = f"TimeoutError: the code exceeded the time limit and the sandbox was stopped ({e})"
+            else:
+                error = f"The sandbox process crashed and was restarted ({e})"
+        return _format_output(output=collector.output, result=result, error=error, max_chars=self._max_output_chars)
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serialize the tool to a dictionary.
+
+        :returns: Dictionary with serialized data.
+        """
+        return {
+            "type": generate_qualified_class_name(type(self)),
+            "data": {
+                "name": self.name,
+                "description": self.description,
+                "resource_limits": self._resource_limits,
+                "type_check": self._type_check,
+                "max_output_chars": self._max_output_chars,
+            },
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "MontyPythonTool":
+        """
+        Deserialize the tool from a dictionary.
+
+        :param data: Dictionary to deserialize from.
+        :returns: Deserialized tool.
+        """
+        return cls(**data["data"])

monty_haystack-1.0.0.dist-info/METADATA

@@ -0,0 +1,38 @@
+Metadata-Version: 2.5
+Name: monty-haystack
+Version: 1.0.0
+Summary: Sandboxed Python code execution tool for Haystack Agents, powered by Pydantic Monty
+Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/monty#readme
+Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
+Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/monty
+Author-email: deepset GmbH <info@deepset.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Keywords: agents,code-execution,haystack,monty,pydantic,sandbox,tools
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+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: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.10
+Requires-Dist: haystack-ai>=3.0.0
+Requires-Dist: pydantic-monty>=1.0.0
+Description-Content-Type: text/markdown
+
+# monty-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/monty-haystack.svg)](https://pypi.org/project/monty-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/monty-haystack.svg)](https://pypi.org/project/monty-haystack)
+
+- [Integration page](https://haystack.deepset.ai/integrations/monty)
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/monty/CHANGELOG.md)
+
+---
+
+## Contributing
+
+Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).

monty_haystack-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+haystack_integrations/tools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/tools/monty/__init__.py,sha256=Io9VQ-1Pu6Tna-bCsbZ1dm7rgWSanA_HDRF-V8z_TSM,216
+haystack_integrations/tools/monty/python_tool.py,sha256=-Jrh57t1lq1I_7RWY78SxgGZzPjmFelN16DflSLf64U,10043
+monty_haystack-1.0.0.dist-info/METADATA,sha256=xTj95d0or5gsiJxBbC2KRh3UREnHmdtTxkMTpaMhtF4,1843
+monty_haystack-1.0.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+monty_haystack-1.0.0.dist-info/licenses/LICENSE.txt,sha256=OrAtTu4aPmrTjKDSTzkSPgo_ji6NOMWO2N9JOTFyAzM,11350
+monty_haystack-1.0.0.dist-info/RECORD,,

monty_haystack-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

monty_haystack-1.0.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023-present deepset GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.