fabricatio 0.2.7.dev5__cp312-cp312-win_amd64.whl → 0.2.8__cp312-cp312-win_amd64.whl

fabricatio/models/extra/article_base.py

@@ -1,24 +1,23 @@
 """A foundation for hierarchical document components with dependency tracking."""
-from abc import ABC
+
+from abc import ABC, abstractmethod
 from enum import StrEnum
-from typing import TYPE_CHECKING, Generator, List, Optional, Self, Union, overload
+from itertools import chain
+from typing import Generator, List, Optional, Self, Tuple, overload
 
 from fabricatio.models.generic import (
-    Base,
+    AsPrompt,
     CensoredAble,
     Display,
+    FinalizedDumpAble,
     Introspect,
     ModelHash,
     PersistentAble,
-    ProposedAble,
+    ProposedUpdateAble,
     ResolveUpdateConflict,
-    UpdateFrom,
+    SequencePatch,
 )
 
-if TYPE_CHECKING:
-    from fabricatio.models.extra.article_main import Article
-    from fabricatio.models.extra.article_outline import ArticleOutline
-
 
 class ReferringType(StrEnum):
     """Enumeration of different types of references that can be made in an article."""
@@ -28,7 +27,10 @@ class ReferringType(StrEnum):
     SUBSECTION = "subsection"
 
 
-class ArticleRef(CensoredAble):
+type RefKey = Tuple[str, Optional[str], Optional[str]]
+
+
+class ArticleRef(CensoredAble, 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:
@@ -61,30 +63,21 @@ class ArticleRef(CensoredAble):
             ```
     """
 
-    referred_subsection_title: Optional[str] = None
-    """`title` Field of the referenced subsection."""
-
-    referred_section_title: Optional[str] = None
-    """`title` Field of the referenced section."""
-
     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 __hash__(self) -> int:
-        """Overrides the default hash function to ensure consistent hashing across instances."""
-        return hash((self.referred_chapter_title, self.referred_section_title, self.referred_subsection_title))
-
-    @overload
-    def deref(self, article: "Article") -> Optional["ArticleMainBase"]:
-        """Dereference the reference to the actual section or subsection within the provided article."""
-
-    @overload
-    def deref(self, article: "ArticleOutline") -> Optional["ArticleOutlineBase"]:
-        """Dereference the reference to the actual section or subsection within the provided article."""
+    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: Union["ArticleOutline", "Article"]
-    ) -> Union["ArticleOutlineBase", "ArticleMainBase", None]:
+    def deref(self, article: "ArticleBase") -> Optional["ArticleOutlineBase"]:
         """Dereference the reference to the actual section or subsection within the provided article.
 
         Args:
@@ -111,21 +104,74 @@ class ArticleRef(CensoredAble):
         return ReferringType.CHAPTER
 
 
-class SubSectionBase(
-    UpdateFrom,
+class ArticleMetaData(CensoredAble, Display):
+    """Metadata for an article component."""
+
+    description: str
+    """Description of the research component in academic style."""
+
+    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."""
+
+    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."""
+
+
+class ArticleRefSequencePatch(SequencePatch[ArticleRef]):
+    """Patch for article refs."""
+
+
+class ArticleOutlineBase(
+    ArticleMetaData,
+    ResolveUpdateConflict,
+    ProposedUpdateAble,
+    PersistentAble,
+    ModelHash,
     Introspect,
 ):
-    """Base class for article sections and subsections."""
+    """Base class for article outlines."""
 
-    title: str
-    """Title of the subsection, do not add any prefix or suffix to the title. should not contain special characters."""
+    @property
+    def metadata(self) -> ArticleMetaData:
+        """Returns the metadata of the article component."""
+        return ArticleMetaData.model_validate(self, from_attributes=True)
+
+    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.description = other.description
+        return self
 
+    def display_metadata(self) -> str:
+        """Displays the metadata of the current instance."""
+        return self.model_dump_json(
+            indent=1, include={"title", "writing_aim", "description", "support_to", "depend_on"}
+        )
+
+    def update_from_inner(self, other: Self) -> Self:
+        """Updates the current instance with the attributes of another instance."""
+        return self.update_metadata(other)
+
+    @abstractmethod
     def to_typst_code(self) -> str:
         """Converts the component into a Typst code snippet for rendering."""
-        return f"=== {self.title}\n"
 
-    def update_from_inner(self, other: Self) -> Self:
-        return self
+
+class SubSectionBase(ArticleOutlineBase):
+    """Base class for article sections and subsections."""
+
+    def to_typst_code(self) -> str:
+        """Converts the component into a Typst code snippet for rendering."""
+        return f"=== {self.title}\n"
 
     def introspect(self) -> str:
         """Introspects the article subsection outline."""
@@ -138,16 +184,11 @@ class SubSectionBase(
         return ""
 
 
-class SectionBase[T: SubSectionBase](
-    UpdateFrom,
-    Introspect,
-):
+class SectionBase[T: SubSectionBase](ArticleOutlineBase):
     """Base class for article sections and subsections."""
 
     subsections: List[T]
     """Subsections of the section. Contains at least one subsection. You can also add more as needed."""
-    title: str
-    """Title of the section, do not add any prefix or suffix to the title. should not contain special characters."""
 
     def to_typst_code(self) -> str:
         """Converts the section into a Typst formatted code snippet.
@@ -174,6 +215,7 @@ class SectionBase[T: SubSectionBase](
 
     def update_from_inner(self, other: Self) -> Self:
         """Updates the current instance with the attributes of another instance."""
+        super().update_from_inner(other)
         if len(self.subsections) == 0:
             self.subsections = other.subsections
             return self
@@ -189,16 +231,12 @@ class SectionBase[T: SubSectionBase](
         return ""
 
 
-class ChapterBase[T: SectionBase](
-    UpdateFrom,
-    Introspect,
-):
+class ChapterBase[T: SectionBase](ArticleOutlineBase):
     """Base class for article chapters."""
 
     sections: List[T]
     """Sections of the chapter. Contains at least one section. You can also add more as needed."""
-    title: str
-    """Title of the chapter, do not add any prefix or suffix to the title. should not contain special characters."""
+
     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)
@@ -233,21 +271,35 @@ class ChapterBase[T: SectionBase](
         return ""
 
 
-class ArticleBase[T: ChapterBase](Base):
+class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, ABC):
     """Base class for article outlines."""
 
+    language: str
+    """Written language of the article. SHALL be aligned to the language of the article proposal provided."""
+
+    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
+    """
+
+    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."""
-    title: str
-    """Title of the article outline, do not add any prefix or suffix to the title. should not contain special characters."""
 
-    def iter_dfs(
+    def iter_dfs_rev(
         self,
-    ) -> Generator[ChapterBase | SectionBase | SubSectionBase, None, None]:
-        """Performs a depth-first search (DFS) through the article structure.
+    ) -> Generator[ArticleOutlineBase, None, None]:
+        """Performs a depth-first search (DFS) through the article structure in reverse order.
 
         Returns:
-            Generator[ArticleMainBase]: Each component in the article structure.
+            Generator[ArticleMainBase]: Each component in the article structure in reverse order.
         """
         for chap in self.chapters:
             for sec in chap.sections:
@@ -255,37 +307,121 @@ class ArticleBase[T: ChapterBase](Base):
                 yield sec
             yield chap
 
+    def iter_dfs(self) -> Generator[ArticleOutlineBase, None, None]:
+        """Performs a depth-first search (DFS) through the article structure.
 
-class ArticleOutlineBase(
-    CensoredAble,
-    UpdateFrom,
-    ResolveUpdateConflict,
-    ProposedAble,
-    PersistentAble,
-    Display,
-    ModelHash,
-    ABC,
-):
-    """Base class for article outlines."""
+        Returns:
+            Generator[ArticleMainBase]: Each component in the article structure.
+        """
+        for chap in self.chapters:
+            yield chap
+            for sec in chap.sections:
+                yield sec
+                yield from sec.subsections
 
-    description: str
-    """Description of the research component in academic style."""
+    def iter_support_on(self, rev: bool = False) -> Generator[ArticleRef, None, None]:
+        """Iterates over all references that the article components support.
 
-    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."""
+        Args:
+            rev (bool): If True, iterate in reverse order.
 
-    writing_aim: List[str]
-    """List of writing aims of the research component in academic style."""
+        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 update_from_inner(self, other: Self) -> Self:
-        """Updates 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.description = other.description
-        return self
+    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.
+
+        Returns:
+            Generator[ArticleOutlineBase]: Each section in the article.
+        """
+        for chap in self.chapters:
+            for sec in chap.sections:
+                yield chap, sec
+
+    def iter_subsections(self) -> Generator[Tuple[ChapterBase, SectionBase, SubSectionBase], None, None]:
+        """Iterates through all subsections in the article.
+
+        Returns:
+            Generator[ArticleOutlineBase]: Each subsection in the article.
+        """
+        for chap, sec in self.iter_sections():
+            for subsec in sec.subsections:
+                yield chap, sec, subsec
+
+    def find_introspected(self) -> Optional[Tuple[ArticleOutlineBase, str]]:
+        """Finds the first introspected component in the article structure."""
+        summary = ""
+        for component in self.iter_dfs_rev():
+            summary += component.introspect()
+            if summary:
+                return component, summary
+        return None
+
+    @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 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 = ""
+        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 summary and not gather_identical:
+                    return ref, summary
+                if summary and gather_identical:
+                    return [
+                        identical_ref
+                        for identical_ref in chain(self.iter_depend_on(), self.iter_support_on())
+                        if identical_ref == ref
+                    ], summary
+
+        return None
+
+    def finalized_dump(self) -> str:
+        """Generates standardized hierarchical markup for academic publishing systems.
+
+        Implements ACL 2024 outline conventions with four-level structure:
+        = Chapter Title (Level 1)
+        == Section Title (Level 2)
+        === Subsection Title (Level 3)
+        ==== Subsubsection Title (Level 4)
+
+        Returns:
+            str: Strictly formatted outline with academic sectioning
+
+        Example:
+            = Methodology
+            == Neural Architecture Search Framework
+            === Differentiable Search Space
+            ==== Constrained Optimization Parameters
+            === Implementation Details
+            == Evaluation Protocol
+        """
+        return "\n\n".join(a.to_typst_code() for a in self.chapters)