fabricatio 0.2.9.dev3__cp312-cp312-win_amd64.whl → 0.2.10.dev0__cp312-cp312-win_amd64.whl

fabricatio/models/extra/article_base.py

@@ -2,8 +2,7 @@
 
 from abc import ABC, abstractmethod
 from enum import StrEnum
-from itertools import chain
-from typing import Generator, List, Optional, Self, Tuple, overload
+from typing import Generator, List, Optional, Self, Tuple
 
 from fabricatio.models.generic import (
     AsPrompt,
@@ -15,9 +14,11 @@ from fabricatio.models.generic import (
     PersistentAble,
     ProposedUpdateAble,
     ResolveUpdateConflict,
-    SequencePatch,
     SketchedAble,
+    Titled,
+    WordCount,
 )
+from pydantic import Field
 
 
 class ReferringType(StrEnum):
@@ -28,102 +29,25 @@ class ReferringType(StrEnum):
     SUBSECTION = "subsection"
 
 
-type RefKey = Tuple[str, Optional[str], Optional[str]]
-
-
-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:
-        - Referring to a chapter titled `Introduction`:
-            Using Python
-            ```python
-            ArticleRef(referred_chapter_title="Introduction")
-            ```
-            Using JSON
-            ```json
-            {referred_chapter_title="Introduction"}
-            ```
-        - Referring to a section titled `Background` under the `Introduction` chapter:
-            Using Python
-            ```python
-            ArticleRef(referred_chapter_title="Introduction", referred_section_title="Background")
-            ```
-            Using JSON
-            ```json
-            {referred_chapter_title="Introduction", referred_section_title="Background"}
-            ```
-        - Referring to a subsection titled `Related Work` under the `Background` section of the `Introduction` chapter:
-            Using Python
-            ```python
-            ArticleRef(referred_chapter_title="Introduction", referred_section_title="Background", referred_subsection_title="Related Work")
-            ```
-            Using JSON
-            ```json
-            {referred_chapter_title="Introduction", referred_section_title="Background", referred_subsection_title="Related Work"}
-            ```
-    """
-
-    referred_chapter_title: str
-    """`title` Field of the referenced chapter"""
-    referred_section_title: Optional[str] = None
-    """`title` Field of the referenced section."""
-    referred_subsection_title: Optional[str] = None
-    """`title` Field of the referenced subsection."""
-
-    def update_from_inner(self, other: Self) -> Self:
-        """Updates the current instance with the attributes of another instance."""
-        self.referred_chapter_title = other.referred_chapter_title
-        self.referred_section_title = other.referred_section_title
-        self.referred_subsection_title = other.referred_subsection_title
-        return self
-
-    def deref(self, article: "ArticleBase") -> Optional["ArticleOutlineBase"]:
-        """Dereference the reference to the actual section or subsection within the provided article.
-
-        Args:
-            article (ArticleOutline | Article): The article to dereference the reference from.
 
-        Returns:
-            ArticleMainBase | ArticleOutline | None: The dereferenced section or subsection, or None if not found.
-        """
-        chap = next((chap for chap in article.chapters if chap.title == self.referred_chapter_title), None)
-        if self.referred_section_title is None or chap is None:
-            return chap
-        sec = next((sec for sec in chap.sections if sec.title == self.referred_section_title), None)
-        if self.referred_subsection_title is None or sec is None:
-            return sec
-        return next((subsec for subsec in sec.subsections if subsec.title == self.referred_subsection_title), None)
+type RefKey = Tuple[str, Optional[str], Optional[str]]
 
-    @property
-    def referring_type(self) -> ReferringType:
-        """Determine the type of reference based on the presence of specific attributes."""
-        if self.referred_subsection_title is not None:
-            return ReferringType.SUBSECTION
-        if self.referred_section_title is not None:
-            return ReferringType.SECTION
-        return ReferringType.CHAPTER
 
 
-class ArticleMetaData(SketchedAble, Described, Language):
+class ArticleMetaData(SketchedAble, Described, WordCount, Titled, Language):
     """Metadata for an article component."""
 
-    support_to: List[ArticleRef]
-    """List of references to other component of this articles that this component supports."""
-    depend_on: List[ArticleRef]
-    """List of references to other component of this articles that this component depends on."""
+    description: str = Field(
+        alias="elaboration",
+        description=Described.model_fields["description"].description,
+    )
 
-    writing_aim: List[str]
-    """List of writing aims of the research component in academic style."""
-    title: str
-    """Do not add any prefix or suffix to the title. should not contain special characters."""
+    title: str = Field(alias="heading", description=Titled.model_fields["title"].description)
 
-    expected_word_count: int
-    """Expected word count of this research component."""
+    aims: List[str]
+    """List of writing aims of the research component in academic style."""
 
 
-class ArticleRefSequencePatch(SequencePatch[ArticleRef]):
-    """Patch for article refs."""
 
 
 class ArticleOutlineBase(
@@ -143,12 +67,8 @@ class ArticleOutlineBase(
 
     def update_metadata(self, other: ArticleMetaData) -> Self:
         """Updates the metadata of the current instance with the attributes of another instance."""
-        self.support_to.clear()
-        self.support_to.extend(other.support_to)
-        self.depend_on.clear()
-        self.depend_on.extend(other.depend_on)
-        self.writing_aim.clear()
-        self.writing_aim.extend(other.writing_aim)
+        self.aims.clear()
+        self.aims.extend(other.aims)
         self.description = other.description
         return self
 
@@ -272,22 +192,19 @@ class ChapterBase[T: SectionBase](ArticleOutlineBase):
         return ""
 
 
-class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, Language, ABC):
+class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, WordCount, Described, Titled, Language, ABC):
     """Base class for article outlines."""
 
-    title: str
-    """Title of the academic paper."""
-
-    prospect: str
-    """Consolidated research statement with four pillars:
-    1. Problem Identification: Current limitations
-    2. Methodological Response: Technical approach
-    3. Empirical Validation: Evaluation strategy
-    4. Scholarly Impact: Field contributions
-    """
+    title: str = Field(alias="heading", description=Titled.model_fields["title"].description)
+    description: str = Field(alias="abstract")
+    """The abstract serves as a concise summary of an academic article, encapsulating its core purpose, methodologies, key results,
+    and conclusions while enabling readers to rapidly assess the relevance and significance of the study.
+    Functioning as the article's distilled essence, it succinctly articulates the research problem, objectives,
+    and scope, providing a roadmap for the full text while also facilitating database indexing, literature reviews,
+    and citation tracking through standardized metadata. Additionally, it acts as an accessibility gateway,
+    allowing scholars to gauge the study's contribution to existing knowledge, its methodological rigor,
+    and its broader implications without engaging with the entire manuscript, thereby optimizing scholarly communication efficiency."""
 
-    abstract: str
-    """The abstract is a concise summary of the academic paper's main findings."""
     chapters: List[T]
     """Chapters of the article. Contains at least one chapter. You can also add more as needed."""
 
@@ -317,34 +234,6 @@ class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, Language, ABC):
                 yield sec
                 yield from sec.subsections
 
-    def iter_support_on(self, rev: bool = False) -> Generator[ArticleRef, None, None]:
-        """Iterates over all references that the article components support.
-
-        Args:
-            rev (bool): If True, iterate in reverse order.
-
-        Yields:
-            ArticleRef: Each reference that the article components support.
-        """
-        if rev:
-            yield from chain(*[a.support_to for a in self.iter_dfs_rev()])
-            return
-        yield from chain(*[a.support_to for a in self.iter_dfs()])
-
-    def iter_depend_on(self, rev: bool = False) -> Generator[ArticleRef, None, None]:
-        """Iterates over all references that the article components depend on.
-
-        Args:
-            rev (bool): If True, iterate in reverse order.
-
-        Yields:
-            ArticleRef: Each reference that the article components depend on.
-        """
-        if rev:
-            yield from chain(*[a.depend_on for a in self.iter_dfs_rev()])
-            return
-        yield from chain(*[a.depend_on for a in self.iter_dfs()])
-
     def iter_sections(self) -> Generator[Tuple[ChapterBase, SectionBase], None, None]:
         """Iterates through all sections in the article.
 
@@ -378,12 +267,6 @@ class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, Language, ABC):
         """Gathers all introspected components in the article structure."""
         return "\n".join([i for component in self.chapters if (i := component.introspect())])
 
-    @overload
-    def find_illegal_ref(self, gather_identical: bool) -> Optional[Tuple[ArticleRef | List[ArticleRef], str]]: ...
-
-    @overload
-    def find_illegal_ref(self) -> Optional[Tuple[ArticleRef, str]]: ...
-
     def iter_chap_title(self) -> Generator[str, None, None]:
         """Iterates through all chapter titles in the article."""
         for chap in self.chapters:
@@ -399,75 +282,6 @@ class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, Language, ABC):
         for _, _, subsec in self.iter_subsections():
             yield subsec.title
 
-    def find_illegal_ref(self, gather_identical: bool = False) -> Optional[Tuple[ArticleRef | List[ArticleRef], str]]:
-        """Finds the first illegal component in the outline.
-
-        Returns:
-            Tuple[ArticleOutlineBase, str]: A tuple containing the illegal component and an error message.
-        """
-        summary = ""
-        chap_titles_set = set(self.iter_chap_title())
-        sec_titles_set = set(self.iter_section_title())
-        subsec_titles_set = set(self.iter_subsection_title())
-
-        for component in self.iter_dfs_rev():
-            for ref in chain(component.depend_on, component.support_to):
-                if not ref.deref(self):
-                    summary += f"Invalid internal reference in `{component.__class__.__name__}` titled `{component.title}`, because the referred {ref.referring_type} is not exists within the article, see the original obj dump: {ref.model_dump()}\n"
-
-                    if ref.referred_chapter_title not in (chap_titles_set):
-                        summary += f"Chapter titled `{ref.referred_chapter_title}` is not any of {chap_titles_set}\n"
-                    if ref.referred_section_title and ref.referred_section_title not in (sec_titles_set):
-                        summary += f"Section Titled `{ref.referred_section_title}` is not any of {sec_titles_set}\n"
-                    if ref.referred_subsection_title and ref.referred_subsection_title not in (subsec_titles_set):
-                        summary += (
-                            f"Subsection Titled `{ref.referred_subsection_title}` is not any of {subsec_titles_set}"
-                        )
-
-                if summary:
-                    return (
-                        (
-                            [
-                                identical_ref
-                                for identical_ref in chain(self.iter_depend_on(), self.iter_support_on())
-                                if identical_ref == ref
-                            ],
-                            summary,
-                        )
-                        if gather_identical
-                        else (ref, summary)
-                    )
-
-        return None
-
-    def gather_illegal_ref(self) -> Tuple[List[ArticleRef], str]:
-        """Gathers all illegal references in the article."""
-        summary = []
-        chap_titles_set = set(self.iter_chap_title())
-        sec_titles_set = set(self.iter_section_title())
-        subsec_titles_set = set(self.iter_subsection_title())
-        res_seq = []
-
-        for component in self.iter_dfs():
-            for ref in (
-                r for r in chain(component.depend_on, component.support_to) if not r.deref(self) and r not in res_seq
-            ):
-                res_seq.append(ref)
-                if ref.referred_chapter_title not in chap_titles_set:
-                    summary.append(
-                        f"Chapter titled `{ref.referred_chapter_title}` is not exist, since it is not any of {chap_titles_set}."
-                    )
-                if ref.referred_section_title and (ref.referred_section_title not in sec_titles_set):
-                    summary.append(
-                        f"Section Titled `{ref.referred_section_title}` is not exist, since it is not any of {sec_titles_set}"
-                    )
-                if ref.referred_subsection_title and (ref.referred_subsection_title not in subsec_titles_set):
-                    summary.append(
-                        f"Subsection Titled `{ref.referred_subsection_title}` is not exist, since it is not any of {subsec_titles_set}"
-                    )
-
-        return res_seq, "\n".join(summary)
-
     def finalized_dump(self) -> str:
         """Generates standardized hierarchical markup for academic publishing systems.
 

fabricatio/models/extra/article_main.py

@@ -1,12 +1,11 @@
 """ArticleBase and ArticleSubsection classes for managing hierarchical document components."""
 
-from itertools import chain
 from typing import Dict, Generator, List, Self, Tuple, override
 
+from fabricatio.fs.readers import extract_sections
 from fabricatio.journal import logger
 from fabricatio.models.extra.article_base import (
     ArticleBase,
-    ArticleOutlineBase,
     ChapterBase,
     SectionBase,
     SubSectionBase,
@@ -14,26 +13,32 @@ from fabricatio.models.extra.article_base import (
 from fabricatio.models.extra.article_outline import (
     ArticleOutline,
 )
-from fabricatio.models.generic import PersistentAble, SequencePatch, SketchedAble, WithRef
+from fabricatio.models.generic import Described, PersistentAble, SequencePatch, SketchedAble, WithRef, WordCount
 from fabricatio.rust import word_count
-from fabricatio.utils import ok
+from pydantic import Field
 
+PARAGRAPH_SEP = "// - - -"
 
-class Paragraph(SketchedAble):
+
+class Paragraph(SketchedAble, WordCount, Described):
     """Structured academic paragraph blueprint for controlled content generation."""
 
-    description: str
-    """Functional summary of the paragraph's role in document structure."""
+    description: str = Field(
+        alias="elaboration",
+        description=Described.model_fields["description"].description,
+    )
 
-    writing_aim: List[str]
+    aims: List[str]
     """Specific communicative objectives for this paragraph's content."""
 
-    expected_word_count: int
-    """Expected word count for the paragraph."""
-
     content: str
     """The actual content of the paragraph, represented as a string."""
 
+    @classmethod
+    def from_content(cls, content: str) -> Self:
+        """Create a Paragraph object from the given content."""
+        return cls(elaboration="", aims=[], expected_word_count=word_count(content), content=content)
+
 
 class ArticleParagraphSequencePatch(SequencePatch[Paragraph]):
     """Patch for `Paragraph` list of `ArticleSubsection`."""
@@ -57,7 +62,7 @@ class ArticleSubsection(SubSectionBase):
         """Introspects the subsection and returns a summary of its state."""
         summary = ""
         if len(self.paragraphs) == 0:
-            summary += f"`{self.__class__.__name__}` titled `{self.title}` have no paragraphs!\n"
+            summary += f"`{self.__class__.__name__}` titled `{self.title}` have no paragraphs, You should add some!\n"
         if (
             abs((wc := self.word_count) - self.expected_word_count) / self.expected_word_count
             > self._max_word_count_deviation
@@ -80,16 +85,53 @@ class ArticleSubsection(SubSectionBase):
         Returns:
             str: Typst code snippet for rendering.
         """
-        return f"=== {self.title}\n" + "\n\n".join(p.content for p in self.paragraphs)
+        return f"=== {self.title}\n" + f"\n{PARAGRAPH_SEP}\n".join(p.content for p in self.paragraphs)
+
+    @classmethod
+    def from_typst_code(cls, title: str, body: str) -> Self:
+        """Creates an Article object from the given Typst code."""
+        return cls(
+            heading=title,
+            elaboration="",
+            paragraphs=[Paragraph.from_content(p) for p in body.split(PARAGRAPH_SEP)],
+            expected_word_count=word_count(body),
+            aims=[],
+        )
 
 
 class ArticleSection(SectionBase[ArticleSubsection]):
     """Atomic argumentative unit with high-level specificity."""
 
+    @classmethod
+    def from_typst_code(cls, title: str, body: str) -> Self:
+        """Creates an Article object from the given Typst code."""
+        return cls(
+            subsections=[
+                ArticleSubsection.from_typst_code(*pack) for pack in extract_sections(body, level=3, section_char="=")
+            ],
+            heading=title,
+            elaboration="",
+            expected_word_count=word_count(body),
+            aims=[],
+        )
+
 
 class ArticleChapter(ChapterBase[ArticleSection]):
     """Thematic progression implementing research function."""
 
+    @classmethod
+    def from_typst_code(cls, title: str, body: str) -> Self:
+        """Creates an Article object from the given Typst code."""
+        return cls(
+            sections=[
+                ArticleSection.from_typst_code(*pack) for pack in extract_sections(body, level=2, section_char="=")
+            ],
+            heading=title,
+            elaboration="",
+            expected_word_count=word_count(body),
+            aims=[],
+        )
+
 
 class Article(
     SketchedAble,
@@ -126,107 +168,39 @@ class Article(
             Article: The generated article.
         """
         # Set the title from the outline
-        article = Article(**outline.model_dump(exclude={"chapters"}), chapters=[])
+        article = Article(**outline.model_dump(exclude={"chapters"}, by_alias=True), chapters=[])
 
         for chapter in outline.chapters:
             # Create a new chapter
             article_chapter = ArticleChapter(
                 sections=[],
-                **chapter.model_dump(exclude={"sections"}),
+                **chapter.model_dump(exclude={"sections"}, by_alias=True),
             )
             for section in chapter.sections:
                 # Create a new section
                 article_section = ArticleSection(
                     subsections=[],
-                    **section.model_dump(exclude={"subsections"}),
+                    **section.model_dump(exclude={"subsections"}, by_alias=True),
                 )
                 for subsection in section.subsections:
                     # Create a new subsection
                     article_subsection = ArticleSubsection(
                         paragraphs=[],
-                        **subsection.model_dump(),
+                        **subsection.model_dump(by_alias=True),
                     )
                     article_section.subsections.append(article_subsection)
                 article_chapter.sections.append(article_section)
             article.chapters.append(article_chapter)
         return article
 
-    def gather_dependencies(self, article: ArticleOutlineBase) -> List[ArticleOutlineBase]:
-        """Gathers dependencies for all sections and subsections in the article.
-
-        This method should be called after the article is fully constructed.
-        """
-        depends = [ok(a.deref(self)) for a in article.depend_on]
-
-        supports = []
-        for a in self.iter_dfs_rev():
-            if article in {ok(b.deref(self)) for b in a.support_to}:
-                supports.append(a)
-
-        return list(set(depends + supports))
-
-    def gather_dependencies_recursive(self, article: ArticleOutlineBase) -> List[ArticleOutlineBase]:
-        """Gathers all dependencies recursively for the given article.
-
-        Args:
-            article (ArticleOutlineBase): The article to gather dependencies for.
-
-        Returns:
-            List[ArticleBase]: A list of all dependencies for the given article.
-        """
-        q = self.gather_dependencies(article)
-
-        deps = []
-        while q:
-            a = q.pop()
-            deps.extend(self.gather_dependencies(a))
-
-        deps = list(
-            chain(
-                filter(lambda x: isinstance(x, ArticleChapter), deps),
-                filter(lambda x: isinstance(x, ArticleSection), deps),
-                filter(lambda x: isinstance(x, ArticleSubsection), deps),
-            )
+    @classmethod
+    def from_typst_code(cls, title: str, body: str) -> Self:
+        """Generates an article from the given Typst code."""
+        return cls(
+            chapters=[
+                ArticleChapter.from_typst_code(*pack) for pack in extract_sections(body, level=1, section_char="=")
+            ],
+            heading=title,
+            expected_word_count=word_count(body),
+            abstract="",
         )
-
-        # Initialize result containers
-        formatted_code = ""
-        processed_components = []
-
-        # Process all dependencies
-        while deps:
-            component = deps.pop()
-            # Skip duplicates
-            if (component_code := component.to_typst_code()) in formatted_code:
-                continue
-
-            # Add this component
-            formatted_code += component_code
-            processed_components.append(component)
-
-        return processed_components
-
-    def iter_dfs_with_deps(
-        self, chapter: bool = True, section: bool = True, subsection: bool = True
-    ) -> Generator[Tuple[ArticleOutlineBase, List[ArticleOutlineBase]], None, None]:
-        """Iterates through the article in a depth-first manner, yielding each component and its dependencies.
-
-        Args:
-            chapter (bool, optional): Whether to include chapter components. Defaults to True.
-            section (bool, optional): Whether to include section components. Defaults to True.
-            subsection (bool, optional): Whether to include subsection components. Defaults to True.
-
-        Yields:
-            Tuple[ArticleBase, List[ArticleBase]]: Each component and its dependencies.
-        """
-        if all((not chapter, not section, not subsection)):
-            raise ValueError("At least one of chapter, section, or subsection must be True.")
-
-        for component in self.iter_dfs_rev():
-            if not chapter and isinstance(component, ArticleChapter):
-                continue
-            if not section and isinstance(component, ArticleSection):
-                continue
-            if not subsection and isinstance(component, ArticleSubsection):
-                continue
-            yield component, (self.gather_dependencies_recursive(component))

fabricatio/models/extra/article_proposal.py

@@ -2,21 +2,25 @@
 
 from typing import Dict, List
 
-from fabricatio.models.generic import AsPrompt, PersistentAble, SketchedAble, WithRef
-
-
-class ArticleProposal(SketchedAble, WithRef[str], AsPrompt, PersistentAble):
+from fabricatio.models.generic import (
+    AsPrompt,
+    Described,
+    Language,
+    PersistentAble,
+    SketchedAble,
+    Titled,
+    WithRef,
+    WordCount,
+)
+from pydantic import Field
+
+
+class ArticleProposal(SketchedAble, WithRef[str], AsPrompt, PersistentAble, WordCount, Described, Titled, Language):
     """Structured proposal for academic paper development with core research elements.
 
     Guides LLM in generating comprehensive research proposals with clearly defined components.
     """
 
-    language: str
-    """The language in which the article is written. This should align with the language specified in the article briefing."""
-
-    title: str
-    """The title of the academic paper, formatted in Title Case."""
-
     focused_problem: List[str]
     """A list of specific research problems or questions that the paper aims to address."""
 
@@ -38,12 +42,9 @@ class ArticleProposal(SketchedAble, WithRef[str], AsPrompt, PersistentAble):
     keywords: List[str]
     """A list of keywords that represent the main topics and focus areas of the research."""
 
-    abstract: str
+    description: str = Field(alias="abstract")
     """A concise summary of the research proposal, outlining the main points and objectives."""
 
-    expected_word_count: int
-    """The estimated word count of the final academic paper."""
-
     def _as_prompt_inner(self) -> Dict[str, str]:
         return {
             "ArticleBriefing": self.referenced,

fabricatio/models/extra/patches.py

@@ -3,17 +3,17 @@
 from typing import Optional, Type
 
 from fabricatio.models.extra.rule import RuleSet
-from fabricatio.models.generic import Patch, WithBriefing
+from fabricatio.models.generic import Language, Patch, WithBriefing
 from pydantic import BaseModel
 
 
-class BriefingPatch[T: WithBriefing](Patch[T], WithBriefing):
-    """Patch class for updating the description and name of a `WithBriefing` object, all fields within this instance will be directly copied onto the target model's field."""
+class BriefingMetadata[T: WithBriefing](Patch[T], WithBriefing):
+    """A patch class for updating the description and name of a `WithBriefing` object, all fields within this instance will be directly copied onto the target model's field."""
 
 
-class RuleSetBriefingPatch(BriefingPatch[RuleSet]):
-    """Patch class for updating the description and name of a `RuleSet` object, all fields within this instance will be directly copied onto the target model's field."""
-    language: str
+class RuleSetMetadata(BriefingMetadata[RuleSet], Language):
+    """A patch class for updating the description and name of a `RuleSet` object, all fields within this instance will be directly copied onto the target model's field."""
+
     @staticmethod
     def ref_cls() -> Optional[Type[BaseModel]]:
         """Get the reference class of the model."""