fabricatio 0.2.0.dev11__cp312-cp312-win_amd64.whl → 0.2.0.dev12__cp312-cp312-win_amd64.whl

fabricatio/__init__.py

@@ -28,5 +28,5 @@ __all__ = [
     "env",
     "logger",
     "magika",
-    "template_manager"
+    "template_manager",
 ]

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

@@ -274,10 +274,7 @@ 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()
-        }
+        template_data = {"prompt": prompt, "json_example": Task.json_example()}
         return await self.aask_validate(
             template_manager.render_template("propose_task", template_data),
             _validate_json,

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.dev11.dist-info → fabricatio-0.2.0.dev12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.0.dev11
+Version: 0.2.0.dev12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12

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

@@ -1,29 +1,30 @@
-fabricatio-0.2.0.dev11.dist-info/METADATA,sha256=YbNXgr1d-MFCEAUePsKUxcv4vsfok3Q_wIcqbgYn0TA,6017
-fabricatio-0.2.0.dev11.dist-info/WHEEL,sha256=tpW5AN9B-9qsM9WW2FXG2r193YXiqexDadpKp0A2daI,96
-fabricatio-0.2.0.dev11.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio-0.2.0.dev12.dist-info/METADATA,sha256=YEajxaRO-nlzAs-7NthqNeuxmcT2qjYECILk1gKZBSw,6017
+fabricatio-0.2.0.dev12.dist-info/WHEEL,sha256=tpW5AN9B-9qsM9WW2FXG2r193YXiqexDadpKp0A2daI,96
+fabricatio-0.2.0.dev12.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
 fabricatio/actions/communication.py,sha256=tmsr3H_w-V-b2WxLEyWByGuwSCLgHIHTdHYAgHrdUxc,425
 fabricatio/actions/transmission.py,sha256=PedZ6XsflKdT5ikzaqWr_6h8jci0kekAHfwygzKBUns,1188
 fabricatio/actions/__init__.py,sha256=eFmFVPQvtNgFynIXBVr3eP-vWQDWCPng60YY5LXvZgg,115
 fabricatio/config.py,sha256=wArRP1n3QIRwGjZOgAezdYwMYqhsrxz3D_biXAZjB28,8057
 fabricatio/core.py,sha256=yQK2ZrbPYDJOaNDp0Bky3muTkB-ZaQ1ld_Qfflm2dY0,5938
-fabricatio/decorators.py,sha256=Qsyb-_cDwtXY5yhyLrYZEAlrHh5ZuEooQ8vEOUAxj8k,1855
+fabricatio/decorators.py,sha256=0b8UeW6V1X6EYRgnvFlWymYOSc4nZBQNVly64JucKeY,1204
 fabricatio/fs/readers.py,sha256=mw0VUH3P7Wk0SMlcQm2yOfjEz5C3mQ_kjduAjecaxgY,123
 fabricatio/fs/__init__.py,sha256=lWcKYg0v3mv2LnnSegOQaTtlVDODU0vtw_s6iKU5IqQ,122
 fabricatio/journal.py,sha256=z5K5waad9xmGr1hGrqSgFDRH3wiDQ5Oqfe0o98DaM-k,707
-fabricatio/models/action.py,sha256=-kTWzUGIkZygy3tqcrEBQvboEJx2-PGAQR0C0ZqERRE,5044
+fabricatio/models/action.py,sha256=5s3pgFav3AOeZzzAoFAyL3f-uiHIpEE86W_w0qC2YIM,5009
 fabricatio/models/events.py,sha256=DDdcexweKV7jmPLHx51PIQ6eIByRrFyAMyx2VMhl9JY,2650
-fabricatio/models/generic.py,sha256=CtC6xzSbZr1oQUwswlHVeEbf3pXuS0Q7Qo-e0S_2Zp4,16086
+fabricatio/models/generic.py,sha256=TqfVFxEm56l3LiIN4m4WS9CylzQacGfYGElkItkhF3A,19724
 fabricatio/models/role.py,sha256=sgsympwkp6HIbWkaAt4gMU2WdVO-bHwX0Gy6DNyhoLA,1016
-fabricatio/models/task.py,sha256=Gw1dAeeSPyNdlbcWnrKHDPs7owoOqLTnm5sxBFsBYvk,9409
-fabricatio/models/tool.py,sha256=3htDwksf4k6JfYRY3RYirjvcpZUqwj5BNB7DO0nGBN0,3399
+fabricatio/models/task.py,sha256=bP3tKj9JXmtC_n3Y8-8Lgs0qhjcXxsuCDRD5DoYWsA4,9372
+fabricatio/models/tool.py,sha256=vSuFe-SsZHRGqSdpoCSumVZYoS9ktzQBFnJjDqOtZys,5031
 fabricatio/models/utils.py,sha256=i_kpcQpct04mQFk1nbcVGV-pl1YThWu4Qk3wbewzKkc,2535
-fabricatio/parser.py,sha256=eIdpGBUKHAAWaWEu3NP_7zwgsxHoXIMVaHUAlSjQ6ko,2424
+fabricatio/parser.py,sha256=M0-ywN2V512dHxomTo9hcdu80-pkXDh_vG4Wc_udOl8,2468
 fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fabricatio/toolboxes/arithmetic.py,sha256=5eWTrwGFn_ap1pfAbDyXpw-NADk_QtD1dmxOr-A7rdk,1317
 fabricatio/toolboxes/task.py,sha256=xgyPetm2R_HlQwpzE8YPnBN7QOYLd0-T8E6QPZG1PPQ,204
 fabricatio/toolboxes/__init__.py,sha256=bjefmPd7wBaWhbZzdMPXvrjMTeRzlUh_Dev2PUAc124,158
 fabricatio/_rust.pyi,sha256=IHNv9SHdjve24PBWhdRGCqWYdo2tSAkxYR9CddHhzX8,1540
 fabricatio/_rust_instances.py,sha256=PJC8TAkcH9f1Ak-0CKxSom_HTFHQEXZ8-aSDrYw7dwI,157
-fabricatio/__init__.py,sha256=PDDcg-2xRcPrUI1PwlO-jp2ZE0Cb-JAjm2bJX4k_v8g,912
-fabricatio/_rust.cp312-win_amd64.pyd,sha256=-NNhrNKOPQwAi-Np1vTMiw0W07JsSIuxbOrEFknpzeU,1123840
-fabricatio-0.2.0.dev11.data/scripts/tdown.exe,sha256=5rX8rGz1cWDMbPlBWbcarlCKlLty7_bgRtDL5iTvv8I,3387904
-fabricatio-0.2.0.dev11.dist-info/RECORD,,
+fabricatio/__init__.py,sha256=C9r6OVyMBb8IqwERNUq8lKDLe4BqN7fiu-O4TsXZ5xU,913
+fabricatio/_rust.cp312-win_amd64.pyd,sha256=Rz8qC0BE2eYcGVxBZC3BoUuLw9Z0PF768Pyece2KWcA,1128960
+fabricatio-0.2.0.dev12.data/scripts/tdown.exe,sha256=3CNAK6oj52AI-WUdjB4DCmuB1Z4JByPxFvRkATtBw1A,3385856
+fabricatio-0.2.0.dev12.dist-info/RECORD,,