fabricatio 0.2.6.dev0__cp312-cp312-win_amd64.whl → 0.2.6.dev1__cp312-cp312-win_amd64.whl

fabricatio/__init__.py

@@ -3,11 +3,11 @@
 from importlib.util import find_spec
 
 from fabricatio._rust import BibManager
-from fabricatio._rust_instances import template_manager
+from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.actions.article import ExtractArticleEssence, GenerateArticleProposal, GenerateOutline
 from fabricatio.actions.output import DumpFinalizedOutput
 from fabricatio.core import env
-from fabricatio.fs import magika, safe_json_read, safe_text_read
+from fabricatio.fs import MAGIKA, safe_json_read, safe_text_read
 from fabricatio.journal import logger
 from fabricatio.models.action import Action, WorkFlow
 from fabricatio.models.events import Event
@@ -16,21 +16,23 @@ from fabricatio.models.role import Role
 from fabricatio.models.task import Task
 from fabricatio.models.tool import ToolBox
 from fabricatio.models.utils import Message, Messages
-from fabricatio.parser import Capture, CodeBlockCapture, JsonCapture, PythonCapture
+from fabricatio.parser import Capture, GenericCapture, JsonCapture, PythonCapture
 from fabricatio.toolboxes import arithmetic_toolbox, basic_toolboxes, fs_toolbox
 from fabricatio.workflows.articles import WriteOutlineWorkFlow
 
 __all__ = [
+    "MAGIKA",
+    "TEMPLATE_MANAGER",
     "Action",
     "ArticleEssence",
     "BibManager",
     "Capture",
-    "CodeBlockCapture",
     "DumpFinalizedOutput",
     "Event",
     "ExtractArticleEssence",
     "GenerateArticleProposal",
     "GenerateOutline",
+    "GenericCapture",
     "JsonCapture",
     "Message",
     "Messages",
@@ -45,10 +47,8 @@ __all__ = [
     "env",
     "fs_toolbox",
     "logger",
-    "magika",
     "safe_json_read",
     "safe_text_read",
-    "template_manager",
 ]
 
 

fabricatio/_rust_instances.py

@@ -3,7 +3,7 @@
 from fabricatio._rust import TemplateManager
 from fabricatio.config import configs
 
-template_manager = TemplateManager(
+TEMPLATE_MANAGER = TemplateManager(
     template_dirs=configs.templates.template_dir,
     suffix=configs.templates.template_suffix,
     active_loading=configs.templates.active_loading,

fabricatio/capabilities/correct.py

@@ -0,0 +1,103 @@
+"""Correct capability module providing advanced review and validation functionality.
+
+This module implements the Correct capability, which extends the Review functionality
+to provide mechanisms for reviewing, validating, and correcting various objects and tasks
+based on predefined criteria and templates.
+"""
+
+from typing import Optional, Unpack
+
+from fabricatio._rust_instances import TEMPLATE_MANAGER
+from fabricatio.capabilities.review import Review, ReviewResult
+from fabricatio.config import configs
+from fabricatio.models.generic import Display, ProposedAble, WithBriefing
+from fabricatio.models.kwargs_types import ReviewKwargs
+from fabricatio.models.task import Task
+
+
+class Correct(Review):
+    """Correct capability for reviewing, validating, and improving objects.
+
+    This class enhances the Review capability with specialized functionality for
+    correcting and improving objects based on review feedback. It can process
+    various inputs including tasks, strings, and generic objects that implement
+    the required interfaces, applying corrections based on templated review processes.
+    """
+
+    async def correct_obj[M: ProposedAble](
+        self, obj: M, **kwargs: Unpack[ReviewKwargs[ReviewResult[str]]]
+    ) -> Optional[M]:
+        """Review and correct an object based on defined criteria and templates.
+
+        This method first conducts a review of the given object, then uses the review results
+        to generate a corrected version of the object using appropriate templates.
+
+        Args:
+            obj (M): The object to be reviewed and corrected. Must implement ProposedAble.
+            **kwargs: Review configuration parameters including criteria and review options.
+
+        Returns:
+            Optional[M]: A corrected version of the input object, or None if correction fails.
+
+        Raises:
+            TypeError: If the provided object doesn't implement Display or WithBriefing interfaces.
+        """
+        if not isinstance(obj, (Display, WithBriefing)):
+            raise TypeError(f"Expected Display or WithBriefing, got {type(obj)}")
+        review_res = await self.review_obj(obj, **kwargs)
+        await review_res.supervisor_check()
+        if "default" in kwargs:
+            kwargs["default"] = None
+        return await self.propose(
+            obj.__class__,
+            TEMPLATE_MANAGER.render_template(
+                configs.templates.correct_template,
+                {
+                    "content": obj.display() if isinstance(obj, Display) else obj.briefing,
+                    "review": review_res.display(),
+                },
+            ),
+            **kwargs,
+        )
+
+    async def correct_string(self, input_text: str, **kwargs: Unpack[ReviewKwargs[ReviewResult[str]]]) -> Optional[str]:
+        """Review and correct a string based on defined criteria and templates.
+
+        This method applies the review process to the input text and generates
+        a corrected version based on the review results.
+
+        Args:
+            input_text (str): The text content to be reviewed and corrected.
+            **kwargs: Review configuration parameters including criteria and review options.
+
+        Returns:
+            Optional[str]: The corrected text content, or None if correction fails.
+        """
+        review_res = await self.review_string(input_text, **kwargs)
+        await review_res.supervisor_check()
+
+        if "default" in kwargs:
+            kwargs["default"] = None
+        return await self.ageneric_string(
+            TEMPLATE_MANAGER.render_template(
+                configs.templates.correct_template, {"content": input_text, "review": review_res.display()}
+            ),
+            **kwargs,
+        )
+
+    async def correct_task[T](
+        self, task: Task[T], **kwargs: Unpack[ReviewKwargs[ReviewResult[str]]]
+    ) -> Optional[Task[T]]:
+        """Review and correct a task object based on defined criteria.
+
+        This is a specialized version of correct_obj specifically for Task objects,
+        applying the same review and correction process to task definitions.
+
+        Args:
+            task (Task[T]): The task to be reviewed and corrected.
+            **kwargs: Review configuration parameters including criteria and review options.
+
+        Returns:
+            Optional[Task[T]]: The corrected task, or None if correction fails.
+        """
+        return await self.correct_obj(task, **kwargs)

fabricatio/capabilities/rag.py

@@ -10,7 +10,7 @@ from os import PathLike
 from pathlib import Path
 from typing import Any, Callable, Dict, List, Optional, Self, Union, Unpack, cast, overload
 
-from fabricatio._rust_instances import template_manager
+from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.config import configs
 from fabricatio.journal import logger
 from fabricatio.models.kwargs_types import (
@@ -306,7 +306,7 @@ class RAG(EmbeddingUsage):
             similarity_threshold=similarity_threshold,
         )
 
-        rendered = template_manager.render_template(configs.templates.retrieved_display_template, {"docs": docs[::-1]})
+        rendered = TEMPLATE_MANAGER.render_template(configs.templates.retrieved_display_template, {"docs": docs[::-1]})
 
         logger.debug(f"Retrieved Documents: \n{rendered}")
         return await self.aask(
@@ -326,7 +326,7 @@ class RAG(EmbeddingUsage):
             List[str]: A list of refined questions.
         """
         return await self.aliststr(
-            template_manager.render_template(
+            TEMPLATE_MANAGER.render_template(
                 configs.templates.refined_query_template,
                 {"question": [question] if isinstance(question, str) else question},
             ),

fabricatio/capabilities/rating.py

@@ -4,7 +4,7 @@ from itertools import permutations
 from random import sample
 from typing import Dict, List, Optional, Set, Tuple, Union, Unpack, overload
 
-from fabricatio._rust_instances import template_manager
+from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.config import configs
 from fabricatio.journal import logger
 from fabricatio.models.generic import WithBriefing
@@ -53,7 +53,7 @@ class GiveRating(WithBriefing, LLMUsage):
         logger.info(f"Rating for {to_rate}")
         return await self.aask_validate(
             question=(
-                template_manager.render_template(
+                TEMPLATE_MANAGER.render_template(
                     configs.templates.rate_fine_grind_template,
                     {
                         "to_rate": to_rate,
@@ -65,7 +65,7 @@ class GiveRating(WithBriefing, LLMUsage):
             )
             if isinstance(to_rate, str)
             else [
-                template_manager.render_template(
+                TEMPLATE_MANAGER.render_template(
                     configs.templates.rate_fine_grind_template,
                     {
                         "to_rate": item,
@@ -150,7 +150,7 @@ class GiveRating(WithBriefing, LLMUsage):
 
         return await self.aask_validate(
             question=(
-                template_manager.render_template(
+                TEMPLATE_MANAGER.render_template(
                     configs.templates.draft_rating_manual_template,
                     {
                         "topic": topic,
@@ -180,7 +180,7 @@ class GiveRating(WithBriefing, LLMUsage):
         """
         return await self.aask_validate(
             question=(
-                template_manager.render_template(
+                TEMPLATE_MANAGER.render_template(
                     configs.templates.draft_rating_criteria_template,
                     {
                         "topic": topic,
@@ -230,7 +230,7 @@ class GiveRating(WithBriefing, LLMUsage):
         reasons = flatten(
             await self.aask_validate(
                 question=[
-                    template_manager.render_template(
+                    TEMPLATE_MANAGER.render_template(
                         configs.templates.extract_reasons_from_examples_template,
                         {
                             "topic": topic,
@@ -250,7 +250,7 @@ class GiveRating(WithBriefing, LLMUsage):
         # extract certain mount of criteria from reasons according to their importance and frequency
         return await self.aask_validate(
             question=(
-                template_manager.render_template(
+                TEMPLATE_MANAGER.render_template(
                     configs.templates.extract_criteria_from_reasons_template,
                     {
                         "topic": topic,
@@ -290,7 +290,7 @@ class GiveRating(WithBriefing, LLMUsage):
         # get the importance multiplier indicating how important is second criterion compared to the first one
         relative_weights = await self.aask_validate(
             question=[
-                template_manager.render_template(
+                TEMPLATE_MANAGER.render_template(
                     configs.templates.draft_rating_weights_klee_template,
                     {
                         "topic": topic,

fabricatio/capabilities/review.py

@@ -2,15 +2,17 @@
 
 from typing import List, Optional, Self, Set, Unpack, cast
 
-from fabricatio import template_manager
+from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.capabilities.propose import Propose
 from fabricatio.capabilities.rating import GiveRating
 from fabricatio.config import configs
 from fabricatio.models.generic import Base, Display, ProposedAble, WithBriefing
 from fabricatio.models.kwargs_types import ReviewKwargs, ValidateKwargs
 from fabricatio.models.task import Task
-from questionary import Choice, checkbox
-from rich import print
+from fabricatio.models.utils import ask_edit
+from questionary import Choice, checkbox, text
+from questionary import print as q_print
+from rich import print as r_print
 
 
 class ProblemSolutions(Base):
@@ -53,6 +55,25 @@ class ProblemSolutions(Base):
         self.solutions = solutions
         return self
 
+    async def edit_problem(self) -> Self:
+        """Interactively edit the problem description using a prompt.
+
+        Returns:
+            Self: The current instance with updated problem description.
+        """
+        self.problem = await text("Please edit the problem below:", default=self.problem).ask_async()
+        return self
+
+    async def edit_solutions(self) -> Self:
+        """Interactively edit the list of potential solutions using a prompt.
+
+        Returns:
+            Self: The current instance with updated solutions.
+        """
+        q_print(self.problem, style="bold cyan")
+        self.solutions = await ask_edit(self.solutions)
+        return self
+
 
 class ReviewResult[T](ProposedAble, Display):
     """Represents the outcome of a review process with identified problems and solutions.
@@ -110,7 +131,7 @@ class ReviewResult[T](ProposedAble, Display):
         """
         return self._ref
 
-    async def supervisor_check(self, check_solutions: bool = False) -> Self:
+    async def supervisor_check(self, check_solutions: bool = True) -> Self:
         """Perform an interactive review session to filter problems and solutions.
 
         Presents an interactive prompt allowing a supervisor to select which
@@ -132,23 +153,25 @@ class ReviewResult[T](ProposedAble, Display):
         else:
             raise TypeError(f"Unsupported type for review: {type(self._ref)}")
         # Choose the problems to retain
-        print(display)
+        r_print(display)
         chosen_ones: List[ProblemSolutions] = await checkbox(
             f"Please choose the problems you want to retain.(Default: retain all)\n\t`{self.review_topic}`",
             choices=[Choice(p.problem, p, checked=True) for p in self.problem_solutions],
         ).ask_async()
+        self.problem_solutions = [await p.edit_problem() for p in chosen_ones]
         if not check_solutions:
-            self.problem_solutions = chosen_ones
             return self
 
         # Choose the solutions to retain
-        for to_exam in chosen_ones:
+        for to_exam in self.problem_solutions:
             to_exam.update_solutions(
                 await checkbox(
                     f"Please choose the solutions you want to retain.(Default: retain all)\n\t`{to_exam.problem}`",
                     choices=[Choice(s, s, checked=True) for s in to_exam.solutions],
                 ).ask_async()
             )
+            await to_exam.edit_solutions()
+
         return self
 
 
@@ -181,7 +204,7 @@ class Review(GiveRating, Propose):
 
     async def review_string(
         self,
-        text: str,
+        input_text: str,
         topic: str,
         criteria: Optional[Set[str]] = None,
         **kwargs: Unpack[ValidateKwargs[ReviewResult[str]]],
@@ -192,7 +215,7 @@ class Review(GiveRating, Propose):
         based on the given topic and criteria.
 
         Args:
-            text (str): The text content to be reviewed.
+            input_text (str): The text content to be reviewed.
             topic (str): The subject topic for the review criteria.
             criteria (Optional[Set[str]], optional): A set of criteria for the review.
                 If not provided, criteria will be drafted automatically. Defaults to None.
@@ -202,18 +225,32 @@ class Review(GiveRating, Propose):
             ReviewResult[str]: A review result containing identified problems and proposed solutions,
                 with a reference to the original text.
         """
-        criteria = criteria or (await self.draft_rating_criteria(topic))
-        manual = await self.draft_rating_manual(topic, criteria)
-        res: ReviewResult[str] = await self.propose(
+        default = None
+        if "default" in kwargs:
+            default = kwargs.pop("default")
+
+        criteria = criteria or (await self.draft_rating_criteria(topic, **kwargs))
+        if not criteria:
+            raise ValueError("No criteria provided for review.")
+        manual = await self.draft_rating_manual(topic, criteria, **kwargs)
+
+        if default is not None:
+            kwargs["default"] = default
+        res = await self.propose(
             ReviewResult,
-            template_manager.render_template(
-                configs.templates.review_string_template, {"text": text, "topic": topic, "criteria_manual": manual}
+            TEMPLATE_MANAGER.render_template(
+                configs.templates.review_string_template,
+                {"text": input_text, "topic": topic, "criteria_manual": manual},
             ),
             **kwargs,
         )
-        return res.update_ref(text).update_topic(topic)
+        if not res:
+            raise ValueError("Failed to generate review result.")
+        return res.update_ref(input_text).update_topic(topic)
 
-    async def review_obj[M: (Display, WithBriefing)](self, obj: M, **kwargs: Unpack[ReviewKwargs]) -> ReviewResult[M]:
+    async def review_obj[M: (Display, WithBriefing)](
+        self, obj: M, **kwargs: Unpack[ReviewKwargs[ReviewResult[str]]]
+    ) -> ReviewResult[M]:
         """Review an object that implements Display or WithBriefing interface.
 
         This method extracts displayable text from the object and performs a review

fabricatio/capabilities/task.py

@@ -4,7 +4,7 @@ from types import CodeType
 from typing import Any, Dict, List, Optional, Tuple, Unpack, cast
 
 import orjson
-from fabricatio._rust_instances import template_manager
+from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.capabilities.propose import Propose
 from fabricatio.config import configs
 from fabricatio.journal import logger
@@ -66,7 +66,7 @@ class HandleTask(WithBriefing, ToolBoxUsage):
 
             return None
 
-        q = template_manager.render_template(
+        q = TEMPLATE_MANAGER.render_template(
             configs.templates.draft_tool_usage_code_template,
             {
                 "data_module_name": configs.toolbox.data_module_name,

fabricatio/config.py

@@ -19,8 +19,6 @@ from pydantic import (
 )
 from pydantic_settings import (
     BaseSettings,
-    DotEnvSettingsSource,
-    EnvSettingsSource,
     PydanticBaseSettingsSource,
     PyprojectTomlConfigSettingsSource,
     SettingsConfigDict,
@@ -228,6 +226,12 @@ class TemplateConfig(BaseModel):
     review_string_template: str = Field(default="review_string")
     """The name of the review string template which will be used to review a string."""
 
+    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."""
+
 
 class MagikaConfig(BaseModel):
     """Magika configuration class."""
@@ -370,6 +374,9 @@ class Settings(BaseSettings):
     ) -> tuple[PydanticBaseSettingsSource, ...]:
         """Customize settings sources.
 
+        This method customizes the settings sources used by the application. It returns a tuple of settings sources, including
+        the dotenv settings source, environment settings source, a custom TomlConfigSettingsSource, and a custom
+
         Args:
             settings_cls (type[BaseSettings]): The settings class.
             init_settings (PydanticBaseSettingsSource): Initial settings source.
@@ -381,10 +388,12 @@ class Settings(BaseSettings):
             tuple[PydanticBaseSettingsSource, ...]: A tuple of settings sources.
         """
         return (
-            DotEnvSettingsSource(settings_cls),
-            EnvSettingsSource(settings_cls),
-            TomlConfigSettingsSource(settings_cls),
+            init_settings,
+            dotenv_settings,
+            env_settings,
+            file_secret_settings,
             PyprojectTomlConfigSettingsSource(settings_cls),
+            TomlConfigSettingsSource(settings_cls),
         )
 
 

fabricatio/fs/__init__.py

@@ -11,9 +11,10 @@ from fabricatio.fs.curd import (
     move_file,
     tree,
 )
-from fabricatio.fs.readers import magika, safe_json_read, safe_text_read
+from fabricatio.fs.readers import MAGIKA, safe_json_read, safe_text_read
 
 __all__ = [
+    "MAGIKA",
     "absolute_path",
     "copy_file",
     "create_directory",
@@ -21,7 +22,6 @@ __all__ = [
     "delete_file",
     "dump_text",
     "gather_files",
-    "magika",
     "move_file",
     "safe_json_read",
     "safe_text_read",

fabricatio/fs/readers.py

@@ -9,7 +9,7 @@ from magika import Magika
 from fabricatio.config import configs
 from fabricatio.journal import logger
 
-magika = Magika(model_dir=configs.magika.model_dir)
+MAGIKA = Magika(model_dir=configs.magika.model_dir)
 
 
 def safe_text_read(path: Path | str) -> str:

fabricatio/journal.py

@@ -19,10 +19,3 @@ logger.add(
 logger.add(sys.stderr, level=configs.debug.log_level)
 
 __all__ = ["logger"]
-if __name__ == "__main__":
-    logger.debug("This is a trace message.")
-    logger.info("This is an information message.")
-    logger.success("This is a success message.")
-    logger.warning("This is a warning message.")
-    logger.error("This is an error message.")
-    logger.critical("This is a critical message.")

fabricatio/models/action.py

@@ -5,7 +5,7 @@ from abc import abstractmethod
 from asyncio import Queue, create_task
 from typing import Any, Dict, Self, Tuple, Type, Union, final
 
-from fabricatio.capabilities.review import Review
+from fabricatio.capabilities.correct import Correct
 from fabricatio.capabilities.task import HandleTask, ProposeTask
 from fabricatio.journal import logger
 from fabricatio.models.generic import WithBriefing
@@ -14,7 +14,7 @@ from fabricatio.models.usages import ToolBoxUsage
 from pydantic import Field, PrivateAttr
 
 
-class Action(HandleTask, ProposeTask, Review):
+class Action(HandleTask, ProposeTask, Correct):
     """Class that represents an action to be executed in a workflow."""
 
     name: str = Field(default="")

fabricatio/models/generic.py

@@ -6,9 +6,9 @@ from typing import Any, Callable, Dict, Iterable, List, Optional, Self, Union, f
 
 import orjson
 from fabricatio._rust import blake3_hash
-from fabricatio._rust_instances import template_manager
+from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.config import configs
-from fabricatio.fs.readers import magika, safe_text_read
+from fabricatio.fs.readers import MAGIKA, safe_text_read
 from fabricatio.journal import logger
 from fabricatio.parser import JsonCapture
 from pydantic import (
@@ -40,6 +40,14 @@ class Display(Base):
         """
         return self.model_dump_json(indent=1)
 
+    def compact(self) -> str:
+        """Display the model in a compact JSON string.
+
+        Returns:
+            str: The compact JSON string of the model.
+        """
+        return self.model_dump_json()
+
 
 class Named(Base):
     """Class that includes a name attribute."""
@@ -118,12 +126,12 @@ class CreateJsonObjPrompt(WithFormatedJsonSchema):
             str: The prompt for creating a JSON object with given requirement.
         """
         if isinstance(requirement, str):
-            return template_manager.render_template(
+            return TEMPLATE_MANAGER.render_template(
                 configs.templates.create_json_obj_template,
                 {"requirement": requirement, "json_schema": cls.formated_json_schema()},
             )
         return [
-            template_manager.render_template(
+            TEMPLATE_MANAGER.render_template(
                 configs.templates.create_json_obj_template,
                 {"requirement": r, "json_schema": cls.formated_json_schema()},
             )
@@ -247,13 +255,13 @@ class WithDependency(Base):
         Returns:
             str: The generated prompt for the task.
         """
-        return template_manager.render_template(
+        return TEMPLATE_MANAGER.render_template(
             configs.templates.dependencies_template,
             {
                 (pth := Path(p)).name: {
                     "path": pth.as_posix(),
                     "exists": pth.exists(),
-                    "description": (identity := magika.identify_path(pth)).output.description,
+                    "description": (identity := MAGIKA.identify_path(pth)).output.description,
                     "size": f"{pth.stat().st_size / (1024 * 1024) if pth.exists() and pth.is_file() else 0:.3f} MB",
                     "content": (text := safe_text_read(pth)),
                     "lines": len(text.splitlines()),

fabricatio/models/kwargs_types.py

@@ -12,7 +12,7 @@ class CollectionSimpleConfigKwargs(TypedDict, total=False):
     These arguments are typically used when configuring connections to vector databases.
     """
 
-    dimension: int|None
+    dimension: int | None
     timeout: float
 
 
@@ -23,7 +23,7 @@ class FetchKwargs(TypedDict, total=False):
     and result limiting parameters.
     """
 
-    collection_name: str|None
+    collection_name: str | None
     similarity_threshold: float
     result_per_query: int
 

fabricatio/models/role.py

@@ -2,7 +2,7 @@
 
 from typing import Any, Self, Set
 
-from fabricatio.capabilities.review import Review
+from fabricatio.capabilities.correct import Correct
 from fabricatio.capabilities.task import HandleTask, ProposeTask
 from fabricatio.core import env
 from fabricatio.journal import logger
@@ -12,7 +12,7 @@ from fabricatio.models.tool import ToolBox
 from pydantic import Field
 
 
-class Role(ProposeTask, HandleTask, Review):
+class Role(ProposeTask, HandleTask, Correct):
     """Class that represents a role with a registry of events and workflows."""
 
     registry: dict[Event | str, WorkFlow] = Field(default_factory=dict)

fabricatio/models/task.py

@@ -6,7 +6,7 @@ It includes methods to manage the task's lifecycle, such as starting, finishing,
 from asyncio import Queue
 from typing import Any, List, Optional, Self
 
-from fabricatio._rust_instances import template_manager
+from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.config import configs
 from fabricatio.core import env
 from fabricatio.journal import logger
@@ -253,7 +253,7 @@ class Task[T](WithBriefing, ProposedAble, WithDependency):
         Returns:
             str: The briefing of the task.
         """
-        return template_manager.render_template(
+        return TEMPLATE_MANAGER.render_template(
             configs.templates.task_briefing_template,
             self.model_dump(),
         )

fabricatio/models/usages.py

@@ -5,7 +5,7 @@ from typing import Callable, Dict, Iterable, List, Optional, Self, Sequence, Set
 
 import asyncstdlib
 import litellm
-from fabricatio._rust_instances import template_manager
+from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.config import configs
 from fabricatio.journal import logger
 from fabricatio.models.generic import ScopedConfig, WithBriefing
@@ -13,7 +13,7 @@ from fabricatio.models.kwargs_types import ChooseKwargs, EmbeddingKwargs, Genera
 from fabricatio.models.task import Task
 from fabricatio.models.tool import Tool, ToolBox
 from fabricatio.models.utils import Messages
-from fabricatio.parser import JsonCapture
+from fabricatio.parser import GenericCapture, JsonCapture
 from litellm import Router, stream_chunk_builder
 from litellm.types.router import Deployment, LiteLLM_Params, ModelInfo
 from litellm.types.utils import (
@@ -30,6 +30,7 @@ from pydantic import Field, NonNegativeInt, PositiveInt
 if configs.cache.enabled and configs.cache.type:
     litellm.enable_cache(type=configs.cache.type, **configs.cache.params)
     logger.success(f"{configs.cache.type.name} Cache enabled")
+
 ROUTER = Router(
     routing_strategy="usage-based-routing-v2",
     allowed_fails=configs.routing.allowed_fails,
@@ -301,7 +302,7 @@ class LLMUsage(ScopedConfig):
             List[str]: The validated response as a list of strings.
         """
         return await self.aask_validate(
-            template_manager.render_template(
+            TEMPLATE_MANAGER.render_template(
                 configs.templates.liststr_template,
                 {"requirement": requirement, "k": k},
             ),
@@ -320,7 +321,7 @@ class LLMUsage(ScopedConfig):
             List[str]: The validated response as a list of strings.
         """
         return await self.aliststr(
-            template_manager.render_template(
+            TEMPLATE_MANAGER.render_template(
                 configs.templates.pathstr_template,
                 {"requirement": requirement},
             ),
@@ -345,6 +346,25 @@ class LLMUsage(ScopedConfig):
             )
         ).pop()
 
+    async def ageneric_string(self, requirement: str, **kwargs: Unpack[ValidateKwargs[str]]) -> str:
+        """Asynchronously generates a generic string based on a given requirement.
+
+        Args:
+            requirement (str): The requirement for the string.
+            **kwargs (Unpack[GenerateKwargs]): Additional keyword arguments for the LLM usage.
+
+        Returns:
+            str: The generated string.
+        """
+        return await self.aask_validate(
+            TEMPLATE_MANAGER.render_template(
+                configs.templates.generic_string_template,
+                {"requirement": requirement, "language": GenericCapture.capture_type},
+            ),
+            validator=lambda resp: GenericCapture.capture(resp),
+            **kwargs,
+        )
+
     async def achoose[T: WithBriefing](
         self,
         instruction: str,
@@ -371,7 +391,7 @@ class LLMUsage(ScopedConfig):
         if dup := duplicates_everseen(choices, key=lambda x: x.name):
             logger.error(err := f"Redundant choices: {dup}")
             raise ValueError(err)
-        prompt = template_manager.render_template(
+        prompt = TEMPLATE_MANAGER.render_template(
             configs.templates.make_choice_template,
             {
                 "instruction": instruction,
@@ -444,7 +464,7 @@ class LLMUsage(ScopedConfig):
             bool: The judgment result (True or False) based on the AI's response.
         """
         return await self.aask_validate(
-            question=template_manager.render_template(
+            question=TEMPLATE_MANAGER.render_template(
                 configs.templates.make_judgment_template,
                 {"prompt": prompt, "affirm_case": affirm_case, "deny_case": deny_case},
             ),

fabricatio/models/utils.py

@@ -4,6 +4,7 @@ from enum import Enum
 from typing import Any, Dict, List, Literal, Optional, Self
 
 from pydantic import BaseModel, ConfigDict, Field
+from questionary import text
 
 
 class Message(BaseModel):
@@ -144,3 +145,23 @@ class TaskStatus(Enum):
     Finished = "finished"
     Failed = "failed"
     Cancelled = "cancelled"
+
+
+async def ask_edit(
+    text_seq: List[str],
+) -> List[str]:
+    """Asks the user to edit a list of texts.
+
+    Args:
+        text_seq (List[str]): A list of texts to be edited.
+
+    Returns:
+        List[str]: A list of edited texts.
+        If the user does not edit a text, it will not be included in the returned list.
+    """
+    res = []
+    for i, t in enumerate(text_seq):
+        edited = await text(f"[{i}] ", default=t).ask_async()
+        if edited:
+            res.append(edited)
+    return res

fabricatio/parser.py

@@ -35,7 +35,7 @@ class Capture(BaseModel):
         """Initialize the compiled pattern."""
         self._compiled = compile(self.pattern, self.flags)
 
-    def fix[T](self, text: str | Iterable[str]|T) -> str | List[str]|T:
+    def fix[T](self, text: str | Iterable[str] | T) -> str | List[str] | T:
         """Fix the text using the pattern.
 
         Args:
@@ -47,8 +47,8 @@ class Capture(BaseModel):
         match self.capture_type:
             case "json":
                 if isinstance(text, str):
-                    return repair_json(text,ensure_ascii=False)
-                return [repair_json(item) for item in text]
+                    return repair_json(text, ensure_ascii=False)
+                return [repair_json(item, ensure_ascii=False) for item in text]
             case _:
                 return text
 
@@ -134,8 +134,16 @@ class Capture(BaseModel):
         """
         return cls(pattern=f"```{language}\n(.*?)\n```", capture_type=language)
 
+    @classmethod
+    def capture_generic_block(cls, language: str) -> Self:
+        """Capture the first occurrence of a generic code block in the given text.
+
+        Returns:
+            Self: The instance of the class with the captured code block.
+        """
+        return cls(pattern=f"--- Start of {language} ---\n(.*?)\n--- end of {language} ---", capture_type=language)
+
 
 JsonCapture = Capture.capture_code_block("json")
 PythonCapture = Capture.capture_code_block("python")
-MarkdownCapture = Capture.capture_code_block("markdown")
-CodeBlockCapture = Capture(pattern="```.*?\n(.*?)\n```")
+GenericCapture = Capture.capture_generic_block("String")

{fabricatio-0.2.6.dev0.dist-info → fabricatio-0.2.6.dev1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.6.dev0
+Version: 0.2.6.dev1
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12
@@ -176,7 +176,7 @@ if __name__ == "__main__":
 ### Template Management and Rendering
 
 ```python
-from fabricatio._rust_instances import template_manager
+from fabricatio._rust_instances import TEMPLATE_MANAGER
 
 template_name = "claude-xml.hbs"
 data = {
@@ -185,7 +185,7 @@ data = {
     "files": [{"path": "file1.py", "code": "print('Hello')"}],
 }
 
-rendered_template = template_manager.render_template(template_name, data)
+rendered_template = TEMPLATE_MANAGER.render_template(template_name, data)
 print(rendered_template)
 ```
 

fabricatio-0.2.6.dev1.dist-info/RECORD

@@ -0,0 +1,42 @@
+fabricatio-0.2.6.dev1.dist-info/METADATA,sha256=BSySyhuAwgYRJFDSx2zlSSpAICPoplPXW3G4tHd0JnA,8896
+fabricatio-0.2.6.dev1.dist-info/WHEEL,sha256=tpW5AN9B-9qsM9WW2FXG2r193YXiqexDadpKp0A2daI,96
+fabricatio-0.2.6.dev1.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio/actions/article.py,sha256=yzRwgc203vI3MW_oWyFybDxTz6kaBBvUgN2zOJJ9Amc,2825
+fabricatio/actions/output.py,sha256=KSSLvEvXsA10ACN2mbqGo98QwKLVUAoMUJNKYk6HhGc,645
+fabricatio/actions/rag.py,sha256=GpT7YlqOYznZyaT-6Y84_33HtZGT-5s71ZK8iroQA9g,813
+fabricatio/capabilities/correct.py,sha256=QslmBYcpblSykZmjxr0vLgyfU0uGKOcwRxUYJZ9-jBc,4527
+fabricatio/capabilities/propose.py,sha256=y3kge5g6bb8HYuV8e9h4MdqOMTlsfAIZpqE_cagWPTY,1593
+fabricatio/capabilities/rag.py,sha256=OebdGps8LGniN_HkRAOuwZd1ZQsyQe3WrduNAmBSxLM,15773
+fabricatio/capabilities/rating.py,sha256=R9otyZVE2E3kKxrOCTZMeesBCPbC-fSb7bXgZPMQzfU,14406
+fabricatio/capabilities/review.py,sha256=XYzpSnFCT9HS2XytQT8HDgV4SjXehexoJgucZFMx6P8,11102
+fabricatio/capabilities/task.py,sha256=nVsC8smZRM5kGnIDiQtgP9kiGkz5KB1S9NXhMvwY2CQ,4607
+fabricatio/config.py,sha256=bpj8i0KT8HQ9ka2kX3lcILBWh4S5_PenCas9wu_Ueg0,16302
+fabricatio/core.py,sha256=VQ_JKgUGIy2gZ8xsTBZCdr_IP7wC5aPg0_bsOmjQ588,6458
+fabricatio/decorators.py,sha256=uzsP4tFKQNjDHBkofsjjoJA0IUAaYOtt6YVedoyOqlo,6551
+fabricatio/fs/curd.py,sha256=N6l2MncjrFfnXBRtteRouXp5Rjy8EAKC_i29_G-zz98,4618
+fabricatio/fs/readers.py,sha256=EZKN_AZdrp8DggJECP53QHw3uHeSDf-AwCAA_V7fNKU,1202
+fabricatio/fs/__init__.py,sha256=PCf0s_9KDjVfNw7AfPoJzGt3jMq4gJOfbcT4pb0D0ZY,588
+fabricatio/journal.py,sha256=stnEP88aUBA_GmU9gfTF2EZI8FS2OyMLGaMSTgK4QgA,476
+fabricatio/models/action.py,sha256=25kaph3csV0VQtxVPQCyRAusgwp6E1R1g4KBs7H9T2c,6448
+fabricatio/models/events.py,sha256=QvlnS8FEELg6KNabcJMeh2GV_y0ZBzKOPphcteKYWYU,4183
+fabricatio/models/extra.py,sha256=O8ncZVsaNmlR5f8c_b2HJc-yVZQ2YhB6ddDbfT0Ysh4,7412
+fabricatio/models/generic.py,sha256=IdPJMf3qxZFq8yqd6OuAYKfCM0wBlJkozgxvxQZVEEc,14025
+fabricatio/models/kwargs_types.py,sha256=jTXgCti-3AyPJwea7g4FxBdsbIwD7jnusi0VhhEhSGo,4286
+fabricatio/models/role.py,sha256=7S3HSjFLaSTZ5bzgTJLeZ3PpAQDEGBxPhou5Mp8ONpQ,1842
+fabricatio/models/task.py,sha256=8NaR7ojQWyM740EDTqt9stwHKdrD6axCRpLKo0QzS-I,10492
+fabricatio/models/tool.py,sha256=4b-v4WIC_LuLOKzzXL9bvKXr8vmGZ8O2uAFv5-1KRA0,7052
+fabricatio/models/usages.py,sha256=hR4OU4sjQ2jKaH5_kkN83vG58n3kcKnt9osND0BYi0Q,28634
+fabricatio/models/utils.py,sha256=1bCqeB6za7ecCAM3cU1raNWuN56732m45rXtlIlc3I4,5017
+fabricatio/parser.py,sha256=SzyVzbKj5L_0IcI5Z5ILpopJxE-1hGhmomskTWdcc68,6194
+fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fabricatio/toolboxes/arithmetic.py,sha256=WLqhY-Pikv11Y_0SGajwZx3WhsLNpHKf9drzAqOf_nY,1369
+fabricatio/toolboxes/fs.py,sha256=l4L1CVxJmjw9Ld2XUpIlWfV0_Fu_2Og6d3E13I-S4aE,736
+fabricatio/toolboxes/__init__.py,sha256=KBJi5OG_pExscdlM7Bnt_UF43j4I3Lv6G71kPVu4KQU,395
+fabricatio/workflows/articles.py,sha256=RebdC_BzSXC-xsck5I9ccC_XIgfhtoeM8FZuhtVDn3U,580
+fabricatio/workflows/rag.py,sha256=-YYp2tlE9Vtfgpg6ROpu6QVO8j8yVSPa6yDzlN3qVxs,520
+fabricatio/_rust.pyi,sha256=pI747rOciunGuQZDvfC3O0A6pLyOiaHSa3A5kHuQO0E,3169
+fabricatio/_rust_instances.py,sha256=2GwF8aVfYNemRI2feBzH1CZfBGno-XJJE5imJokGEYw,314
+fabricatio/__init__.py,sha256=wTPzKLGztMr7orV-KizHRXJFhPGncvAHE7BPeSmBVDU,1926
+fabricatio/_rust.cp312-win_amd64.pyd,sha256=j7ToedGSthvqB4_o2rPN970MQxbmlgQ07zZ6JAKT0eI,1815552
+fabricatio-0.2.6.dev1.data/scripts/tdown.exe,sha256=aq0eF5FWu3Dxz2_8_RDa-lR5HrgGL01nLFWkfcuKSSI,3395072
+fabricatio-0.2.6.dev1.dist-info/RECORD,,

fabricatio-0.2.6.dev0.dist-info/RECORD

@@ -1,41 +0,0 @@
-fabricatio-0.2.6.dev0.dist-info/METADATA,sha256=0rCWeinWl5uI8bzZhMeRORs5dJ8sWa5z5zpoy3Lnj6A,8896
-fabricatio-0.2.6.dev0.dist-info/WHEEL,sha256=tpW5AN9B-9qsM9WW2FXG2r193YXiqexDadpKp0A2daI,96
-fabricatio-0.2.6.dev0.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
-fabricatio/actions/article.py,sha256=yzRwgc203vI3MW_oWyFybDxTz6kaBBvUgN2zOJJ9Amc,2825
-fabricatio/actions/output.py,sha256=KSSLvEvXsA10ACN2mbqGo98QwKLVUAoMUJNKYk6HhGc,645
-fabricatio/actions/rag.py,sha256=GpT7YlqOYznZyaT-6Y84_33HtZGT-5s71ZK8iroQA9g,813
-fabricatio/capabilities/propose.py,sha256=y3kge5g6bb8HYuV8e9h4MdqOMTlsfAIZpqE_cagWPTY,1593
-fabricatio/capabilities/rag.py,sha256=YYaabej-f6a7gBRbJRcJ_Fj89BloNCw0sHOPqs_W8Bk,15773
-fabricatio/capabilities/rating.py,sha256=0Xrfp_AW9u2ltHnZXxz3Pt3fr8fMsO0QiFadegh49IU,14406
-fabricatio/capabilities/review.py,sha256=4FbM8dO-JSPnu22I1lykM9y1gzBtXI5Wj33KtzvULWU,9757
-fabricatio/capabilities/task.py,sha256=hvyZtgkBdrZmuxGqTe-ZkGp2LjymPNE1RK7Y-ztDb7M,4607
-fabricatio/config.py,sha256=rh8OkGwvuM0-bkZGqhVjMt7-hpdD-rz3Ai7OucrbbWY,15784
-fabricatio/core.py,sha256=VQ_JKgUGIy2gZ8xsTBZCdr_IP7wC5aPg0_bsOmjQ588,6458
-fabricatio/decorators.py,sha256=uzsP4tFKQNjDHBkofsjjoJA0IUAaYOtt6YVedoyOqlo,6551
-fabricatio/fs/curd.py,sha256=N6l2MncjrFfnXBRtteRouXp5Rjy8EAKC_i29_G-zz98,4618
-fabricatio/fs/readers.py,sha256=RNWx4T2XXigeprJOxw8YjHfyGlrCtB5MVz01Gw9lvw4,1202
-fabricatio/fs/__init__.py,sha256=uk4yIlz43Yl2mQZ5QuoMstg0DaIQV9h6XXxU4SbdWpY,588
-fabricatio/journal.py,sha256=pCpIFk-IOsDmCcjx1fOsWDDxjkeAGYgu2OrFnuItwcA,801
-fabricatio/models/action.py,sha256=onNzHqb7QaqAQ9dtVKf85DWHiJaGeK9gORi_pT7B5Wc,6445
-fabricatio/models/events.py,sha256=QvlnS8FEELg6KNabcJMeh2GV_y0ZBzKOPphcteKYWYU,4183
-fabricatio/models/extra.py,sha256=O8ncZVsaNmlR5f8c_b2HJc-yVZQ2YhB6ddDbfT0Ysh4,7412
-fabricatio/models/generic.py,sha256=LnXmwdZ8Rjx_lanWOz0T1NsBsFRXfXqubYNzsCvLEH0,13808
-fabricatio/models/kwargs_types.py,sha256=RKD_EXMlz4vuVpGzB9y5qDotSHNOKjk6R0EI4BoNaCg,4282
-fabricatio/models/role.py,sha256=M9JVDmLLvJhY3G0hHMdcs1ywJ0eoAb6CLYbzhv-l_8s,1839
-fabricatio/models/task.py,sha256=sbC0EAZC4rPL2GCJ9i9GlFcZUJ96g39SQ2QP8bbgdqs,10492
-fabricatio/models/tool.py,sha256=4b-v4WIC_LuLOKzzXL9bvKXr8vmGZ8O2uAFv5-1KRA0,7052
-fabricatio/models/usages.py,sha256=dpMIIoYGRyer97sSP2sQVpihLl2C3REtUMDVZum0DQw,27825
-fabricatio/models/utils.py,sha256=QI3bYrKBbzLbKvyzVrZXGcWq3trOOTE-hQAC_WNvjMg,4457
-fabricatio/parser.py,sha256=pwYAoLbWYXtABcnV3s5GdBM0Ngczq-r7n0jKSnpdAxE,5838
-fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fabricatio/toolboxes/arithmetic.py,sha256=WLqhY-Pikv11Y_0SGajwZx3WhsLNpHKf9drzAqOf_nY,1369
-fabricatio/toolboxes/fs.py,sha256=l4L1CVxJmjw9Ld2XUpIlWfV0_Fu_2Og6d3E13I-S4aE,736
-fabricatio/toolboxes/__init__.py,sha256=KBJi5OG_pExscdlM7Bnt_UF43j4I3Lv6G71kPVu4KQU,395
-fabricatio/workflows/articles.py,sha256=RebdC_BzSXC-xsck5I9ccC_XIgfhtoeM8FZuhtVDn3U,580
-fabricatio/workflows/rag.py,sha256=-YYp2tlE9Vtfgpg6ROpu6QVO8j8yVSPa6yDzlN3qVxs,520
-fabricatio/_rust.pyi,sha256=pI747rOciunGuQZDvfC3O0A6pLyOiaHSa3A5kHuQO0E,3169
-fabricatio/_rust_instances.py,sha256=RybIzB2kCoMeU_1kMm2JTz1ka8i524hAra66joDf--s,314
-fabricatio/__init__.py,sha256=22KLRAVoJZUrK7gsDjU1NfiLCnZtV-qgx6TO2YMbuH8,1930
-fabricatio/_rust.cp312-win_amd64.pyd,sha256=AhBvJkNL2zAztAgKdFMhVjnek1VBtetgCX3CCusrM-4,1815552
-fabricatio-0.2.6.dev0.data/scripts/tdown.exe,sha256=FfiaaE9jKm61UyaQHNF7u-QJc8JQhi9btQjn1ySnQ28,3395072
-fabricatio-0.2.6.dev0.dist-info/RECORD,,