fabricatio 0.2.9.dev1__cp312-cp312-win_amd64.whl → 0.2.9.dev2__cp312-cp312-win_amd64.whl

fabricatio/actions/output.py

@@ -1,7 +1,7 @@
 """Dump the finalized output to a file."""
 
 from pathlib import Path
-from typing import Iterable, List, Optional, Type
+from typing import Any, Iterable, List, Optional, Type
 
 from fabricatio.journal import logger
 from fabricatio.models.action import Action
@@ -33,6 +33,7 @@ class DumpFinalizedOutput(Action):
                 "Could not find the path of file to dump the data.",
             )
         )
+        logger.info(f"Saving output to {dump_path.as_posix()}")
         ok(to_dump, "Could not dump the data since the path is not specified.").finalized_dump_to(dump_path)
         return dump_path.as_posix()
 
@@ -41,7 +42,11 @@ class PersistentAll(Action):
     """Persist all the data to a file."""
 
     output_key: str = "persistent_count"
+    """The number of objects persisted."""
     persist_dir: Optional[str] = None
+    """The directory to persist the data."""
+    override: bool = False
+    """Whether to remove the existing dir before dumping."""
 
     async def _execute(
         self,
@@ -64,16 +69,22 @@ class PersistentAll(Action):
         if persist_dir.is_file():
             logger.warning("Dump should be a directory, but it is a file. Skip dumping.")
             return count
-
+        if self.override and persist_dir.is_dir():
+            logger.info(f"Override the existing directory {persist_dir.as_posix()}.")
+            persist_dir.rmdir()
+        logger.info(f"Starting persistence in directory {persist_dir}")
         for k, v in cxt.items():
             final_dir = persist_dir.joinpath(k)
+            logger.debug(f"Checking key {k} for persistence")
             if isinstance(v, PersistentAble):
+                logger.info(f"Persisting object {k} to {final_dir}")
                 final_dir.mkdir(parents=True, exist_ok=True)
                 v.persist(final_dir)
                 count += 1
             if isinstance(v, Iterable) and any(
                 persistent_ables := (pers for pers in v if isinstance(pers, PersistentAble))
             ):
+                logger.info(f"Persisting collection {k} to {final_dir}")
                 final_dir.mkdir(parents=True, exist_ok=True)
                 for per in persistent_ables:
                     per.persist(final_dir)
@@ -93,10 +104,39 @@ class RetrieveFromPersistent[T: PersistentAble](Action):
     """The class of the object to retrieve."""
 
     async def _execute(self, /, **__) -> Optional[T | List[T]]:
-        logger.info(f"Retrieve `{self.retrieve_cls.__name__}` from persistent file: {self.load_path}")
+        logger.info(f"Retrieve `{self.retrieve_cls.__name__}` from {self.load_path}")
         if not (p := Path(self.load_path)).exists():
+            logger.warning(f"Path {self.load_path} does not exist")
             return None
 
         if p.is_dir():
+            logger.info(f"Found directory with {len(list(p.glob('*')))} items")
             return [self.retrieve_cls.from_persistent(per) for per in p.glob("*")]
         return self.retrieve_cls.from_persistent(self.load_path)
+
+
+class GatherAsList(Action):
+    """Gather the objects from the context as a list.
+
+    Notes:
+        If both `gather_suffix` and `gather_prefix` are specified, only the objects with the suffix will be gathered.
+    """
+    output_key: str = "gathered"
+    """Gather the objects from the context as a list."""
+    gather_suffix: Optional[str] = None
+    """Gather the objects from the context as a list."""
+    gather_prefix: Optional[str] = None
+    """Gather the objects from the context as a list."""
+
+    async def _execute(self, **cxt) -> List[Any]:
+
+        if self.gather_suffix is not None:
+            result = [cxt[k] for k in cxt if k.endswith(self.gather_suffix)]
+            logger.debug(f"Gathered {len(result)} items with suffix {self.gather_suffix}")
+            return result
+        if  self.gather_prefix is None:
+            logger.error(err:="Either `gather_suffix` or `gather_prefix` must be specified.")
+            raise ValueError(err)
+        result = [cxt[k] for k in cxt if k.startswith(self.gather_prefix)]
+        logger.debug(f"Gathered {len(result)} items with prefix {self.gather_prefix}")
+        return result

fabricatio/capabilities/censor.py

@@ -20,8 +20,6 @@ class Censor(Correct, Check):
     Inherits from both Correct and Check classes.
     Provides methods to censor objects and strings by first checking them against a ruleset and then correcting them if necessary.
 
-    Attributes:
-        ruleset (RuleSet): The ruleset to be used for censoring.
     """
 
     async def censor_obj[M: SketchedAble](
@@ -42,7 +40,7 @@ class Censor(Correct, Check):
         """
         imp = await self.check_obj(obj, ruleset, **override_kwargs(kwargs, default=None))
         if imp is None:
-            return imp
+            return None
         return await self.correct_obj(obj, imp, **kwargs)
 
     async def censor_string(

fabricatio/capabilities/check.py

@@ -11,6 +11,7 @@ from fabricatio.models.extra.problem import Improvement
 from fabricatio.models.extra.rule import Rule, RuleSet
 from fabricatio.models.generic import Display, WithBriefing
 from fabricatio.models.kwargs_types import ValidateKwargs
+from fabricatio.rust import detect_language
 from fabricatio.utils import override_kwargs
 
 
@@ -56,9 +57,7 @@ class Check(AdvancedJudge, Propose):
 
         ruleset_patch = await self.propose(
             RuleSetBriefingPatch,
-            f"# Rules Requirements\n{rule_reqs}\n# Generated Rules\n{Display.seq_display(rules)}\n\n"
-            f"You need to write a concise and detailed patch for this ruleset that can be applied to the ruleset nicely.\n"
-            f"Note that all fields in this patch will be directly copied to the ruleset obj, including `name` and `description`, so write when knowing the subject.\n",
+            f"{ruleset_requirement}\n\nYou should use `{detect_language(ruleset_requirement)}`!",
             **override_kwargs(kwargs, default=None),
         )
 
@@ -98,7 +97,7 @@ class Check(AdvancedJudge, Propose):
                 Improvement,
                 TEMPLATE_MANAGER.render_template(
                     configs.templates.check_string_template,
-                    {"to_check": input_text, "rule": rule, "judge": judge.display(), "reference": reference},
+                    {"to_check": input_text, "rule": rule.display(), "judge": judge.display(), "reference": reference},
                 ),
                 **kwargs,
             )

fabricatio/capabilities/correct.py

@@ -78,11 +78,11 @@ class Correct(Rating, Propose):
             TEMPLATE_MANAGER.render_template(
                 configs.templates.fix_troubled_obj_template,
                 {
-                    "problem": problem_solutions.problem,
+                    "problem": problem_solutions.problem.display(),
                     "solution": ok(
                         problem_solutions.final_solution(),
                         f"No solution found for problem: {problem_solutions.problem}",
-                    ),
+                    ).display(),
                     "reference": reference,
                 },
             ),
@@ -111,11 +111,11 @@ class Correct(Rating, Propose):
             TEMPLATE_MANAGER.render_template(
                 configs.templates.fix_troubled_string_template,
                 {
-                    "problem": problem_solutions.problem,
+                    "problem": problem_solutions.problem.display(),
                     "solution": ok(
                         problem_solutions.final_solution(),
                         f"No solution found for problem: {problem_solutions.problem}",
-                    ),
+                    ).display(),
                     "reference": reference,
                     "string_to_fix": input_text,
                 },

fabricatio/config.py

@@ -303,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/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
@@ -50,28 +55,26 @@ class Action(WithBriefing, LLMUsage):
         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)
 
@@ -83,10 +86,10 @@ class Action(WithBriefing, LLMUsage):
 
     @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}"
@@ -98,10 +101,15 @@ class Action(WithBriefing, LLMUsage):
         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.
 
-    A workflow manages the execution of multiple actions in sequence, passing
-    a shared context between them and handling task lifecycle events.
+    Handles context propagation between actions, error handling, and task lifecycle
+    events like cancellation and completion.
+
+    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 = ""
@@ -137,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}")
 
@@ -206,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)}
@@ -230,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/extra/article_base.py

@@ -7,8 +7,6 @@ from typing import Generator, List, Optional, Self, Tuple, overload
 
 from fabricatio.models.generic import (
     AsPrompt,
-    CensoredAble,
-    Display,
     FinalizedDumpAble,
     Introspect,
     ModelHash,
@@ -16,6 +14,7 @@ from fabricatio.models.generic import (
     ProposedUpdateAble,
     ResolveUpdateConflict,
     SequencePatch,
+    SketchedAble,
 )
 
 
@@ -30,7 +29,7 @@ class ReferringType(StrEnum):
 type RefKey = Tuple[str, Optional[str], Optional[str]]
 
 
-class ArticleRef(CensoredAble, ProposedUpdateAble):
+class ArticleRef(ProposedUpdateAble):
     """Reference to a specific chapter, section or subsection within the article. You SHALL not refer to an article component that is external and not present within our own article.
 
     Examples:
@@ -104,7 +103,7 @@ class ArticleRef(CensoredAble, ProposedUpdateAble):
         return ReferringType.CHAPTER
 
 
-class ArticleMetaData(CensoredAble, Display):
+class ArticleMetaData(SketchedAble):
     """Metadata for an article component."""
 
     description: str
@@ -120,6 +119,9 @@ class ArticleMetaData(CensoredAble, Display):
     title: str
     """Do not add any prefix or suffix to the title. should not contain special characters."""
 
+    expected_word_count: int
+    """Expected word count of this research component."""
+
 
 class ArticleRefSequencePatch(SequencePatch[ArticleRef]):
     """Patch for article refs."""

fabricatio/models/extra/article_main.py

@@ -14,11 +14,11 @@ from fabricatio.models.extra.article_base import (
 from fabricatio.models.extra.article_outline import (
     ArticleOutline,
 )
-from fabricatio.models.generic import CensoredAble, Display, PersistentAble, SequencePatch, WithRef
+from fabricatio.models.generic import PersistentAble, SequencePatch, SketchedAble, WithRef
 from fabricatio.utils import ok
 
 
-class Paragraph(CensoredAble):
+class Paragraph(SketchedAble):
     """Structured academic paragraph blueprint for controlled content generation."""
 
     description: str
@@ -73,8 +73,7 @@ class ArticleChapter(ChapterBase[ArticleSection]):
 
 
 class Article(
-    Display,
-    CensoredAble,
+    SketchedAble,
     WithRef[ArticleOutline],
     PersistentAble,
     ArticleBase[ArticleChapter],

fabricatio/models/extra/article_outline.py

@@ -9,7 +9,7 @@ from fabricatio.models.extra.article_base import (
     SubSectionBase,
 )
 from fabricatio.models.extra.article_proposal import ArticleProposal
-from fabricatio.models.generic import CensoredAble, Display, PersistentAble, WithRef
+from fabricatio.models.generic import PersistentAble, SketchedAble, WithRef
 
 
 class ArticleSubsectionOutline(SubSectionBase):
@@ -25,8 +25,7 @@ class ArticleChapterOutline(ChapterBase[ArticleSectionOutline]):
 
 
 class ArticleOutline(
-    Display,
-    CensoredAble,
+    SketchedAble,
     WithRef[ArticleProposal],
     PersistentAble,
     ArticleBase[ArticleChapterOutline],

fabricatio/models/extra/article_proposal.py

@@ -2,10 +2,10 @@
 
 from typing import Dict, List
 
-from fabricatio.models.generic import AsPrompt, CensoredAble, Display, PersistentAble, WithRef
+from fabricatio.models.generic import AsPrompt, SketchedAble, PersistentAble, WithRef
 
 
-class ArticleProposal(CensoredAble, Display, WithRef[str], AsPrompt, PersistentAble):
+class ArticleProposal(SketchedAble, WithRef[str], AsPrompt, PersistentAble):
     """Structured proposal for academic paper development with core research elements.
 
     Guides LLM in generating comprehensive research proposals with clearly defined components.
@@ -41,8 +41,8 @@ class ArticleProposal(CensoredAble, Display, WithRef[str], AsPrompt, PersistentA
     abstract: str
     """A concise summary of the research proposal, outlining the main points and objectives."""
 
-    min_word_count: int
-    """The minimum number of words required for the research proposal."""
+    expected_word_count: int
+    """The estimated word count of the final academic paper."""
 
     def _as_prompt_inner(self) -> Dict[str, str]:
         return {

fabricatio/models/generic.py

@@ -33,45 +33,50 @@ class Base(BaseModel):
     """Base class for all models with Pydantic configuration.
 
     This class sets up the basic Pydantic configuration for all models in the Fabricatio library.
+    The `model_config` uses `use_attribute_docstrings=True` to ensure field descriptions are
+    pulled from the attribute's docstring instead of the default Pydantic behavior.
     """
-
     model_config = ConfigDict(use_attribute_docstrings=True)
 
 
 class Display(Base):
-    """Class that provides a method to display the model in a formatted JSON string.
+    """Class that provides formatted JSON representation utilities.
 
-    This class includes methods to display the model in both formatted and compact JSON strings.
+    Provides methods to generate both pretty-printed and compact JSON representations of the model.
+    Used for debugging and logging purposes.
     """
-
     def display(self) -> str:
-        """Display the model in a formatted JSON string.
+        """Generate pretty-printed JSON representation.
 
         Returns:
-            str: The formatted JSON string of the model.
+            str: JSON string with 1-level indentation for readability
         """
         return self.model_dump_json(indent=1)
 
     def compact(self) -> str:
-        """Display the model in a compact JSON string.
+        """Generate compact JSON representation.
 
         Returns:
-            str: The compact JSON string of the model.
+            str: Minified JSON string without whitespace
         """
         return self.model_dump_json()
 
     @staticmethod
     def seq_display(seq: Iterable["Display"], compact: bool = False) -> str:
-        """Display a sequence of Display objects in a formatted JSON string.
+        """Generate formatted display for sequence of Display objects.
 
         Args:
-            seq (Iterable[Display]): The sequence of Display objects to display.
-            compact (bool): Whether to display the sequence in a compact format. Defaults to False.
+            seq (Iterable[Display]): Sequence of objects to display
+            compact (bool): Use compact format instead of pretty print
 
         Returns:
-            str: The formatted JSON string of the sequence.
+            str: Combined display output with boundary markers
         """
-        return "\n".join(d.compact() if compact else d.display() for d in seq)
+        return (
+            "--- Start of Extra Info Sequence ---"
+            + "\n".join(d.compact() if compact else d.display() for d in seq)
+            + "--- End of Extra Info Sequence ---"
+        )
 
 
 class Named(Base):
@@ -184,25 +189,29 @@ class WithRef[T](Base):
 
 
 class PersistentAble(Base):
-    """Class that provides a method to persist the object.
+    """Class providing file persistence capabilities.
 
-    This class includes methods to persist the object to a file or directory.
+    Enables saving model instances to disk with timestamped filenames and loading from persisted files.
+    Implements basic versioning through filename hashing and timestamping.
     """
-
     def persist(self, path: str | Path) -> Self:
-        """Persist the object to a file or directory.
+        """Save model instance to disk with versioned filename.
 
         Args:
-            path (str | Path): The path to save the object.
+            path (str | Path): Target directory or file path. If directory, filename is auto-generated.
 
         Returns:
-            Self: The current instance of the object.
+            Self: Current instance for method chaining
+
+        Notes:
+            - Filename format: <ClassName>_<YYYYMMDD_HHMMSS>_<6-char_hash>.json
+            - Hash generated from JSON content ensures uniqueness
         """
         p = Path(path)
         out = self.model_dump_json()
 
         # Generate a timestamp in the format YYYYMMDD_HHMMSS
-        timestamp = datetime.now().strftime("%Y%m%d")
+        timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
 
         # Generate the hash
         file_hash = blake3_hash(out.encode())[:6]
@@ -219,15 +228,52 @@ class PersistentAble(Base):
         logger.info(f"Persisted `{self.__class__.__name__}` to {p.as_posix()}")
         return self
 
+    @classmethod
+    def from_latest_persistent(cls, dir_path: str | Path) -> Self:
+        """Load most recent persisted instance from directory.
+
+        Args:
+            dir_path (str | Path): Directory containing persisted files
+
+        Returns:
+            Self: Most recently modified instance
+
+        Raises:
+            NotADirectoryError: If path is not a valid directory
+            FileNotFoundError: If no matching files found
+        """
+        dir_path = Path(dir_path)
+        if not dir_path.is_dir():
+            raise NotADirectoryError(f"{dir_path} is not a valid directory")
+
+        pattern = f"{cls.__name__}_*.json"
+        files = list(dir_path.glob(pattern))
+
+        if not files:
+            raise FileNotFoundError(f"No persistent files found for {cls.__name__} in {dir_path}")
+
+        def _get_timestamp(file_path: Path) -> datetime:
+            stem = file_path.stem
+            parts = stem.split("_")
+            return datetime.strptime(f"{parts[1]}_{parts[2]}", "%Y%m%d_%H%M%S")
+
+        files.sort(key=lambda f: _get_timestamp(f), reverse=True)
+
+        return cls.from_persistent(files.pop(0))
+
     @classmethod
     def from_persistent(cls, path: str | Path) -> Self:
-        """Load the object from a file.
+        """Load an instance from a specific persisted file.
 
         Args:
-            path (str | Path): The path to load the object from.
+            path (str | Path): Path to the JSON file.
 
         Returns:
-            Self: The current instance of the object.
+            Self: The loaded instance from the file.
+
+        Raises:
+            FileNotFoundError: If the specified file does not exist.
+            ValueError: If the file content is invalid for the model.
         """
         return cls.model_validate_json(safe_text_read(path))
 
@@ -236,7 +282,7 @@ class Language(Base):
     """Class that provides a language attribute."""
 
     language: str
-    """The written language of this object, which should be aligned to the original requirement 
+    """The written language of this object, which should be aligned to the original requirement
     For example if the requirement is in Chinese, the language should be set to `zh`, if the requirement is in English, the language should be set to `en` and etc."""
 
 
@@ -619,11 +665,11 @@ class Vectorizable(Base):
 
 
 class ScopedConfig(Base):
-    """Class that manages a scoped configuration.
+    """Configuration holder with hierarchical fallback mechanism.
 
-    This class includes attributes and methods to manage configuration settings scoped to the instance.
+    Manages LLM, embedding, and vector database configurations with fallback logic.
+    Allows configuration values to be overridden in a hierarchical manner.
     """
-
     llm_api_endpoint: Optional[HttpUrl] = None
     """The OpenAI API endpoint."""
 
@@ -698,13 +744,15 @@ class ScopedConfig(Base):
 
     @final
     def fallback_to(self, other: "ScopedConfig") -> Self:
-        """Fallback to another instance's attribute values if the current instance's attributes are None.
+        """Merge configuration values with fallback priority.
+
+        Copies non-null values from 'other' to self where current values are None.
 
         Args:
-            other (ScopedConfig): Another instance from which to copy attribute values.
+            other (ScopedConfig): Configuration to fallback to
 
         Returns:
-            Self: The current instance, allowing for method chaining.
+            Self: Current instance with merged values
         """
         # Iterate over the attribute names and copy values from 'other' to 'self' where applicable
         # noinspection PydanticTypeChecker,PyTypeChecker
@@ -718,13 +766,15 @@ class ScopedConfig(Base):
 
     @final
     def hold_to(self, others: Union["ScopedConfig", Iterable["ScopedConfig"]]) -> Self:
-        """Hold to another instance's attribute values if the current instance's attributes are None.
+        """Propagate non-null values to other configurations.
+
+        Copies current non-null values to target configurations where they are None.
 
         Args:
-            others (Union[ScopedConfig, Iterable[ScopedConfig]]): Another instance or iterable of instances from which to copy attribute values.
+            others (ScopedConfig|Iterable): Target configurations to update
 
         Returns:
-            Self: The current instance, allowing for method chaining.
+            Self: Current instance unchanged
         """
         if not isinstance(others, Iterable):
             others = [others]
@@ -777,14 +827,15 @@ class Patch[T](ProposedAble):
             str: The JSON schema of the model in a formatted string.
         """
         my_schema = cls.model_json_schema(schema_generator=UnsortGenerate)
-        if (ref_cls := cls.ref_cls()) is not None:
+
+        ref_cls = cls.ref_cls()
+        if ref_cls is not None:
             # copy the desc info of each corresponding fields from `ref_cls`
-            for field_name, field_info in cls.model_fields.items():
-                if (ref_field := getattr(ref_cls, field_name, None)) is not None:
-                    if (desc := ref_field.field_info.description) is not None:
-                        my_schema["properties"][field_name]["description"] = desc
-                    if (example := ref_field.field_info.examples) is not None:
-                        my_schema["properties"][field_name]["examples"] = example
+            for field_name in [f for f in cls.model_fields if f in ref_cls.model_fields]:
+                my_schema["properties"][field_name]["description"] = (
+                    ref_cls.model_fields[field_name].description or my_schema["properties"][field_name]["description"]
+                )
+            my_schema["description"] = ref_cls.__doc__
 
         return orjson.dumps(
             my_schema,

fabricatio/rust.pyi

@@ -1,5 +1,7 @@
 from pathlib import Path
-from typing import Any, Dict, List, Optional
+from typing import List, Optional
+
+from pydantic import JsonValue
 
 class TemplateManager:
     """Template rendering engine using Handlebars templates.
@@ -41,7 +43,7 @@ class TemplateManager:
         This refreshes the template cache, finding any new or modified templates.
         """
 
-    def render_template(self, name: str, data: Dict[str, Any]) -> str:
+    def render_template(self, name: str, data: JsonValue) -> str:
         """Render a template with context data.
 
         Args:
@@ -55,7 +57,7 @@ class TemplateManager:
             RuntimeError: If template rendering fails
         """
 
-    def render_template_raw(self, template: str, data: Dict[str, Any]) -> str:
+    def render_template_raw(self, template: str, data: JsonValue) -> str:
         """Render a template with context data.
 
         Args:
@@ -76,7 +78,7 @@ def blake3_hash(content: bytes) -> str:
         Hex-encoded BLAKE3 hash string
     """
 
-def detect_language(string:str)->str:
+def detect_language(string: str) -> str:
     """Detect the language of a given string."""
 
 class BibManager:
@@ -165,7 +167,7 @@ class BibManager:
             Title if found, None otherwise
         """
 
-    def get_field_by_key(self, key: str, field: str)-> Optional[str]:
+    def get_field_by_key(self, key: str, field: str) -> Optional[str]:
         """Retrieve a specific field by citation key.
 
         Args:

{fabricatio-0.2.9.dev1.dist-info → fabricatio-0.2.9.dev2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.9.dev1
+Version: 0.2.9.dev2
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12

{fabricatio-0.2.9.dev1.dist-info → fabricatio-0.2.9.dev2.dist-info}/RECORD

@@ -1,43 +1,43 @@
-fabricatio-0.2.9.dev1.dist-info/METADATA,sha256=-IE_9trmCGkYuiIMorqcfBiHinbpt-bDX_HYF6pJj1A,5288
-fabricatio-0.2.9.dev1.dist-info/WHEEL,sha256=jABKVkLC9kJr8mi_er5jOqpiQUjARSLXDUIIxDqsS50,96
-fabricatio-0.2.9.dev1.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio-0.2.9.dev2.dist-info/METADATA,sha256=ElK7Y7uZngHDENVdObyZ5dxGFdvEt1tXligNdjKUKjc,5288
+fabricatio-0.2.9.dev2.dist-info/WHEEL,sha256=jABKVkLC9kJr8mi_er5jOqpiQUjARSLXDUIIxDqsS50,96
+fabricatio-0.2.9.dev2.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
 fabricatio/actions/article.py,sha256=D-9aGLC1eW9w_aNICGNpdkUm7jx01h8nBcAPSW_Da7E,12788
 fabricatio/actions/article_rag.py,sha256=dkfskNqntVPi81Xm_NFdTQM8v2nR9FJIexzkK9rg-NU,4352
-fabricatio/actions/output.py,sha256=-FfTzXEHIb_zOT-j4T4b5ND96zHLDEGdjlmmPviIbiM,3754
+fabricatio/actions/output.py,sha256=4b5fs_blwWDjm3qgEoHgOJV8Bb6YzE1uQH2J7KG3I8o,5761
 fabricatio/actions/rag.py,sha256=5nSih3YUkdt1uU02hSAMW6sADq9mkMOR1wDv7zIrIGQ,2737
 fabricatio/actions/rules.py,sha256=pA6ADNgpPWBp2a3FTEuF--0INHg0QJxc0kfxF1zMDXQ,1541
 fabricatio/actions/__init__.py,sha256=wVENCFtpVb1rLFxoOFJt9-8smLWXuJV7IwA8P3EfFz4,48
 fabricatio/capabilities/advanced_judge.py,sha256=selB0Gwf1F4gGJlwBiRo6gI4KOUROgh3WnzO3mZFEls,706
-fabricatio/capabilities/censor.py,sha256=J-YgwnDus3vKDpeFENhGvUSxvpC8FnhhnWJe1RffcqI,3869
-fabricatio/capabilities/check.py,sha256=uzxiar7bHGgxu7JqU8tRSncN3KP6xo5r3c8wvyBd3M8,8287
-fabricatio/capabilities/correct.py,sha256=I9RWmFjwXEjbYzIgtyFbqc0RvTpHeMHdGT9tuKHwCtY,9177
+fabricatio/capabilities/censor.py,sha256=7LJrybFsv5yGjd_bfiempUw_YpmiYBze9XIzRLqH2CA,3787
+fabricatio/capabilities/check.py,sha256=9NTRyJ8FvK-cC4o0KUolhZu58JLeOU8Mz9HIoBuNxP4,8044
+fabricatio/capabilities/correct.py,sha256=b6GCcLzRruC6VjFS-uhC3m-7LGosr3Pso3cYLokQ03Y,9217
 fabricatio/capabilities/propose.py,sha256=hkBeSlmcTdfYWT-ph6nlbtHXBozi_JXqXlWcnBy3W78,2007
 fabricatio/capabilities/rag.py,sha256=8TTJSV2Tz0naXyOQ5c_RQ4h9ZxyOOSE7BvyWxKkQMU0,17722
 fabricatio/capabilities/rating.py,sha256=5HjWGk-tFscnMo4cFTAE820yeOaXT9utNSRKVrSTbSA,17012
 fabricatio/capabilities/review.py,sha256=-EMZe0ADFPT6fPGmra16UPjJC1M3rAs6dPFdTZ88Fgg,5060
 fabricatio/capabilities/task.py,sha256=JahC61X233UIPsjovxJgc_yqj_BjWZJBCzJZq11M2Xk,4417
 fabricatio/capabilities/__init__.py,sha256=v1cHRHIJ2gxyqMLNCs6ERVcCakSasZNYzmMI4lqAcls,57
-fabricatio/config.py,sha256=Q9VHk4T8ajJEPPckjUuhJ0vjvqc79zufUbek_5GHTbE,17679
+fabricatio/config.py,sha256=fJHPY3LXSZWpEF17rAkY-IKeuB7oFlQrkRBIsModnlI,17687
 fabricatio/core.py,sha256=VQ_JKgUGIy2gZ8xsTBZCdr_IP7wC5aPg0_bsOmjQ588,6458
 fabricatio/decorators.py,sha256=C0Gi7wcXC-0sWITqsSv3JdBGcgVJOlRvOt0FfO0aUsA,7554
 fabricatio/fs/curd.py,sha256=p8y0LGKgVDk-CWOlm37E6wg7RK6RCD6denKo-VsW28c,4763
 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=C0PnZ5ycLcqcQ5s1h4KcLJXc1ZZmxYRfCQvz2DuSAOo,9229
+fabricatio/models/action.py,sha256=N7h03z0fWSBVnSzc6uWRetrZluXr6Ibg4D5rD-vjUSU,9778
 fabricatio/models/adv_kwargs_types.py,sha256=dcYMLn6xcnWLZTLTBdtpgUZWi-VBeub721GzHRZFT1g,860
 fabricatio/models/events.py,sha256=QvlnS8FEELg6KNabcJMeh2GV_y0ZBzKOPphcteKYWYU,4183
 fabricatio/models/extra/advanced_judge.py,sha256=mi3KiB8FUuSYICzXPXKwVhCyRE1GL3gHLkwuc-4mh3c,999
-fabricatio/models/extra/article_base.py,sha256=1Fg3iWbod1TCU3nIJK9mOq_8K3oGBtSW03VUwi2I5tg,17058
+fabricatio/models/extra/article_base.py,sha256=suOcuvxGwnTDLRyiWDEhCsw2h2zrClBclGzsO3273XI,17112
 fabricatio/models/extra/article_essence.py,sha256=xd6j-PDqjhrMjgUmyfk6HqkyMLu-sS9feUo0sZ3QABY,2825
-fabricatio/models/extra/article_main.py,sha256=0Xj54pRxUw5Iaj9npYmHKT-ZMvEIBlZ6G1ysNJRgceM,8225
-fabricatio/models/extra/article_outline.py,sha256=jFbVgiwlo7rnwCGS6ToVgeMUOoRe99Edgbx95THR6z8,1450
-fabricatio/models/extra/article_proposal.py,sha256=L2kPvH1XCCQSNcI1KQU3ULGq7C24Y88ssugX43LgbsE,2043
+fabricatio/models/extra/article_main.py,sha256=6ULNb6kHW6wlFs1P-4hJsQdB4fSKs2yTqwXMHEcTO1g,8202
+fabricatio/models/extra/article_outline.py,sha256=w7O0SHgC7exbptWVbR62FMHAueMgBpyWKVYMGGl_oj8,1427
+fabricatio/models/extra/article_proposal.py,sha256=BLt0GBqrDDKSXy9ukrmYCM2HInYVGI5MVGkUYvoNBf8,2020
 fabricatio/models/extra/patches.py,sha256=-nBsse7g1astJh_IWZLXJdEQxpRla-DkHWqSHE-zbMU,989
 fabricatio/models/extra/problem.py,sha256=KwYkc7kjoEG7cwj9C8sWLoZgtBqJVuxlU_7KkvtSgO0,5828
 fabricatio/models/extra/rule.py,sha256=SDAPub17OzVJlPby358MQpKCyxmmojWucfuyr5zogeI,2091
 fabricatio/models/extra/__init__.py,sha256=XlYnS_2B9nhLhtQkjE7rvvfPmAAtXVdNi9bSDAR-Ge8,54
-fabricatio/models/generic.py,sha256=ioofSuSxJrgij6ZwucCV7RkVEU9XkW3C359k7s8ZhPA,28274
+fabricatio/models/generic.py,sha256=Zfokr5BhIW2Rt6_cOfMoHPCsLDRSHENwqagdD-YqbEQ,30156
 fabricatio/models/kwargs_types.py,sha256=sMDA85SoC1AOJ5k6qC8qUiUv0Ne0_5ThU9FZITRNen4,5673
 fabricatio/models/role.py,sha256=-CRcj5_M3_ciLPzwiNn92grBmwoSLQ-n4koVZiCNTBM,2953
 fabricatio/models/task.py,sha256=YXvO3upJkTqMQjPgUGfp0bIiSyZzek2f4IagHdMW5Ik,10491
@@ -46,7 +46,7 @@ fabricatio/models/usages.py,sha256=atMrA1MlPthpKYjV5lIrvJwe-BFomOQXQAWAS85YFqw,3
 fabricatio/models/utils.py,sha256=Ac5g-8ic6q_w7dhNuh-iiofpL1sqOACxbjPPTljP2LY,4417
 fabricatio/parser.py,sha256=UOSvXigEXK-eXsr3m3b7glOhbBWs4kDJTeTNyuqA9ic,6315
 fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fabricatio/rust.pyi,sha256=iMEp-lQDKr8PD42ct6d24dPGNjpBiNAGwHyPZGtu-e4,5195
+fabricatio/rust.pyi,sha256=DC4d8zQierX3J-M1oTaXyGBoBPus7N5uFt0hyGNl3P0,5212
 fabricatio/rust_instances.py,sha256=Byeo8KHW_dJiXujJq7YPGDLBX5bHNDYbBc4sY3uubVY,313
 fabricatio/toolboxes/arithmetic.py,sha256=WLqhY-Pikv11Y_0SGajwZx3WhsLNpHKf9drzAqOf_nY,1369
 fabricatio/toolboxes/fs.py,sha256=l4L1CVxJmjw9Ld2XUpIlWfV0_Fu_2Og6d3E13I-S4aE,736
@@ -56,6 +56,6 @@ fabricatio/workflows/articles.py,sha256=G5HGRr-DHuYuEcfhFdFAuDvTTJ9aSU_UQ2yYXEjT
 fabricatio/workflows/rag.py,sha256=-YYp2tlE9Vtfgpg6ROpu6QVO8j8yVSPa6yDzlN3qVxs,520
 fabricatio/workflows/__init__.py,sha256=5ScFSTA-bvhCesj3U9Mnmi6Law6N1fmh5UKyh58L3u8,51
 fabricatio/__init__.py,sha256=Rmvq2VgdS2u68vnOi2i5RbeWbAwrJDbk8D8D883PJWE,1022
-fabricatio/rust.cp312-win_amd64.pyd,sha256=_KH3Q40xx8oxJyKgmUNtRoWQXtCMmWZg239SqJaUxx8,2170880
-fabricatio-0.2.9.dev1.data/scripts/tdown.exe,sha256=XH14dECiES13OanYo8sGr0B9DJdaGRO-a_S4933s4D4,3395072
-fabricatio-0.2.9.dev1.dist-info/RECORD,,
+fabricatio/rust.cp312-win_amd64.pyd,sha256=J7RO4JEsfwpgeZSsV2wWtlMd3TXL0a90AJdDLkqlX58,2170880
+fabricatio-0.2.9.dev2.data/scripts/tdown.exe,sha256=VvK4W6LYfgPzIEwegvpCKkmuhXkBR8MgzIQEYJhNIXQ,3395072
+fabricatio-0.2.9.dev2.dist-info/RECORD,,