fabricatio 0.2.5.dev5__cp312-cp312-manylinux_2_34_x86_64.whl → 0.2.6.dev1__cp312-cp312-manylinux_2_34_x86_64.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/actions/article.py

@@ -2,7 +2,7 @@
 
 from os import PathLike
 from pathlib import Path
-from typing import Callable, List
+from typing import Callable, List, Optional
 
 from fabricatio.fs import safe_text_read
 from fabricatio.journal import logger
@@ -27,7 +27,7 @@ class ExtractArticleEssence(Action):
         task_input: Task,
         reader: Callable[[P], str] = lambda p: Path(p).read_text(encoding="utf-8"),
         **_,
-    ) -> List[ArticleEssence]:
+    ) -> Optional[List[ArticleEssence]]:
         if not task_input.dependencies:
             logger.info(err := "Task not approved, since no dependencies are provided.")
             raise RuntimeError(err)
@@ -51,7 +51,7 @@ class GenerateArticleProposal(Action):
         self,
         task_input: Task,
         **_,
-    ) -> ArticleProposal:
+    ) -> Optional[ArticleProposal]:
         input_path = await self.awhich_pathstr(
             f"{task_input.briefing}\nExtract the path of file, which contains the article briefing that I need to read."
         )
@@ -73,7 +73,7 @@ class GenerateOutline(Action):
         self,
         article_proposal: ArticleProposal,
         **_,
-    ) -> ArticleOutline:
+    ) -> Optional[ArticleOutline]:
         return await self.propose(
             ArticleOutline,
             article_proposal.display(),

fabricatio/actions/output.py

@@ -1,7 +1,5 @@
 """Dump the finalized output to a file."""
 
-from typing import Unpack
-
 from fabricatio.models.action import Action
 from fabricatio.models.generic import FinalizedDumpAble
 from fabricatio.models.task import Task
@@ -12,7 +10,7 @@ class DumpFinalizedOutput(Action):
 
     output_key: str = "dump_path"
 
-    async def _execute(self, task_input: Task, to_dump: FinalizedDumpAble, **cxt: Unpack) -> str:
+    async def _execute(self, task_input: Task, to_dump: FinalizedDumpAble, **_) -> str:
         dump_path = await self.awhich_pathstr(
             f"{task_input.briefing}\n\nExtract a single path of the file, to which I will dump the data."
         )

fabricatio/actions/rag.py

@@ -1,6 +1,6 @@
 """Inject data into the database."""
 
-from typing import List, Optional, Unpack
+from typing import List, Optional
 
 from fabricatio.capabilities.rag import RAG
 from fabricatio.models.action import Action
@@ -13,7 +13,7 @@ class InjectToDB(Action, RAG):
     output_key: str = "collection_name"
 
     async def _execute[T: PrepareVectorization](
-        self, to_inject: T | List[T], collection_name: Optional[str] = "my_collection", **cxt: Unpack
+        self, to_inject: T | List[T], collection_name: Optional[str] = "my_collection", **_
     ) -> Optional[str]:
         if not isinstance(to_inject, list):
             to_inject = [to_inject]

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

@@ -8,9 +8,9 @@ from functools import lru_cache
 from operator import itemgetter
 from os import PathLike
 from pathlib import Path
-from typing import Any, Callable, Dict, List, Optional, Self, Union, Unpack, overload
+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 (
@@ -111,9 +111,9 @@ class RAG(EmbeddingUsage):
             create (bool): Whether to create the collection if it does not exist.
             **kwargs (Unpack[CollectionSimpleConfigKwargs]): Additional keyword arguments for collection configuration.
         """
-        if create and collection_name and not self._client.has_collection(collection_name):
+        if create and collection_name and self.client.has_collection(collection_name):
             kwargs["dimension"] = kwargs.get("dimension") or self.milvus_dimensions or configs.rag.milvus_dimensions
-            self._client.create_collection(collection_name, auto_id=True, **kwargs)
+            self.client.create_collection(collection_name, auto_id=True, **kwargs)
             logger.info(f"Creating collection {collection_name}")
 
         self.target_collection = collection_name
@@ -152,15 +152,17 @@ class RAG(EmbeddingUsage):
             Self: The current instance, allowing for method chaining.
         """
         if isinstance(data, MilvusData):
-            data = data.prepare_insertion()
-        if isinstance(data, list):
-            data = [d.prepare_insertion() if isinstance(d, MilvusData) else d for d in data]
+            prepared_data = data.prepare_insertion()
+        elif isinstance(data, list):
+            prepared_data = [d.prepare_insertion() if isinstance(d, MilvusData) else d for d in data]
+        else:
+            raise TypeError(f"Expected MilvusData or list of MilvusData, got {type(data)}")
         c_name = collection_name or self.safe_target_collection
-        self._client.insert(c_name, data)
+        self.client.insert(c_name, prepared_data)
 
         if flush:
             logger.debug(f"Flushing collection {c_name}")
-            self._client.flush(c_name)
+            self.client.flush(c_name)
         return self
 
     async def consume_file(
@@ -196,14 +198,14 @@ class RAG(EmbeddingUsage):
         self.add_document(await self.pack(text), collection_name or self.safe_target_collection, flush=True)
         return self
 
-    async def afetch_document(
+    async def afetch_document[V: (int, str, float, bytes)](
         self,
         vecs: List[List[float]],
         desired_fields: List[str] | str,
         collection_name: Optional[str] = None,
         similarity_threshold: float = 0.37,
         result_per_query: int = 10,
-    ) -> List[Dict[str, Any]] | List[Any]:
+    ) -> List[Dict[str, Any]] | List[V]:
         """Fetch data from the collection.
 
         Args:
@@ -217,7 +219,7 @@ class RAG(EmbeddingUsage):
             List[Dict[str, Any]] | List[Any]: The retrieved data.
         """
         # Step 1: Search for vectors
-        search_results = self._client.search(
+        search_results = self.client.search(
             collection_name or self.safe_target_collection,
             vecs,
             search_params={"radius": similarity_threshold},
@@ -237,7 +239,7 @@ class RAG(EmbeddingUsage):
 
         if isinstance(desired_fields, list):
             return resp
-        return [r.get(desired_fields) for r in resp]
+        return [r.get(desired_fields) for r in resp]  # extract the single field as list
 
     async def aretrieve(
         self,
@@ -257,12 +259,13 @@ class RAG(EmbeddingUsage):
         """
         if isinstance(query, str):
             query = [query]
-        return (
+        return cast(
+            List[str],
             await self.afetch_document(
                 vecs=(await self.vectorize(query)),
                 desired_fields="text",
                 **kwargs,
-            )
+            ),
         )[:final_limit]
 
     async def aask_retrieved(
@@ -303,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(
@@ -323,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,16 +4,16 @@ 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
 from fabricatio.models.generic import WithBriefing
 from fabricatio.models.kwargs_types import ChooseKwargs, ValidateKwargs
 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 loguru import logger
 
 
 class ProposeTask(WithBriefing, Propose):
@@ -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,