fabricatio 0.2.0.dev10__cp312-cp312-manylinux_2_34_x86_64.whl → 0.2.0.dev12__cp312-cp312-manylinux_2_34_x86_64.whl

fabricatio/__init__.py

@@ -1,7 +1,6 @@
 """Fabricatio is a Python library for building llm app using event-based agent structure."""
 
-from fabricatio._rust import TemplateManager
-from fabricatio.config import configs
+from fabricatio._rust_instances import template_manager
 from fabricatio.core import env
 from fabricatio.fs import magika
 from fabricatio.journal import logger
@@ -13,8 +12,6 @@ from fabricatio.models.tool import ToolBox
 from fabricatio.models.utils import Message, Messages
 from fabricatio.parser import Capture, CodeBlockCapture, JsonCapture, PythonCapture
 
-template_manager = TemplateManager(configs.code2prompt.template_dir)
-
 __all__ = [
     "Action",
     "Capture",
@@ -31,5 +28,5 @@ __all__ = [
     "env",
     "logger",
     "magika",
-    "template_manager"
+    "template_manager",
 ]

fabricatio/_rust_instances.py

@@ -0,0 +1,4 @@
+from fabricatio._rust import TemplateManager
+from fabricatio.config import configs
+
+template_manager = TemplateManager(configs.code2prompt.template_dir)

fabricatio/decorators.py

@@ -19,30 +19,9 @@ def depend_on_external_cmd[**P, R](bin_name: str, install_tip: str) -> Callable[
         RuntimeError: If the required binary is not found.
     """
 
-    def decorator(func: Callable[P, R]) -> Callable[P, R]:
-        """Decorator to wrap the function with binary presence check.
-
-        Args:
-            func (Callable[P, R]): The function to be decorated.
-
-        Returns:
-            Callable[P, R]: The wrapped function.
-        """
-
+    def _decorator(func: Callable[P, R]) -> Callable[P, R]:
         @wraps(func)
-        def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
-            """Wrapper function to check for the presence of the required binary.
-
-            Args:
-                *args: Positional arguments for the function.
-                **kwargs: Keyword arguments for the function.
-
-            Returns:
-                R: The result of the function call.
-
-            Raises:
-                RuntimeError: If the required binary is not found.
-            """
+        def _wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
             if which(bin_name) is None:
                 err = (
                     f"{bin_name} is required to run function: {func.__name__}, please install it first.\n{install_tip}"
@@ -51,6 +30,6 @@ def depend_on_external_cmd[**P, R](bin_name: str, install_tip: str) -> Callable[
                 raise RuntimeError(err)
             return func(*args, **kwargs)
 
-        return wrapper
+        return _wrapper
 
-    return decorator
+    return _decorator

fabricatio/models/action.py

@@ -123,6 +123,5 @@ class WorkFlow[A: Type[Action] | Action](WithBriefing, LLMUsage):
 
     def fallback_to_self(self) -> Self:
         """Set the fallback for each step to the workflow itself."""
-        for step in self._instances:
-            step.fallback_to(self)
+        self.hold_to(self._instances)
         return self

fabricatio/models/generic.py

@@ -1,13 +1,15 @@
 """This module defines generic classes for models in the Fabricatio library."""
 
 from pathlib import Path
-from typing import Callable, Dict, List, Optional, Self
+from typing import Callable, Dict, Iterable, List, Optional, Self, Union
 
 import litellm
 import orjson
+from fabricatio._rust_instances import template_manager
 from fabricatio.config import configs
 from fabricatio.fs.readers import magika
 from fabricatio.models.utils import Messages
+from fabricatio.parser import JsonCapture
 from litellm.types.utils import Choices, ModelResponse, StreamingChoices
 from pydantic import (
     BaseModel,
@@ -274,21 +276,90 @@ class LLMUsage(Base):
         for _ in range(max_validations):
             if (
                 response := await self.aask(
-                    question,
-                    system_message,
-                    model,
-                    temperature,
-                    stop,
-                    top_p,
-                    max_tokens,
-                    stream,
-                    timeout,
-                    max_retries,
+                    question=question,
+                    system_message=system_message,
+                    model=model,
+                    temperature=temperature,
+                    stop=stop,
+                    top_p=top_p,
+                    max_tokens=max_tokens,
+                    stream=stream,
+                    timeout=timeout,
+                    max_retries=max_retries,
                 )
             ) and (validated := validator(response)):
                 return validated
         raise ValueError("Failed to validate the response.")
 
+    async def achoose[T: WithBriefing](
+        self,
+        instruction: str,
+        choices: List[T],
+        max_validations: PositiveInt = 2,
+        system_message: str = "",
+        model: str | None = None,
+        temperature: NonNegativeFloat | None = None,
+        stop: str | List[str] | None = None,
+        top_p: NonNegativeFloat | None = None,
+        max_tokens: PositiveInt | None = None,
+        stream: bool | None = None,
+        timeout: PositiveInt | None = None,
+        max_retries: PositiveInt | None = None,
+    ) -> List[T]:
+        """Asynchronously executes a multi-choice decision-making process, generating a prompt based on the instruction and options, and validates the returned selection results.
+
+        Args:
+            instruction: The user-provided instruction/question description.
+            choices: A list of candidate options, requiring elements to have `name` and `briefing` fields.
+            max_validations: Maximum number of validation failures, default is 2.
+            system_message: Custom system-level prompt, defaults to an empty string.
+            model: The name of the LLM model to use.
+            temperature: Sampling temperature to control randomness in generation.
+            stop: Stop condition string or list for generation.
+            top_p: Core sampling probability threshold.
+            max_tokens: Maximum token limit for the generated result.
+            stream: Whether to enable streaming response mode.
+            timeout: Request timeout in seconds.
+            max_retries: Maximum number of retries.
+
+        Returns:
+            List[T]: The final validated selection result list, with element types matching the input `choices`.
+
+        Important:
+            - Uses a template engine to generate structured prompts.
+            - Ensures response compliance through JSON parsing and format validation.
+            - Relies on `aask_validate` to implement retry mechanisms with validation.
+        """
+        prompt = template_manager.render_template(
+            "make_choice",
+            {"instruction": instruction, "options": [m.model_dump(include={"name", "briefing"}) for m in choices]},
+        )
+        names = [c.name for c in choices]
+
+        def _validate(response: str) -> List[T] | None:
+            cap = JsonCapture.capture(response)
+            ret = orjson.loads(cap)
+            if not isinstance(ret, List):
+                return None
+            if any(n not in names for n in ret):
+                return None
+            return ret
+
+        return await self.aask_validate(
+            question=prompt,
+            validator=_validate,
+            max_validations=max_validations,
+            system_message=system_message,
+            model=model,
+            temperature=temperature,
+            stop=stop,
+            top_p=top_p,
+            max_tokens=max_tokens,
+            stream=stream,
+            timeout=timeout,
+            max_retries=max_retries,
+        )
+
     def fallback_to(self, other: "LLMUsage") -> Self:
         """Fallback to another instance's attribute values if the current instance's attributes are None.
 
@@ -298,23 +369,9 @@ class LLMUsage(Base):
         Returns:
             Self: The current instance, allowing for method chaining.
         """
-        # Define the list of attribute names to check and potentially copy
-        attr_names = [
-            "llm_api_endpoint",
-            "llm_api_key",
-            "llm_model",
-            "llm_stop_sign",
-            "llm_temperature",
-            "llm_top_p",
-            "llm_generation_count",
-            "llm_stream",
-            "llm_max_tokens",
-            "llm_timeout",
-            "llm_max_retries",
-        ]
-
         # Iterate over the attribute names and copy values from 'other' to 'self' where applicable
-        for attr_name in attr_names:
+        # noinspection PydanticTypeChecker,PyTypeChecker
+        for attr_name in LLMUsage.model_fields:
             # Copy the attribute value from 'other' to 'self' only if 'self' has None and 'other' has a non-None value
             if getattr(self, attr_name) is None and (attr := getattr(other, attr_name)) is not None:
                 setattr(self, attr_name, attr)
@@ -322,6 +379,21 @@ class LLMUsage(Base):
         # Return the current instance to allow for method chaining
         return self
 
+    def hold_to(self, others: Union["LLMUsage", Iterable["LLMUsage"]]) -> Self:
+        """Hold to another instance's attribute values if the current instance's attributes are None.
+
+        Args:
+            others (LLMUsage | Iterable[LLMUsage]): Another instance or iterable of instances from which to copy attribute values.
+
+        Returns:
+            Self: The current instance, allowing for method chaining.
+        """
+        for other in others:
+            # noinspection PyTypeChecker,PydanticTypeChecker
+            for attr_name in LLMUsage.model_fields:
+                if (attr := getattr(self, attr_name)) is not None and getattr(other, attr_name) is None:
+                    setattr(other, attr_name, attr)
+
 
 class WithJsonExample(Base):
     """Class that provides a JSON schema for the model."""

fabricatio/models/task.py

@@ -7,6 +7,7 @@ from asyncio import Queue
 from enum import Enum
 from typing import Any, List, Optional, Self
 
+from fabricatio._rust_instances import template_manager
 from fabricatio.core import env
 from fabricatio.journal import logger
 from fabricatio.models.events import Event, EventLike
@@ -273,11 +274,9 @@ class ProposeTask(LLMUsage, WithBriefing):
                 logger.error(f"Failed to parse task from JSON: {e}")
                 return None
 
+        template_data = {"prompt": prompt, "json_example": Task.json_example()}
         return await self.aask_validate(
-            f"{prompt} \n\nBased on requirement above, "
-            f"you need to construct a task to satisfy that requirement in JSON format "
-            f"written like this: \n\n```json\n{Task.json_example()}\n```\n\n"
-            f"No extra explanation needed. ",
+            template_manager.render_template("propose_task", template_data),
             _validate_json,
             system_message=f"# your personal briefing: \n{self.briefing}",
         )

fabricatio/models/tool.py

@@ -1,9 +1,9 @@
 """A module for defining tools and toolboxes."""
 
-from inspect import getfullargspec, signature
-from typing import Any, Callable, List, Self
+from inspect import iscoroutinefunction, signature
+from typing import Any, Callable, Iterable, List, Optional, Self, Union
 
-from fabricatio.models.generic import WithBriefing
+from fabricatio.models.generic import Base, WithBriefing
 from pydantic import Field
 
 
@@ -24,6 +24,7 @@ class Tool[**P, R](WithBriefing):
         self.name = self.name or self.source.__name__
         assert self.name, "The tool must have a name."
         self.description = self.description or self.source.__doc__ or ""
+        self.description = self.description.strip()
 
     def invoke(self, *args: P.args, **kwargs: P.kwargs) -> R:
         """Invoke the tool's source function with the provided arguments."""
@@ -36,10 +37,15 @@ class Tool[**P, R](WithBriefing):
         Returns:
             str: A brief description of the tool.
         """
-        source_signature = str(signature(self.source))
         # 获取源函数的返回类型
-        return_annotation = getfullargspec(self.source).annotations.get("return", "None")
-        return f"{self.name}{source_signature} -> {return_annotation}\n{self.description}"
+
+        return f"{'async ' if iscoroutinefunction(self.source) else ''}def {self.name}{signature(self.source)}\n{_desc_wrapper(self.description)}"
+
+
+def _desc_wrapper(desc: str) -> str:
+    lines = desc.split("\n")
+    lines_indent = [f"    {line}" for line in ['"""', *lines, '"""']]
+    return "\n".join(lines_indent)
 
 
 class ToolBox(WithBriefing):
@@ -79,7 +85,7 @@ class ToolBox(WithBriefing):
         Returns:
             str: A brief description of the toolbox.
         """
-        list_out = "\n\n".join([f"- {tool.briefing}" for tool in self.tools])
+        list_out = "\n\n".join([f"{tool.briefing}" for tool in self.tools])
         toc = f"## {self.name}: {self.description}\n## {len(self.tools)} tools available:"
         return f"{toc}\n\n{list_out}"
 
@@ -98,3 +104,42 @@ class ToolBox(WithBriefing):
         tool = next((tool for tool in self.tools if tool.name == name), None)
         assert tool, f"No tool named {name} found."
         return tool
+
+
+class ToolUsage(Base):
+    """A class representing the usage of tools in a task."""
+
+    toolboxes: Optional[List[ToolBox]]
+    """The tools used by the task, a list of ToolBox instances."""
+
+    def supply_tools_from(self, others: Union["ToolUsage", Iterable["ToolUsage"]]) -> Self:
+        """Supplies tools from other ToolUsage instances to this instance.
+
+        Args:
+            others ("ToolUsage" | Iterable["ToolUsage"]): A single ToolUsage instance or an iterable of ToolUsage instances
+                from which to take tools.
+
+        Returns:
+            Self: The current ToolUsage instance with updated tools.
+        """
+        if isinstance(others, ToolUsage):
+            others = [others]
+        for other in others:
+            self.toolboxes.extend(other.toolboxes)
+        return self
+
+    def provide_tools_to(self, others: Union["ToolUsage", Iterable["ToolUsage"]]) -> Self:
+        """Provides tools from this instance to other ToolUsage instances.
+
+        Args:
+            others ("ToolUsage" | Iterable["ToolUsage"]): A single ToolUsage instance or an iterable of ToolUsage instances
+                to which to provide tools.
+
+        Returns:
+            Self: The current ToolUsage instance.
+        """
+        if isinstance(others, ToolUsage):
+            others = [others]
+        for other in others:
+            other.toolboxes.extend(self.toolboxes)
+        return self

fabricatio/parser.py

@@ -3,13 +3,11 @@
 from typing import Any, Self, Tuple
 
 import regex
-from pydantic import Field, PositiveInt, PrivateAttr
+from pydantic import BaseModel, ConfigDict, Field, PositiveInt, PrivateAttr
 from regex import Pattern, compile
 
-from fabricatio.models.generic import Base
 
-
-class Capture(Base):
+class Capture(BaseModel):
     """A class to capture patterns in text using regular expressions.
 
     Attributes:
@@ -17,6 +15,7 @@ class Capture(Base):
         _compiled (Pattern): The compiled regular expression pattern.
     """
 
+    model_config = ConfigDict(use_attribute_docstrings=True)
     target_groups: Tuple[int, ...] = Field(default_factory=tuple)
     """The target groups to capture from the pattern."""
     pattern: str = Field(frozen=True)

fabricatio/toolboxes/arithmetic.py

@@ -0,0 +1,60 @@
+from fabricatio.models.tool import ToolBox
+
+arithmetic_tools = ToolBox(name="ArithmeticToolBox", description="A toolbox for arithmetic operations.")
+
+
+@arithmetic_tools.collect_tool
+def add(a: float, b: float) -> float:
+    """Add two numbers.
+
+    Args:
+        a (float): The first number.
+        b (float): The second number.
+
+    Returns:
+        float: The sum of the two numbers.
+    """
+    return a + b
+
+
+@arithmetic_tools.collect_tool
+def subtract(a: float, b: float) -> float:
+    """Subtract two numbers.
+
+    Args:
+        a (float): The first number.
+        b (float): The second number.
+
+    Returns:
+        float: The result of subtracting b from a.
+    """
+    return a - b
+
+
+@arithmetic_tools.collect_tool
+def multiply(a: float, b: float) -> float:
+    """Multiply two numbers.
+
+    Args:
+        a (float): The first number.
+        b (float): The second number.
+
+    Returns:
+        float: The product of the two numbers.
+    """
+    return a * b
+
+
+@arithmetic_tools.collect_tool
+def divide(a: float, b: float) -> float:
+    """Divide two numbers.
+
+    Args:
+        a (float): The numerator.
+        b (float): The denominator (must not be zero).
+
+    Returns:
+        float: The result of dividing a by b.
+
+    """
+    return a / b

{fabricatio-0.2.0.dev10.dist-info → fabricatio-0.2.0.dev12.dist-info}/METADATA

@@ -1,7 +1,8 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.0.dev10
+Version: 0.2.0.dev12
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Framework :: AsyncIO
@@ -23,7 +24,7 @@ Requires-Dist: regex>=2024.11.6
 Requires-Dist: rich>=13.9.4
 License-File: LICENSE
 Summary: A LLM multi-agent framework.
-Keywords: ai,agents,multi-agent,llm
+Keywords: ai,agents,multi-agent,llm,pyo3
 Author-email: Whth <zettainspector@foxmail.com>
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

{fabricatio-0.2.0.dev10.dist-info → fabricatio-0.2.0.dev12.dist-info}/RECORD

@@ -1,28 +1,30 @@
-fabricatio-0.2.0.dev10.dist-info/METADATA,sha256=oobQLrDqEDfEOGsTLMYfzJ6oH3UrbUbHQpCHZIsOoUg,5778
-fabricatio-0.2.0.dev10.dist-info/WHEEL,sha256=RIvmwLDYujv60MYBx2jxyP4vdn1DD7X0kBgz1TQvZuc,108
-fabricatio-0.2.0.dev10.dist-info/licenses/LICENSE,sha256=yDZaTLnOi03bi3Dk6f5IjhLUc5old2yOsihHWU0z-i0,1067
+fabricatio-0.2.0.dev12.dist-info/METADATA,sha256=gWEeKNwVXLETbzTMO9Qd2rkbN_TLH4sdpedRVvW8myc,5824
+fabricatio-0.2.0.dev12.dist-info/WHEEL,sha256=RIvmwLDYujv60MYBx2jxyP4vdn1DD7X0kBgz1TQvZuc,108
+fabricatio-0.2.0.dev12.dist-info/licenses/LICENSE,sha256=yDZaTLnOi03bi3Dk6f5IjhLUc5old2yOsihHWU0z-i0,1067
 fabricatio/fs/__init__.py,sha256=bYE9r8uR0dtknzbg_YaGv_6Wwa27ntkQt0Tl7Kb3HFI,117
 fabricatio/fs/readers.py,sha256=E219Pef7gknltkHjL9iZXwjI841_EPFpNvDG9KBUG3g,118
 fabricatio/toolboxes/__init__.py,sha256=8gd8yPhhQBO0A37w1zqVLfbOG-pyCPrveEtO0MX042A,151
 fabricatio/toolboxes/task.py,sha256=G_nNYT8Sy5ll6YmXES458MUmgJnDSBNwlozyJewdnzY,200
-fabricatio/__init__.py,sha256=ExoKVER1_6bVoTzT9d7LET7HlHYQ4xLoGN9foRX1CnU,977
+fabricatio/toolboxes/arithmetic.py,sha256=MbS1-a4uLGqs7ZypH2dtrTa0d2-Rr8ifok-1mrVfVb4,1257
+fabricatio/__init__.py,sha256=UE2qARwRgL3T1NgnzK9b4Cx3eksUvNZmN_rf-dycM4E,881
 fabricatio/core.py,sha256=apwXgI94DCWpGujGlsmXsTZQvJOQMB9llmuUo7ohd-4,5771
 fabricatio/config.py,sha256=Or_PzOzXy_4Rqje1r788sID4bxILXhNC3r7eelcZJy0,7852
-fabricatio/decorators.py,sha256=Y2F5JuN3K5Pas_JPBLQrB_Np0s1U8k2lPvrdtCHtcRE,1799
+fabricatio/decorators.py,sha256=UgW8_pV_RUm0a69co1POnKvJHh9Qy2R0pyh1BtEKzFI,1169
 fabricatio/journal.py,sha256=u6YTKrD9EoebbR8guvAe5zSqWV1nS-BGyKxZR_Sw2ik,684
-fabricatio/models/generic.py,sha256=1S5guUWnHSpoyNi1D1t4q14e6YNIovI4Goc3kizHd8M,15698
-fabricatio/models/action.py,sha256=PNcm4t34fSaI03ECIOZ8ezvB6PlZkNhJtZFEhtU0Gec,4916
-fabricatio/models/task.py,sha256=W66bRf6au6ysS_ypZ3i4W1mL-WhotfvbhbjX-3CrBj4,9146
+fabricatio/models/generic.py,sha256=Q92xkAL1S8zWMCGDUNQahT9atFamZKhHzKbI1OXjBmk,19264
+fabricatio/models/action.py,sha256=VL_A8BWOuCYQCjwCAm0vExA88KSwm6VkluXHOtHijUw,4882
+fabricatio/models/task.py,sha256=-YB9SGqOYrPmk7ce5Go3OO5Cc7Q_KB7QdmeG49GeZpY,9090
 fabricatio/models/role.py,sha256=1vhpHRKJ6f7PDBLl6jYRZbxTJyrVhNN3FEEh_HAwU3o,990
-fabricatio/models/tool.py,sha256=jzH34UHIgqEwYdXOQ3Jz_TN0cyj_jLTVBVs0qGl9tQU,3299
+fabricatio/models/tool.py,sha256=PCsX5hdf6YnslkyoPA8FwybGvrO0fJFJpHsheBwg2bo,4886
 fabricatio/models/events.py,sha256=S0E7l5iQoJYdUn0pSSziHdXqPzIvvLy8ifVPQxXeAho,2570
 fabricatio/models/utils.py,sha256=u-eR_v-o0BSFSmCprP3mOyAO-WOyg_P68jjzLjyit_w,2457
 fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fabricatio/_rust_instances.py,sha256=c3aB95D7qKrA1AxDHD94lYinklAmK5EL6_DDJUEzPB0,153
 fabricatio/actions/__init__.py,sha256=eLa_5ACZ-FqdrLtOfCHk5nQBxzhIs1kgMIXWmkm2P8Y,110
 fabricatio/actions/communication.py,sha256=4hNzyv5_j4HU291dDuBmBEb66VihQPI9SLRVZrxWu1Y,412
 fabricatio/actions/transmission.py,sha256=gLLKoi4keL64uaEkHDxwVrBGciheupQrO2fW3GkjfEw,1156
 fabricatio/_rust.pyi,sha256=EwMPoCZFOCYZ5h_9PZLvO3YrgBEG0Hwae0ux0hcBabM,1487
-fabricatio/parser.py,sha256=2wFvkyAIlFyB_dj8txr6shc-0ik5cz0mUy_Yj_GrqcI,2355
-fabricatio/_rust.cpython-312-x86_64-linux-gnu.so,sha256=zSQ7Y-Hp7TDAzKenBEEWirLdaVturuUyGbNn1oXtRYs,1191136
-fabricatio-0.2.0.dev10.data/scripts/tdown,sha256=jyItwd3z9dBoOT6EEA3niK0e7AXhhBnL87-T0IBRkYk,4540840
-fabricatio-0.2.0.dev10.dist-info/RECORD,,
+fabricatio/parser.py,sha256=CAI7S3u2xI_-s1JWb4v2GkhiNeX1kr_C2olxy98KLR8,2400
+fabricatio/_rust.cpython-312-x86_64-linux-gnu.so,sha256=JUDe4N51fXgkY7c-vEXnFJaTBWzwwh93AwJPk_QWoGE,1190824
+fabricatio-0.2.0.dev12.data/scripts/tdown,sha256=7IEbm2H2hkcCNmm8b4BEfHtnauc5oO9fIiGn_UXYb3M,4549648
+fabricatio-0.2.0.dev12.dist-info/RECORD,,