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

fabricatio/models/extra/problem.py

@@ -3,12 +3,11 @@
 from itertools import chain
 from typing import Any, List, Optional, Self, Tuple, Unpack
 
-from pydantic import Field
-from rich import print as r_print
-
 from fabricatio.journal import logger
 from fabricatio.models.generic import SketchedAble, WithBriefing
 from fabricatio.utils import ask_edit
+from pydantic import Field
+from rich import print as r_print
 
 
 class Problem(SketchedAble, WithBriefing):
@@ -74,6 +73,7 @@ class ProblemSolutions(SketchedAble):
         return len(self.solutions) > 0
 
     async def edit_problem(self) -> Self:
+        """Interactively edit the problem description."""
         from questionary import text
 
         """Interactively edit the problem description."""

fabricatio/models/generic.py

@@ -6,7 +6,13 @@ from pathlib import Path
 from typing import Any, Callable, Dict, Iterable, List, Mapping, Optional, Self, Type, Union, final, overload
 
 import ujson
+from fabricatio.config import configs
+from fabricatio.fs.readers import safe_text_read
+from fabricatio.journal import logger
+from fabricatio.parser import JsonCapture
 from fabricatio.rust import blake3_hash, detect_language
+from fabricatio.rust_instances import TEMPLATE_MANAGER
+from fabricatio.utils import ok
 from litellm.utils import token_counter
 from pydantic import (
     BaseModel,
@@ -21,13 +27,6 @@ from pydantic import (
 )
 from pydantic.json_schema import GenerateJsonSchema, JsonSchemaValue
 
-from fabricatio.config import configs
-from fabricatio.fs.readers import safe_text_read
-from fabricatio.journal import logger
-from fabricatio.parser import JsonCapture
-from fabricatio.rust_instances import TEMPLATE_MANAGER
-from fabricatio.utils import ok
-
 
 class Base(BaseModel):
     """Base class for all models with Pydantic configuration.
@@ -75,9 +74,9 @@ class Display(Base):
             str: Combined display output with boundary markers
         """
         return (
-                "--- Start of Extra Info Sequence ---"
-                + "\n".join(d.compact() if compact else d.display() for d in seq)
-                + "--- End of Extra Info Sequence ---"
+            "--- Start of Extra Info Sequence ---"
+            + "\n".join(d.compact() if compact else d.display() for d in seq)
+            + "--- End of Extra Info Sequence ---"
         )
 
 
@@ -179,16 +178,13 @@ class WithRef[T](Base):
         )
 
     @overload
-    def update_ref[S: WithRef](self: S, reference: T) -> S:
-        ...
+    def update_ref[S: WithRef](self: S, reference: T) -> S: ...
 
     @overload
-    def update_ref[S: WithRef](self: S, reference: "WithRef[T]") -> S:
-        ...
+    def update_ref[S: WithRef](self: S, reference: "WithRef[T]") -> S: ...
 
     @overload
-    def update_ref[S: WithRef](self: S, reference: None = None) -> S:
-        ...
+    def update_ref[S: WithRef](self: S, reference: None = None) -> S: ...
 
     def update_ref[S: WithRef](self: S, reference: Union[T, "WithRef[T]", None] = None) -> S:  # noqa: PYI019
         """Update the reference of the object.
@@ -472,9 +468,8 @@ class WithFormatedJsonSchema(Base):
             str: The JSON schema of the model in a formatted string.
         """
         return ujson.dumps(
-            cls.model_json_schema(schema_generator=UnsortGenerate),
-            option=ujson.OPT_INDENT_2,
-        ).decode()
+            cls.model_json_schema(schema_generator=UnsortGenerate), indent=2, ensure_ascii=False, sort_keys=False
+        )
 
 
 class CreateJsonObjPrompt(WithFormatedJsonSchema):
@@ -884,15 +879,11 @@ class Patch[T](ProposedAble):
             # copy the desc info of each corresponding fields from `ref_cls`
             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"]
+                    ref_cls.model_fields[field_name].description or my_schema["properties"][field_name]["description"]
                 )
             my_schema["description"] = ref_cls.__doc__
 
-        return ujson.dumps(
-            my_schema,
-            option=ujson.OPT_INDENT_2,
-        ).decode()
+        return ujson.dumps(my_schema, indent=2, ensure_ascii=False, sort_keys=False)
 
 
 class SequencePatch[T](ProposedUpdateAble):

fabricatio/models/kwargs_types.py

@@ -68,7 +68,7 @@ class ValidateKwargs[T](GenerateKwargs, total=False):
 
     default: Optional[T]
     max_validations: int
-    
+
 
 
 class CompositeScoreKwargs(ValidateKwargs[List[Dict[str, float]]], total=False):

fabricatio/rust.pyi

@@ -14,7 +14,6 @@ Key Features:
 from pathlib import Path
 from typing import Any, Dict, List, Optional, overload
 
-
 class TemplateManager:
     """Template rendering engine using Handlebars templates.
 
@@ -25,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.
 
@@ -56,46 +55,145 @@ 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.
-    
+
         Args:
             name: Template name (without extension)
             data: Context dictionary or list of dictionaries to provide variables to the template
-    
+
         Returns:
             Rendered template content as string or list of strings
-    
+
         Raises:
             RuntimeError: If template rendering fails
         """
 
     @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.
-    
+
         Args:
             template: The template string
             data: Context dictionary or list of dictionaries to provide variables to the template
-    
+
         Returns:
             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.
@@ -107,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.
 
@@ -122,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.
 
@@ -133,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.
 
@@ -146,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.
 
@@ -157,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.
 
@@ -228,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.
 
@@ -239,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.
 
@@ -250,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.dev0.dist-info → fabricatio-0.2.11.dev2.dist-info}/METADATA

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