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

fabricatio/actions/article_rag.py

@@ -8,6 +8,7 @@ from fabricatio import BibManager
 from fabricatio.capabilities.censor import Censor
 from fabricatio.capabilities.extract import Extract
 from fabricatio.capabilities.rag import RAG
+from fabricatio.decorators import precheck_package
 from fabricatio.journal import logger
 from fabricatio.models.action import Action
 from fabricatio.models.extra.aricle_rag import ArticleChunk, CitationManager
@@ -15,7 +16,7 @@ from fabricatio.models.extra.article_essence import ArticleEssence
 from fabricatio.models.extra.article_main import Article, ArticleChapter, ArticleSection, ArticleSubsection
 from fabricatio.models.extra.article_outline import ArticleOutline
 from fabricatio.models.extra.rule import RuleSet
-from fabricatio.utils import ok
+from fabricatio.utils import ask_retain, ok
 
 
 class WriteArticleContentRAG(Action, RAG, Extract):
@@ -23,11 +24,14 @@ class WriteArticleContentRAG(Action, RAG, Extract):
 
     ref_limit: int = 35
     """The limit of references to be retrieved"""
+    threshold: float = 0.55
+    """The threshold of relevance"""
     extractor_model: str
     """The model to use for extracting the content from the retrieved references."""
     query_model: str
     """The model to use for querying the database"""
-
+    supervisor: bool = False
+    """Whether to use supervisor mode"""
     req: str = (
         "citation number is REQUIRED to cite any reference!\n"
         "Everything is build upon the typst language, which is similar to latex, \n"
@@ -40,12 +44,12 @@ class WriteArticleContentRAG(Action, RAG, Extract):
         "you can refer to that label by using the syntax with prefix of `@eqt:`"
         "Below is a usage example:\n"
         "```typst\n"
-        "See @eqt:mass-energy-equation , it's the equation.\n"
+        "See @eqt:mass-energy-equation , it's the foundation of physics.\n"
         "$$\n"
         "E = m c^2"
         "$$\n"
-        "<mass-energy-equation>"
-        "In @eqt:mass-energy-equation , we get the foundation of physics.\n"
+        "<mass-energy-equation>\n\n"
+        "In @eqt:mass-energy-equation , $m$ stands for mass, $c$ stands for speed of light, and $E$ stands for energy. \n"
         "```"
     )
 
@@ -57,14 +61,57 @@ class WriteArticleContentRAG(Action, RAG, Extract):
         **cxt,
     ) -> Article:
         article = Article.from_outline(article_outline).update_ref(article_outline)
-        await gather(
-            *[
-                self._inner(article, article_outline, chap, sec, subsec)
-                for chap, sec, subsec in article.iter_subsections()
-            ]
-        )
+
+        if self.supervisor:
+            await gather(
+                *[
+                    self._supervisor_inner(article, article_outline, chap, sec, subsec)
+                    for chap, sec, subsec in article.iter_subsections()
+                ]
+            )
+        else:
+            await gather(
+                *[
+                    self._inner(article, article_outline, chap, sec, subsec)
+                    for chap, sec, subsec in article.iter_subsections()
+                ]
+            )
         return article.convert_tex()
 
+    @precheck_package(
+        "questionary", "`questionary` is required for supervisor mode, please install it by `fabricatio[qa]`"
+    )
+    async def _supervisor_inner(
+        self,
+        article: Article,
+        article_outline: ArticleOutline,
+        chap: ArticleChapter,
+        sec: ArticleSection,
+        subsec: ArticleSubsection,
+    ) -> ArticleSubsection:
+        from questionary import confirm, text
+        from rich import print as r_print
+
+        ret = await self.search_database(article, article_outline, chap, sec, subsec)
+
+        cm = CitationManager(article_chunks=await ask_retain([r.chunk for r in ret], ret)).set_cite_number_all()
+
+        raw = await self.write_raw(article, article_outline, chap, sec, subsec, cm)
+        r_print(raw)
+        while not await confirm("Accept this version and continue?").ask_async():
+            if await confirm("Search for more refs?").ask_async():
+                new_refs = await self.search_database(article, article_outline, chap, sec, subsec)
+                cm.add_chunks(await ask_retain([r.chunk for r in new_refs], new_refs))
+
+            instruction = await text("Enter the instructions to improve").ask_async()
+            raw = await self.write_raw(article, article_outline, chap, sec, subsec, cm, instruction)
+            if await confirm("Edit it?").ask_async():
+                raw = await text("Edit", default=raw).ask_async() or raw
+
+            r_print(raw)
+
+        return await self.extract_new_subsec(subsec, raw, cm)
+
     async def _inner(
         self,
         article: Article,
@@ -73,35 +120,17 @@ class WriteArticleContentRAG(Action, RAG, Extract):
         sec: ArticleSection,
         subsec: ArticleSubsection,
     ) -> ArticleSubsection:
-        ref_q = ok(
-            await self.arefined_query(
-                f"{article_outline.display()}\n\nAbove is my article outline, I m writing graduate thesis titled `{article.title}`. "
-                f"More specifically, i m witting the Chapter `{chap.title}` >> Section `{sec.title}` >> Subsection `{subsec.title}`.\n"
-                f"I need to search related references to build up the content of the subsec mentioned above, which is `{subsec.title}`.\n"
-                f"plus, you can search required formulas by using latex equation code.\n"
-                f"provide 10 queries as possible, to get best result!\n"
-                f"You should provide both English version and chinese version of the refined queries!\n",
-                model=self.query_model,
-            ),
-            "Failed to refine query.",
-        )
-        ret = await self.aretrieve(ref_q, ArticleChunk, final_limit=self.ref_limit, result_per_query=6)
-        ret.reverse()
-        cm = CitationManager().update_chunks(ret)
-
-        raw_paras = await self.aask(
-            f"{cm.as_prompt()}\nAbove is some related reference retrieved for you."
-            f"{article.referenced.display()}\n\nAbove is my article outline, I m writing graduate thesis titled `{article.title}`. "
-            f"More specifically, i m witting the Chapter `{chap.title}` >> Section `{sec.title}` >> Subsection `{subsec.title}`.\n"
-            f"Please help me write the paragraphs of the subsec mentioned above, which is `{subsec.title}`.\n"
-            f"{self.req}\n"
-            f"You SHALL use `{article.language}` as writing language."
-        )
+        ret = await self.search_database(article, article_outline, chap, sec, subsec)
+        cm = CitationManager(article_chunks=ret).set_cite_number_all()
 
-        raw_paras = (
-            raw_paras.replace(r" \( ", "$").replace(r" \) ", "$").replace("\\[\n", "$$\n").replace("\n\\]", "\n$$")
-        )
+        raw_paras = await self.write_raw(article, article_outline, chap, sec, subsec, cm)
+
+        return await self.extract_new_subsec(subsec, raw_paras, cm)
 
+    async def extract_new_subsec(
+        self, subsec: ArticleSubsection, raw_paras: str, cm: CitationManager
+    ) -> ArticleSubsection:
+        """Extract the new subsec."""
         new_subsec = ok(
             await self.extract(
                 ArticleSubsection,
@@ -112,14 +141,71 @@ class WriteArticleContentRAG(Action, RAG, Extract):
             ),
             "Failed to propose new subsection.",
         )
-
         for p in new_subsec.paragraphs:
             p.content = cm.apply(p.content).replace("$$", "\n$$\n")
-
         subsec.update_from(new_subsec)
         logger.debug(f"{subsec.title}:rpl\n{subsec.display()}")
         return subsec
 
+    async def write_raw(
+        self,
+        article: Article,
+        article_outline: ArticleOutline,
+        chap: ArticleChapter,
+        sec: ArticleSection,
+        subsec: ArticleSubsection,
+        cm: CitationManager,
+        extra_instruction: str = "",
+    ) -> str:
+        """Write the raw paragraphs of the subsec."""
+        return (
+            (
+                await self.aask(
+                    f"{cm.as_prompt()}\nAbove is some related reference retrieved for you."
+                    f"{article_outline.finalized_dump()}\n\nAbove is my article outline, I m writing graduate thesis titled `{article.title}`. "
+                    f"More specifically, i m witting the Chapter `{chap.title}` >> Section `{sec.title}` >> Subsection `{subsec.title}`.\n"
+                    f"Please help me write the paragraphs of the subsec mentioned above, which is `{subsec.title}`.\n"
+                    f"{self.req}\n"
+                    f"You SHALL use `{article.language}` as writing language.\n{extra_instruction}"
+                )
+            )
+            .replace(r" \( ", "$")
+            .replace(r" \) ", "$")
+            .replace(r"\(", "$")
+            .replace(r"\)", "$")
+            .replace("\\[\n", "$$\n")
+            .replace("\n\\]", "\n$$")
+        )
+
+    async def search_database(
+        self,
+        article: Article,
+        article_outline: ArticleOutline,
+        chap: ArticleChapter,
+        sec: ArticleSection,
+        subsec: ArticleSubsection,
+        extra_instruction: str = "",
+    ) -> List[ArticleChunk]:
+        """Search database for related references."""
+        ref_q = ok(
+            await self.arefined_query(
+                f"{article_outline.finalized_dump()}\n\nAbove is my article outline, I m writing graduate thesis titled `{article.title}`. "
+                f"More specifically, i m witting the Chapter `{chap.title}` >> Section `{sec.title}` >> Subsection `{subsec.title}`.\n"
+                f"I need to search related references to build up the content of the subsec mentioned above, which is `{subsec.title}`.\n"
+                f"provide 10~16 queries as possible, to get best result!\n"
+                f"You should provide both English version and chinese version of the refined queries!\n{extra_instruction}\n",
+                model=self.query_model,
+            ),
+            "Failed to refine query.",
+        )
+
+        if self.supervisor:
+            ref_q = await ask_retain(ref_q)
+
+        return await self.aretrieve(
+            ref_q, ArticleChunk, final_limit=self.ref_limit, result_per_query=3, similarity_threshold=self.threshold
+        )
+
 
 class TweakArticleRAG(Action, RAG, Censor):
     """Write an article based on the provided outline.

fabricatio/decorators.py

@@ -6,7 +6,7 @@ from importlib.util import find_spec
 from inspect import signature
 from shutil import which
 from types import ModuleType
-from typing import Callable, List, Optional
+from typing import Callable, Coroutine, List, Optional
 
 from fabricatio.config import configs
 from fabricatio.journal import logger
@@ -23,7 +23,20 @@ def precheck_package[**P, R](package_name: str, msg: str) -> Callable[[Callable[
         bool: True if the package exists, False otherwise.
     """
 
-    def _wrapper(func: Callable[P, R]) -> Callable[P, R]:
+    def _wrapper(
+        func: Callable[P, R] | Callable[P, Coroutine[None, None, R]],
+    ) -> Callable[P, R] | Callable[P, Coroutine[None, None, R]]:
+        if iscoroutinefunction(func):
+
+            @wraps(func)
+            async def _async_inner(*args: P.args, **kwargs: P.kwargs) -> R:
+                if find_spec(package_name):
+                    return await func(*args, **kwargs)
+                raise RuntimeError(msg)
+
+            return _async_inner
+
+        @wraps(func)
         def _inner(*args: P.args, **kwargs: P.kwargs) -> R:
             if find_spec(package_name):
                 return func(*args, **kwargs)
@@ -35,7 +48,7 @@ def precheck_package[**P, R](package_name: str, msg: str) -> Callable[[Callable[
 
 
 def depend_on_external_cmd[**P, R](
-        bin_name: str, install_tip: Optional[str], homepage: Optional[str] = None
+    bin_name: str, install_tip: Optional[str], homepage: Optional[str] = None
 ) -> Callable[[Callable[P, R]], Callable[P, R]]:
     """Decorator to check for the presence of an external command.
 
@@ -88,8 +101,9 @@ def logging_execution_info[**P, R](func: Callable[P, R]) -> Callable[P, R]:
     return _wrapper
 
 
-@precheck_package("questionary",
-                  "'questionary' is required to run this function. Have you installed `fabricatio[qa]`?.")
+@precheck_package(
+    "questionary", "'questionary' is required to run this function. Have you installed `fabricatio[qa]`?."
+)
 def confirm_to_execute[**P, R](func: Callable[P, R]) -> Callable[P, Optional[R]] | Callable[P, R]:
     """Decorator to confirm before executing a function.
 
@@ -109,8 +123,8 @@ def confirm_to_execute[**P, R](func: Callable[P, R]) -> Callable[P, Optional[R]]
         @wraps(func)
         async def _wrapper(*args: P.args, **kwargs: P.kwargs) -> Optional[R]:
             if await confirm(
-                    f"Are you sure to execute function: {func.__name__}{signature(func)} \n📦 Args:{args}\n🔑 Kwargs:{kwargs}\n",
-                    instruction="Please input [Yes/No] to proceed (default: Yes):",
+                f"Are you sure to execute function: {func.__name__}{signature(func)} \n📦 Args:{args}\n🔑 Kwargs:{kwargs}\n",
+                instruction="Please input [Yes/No] to proceed (default: Yes):",
             ).ask_async():
                 return await func(*args, **kwargs)
             logger.warning(f"Function: {func.__name__}{signature(func)} canceled by user.")
@@ -121,8 +135,8 @@ def confirm_to_execute[**P, R](func: Callable[P, R]) -> Callable[P, Optional[R]]
         @wraps(func)
         def _wrapper(*args: P.args, **kwargs: P.kwargs) -> Optional[R]:
             if confirm(
-                    f"Are you sure to execute function: {func.__name__}{signature(func)} \n📦 Args:{args}\n��� Kwargs:{kwargs}\n",
-                    instruction="Please input [Yes/No] to proceed (default: Yes):",
+                f"Are you sure to execute function: {func.__name__}{signature(func)} \n📦 Args:{args}\n��� Kwargs:{kwargs}\n",
+                instruction="Please input [Yes/No] to proceed (default: Yes):",
             ).ask():
                 return func(*args, **kwargs)
             logger.warning(f"Function: {func.__name__}{signature(func)} canceled by user.")
@@ -203,7 +217,9 @@ def use_temp_module[**P, R](modules: ModuleType | List[ModuleType]) -> Callable[
     return _decorator
 
 
-def logging_exec_time[**P, R](func: Callable[P, R]) -> Callable[P, R]:
+def logging_exec_time[**P, R](
+    func: Callable[P, R] | Callable[P, Coroutine[None, None, R]],
+) -> Callable[P, R] | Callable[P, Coroutine[None, None, R]]:
     """Decorator to log the execution time of a function.
 
     Args:
@@ -215,6 +231,7 @@ def logging_exec_time[**P, R](func: Callable[P, R]) -> Callable[P, R]:
     from time import time
 
     if iscoroutinefunction(func):
+
         @wraps(func)
         async def _async_wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
             start_time = time()

fabricatio/models/extra/aricle_rag.py

@@ -190,6 +190,12 @@ class CitationManager(AsPrompt):
             self.set_cite_number_all()
         return self
 
+    def add_chunks(self, article_chunks: List[ArticleChunk], set_cite_number: bool = True)-> Self:
+        """Add article chunks."""
+        self.article_chunks.extend(article_chunks)
+        if set_cite_number:
+            self.set_cite_number_all()
+        return self
     def set_cite_number_all(self) -> Self:
         """Set citation numbers for all article chunks."""
         for i, a in enumerate(self.article_chunks, 1):

fabricatio/models/extra/article_base.py

@@ -18,6 +18,7 @@ from fabricatio.models.generic import (
     Titled,
     WordCount,
 )
+from fabricatio.rust import comment
 from pydantic import Field
 
 
@@ -29,11 +30,9 @@ class ReferringType(StrEnum):
     SUBSECTION = "subsection"
 
 
-
 type RefKey = Tuple[str, Optional[str], Optional[str]]
 
 
-
 class ArticleMetaData(SketchedAble, Described, WordCount, Titled, Language):
     """Metadata for an article component."""
 
@@ -48,8 +47,6 @@ class ArticleMetaData(SketchedAble, Described, WordCount, Titled, Language):
     """List of writing aims of the research component in academic style."""
 
 
-
-
 class ArticleOutlineBase(
     ArticleMetaData,
     ResolveUpdateConflict,
@@ -92,7 +89,13 @@ class SubSectionBase(ArticleOutlineBase):
 
     def to_typst_code(self) -> str:
         """Converts the component into a Typst code snippet for rendering."""
-        return f"=== {self.title}\n"
+        return (
+            f"=== {self.title}\n"
+            f"{comment(f'Desc:\n{self.description}\nAims:\n{"\n".join(self.aims)}')}\n"
+            + f"Expected Word Count:{self.expected_word_count}"
+            if self.expected_word_count
+            else ""
+        )
 
     def introspect(self) -> str:
         """Introspects the article subsection outline."""
@@ -117,7 +120,13 @@ class SectionBase[T: SubSectionBase](ArticleOutlineBase):
         Returns:
             str: The formatted Typst code snippet.
         """
-        return f"== {self.title}\n" + "\n\n".join(subsec.to_typst_code() for subsec in self.subsections)
+        return (
+            f"== {self.title}\n"
+            f"{comment(f'Desc:\n{self.description}\nAims:\n{"\n".join(self.aims)}')}\n"
+            + f"Expected Word Count:{self.expected_word_count}"
+            if self.expected_word_count
+            else ""
+        ) + "\n\n".join(subsec.to_typst_code() for subsec in self.subsections)
 
     def resolve_update_conflict(self, other: Self) -> str:
         """Resolve update errors in the article outline."""
@@ -160,7 +169,13 @@ class ChapterBase[T: SectionBase](ArticleOutlineBase):
 
     def to_typst_code(self) -> str:
         """Converts the chapter into a Typst formatted code snippet for rendering."""
-        return f"= {self.title}\n" + "\n\n".join(sec.to_typst_code() for sec in self.sections)
+        return (
+            f"= {self.title}\n"
+            f"{comment(f'Desc:\n{self.description}\nAims:\n{"\n".join(self.aims)}')}\n"
+            + f"Expected Word Count:{self.expected_word_count}"
+            if self.expected_word_count
+            else ""
+        ) + "\n\n".join(sec.to_typst_code() for sec in self.sections)
 
     def resolve_update_conflict(self, other: Self) -> str:
         """Resolve update errors in the article outline."""
@@ -302,4 +317,8 @@ class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, WordCount, Descri
             === Implementation Details
             == Evaluation Protocol
         """
-        return "\n\n".join(a.to_typst_code() for a in self.chapters)
+        return comment(
+            f"Title:{self.title}\nDesc:\n{self.description}\n" + f"Word Count:{self.expected_word_count}"
+            if self.expected_word_count
+            else ""
+        ) + "\n\n".join(a.to_typst_code() for a in self.chapters)

fabricatio/rust.pyi

@@ -24,7 +24,7 @@ class TemplateManager:
     """
 
     def __init__(
-            self, template_dirs: List[Path], suffix: Optional[str] = None, active_loading: Optional[bool] = None
+        self, template_dirs: List[Path], suffix: Optional[str] = None, active_loading: Optional[bool] = None
     ) -> None:
         """Initialize the template manager.
 
@@ -55,13 +55,9 @@ class TemplateManager:
         """
 
     @overload
-    def render_template(self, name: str, data: Dict[str, Any]) -> str:
-        ...
-
+    def render_template(self, name: str, data: Dict[str, Any]) -> str: ...
     @overload
-    def render_template(self, name: str, data: List[Dict[str, Any]]) -> List[str]:
-        ...
-
+    def render_template(self, name: str, data: List[Dict[str, Any]]) -> List[str]: ...
     def render_template(self, name: str, data: Dict[str, Any] | List[Dict[str, Any]]) -> str | List[str]:
         """Render a template with context data.
 
@@ -77,13 +73,9 @@ class TemplateManager:
         """
 
     @overload
-    def render_template_raw(self, template: str, data: Dict[str, Any]) -> str:
-        ...
-
+    def render_template_raw(self, template: str, data: Dict[str, Any]) -> str: ...
     @overload
-    def render_template_raw(self, template: str, data: List[Dict[str, Any]]) -> List[str]:
-        ...
-
+    def render_template_raw(self, template: str, data: List[Dict[str, Any]]) -> List[str]: ...
     def render_template_raw(self, template: str, data: Dict[str, Any] | List[Dict[str, Any]]) -> str | List[str]:
         """Render a template with context data.
 
@@ -95,6 +87,113 @@ class TemplateManager:
             Rendered template content as string or list of strings
         """
 
+class BibManager:
+    """BibTeX bibliography manager for parsing and querying citation data."""
+
+    def __init__(self, path: str) -> None:
+        """Initialize the bibliography manager.
+
+        Args:
+            path: Path to BibTeX (.bib) file to load
+
+        Raises:
+            RuntimeError: If file cannot be read or parsed
+        """
+
+    def get_cite_key_by_title(self, title: str) -> Optional[str]:
+        """Find citation key by exact title match.
+
+        Args:
+            title: Full title to search for (case-insensitive)
+
+        Returns:
+            Citation key if exact match found, None otherwise
+        """
+
+    def get_cite_key_by_title_fuzzy(self, title: str) -> Optional[str]:
+        """Find citation key by fuzzy title match.
+
+        Args:
+            title: Search term to find in bibliography entries
+
+        Returns:
+            Citation key of best matching entry, or None if no good match
+        """
+
+    def get_cite_key_fuzzy(self, query: str) -> Optional[str]:
+        """Find best matching citation using fuzzy text search.
+
+        Args:
+            query: Search term to find in bibliography entries
+
+        Returns:
+            Citation key of best matching entry, or None if no good match
+
+        Notes:
+            Uses nucleo_matcher for high-quality fuzzy text searching
+            See: https://crates.io/crates/nucleo-matcher
+        """
+
+    def list_titles(self, is_verbatim: Optional[bool] = False) -> List[str]:
+        """List all titles in the bibliography.
+
+        Args:
+            is_verbatim: Whether to return verbatim titles (without formatting)
+
+        Returns:
+            List of all titles in the bibliography
+        """
+
+    def get_author_by_key(self, key: str) -> Optional[List[str]]:
+        """Retrieve authors by citation key.
+
+        Args:
+            key: Citation key
+
+        Returns:
+            List of authors if found, None otherwise
+        """
+
+    def get_year_by_key(self, key: str) -> Optional[int]:
+        """Retrieve the publication year by citation key.
+
+        Args:
+            key: Citation key
+
+        Returns:
+            Publication year if found, None otherwise
+        """
+
+    def get_abstract_by_key(self, key: str) -> Optional[str]:
+        """Retrieve the abstract by citation key.
+
+        Args:
+            key: Citation key
+
+        Returns:
+            Abstract if found, None otherwise
+        """
+
+    def get_title_by_key(self, key: str) -> Optional[str]:
+        """Retrieve the title by citation key.
+
+        Args:
+            key: Citation key
+
+        Returns:
+            Title if found, None otherwise
+        """
+
+    def get_field_by_key(self, key: str, field: str) -> Optional[str]:
+        """Retrieve a specific field by citation key.
+
+        Args:
+            key: Citation key
+            field: Field name
+
+        Returns:
+            Field value if found, None otherwise
+        """
 
 def blake3_hash(content: bytes) -> str:
     """Calculate the BLAKE3 cryptographic hash of data.
@@ -106,11 +205,9 @@ def blake3_hash(content: bytes) -> str:
         Hex-encoded BLAKE3 hash string
     """
 
-
 def detect_language(string: str) -> str:
     """Detect the language of a given string."""
 
-
 def split_word_bounds(string: str) -> List[str]:
     """Split the string into words based on word boundaries.
 
@@ -121,7 +218,6 @@ def split_word_bounds(string: str) -> List[str]:
         A list of words extracted from the string.
     """
 
-
 def split_sentence_bounds(string: str) -> List[str]:
     """Split the string into sentences based on sentence boundaries.
 
@@ -132,7 +228,6 @@ def split_sentence_bounds(string: str) -> List[str]:
         A list of sentences extracted from the string.
     """
 
-
 def split_into_chunks(string: str, max_chunk_size: int, max_overlapping_rate: float = 0.3) -> List[str]:
     """Split the string into chunks of a specified size.
 
@@ -145,7 +240,6 @@ def split_into_chunks(string: str, max_chunk_size: int, max_overlapping_rate: fl
         A list of chunks extracted from the string.
     """
 
-
 def word_count(string: str) -> int:
     """Count the number of words in the string.
 
@@ -156,67 +250,51 @@ def word_count(string: str) -> int:
         The number of words in the string.
     """
 
-
 def is_chinese(string: str) -> bool:
     """Check if the given string is in Chinese."""
 
-
 def is_english(string: str) -> bool:
     """Check if the given string is in English."""
 
-
 def is_japanese(string: str) -> bool:
     """Check if the given string is in Japanese."""
 
-
 def is_korean(string: str) -> bool:
     """Check if the given string is in Korean."""
 
-
 def is_arabic(string: str) -> bool:
     """Check if the given string is in Arabic."""
 
-
 def is_russian(string: str) -> bool:
     """Check if the given string is in Russian."""
 
-
 def is_german(string: str) -> bool:
     """Check if the given string is in German."""
 
-
 def is_french(string: str) -> bool:
     """Check if the given string is in French."""
 
-
 def is_hindi(string: str) -> bool:
     """Check if the given string is in Hindi."""
 
-
 def is_italian(string: str) -> bool:
     """Check if the given string is in Italian."""
 
-
 def is_dutch(string: str) -> bool:
     """Check if the given string is in Dutch."""
 
-
 def is_portuguese(string: str) -> bool:
     """Check if the given string is in Portuguese."""
 
-
 def is_swedish(string: str) -> bool:
     """Check if the given string is in Swedish."""
 
-
 def is_turkish(string: str) -> bool:
     """Check if the given string is in Turkish."""
 
-
 def is_vietnamese(string: str) -> bool:
     """Check if the given string is in Vietnamese."""
 
-
 def tex_to_typst(string: str) -> str:
     """Convert TeX to Typst.
 
@@ -227,7 +305,6 @@ def tex_to_typst(string: str) -> str:
         The converted Typst string.
     """
 
-
 def convert_all_inline_tex(string: str) -> str:
     """Convert all inline TeX code in the string.
 
@@ -238,7 +315,6 @@ def convert_all_inline_tex(string: str) -> str:
         The converted string with inline TeX code replaced.
     """
 
-
 def convert_all_block_tex(string: str) -> str:
     """Convert all block TeX code in the string.
 
@@ -249,111 +325,22 @@ def convert_all_block_tex(string: str) -> str:
         The converted string with block TeX code replaced.
     """
 
+def comment(string: str) -> str:
+    """Add comment to the string.
 
-class BibManager:
-    """BibTeX bibliography manager for parsing and querying citation data."""
-
-    def __init__(self, path: str) -> None:
-        """Initialize the bibliography manager.
-
-        Args:
-            path: Path to BibTeX (.bib) file to load
-
-        Raises:
-            RuntimeError: If file cannot be read or parsed
-        """
-
-    def get_cite_key_by_title(self, title: str) -> Optional[str]:
-        """Find citation key by exact title match.
-
-        Args:
-            title: Full title to search for (case-insensitive)
-
-        Returns:
-            Citation key if exact match found, None otherwise
-        """
-
-    def get_cite_key_by_title_fuzzy(self, title: str) -> Optional[str]:
-        """Find citation key by fuzzy title match.
-
-        Args:
-            title: Search term to find in bibliography entries
-
-        Returns:
-            Citation key of best matching entry, or None if no good match
-        """
-
-    def get_cite_key_fuzzy(self, query: str) -> Optional[str]:
-        """Find best matching citation using fuzzy text search.
-
-        Args:
-            query: Search term to find in bibliography entries
-
-        Returns:
-            Citation key of best matching entry, or None if no good match
-
-        Notes:
-            Uses nucleo_matcher for high-quality fuzzy text searching
-            See: https://crates.io/crates/nucleo-matcher
-        """
-
-    def list_titles(self, is_verbatim: Optional[bool] = False) -> List[str]:
-        """List all titles in the bibliography.
-
-        Args:
-            is_verbatim: Whether to return verbatim titles (without formatting)
-
-        Returns:
-            List of all titles in the bibliography
-        """
-
-    def get_author_by_key(self, key: str) -> Optional[List[str]]:
-        """Retrieve authors by citation key.
-
-        Args:
-            key: Citation key
-
-        Returns:
-            List of authors if found, None otherwise
-        """
-
-    def get_year_by_key(self, key: str) -> Optional[int]:
-        """Retrieve the publication year by citation key.
-
-        Args:
-            key: Citation key
-
-        Returns:
-            Publication year if found, None otherwise
-        """
-
-    def get_abstract_by_key(self, key: str) -> Optional[str]:
-        """Retrieve the abstract by citation key.
-
-        Args:
-            key: Citation key
-
-        Returns:
-            Abstract if found, None otherwise
-        """
-
-    def get_title_by_key(self, key: str) -> Optional[str]:
-        """Retrieve the title by citation key.
-
-        Args:
-            key: Citation key
+    Args:
+        string: The input string to which comments will be added.
 
-        Returns:
-            Title if found, None otherwise
-        """
+    Returns:
+        The string with each line prefixed by '// '.
+    """
 
-    def get_field_by_key(self, key: str, field: str) -> Optional[str]:
-        """Retrieve a specific field by citation key.
+def uncomment(string: str) -> str:
+    """Remove comment from the string.
 
-        Args:
-            key: Citation key
-            field: Field name
+    Args:
+        string: The input string from which comments will be removed.
 
-        Returns:
-            Field value if found, None otherwise
-        """
+    Returns:
+        The string with comments (lines starting with '// ' or '//') removed.
+    """

fabricatio/utils.py

@@ -1,6 +1,6 @@
 """A collection of utility functions for the fabricatio package."""
 
-from typing import Any, Dict, List, Mapping, Optional
+from typing import Any, Dict, List, Mapping, Optional, overload
 
 from fabricatio.decorators import precheck_package
 
@@ -8,9 +8,7 @@ from fabricatio.decorators import precheck_package
 @precheck_package(
     "questionary", "'questionary' is required to run this function. Have you installed `fabricatio[qa]`?."
 )
-async def ask_edit(
-    text_seq: List[str],
-) -> List[str]:
+async def ask_edit(text_seq: List[str]) -> List[str]:
     """Asks the user to edit a list of texts.
 
     Args:
@@ -30,6 +28,29 @@ async def ask_edit(
     return res
 
 
+@overload
+async def ask_retain[V](candidates: List[str]) -> List[str]: ...
+
+
+@overload
+async def ask_retain[V](candidates: List[str], value_mapping: List[V]) -> List[V]: ...
+
+
+@precheck_package(
+    "questionary", "'questionary' is required to run this function. Have you installed `fabricatio[qa]`?."
+)
+async def ask_retain[V](candidates: List[str], value_mapping: Optional[List[V]] = None) -> List[str] | List[V]:
+    """Asks the user to retain a list of candidates."""
+    from questionary import Choice, checkbox
+
+    return await checkbox(
+        "Please choose those that should be retained.",
+        choices=[Choice(p, value=p, checked=True) for p in candidates]
+        if value_mapping is None
+        else [Choice(p, value=v) for p, v in zip(candidates, value_mapping, strict=True)],
+    ).ask_async()
+
+
 def override_kwargs(kwargs: Mapping[str, Any], **overrides) -> Dict[str, Any]:
     """Override the values in kwargs with the provided overrides."""
     new_kwargs = dict(kwargs.items())
@@ -71,5 +92,3 @@ def wrapp_in_block(string: str, title: str, style: str = "-") -> str:
         str: The wrapped string.
     """
     return f"--- Start of {title} ---\n{string}\n--- End of {title} ---".replace("-", style)
-
-

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

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

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

@@ -1,8 +1,8 @@
-fabricatio-0.2.11.dev1.dist-info/METADATA,sha256=GC-i85oxlfkyYU9coT5f3zIJUVGksKiKQFDJJBnAxGc,5178
-fabricatio-0.2.11.dev1.dist-info/WHEEL,sha256=jABKVkLC9kJr8mi_er5jOqpiQUjARSLXDUIIxDqsS50,96
-fabricatio-0.2.11.dev1.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio-0.2.11.dev2.dist-info/METADATA,sha256=8vrHMg-FM5vxNTDy3G5Ck3n9MM4UJ9NeHcgXQVUYrRI,5178
+fabricatio-0.2.11.dev2.dist-info/WHEEL,sha256=jABKVkLC9kJr8mi_er5jOqpiQUjARSLXDUIIxDqsS50,96
+fabricatio-0.2.11.dev2.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
 fabricatio/actions/article.py,sha256=J2wneRmGDVzzyvsFw1Ux69Q6kI8Ty3Dty0l5eToSGX0,10237
-fabricatio/actions/article_rag.py,sha256=rN-g3uQbgmMZbYtV63jOMYQ6ssOFtKbRtZGJ8ZOjXug,10710
+fabricatio/actions/article_rag.py,sha256=UdhkZ2MAi094xKkdIKpdprOS-OOPb9xwceKX4tRRhSw,14221
 fabricatio/actions/fs.py,sha256=gJR14U4ln35nt8Z7OWLVAZpqGaLnED-r1Yi-lX22tkI,959
 fabricatio/actions/output.py,sha256=ttXLC2wZmtVN9Ik8zsA7g45rwBO656LyRjOGRdVSyJA,6977
 fabricatio/actions/rag.py,sha256=KN-OWgcQjGmNgSZ-s5B8m4LpYKSGFJR8eq72mo2CP9k,3592
@@ -22,7 +22,7 @@ fabricatio/capabilities/__init__.py,sha256=v1cHRHIJ2gxyqMLNCs6ERVcCakSasZNYzmMI4
 fabricatio/config.py,sha256=okqrVoLhvmAjmfQXlLY3js4nC_qW4v7mxoYaGO2dMQ8,17984
 fabricatio/constants.py,sha256=thfDuF6JEtJ5CHOnAJLfqvn5834n8ep6DH2jc6XGzQM,577
 fabricatio/core.py,sha256=VQ_JKgUGIy2gZ8xsTBZCdr_IP7wC5aPg0_bsOmjQ588,6458
-fabricatio/decorators.py,sha256=nYCYnJd7s0h-jcCLqt4XLcc4fXTUIc5DFnk7gne1GOo,8453
+fabricatio/decorators.py,sha256=RFMYUlQPf561-BIHetpMd7fPig5bZ2brzWiQTgoLOlY,8966
 fabricatio/fs/curd.py,sha256=p8y0LGKgVDk-CWOlm37E6wg7RK6RCD6denKo-VsW28c,4763
 fabricatio/fs/readers.py,sha256=UXvcJO3UCsxHu9PPkg34Yh55Zi-miv61jD_wZQJgKRs,1751
 fabricatio/fs/__init__.py,sha256=FydmlEY_3QY74r1BpGDc5lFLhE6g6gkwOAtE30Fo-aI,786
@@ -31,8 +31,8 @@ fabricatio/models/action.py,sha256=Kfa-zojgHQ1vPoC2lQp-thTTp0oySKn7k6I4ea6iYTs,9
 fabricatio/models/adv_kwargs_types.py,sha256=kUO-SiZtFuz5cZCmMLnJJ9tjQ4-Zd_foo6R8HQMlM5A,1950
 fabricatio/models/events.py,sha256=wiirk_ASg3iXDOZU_gIimci1VZVzWE1nDmxy-hQVJ9M,4150
 fabricatio/models/extra/advanced_judge.py,sha256=INUl_41C8jkausDekkjnEmTwNfLCJ23TwFjq2cM23Cw,1092
-fabricatio/models/extra/aricle_rag.py,sha256=MYTzq_wDxMXDC7kXElQNJxX6b7w50o7LyEvkE4Yosk4,9503
-fabricatio/models/extra/article_base.py,sha256=DxBex4UsMAFmHmriwXkcvGIuU-WTSD4ZfzDEk-no9TA,11894
+fabricatio/models/extra/aricle_rag.py,sha256=bJ9qNa9DkTVvja8GVue5wMnJCwnr6TEO7_fQbQK7fv4,9780
+fabricatio/models/extra/article_base.py,sha256=CeYs0D6XghxgpSnQ-rhtWuuFhcouy_vc6E5oUCPck_w,12840
 fabricatio/models/extra/article_essence.py,sha256=mlIkkRMR3I1RtqiiOnmIE3Vy623L4eECumkRzryE1pw,2749
 fabricatio/models/extra/article_main.py,sha256=4rjev0wpI2jf52NLNatRbqFQmN6rtKaMB9iy30hSEXM,9818
 fabricatio/models/extra/article_outline.py,sha256=w7O0SHgC7exbptWVbR62FMHAueMgBpyWKVYMGGl_oj8,1427
@@ -50,16 +50,16 @@ fabricatio/models/tool.py,sha256=jQ51g4lwTPfsMF1nbreDJtBczbxIHoXcPuLSOqHliq8,125
 fabricatio/models/usages.py,sha256=B9kII7wP9uUj6-M69kbnTsWQpZcJ-gKZ2HplIxL0j1c,33358
 fabricatio/parser.py,sha256=-RbW2yzfJiu2ARq-lZw4tfgsjY2rIZWtJpoUmaE6gJQ,6637
 fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fabricatio/rust.pyi,sha256=g-lfJY5-5kLRNUFHXPHdf539RaTErm1r29HlHAvs8hs,10091
+fabricatio/rust.pyi,sha256=GJRLeeQ1UIaf5kOgJWX2GkwIacoTBk3yBKuD5cKW8i4,10489
 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
 fabricatio/toolboxes/__init__.py,sha256=KBJi5OG_pExscdlM7Bnt_UF43j4I3Lv6G71kPVu4KQU,395
-fabricatio/utils.py,sha256=Fju7bvxrF2r-tGpRGuIQHvgjiifSfDYXZYdBXWtzFns,2310
+fabricatio/utils.py,sha256=vlXbAA4b_odh2wlAcJlNQ-1ckkxNNKDGJaxShdljojA,3146
 fabricatio/workflows/articles.py,sha256=ObYTFUqLUk_CzdmmnX6S7APfxcGmPFqnFr9pdjU7Z4Y,969
 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=xuHK1JAwjOPlN_BojaTTIKycn8ILyBRuSUE8Mlj3qhM,4147712
-fabricatio-0.2.11.dev1.data/scripts/tdown.exe,sha256=yx3AcvfP3lcjWcNlgPBXzH863MlWBnrJjqXkLoC39nk,3351040
-fabricatio-0.2.11.dev1.dist-info/RECORD,,
+fabricatio/rust.cp312-win_amd64.pyd,sha256=UUJZ7DBWgQbROlf5Cfa-yJOWSp_1qNTJwbp4AmxOVUU,4150272
+fabricatio-0.2.11.dev2.data/scripts/tdown.exe,sha256=LtLVx_ahJ-FP1bpQm-GMXr8_xYPf_Ax-tap9bHW6PvA,3350016
+fabricatio-0.2.11.dev2.dist-info/RECORD,,