fabricatio 0.2.8.dev3__cp312-cp312-win_amd64.whl → 0.2.9__cp312-cp312-win_amd64.whl

fabricatio/capabilities/task.py

@@ -4,7 +4,7 @@ from types import CodeType
 from typing import Any, Dict, List, Optional, Tuple, Unpack
 
 import orjson
-from fabricatio._rust_instances import TEMPLATE_MANAGER
+
 from fabricatio.capabilities.propose import Propose
 from fabricatio.config import configs
 from fabricatio.journal import logger
@@ -13,6 +13,7 @@ from fabricatio.models.task import Task
 from fabricatio.models.tool import Tool, ToolExecutor
 from fabricatio.models.usages import ToolBoxUsage
 from fabricatio.parser import JsonCapture, PythonCapture
+from fabricatio.rust_instances import TEMPLATE_MANAGER
 
 
 class ProposeTask(Propose):

fabricatio/config.py

@@ -44,7 +44,7 @@ class LLMConfig(BaseModel):
         top_p (NonNegativeFloat): The top p of the LLM model. Controls diversity via nucleus sampling. Set to 0.35 as per request.
         generation_count (PositiveInt): The number of generations to generate. Default is 1.
         stream (bool): Whether to stream the LLM model's response. Default is False.
-        max_tokens (PositiveInt): The maximum number of tokens to generate. Set to 8192 as per request.
+        max_tokens (PositiveInt): The maximum number of tokens to generate.
     """
 
     model_config = ConfigDict(use_attribute_docstrings=True)
@@ -79,7 +79,7 @@ class LLMConfig(BaseModel):
     """Whether to stream the LLM model's response. Default is False."""
 
     max_tokens: Optional[PositiveInt] = Field(default=None)
-    """The maximum number of tokens to generate. Set to 8192 as per request."""
+    """The maximum number of tokens to generate."""
 
     rpm: Optional[PositiveInt] = Field(default=100)
     """The rate limit of the LLM model in requests per minute. None means not checked."""
@@ -229,9 +229,6 @@ class TemplateConfig(BaseModel):
     generic_string_template: str = Field(default="generic_string")
     """The name of the generic string template which will be used to review a string."""
 
-    correct_template: str = Field(default="correct")
-    """The name of the correct template which will be used to correct a string."""
-
     co_validation_template: str = Field(default="co_validation")
     """The name of the co-validation template which will be used to co-validate a string."""
 
@@ -241,6 +238,17 @@ class TemplateConfig(BaseModel):
     check_string_template: str = Field(default="check_string")
     """The name of the check string template which will be used to check a string."""
 
+    ruleset_requirement_breakdown_template: str = Field(default="ruleset_requirement_breakdown")
+    """The name of the ruleset requirement breakdown template which will be used to breakdown a ruleset requirement."""
+
+    fix_troubled_obj_template: str = Field(default="fix_troubled_obj")
+    """The name of the fix troubled object template which will be used to fix a troubled object."""
+
+    fix_troubled_string_template: str = Field(default="fix_troubled_string")
+    """The name of the fix troubled string template which will be used to fix a troubled string."""
+
+    rule_requirement_template: str = Field(default="rule_requirement")
+    """The name of the rule requirement template which will be used to generate a rule requirement."""
 class MagikaConfig(BaseModel):
     """Magika configuration class."""
 
@@ -295,7 +303,7 @@ class CacheConfig(BaseModel):
 
     model_config = ConfigDict(use_attribute_docstrings=True)
 
-    type: Optional[LiteLLMCacheType] = None
+    type: LiteLLMCacheType = LiteLLMCacheType.LOCAL
     """The type of cache to use. If None, the default cache type will be used."""
     params: CacheKwargs = Field(default_factory=CacheKwargs)
     """The parameters for the cache. If type is None, the default parameters will be used."""

fabricatio/fs/readers.py

@@ -1,9 +1,10 @@
 """Filesystem readers for Fabricatio."""
 
 from pathlib import Path
-from typing import Dict
+from typing import Dict, List, Tuple
 
 import orjson
+import regex
 from magika import Magika
 
 from fabricatio.config import configs
@@ -44,3 +45,21 @@ def safe_json_read(path: Path | str) -> Dict:
     except (orjson.JSONDecodeError, IsADirectoryError, FileNotFoundError) as e:
         logger.error(f"Failed to read file {path}: {e!s}")
         return {}
+
+
+def extract_sections(string: str, level: int, section_char: str = "#") -> List[Tuple[str, str]]:
+    """Extract sections from markdown-style text by header level.
+
+    Args:
+        string (str): Input text to parse
+        level (int): Header level (e.g., 1 for '#', 2 for '##')
+        section_char (str, optional): The character used for headers (default: '#')
+
+    Returns:
+        List[Tuple[str, str]]: List of (header_text, section_content) tuples
+    """
+    return regex.findall(
+        r"^%s{%d}\s+(.+?)\n((?:(?!^%s{%d}\s).|\n)*)" % (section_char, level, section_char, level),
+        string,
+        regex.MULTILINE,
+    )

fabricatio/models/action.py

@@ -1,7 +1,12 @@
-"""Module that contains the classes for actions and workflows.
+"""Module that contains the classes for defining and executing task workflows.
 
-This module defines the Action and WorkFlow classes, which are used for
-creating and executing sequences of actions in a task-based context.
+This module provides the Action and WorkFlow classes for creating structured
+task execution pipelines. Actions represent atomic operations, while WorkFlows
+orchestrate sequences of actions with shared context and error handling.
+
+Classes:
+    Action: Base class for defining executable actions with context management.
+    WorkFlow: Manages action sequences, context propagation, and task lifecycle.
 """
 
 import traceback
@@ -9,16 +14,18 @@ from abc import abstractmethod
 from asyncio import Queue, create_task
 from typing import Any, Dict, Self, Tuple, Type, Union, final
 
-from fabricatio.capabilities.correct import Correct
-from fabricatio.capabilities.task import HandleTask, ProposeTask
 from fabricatio.journal import logger
 from fabricatio.models.generic import WithBriefing
 from fabricatio.models.task import Task
-from fabricatio.models.usages import ToolBoxUsage
+from fabricatio.models.usages import LLMUsage, ToolBoxUsage
 from pydantic import Field, PrivateAttr
 
+OUTPUT_KEY = "task_output"
+
+INPUT_KEY = "task_input"
+
 
-class Action(WithBriefing, HandleTask, ProposeTask, Correct):
+class Action(WithBriefing, LLMUsage):
     """Class that represents an action to be executed in a workflow.
 
     Actions are the atomic units of work in a workflow. Each action performs
@@ -48,28 +55,26 @@ class Action(WithBriefing, HandleTask, ProposeTask, Correct):
         self.description = self.description or self.__class__.__doc__ or ""
 
     @abstractmethod
-    async def _execute(self, *_, **cxt) -> Any:  # noqa: ANN002
-        """Execute the action logic with the provided context arguments.
-
-        This method must be implemented by subclasses to define the actual behavior.
+    async def _execute(self, *_:Any, **cxt) -> Any:
+        """Implement the core logic of the action.
 
         Args:
-            **cxt: The context dictionary containing input and output data.
+            **cxt: Context dictionary containing input/output data.
 
         Returns:
-            Any: The result of the action execution.
+            Result of the action execution to be stored in context.
         """
         pass
 
     @final
     async def act(self, cxt: Dict[str, Any]) -> Dict[str, Any]:
-        """Perform the action and update the context with results.
+        """Execute action and update context.
 
         Args:
-            cxt: The context dictionary containing input and output data.
+            cxt (Dict[str, Any]): Shared context dictionary.
 
         Returns:
-            Dict[str, Any]: The updated context dictionary.
+            Updated context dictionary with new/modified entries.
         """
         ret = await self._execute(**cxt)
 
@@ -81,23 +86,33 @@ class Action(WithBriefing, HandleTask, ProposeTask, Correct):
 
     @property
     def briefing(self) -> str:
-        """Return a formatted description of the action including personality context if available.
+        """Generate formatted action description with personality context.
 
         Returns:
-            str: Formatted briefing text with personality and action description.
+            Briefing text combining personality and action description.
         """
         if self.personality:
             return f"## Your personality: \n{self.personality}\n# The action you are going to perform: \n{super().briefing}"
         return f"# The action you are going to perform: \n{super().briefing}"
 
+    def to_task_output(self)->Self:
+        """Set the output key to OUTPUT_KEY and return the action instance."""
+        self.output_key=OUTPUT_KEY
+        return self
 
 class WorkFlow(WithBriefing, ToolBoxUsage):
-    """Class that represents a sequence of actions to be executed for a task.
+    """Manages sequences of actions to fulfill tasks.
+
+    Handles context propagation between actions, error handling, and task lifecycle
+    events like cancellation and completion.
 
-    A workflow manages the execution of multiple actions in sequence, passing
-    a shared context between them and handling task lifecycle events.
+    Attributes:
+        steps (Tuple): Sequence of Action instances or classes to execute.
+        task_input_key (str): Key for storing task instance in context.
+        task_output_key (str): Key to retrieve final result from context.
     """
-    description:str =""
+
+    description: str = ""
     """The description of the workflow, which describes the workflow's purpose and requirements."""
 
     _context: Queue[Dict[str, Any]] = PrivateAttr(default_factory=lambda: Queue(maxsize=1))
@@ -111,10 +126,10 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
     )
     """The sequence of actions to be executed, can be action classes or instances."""
 
-    task_input_key: str = Field(default="task_input")
+    task_input_key: str = Field(default=INPUT_KEY)
     """Key used to store the input task in the context dictionary."""
 
-    task_output_key: str = Field(default="task_output")
+    task_output_key: str = Field(default=OUTPUT_KEY)
     """Key used to extract the final result from the context dictionary."""
 
     extra_init_context: Dict[str, Any] = Field(default_factory=dict, frozen=True)
@@ -130,26 +145,29 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
         self._instances = tuple(step if isinstance(step, Action) else step() for step in self.steps)
 
     def inject_personality(self, personality: str) -> Self:
-        """Set the personality for all actions that don't have one defined.
+        """Set personality for actions without existing personality.
 
         Args:
-            personality: The personality text to inject.
+            personality (str): Shared personality context
 
         Returns:
-            Self: The workflow instance for method chaining.
+            Workflow instance with updated actions
         """
         for action in filter(lambda a: not a.personality, self._instances):
             action.personality = personality
         return self
 
     async def serve(self, task: Task) -> None:
-        """Execute the workflow to fulfill the given task.
-
-        This method manages the complete lifecycle of processing a task through
-        the workflow's sequence of actions.
+        """Execute workflow to complete given task.
 
         Args:
-            task: The task to be processed.
+            task (Task): Task instance to be processed.
+
+        Steps:
+            1. Initialize context with task instance and extra data
+            2. Execute each action sequentially
+            3. Handle task cancellation and exceptions
+            4. Extract final result from context
         """
         logger.info(f"Start execute workflow: {self.name}")
 
@@ -159,27 +177,27 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
         current_action = None
         try:
             # Process each action in sequence
-            for step in self._instances:
+            for i,step in enumerate(self._instances):
                 current_action = step.name
-                logger.info(f"Executing step >> {current_action}")
+                logger.info(f"Executing step [{i}] >> {current_action}")
 
                 # Get current context and execute action
                 context = await self._context.get()
                 act_task = create_task(step.act(context))
                 # Handle task cancellation
                 if task.is_cancelled():
-                    logger.warning(f"Task cancelled by task: {task.name}")
+                    logger.warning(f"Workflow cancelled by task: {task.name}")
                     act_task.cancel(f"Cancelled by task: {task.name}")
                     break
 
                 # Update context with modified values
                 modified_ctx = await act_task
-                logger.success(f"Step execution finished: {current_action}")
+                logger.success(f"Step [{i}] `{current_action}` execution finished.")
                 if step.output_key:
-                    logger.success(f"Setting output to `{step.output_key}`")
+                    logger.success(f"Setting action `{current_action}` output to `{step.output_key}`")
                 await self._context.put(modified_ctx)
 
-            logger.success(f"Workflow execution finished: {self.name}")
+            logger.success(f"Workflow `{self.name}` execution finished.")
 
             # Get final context and extract result
             final_ctx = await self._context.get()
@@ -199,10 +217,14 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
             await task.fail()
 
     async def _init_context[T](self, task: Task[T]) -> None:
-        """Initialize the context dictionary for workflow execution.
+        """Initialize workflow execution context.
 
         Args:
-            task: The task being served by this workflow.
+            task (Task[T]): Task being processed
+
+        Context includes:
+            - Task instance stored under task_input_key
+            - Any extra_init_context values
         """
         logger.debug(f"Initializing context for workflow: {self.name}")
         initial_context = {self.task_input_key: task, **dict(self.extra_init_context)}
@@ -223,7 +245,7 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
         Returns:
             Self: The workflow instance for method chaining.
         """
-        self.provide_tools_to(self._instances)
+        self.provide_tools_to(i for i in self._instances if isinstance(i,ToolBoxUsage))
         return self
 
     def update_init_context(self, /, **kwargs) -> Self:

fabricatio/models/adv_kwargs_types.py

@@ -0,0 +1,25 @@
+"""A module containing kwargs types for content correction and checking operations."""
+from fabricatio.models.extra.problem import Improvement
+from fabricatio.models.extra.rule import RuleSet
+from fabricatio.models.generic import SketchedAble
+from fabricatio.models.kwargs_types import ReferencedKwargs
+
+
+class CorrectKwargs[T: SketchedAble](ReferencedKwargs[T], total=False):
+    """Arguments for content correction operations.
+
+    Extends GenerateKwargs with parameters for correcting content based on
+    specific criteria and templates.
+    """
+
+    improvement: Improvement
+
+
+class CheckKwargs(ReferencedKwargs[Improvement], total=False):
+    """Arguments for content checking operations.
+
+    Extends GenerateKwargs with parameters for checking content against
+    specific criteria and templates.
+    """
+
+    ruleset: RuleSet

fabricatio/models/extra/__init__.py

@@ -0,0 +1 @@
+"""A module contains extra models for fabricatio."""

fabricatio/models/extra/advanced_judge.py

@@ -2,23 +2,26 @@
 
 from typing import List
 
-from fabricatio.models.generic import Display, ProposedAble
+from fabricatio.models.generic import SketchedAble
 
 
-class JudgeMent(ProposedAble,Display):
+class JudgeMent(SketchedAble):
     """Represents a judgment result containing supporting/denying evidence and final verdict.
 
     The class stores both affirmative and denies evidence, truth and reasons lists along with the final boolean judgment.
     """
+
+    issue_to_judge: str
+    """The issue to be judged, including the original question and context"""
+
     deny_evidence: List[str]
     """List of clues supporting the denial."""
 
     affirm_evidence: List[str]
     """List of clues supporting the affirmation."""
 
-
     final_judgement: bool
-    """The final judgment made according to all extracted clues."""
+    """The final judgment made according to all extracted clues. true for the `issue_to_judge` is correct and false for incorrect."""
 
     def __bool__(self) -> bool:
         """Return the final judgment value.