fabricatio 0.2.8.dev4__tar.gz → 0.2.9.dev1__tar.gz

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/Cargo.lock

@@ -453,6 +453,7 @@ dependencies = [
  "rayon",
  "serde_json",
  "walkdir",
+ "whichlang",
 ]
 
 [[package]]
@@ -2099,6 +2100,12 @@ dependencies = [
  "wasm-bindgen",
 ]
 
+[[package]]
+name = "whichlang"
+version = "0.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0b9aa3ad29c3d08283ac6b769e3ec15ad1ddb88af7d2e9bc402c574973b937e7"
+
 [[package]]
 name = "winapi-util"
 version = "0.1.9"

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/Cargo.toml

@@ -15,6 +15,7 @@ pythonize = "0.23.0"
 rayon = "1.10.0"
 serde_json = "1.0.138"
 walkdir = "2.5.0"
+whichlang = "0.1.1"
 
 [workspace]
 

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/PKG-INFO

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

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/examples/make_diary/diary.py

@@ -4,7 +4,7 @@ import asyncio
 from datetime import datetime
 from typing import Optional, Set, Unpack
 
-from fabricatio import Action, Event, Role, Task, WorkFlow, fs_toolbox, logger
+from fabricatio import Action, Event, Role, Task, WorkFlow, logger, toolboxes
 from fabricatio.fs.readers import safe_json_read
 from fabricatio.models.tool import ToolBox
 from pydantic import Field
@@ -48,7 +48,7 @@ class WriteDiary(Action):
 class DumpText(Action):
     """Dump the text to a file."""
 
-    toolboxes: Set[ToolBox] = Field(default_factory=lambda: {fs_toolbox})
+    toolboxes: Set[ToolBox] = Field(default_factory=lambda: {toolboxes.fs_toolbox})
     output_key: str = "task_output"
 
     async def _execute(self, task_input: Task, dump_text: str, **_: Unpack) -> Optional[str]:

fabricatio-0.2.9.dev1/examples/rules/draft_ruleset.py

@@ -0,0 +1,59 @@
+"""Example of using the library."""
+
+import asyncio
+from typing import TYPE_CHECKING
+
+from fabricatio import Event, Role, WorkFlow, logger
+from fabricatio.actions.output import PersistentAll
+from fabricatio.actions.rules import DraftRuleSet
+from fabricatio.models.task import Task
+from fabricatio.utils import ok
+
+if TYPE_CHECKING:
+    from fabricatio.models.extra.rule import RuleSet
+
+
+async def main() -> None:
+    """Main function."""
+    Role(
+        name="Undergraduate Researcher",
+        llm_model="openai/qwen-plus",
+        llm_rpm=1000,
+        llm_tpm=3000000,
+        llm_max_tokens=8190,
+        registry={
+            Event.quick_instantiate(ns := "article"): WorkFlow(
+                name="write ruleset",
+                description="Generate an outline for an article. dump the outline to the given path. in typst format.",
+                steps=(
+                    DraftRuleSet(
+                        ruleset_requirement="1.when try to use an article as reference cited in our article, you should obey the format like (author1, author2 et al., YYYY)\n"
+                        "2.we use typst to generate numeric citation. For example, for an article whose `bibtex_key` is `YanWindEnergy2018`, you can create a numeric citation by typing `#cite(<YanWindEnergy2018>)`(note that `bibtex_key` with `<` and `>` wrapped is needed), those notations could automatically be processed and output by compiler as a numeric citation like `[1]` in the upper right corner of text.\n"
+                        "3.in addition, since `#cite()` can ONLY cite ONE article at once, we need use multiple `#cite()` notations to cite multiple articles, for example, there are three articles whose `bibtex_key` are `YanWindEnergy2018`, `YanWindEnergy2019`, `YanWindEnergy2020, you can cite them three as numeric citation by typing `#cite(<YanWindEnergy2018>)#cite(<YanWindEnergy2019>)#cite(<YanWindEnergy2020>)` those notations could automatically be processed and output by compiler as a numeric citation like `[1,2,3]` in the upper right corner of text.\n"
+                        "4.to cover more references, we usually cite more than one articles that have similar opinions in a single sentence if possible.\n"
+                        "5.when using `#cite()` notation, you must be aware of the cite key should be wrapped by `<` and `>`, compiler wont let it pass compilation otherwise.",
+                        rule_count=5,
+                        output_key="en_ruleset"
+                    ),
+                    DraftRuleSet(
+                        ruleset_requirement="1. 当在文章中引用其他文章作为参考文献时，应遵循（作者1，作者2等，年份）的格式进行标注。\n"
+                        "2. 我们使用Typst生成数字引用格式。例如，对于BibTeX键为`YanWindEnergy2018`的文献，可通过输入`#cite(<YanWindEnergy2018>)`创建数字引用（注意：BibTeX键必须用尖括号`<`和`>`包裹）。这些标记会被编译器自动处理并输出为右上角的数字引用格式，例如文本旁的[1]。\n"
+                        "3. 此外，由于`#cite()`每次只能引用单一文献，需通过叠加多个`#cite()`标记实现多文献引用。例如，若需引用三个BibTeX键分别为`YanWindEnergy2018`、`YanWindEnergy2019`和`YanWindEnergy2020`的文献，应输入`#cite(<YanWindEnergy2018>)#cite(<YanWindEnergy2019>)#cite(<YanWindEnergy2020>)`，编译后将呈现为[1,2,3]的右上角数字引用格式。\n"
+                        "4. 为增加参考文献的覆盖率，我们通常建议在可能的情况下，将多个观点相似的文献合并引用于同一句子中。"
+                        "5. 使用`#cite()`时需注意：BibTeX键必须用尖括号`<`和`>`包裹，否则编译器将拒绝通过编译。",
+                        rule_count=5,
+                        output_key="zh_ruleset"
+                    ),
+                    PersistentAll(persist_dir="persistent"),
+                ),
+            )
+        },
+    )
+
+    proposed_task: Task[RuleSet] = Task(name="write an ruleset")
+    ruleset = ok(await proposed_task.delegate(ns), "Failed to generate ruleset")
+    logger.success(f"The rule is: \n{ruleset.display()}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/examples/task_handle/handle_task.py

@@ -3,7 +3,7 @@
 import asyncio
 from typing import Any, Set, Unpack
 
-from fabricatio import Action, Event, PythonCapture, Role, Task, ToolBox, WorkFlow, fs_toolbox, logger
+from fabricatio import Action, Event, PythonCapture, Role, Task, ToolBox, WorkFlow, logger, toolboxes
 from pydantic import Field
 
 
@@ -23,7 +23,7 @@ class WriteCode(Action):
 class DumpText(Action):
     """Dump the text to a file."""
 
-    toolboxes: Set[ToolBox] = Field(default_factory=lambda: {fs_toolbox})
+    toolboxes: Set[ToolBox] = Field(default_factory=lambda: {toolboxes.fs_toolbox})
     output_key: str = "task_output"
 
     async def _execute(self, task_input: Task, dump_text: str, **_: Unpack) -> Any:

fabricatio-0.2.9.dev1/examples/write_article/.gitignore

@@ -0,0 +1,3 @@
+article_briefing.txt
+out.typ
+persistent

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/examples/write_article/write_article.py

@@ -50,7 +50,7 @@ async def main() -> None:
                 article_briefing=Path("./article_briefing.txt").read_text(),
                 dump_path="out.typ",
                 persist_dir="persistent",
-                collection_name="article_essence"
+                collection_name="article_essence_0324"
             )
         },
     )

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/examples/write_outline/write_outline.py

@@ -2,7 +2,8 @@
 
 import asyncio
 
-from fabricatio import Event, Role, WriteOutlineWorkFlow, logger
+from fabricatio import Event, Role, logger
+from fabricatio.workflows.articles import WriteOutlineCorrectedWorkFlow
 
 
 async def main() -> None:
@@ -10,7 +11,7 @@ async def main() -> None:
     role = Role(
         name="Undergraduate Researcher",
         description="Write an outline for an article in typst format.",
-        registry={Event.quick_instantiate(ns := "article"): WriteOutlineWorkFlow},
+        registry={Event.quick_instantiate(ns := "article"): WriteOutlineCorrectedWorkFlow},
     )
 
     proposed_task = await role.propose_task(

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/examples/write_outline/write_outline_corrected.py

@@ -3,7 +3,7 @@
 import asyncio
 
 from fabricatio import Event, Role, WorkFlow, logger
-from fabricatio.actions.article import CorrectOutline, CorrectProposal, GenerateArticleProposal, GenerateOutline
+from fabricatio.actions.article import CorrectOutline, CorrectProposal, GenerateArticleProposal, GenerateInitialOutline
 from fabricatio.actions.output import DumpFinalizedOutput
 
 
@@ -25,7 +25,7 @@ async def main() -> None:
                         llm_model="deepseek/deepseek-reasoner",
                         llm_temperature=1.3,
                     ),
-                    GenerateOutline(llm_model="deepseek/deepseek-chat", llm_temperature=1.4, llm_top_p=0.5),
+                    GenerateInitialOutline(llm_model="deepseek/deepseek-chat", llm_temperature=1.4, llm_top_p=0.5),
                     CorrectOutline(output_key="to_dump", llm_temperature=1.4, llm_top_p=0.45),
                     DumpFinalizedOutput(output_key="task_output"),
                 ),

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fabricatio"
-version = "0.2.8-dev4"
+version = "0.2.9-dev1"
 description = "A LLM multi-agent framework."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -57,7 +57,7 @@ build-backend = "maturin"
 
 [tool.maturin]
 python-source = "python"
-module-name = "fabricatio._rust"
+module-name = "fabricatio.rust"
 data = "extra"
 [dependency-groups]
 dev = [

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/__init__.py

@@ -1,10 +1,6 @@
 """Fabricatio is a Python library for building llm app using event-based agent structure."""
 
-from importlib.util import find_spec
-
-from fabricatio import actions, toolboxes, workflows
-from fabricatio._rust import BibManager
-from fabricatio._rust_instances import TEMPLATE_MANAGER
+from fabricatio import actions, capabilities, toolboxes, workflows
 from fabricatio.core import env
 from fabricatio.journal import logger
 from fabricatio.models import extra
@@ -14,6 +10,8 @@ from fabricatio.models.role import Role
 from fabricatio.models.task import Task
 from fabricatio.models.tool import ToolBox
 from fabricatio.parser import Capture, GenericCapture, JsonCapture, PythonCapture
+from fabricatio.rust import BibManager
+from fabricatio.rust_instances import TEMPLATE_MANAGER
 
 __all__ = [
     "TEMPLATE_MANAGER",
@@ -29,15 +27,10 @@ __all__ = [
     "ToolBox",
     "WorkFlow",
     "actions",
+    "capabilities",
     "env",
     "extra",
     "logger",
     "toolboxes",
     "workflows",
 ]
-
-
-if find_spec("pymilvus"):
-    from fabricatio.capabilities.rag import RAG
-
-    __all__ += ["RAG"]

fabricatio-0.2.9.dev1/python/fabricatio/actions/__init__.py

@@ -0,0 +1 @@
+"""A module containing some builtin actins."""

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/actions/article.py

@@ -4,7 +4,8 @@ from asyncio import gather
 from pathlib import Path
 from typing import Any, Callable, List, Optional
 
-from fabricatio._rust import BibManager
+from more_itertools import filter_map
+
 from fabricatio.capabilities.censor import Censor
 from fabricatio.capabilities.correct import Correct
 from fabricatio.capabilities.propose import Propose
@@ -18,8 +19,8 @@ from fabricatio.models.extra.article_outline import ArticleOutline
 from fabricatio.models.extra.article_proposal import ArticleProposal
 from fabricatio.models.extra.rule import RuleSet
 from fabricatio.models.task import Task
+from fabricatio.rust import BibManager
 from fabricatio.utils import ok
-from more_itertools import filter_map
 
 
 class ExtractArticleEssence(Action, Propose):

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/actions/rag.py

@@ -2,12 +2,13 @@
 
 from typing import List, Optional
 
+from questionary import text
+
 from fabricatio.capabilities.rag import RAG
 from fabricatio.journal import logger
 from fabricatio.models.action import Action
 from fabricatio.models.generic import Vectorizable
 from fabricatio.models.task import Task
-from questionary import text
 
 
 class InjectToDB(Action, RAG):

fabricatio-0.2.9.dev1/python/fabricatio/actions/rules.py

@@ -0,0 +1,39 @@
+"""A module containing the DraftRuleSet action."""
+
+from typing import Optional
+
+from fabricatio.capabilities.check import Check
+from fabricatio.models.action import Action
+from fabricatio.models.extra.rule import RuleSet
+from fabricatio.utils import ok
+
+
+class DraftRuleSet(Action, Check):
+    """Action to draft a ruleset based on a given requirement description."""
+
+    output_key: str = "drafted_ruleset"
+    """The key used to store the drafted ruleset in the context dictionary."""
+
+    ruleset_requirement: Optional[str] = None
+    """The natural language description of the desired ruleset characteristics."""
+    rule_count: int = 0
+    """The number of rules to generate in the ruleset (0 for no restriction)."""
+    async def _execute(
+        self,
+        ruleset_requirement: Optional[str]=None,
+        **_,
+    ) -> Optional[RuleSet]:
+        """Draft a ruleset based on the requirement description.
+
+        Args:
+            ruleset_requirement (str): Natural language description of desired ruleset characteristics
+            rule_count (int): Number of rules to generate (0 for no restriction)
+            **kwargs: Validation parameters for rule generation
+
+        Returns:
+            Optional[RuleSet]: Drafted ruleset object or None if generation fails
+        """
+        return await self.draft_ruleset(
+            ruleset_requirement=ok(ruleset_requirement or self.ruleset_requirement,"No ruleset requirement provided"),
+            rule_count=self.rule_count,
+        )

fabricatio-0.2.9.dev1/python/fabricatio/capabilities/__init__.py

@@ -0,0 +1 @@
+"""A module containing some high level capabilities."""

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/capabilities/censor.py

@@ -19,6 +19,9 @@ class Censor(Correct, Check):
 
     Inherits from both Correct and Check classes.
     Provides methods to censor objects and strings by first checking them against a ruleset and then correcting them if necessary.
+
+    Attributes:
+        ruleset (RuleSet): The ruleset to be used for censoring.
     """
 
     async def censor_obj[M: SketchedAble](

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/capabilities/check.py

@@ -6,7 +6,7 @@ from fabricatio import TEMPLATE_MANAGER
 from fabricatio.capabilities.advanced_judge import AdvancedJudge
 from fabricatio.capabilities.propose import Propose
 from fabricatio.config import configs
-from fabricatio.models.extra.patches import BriefingPatch
+from fabricatio.models.extra.patches import RuleSetBriefingPatch
 from fabricatio.models.extra.problem import Improvement
 from fabricatio.models.extra.rule import Rule, RuleSet
 from fabricatio.models.generic import Display, WithBriefing
@@ -50,21 +50,22 @@ class Check(AdvancedJudge, Propose):
         if rule_reqs is None:
             return None
 
-        rules = await self.propose(Rule, rule_reqs, **kwargs)
+        rules = await self.propose(Rule, [TEMPLATE_MANAGER.render_template(configs.templates.rule_requirement_template, {"rule_requirement": r}) for r in rule_reqs], **kwargs)
         if any(r for r in rules if r is None):
             return None
 
         ruleset_patch = await self.propose(
-            BriefingPatch,
+            RuleSetBriefingPatch,
             f"# Rules Requirements\n{rule_reqs}\n# Generated Rules\n{Display.seq_display(rules)}\n\n"
-            f"You need to write a concise and detailed patch for this ruleset that can be applied to the ruleset nicely",
+            f"You need to write a concise and detailed patch for this ruleset that can be applied to the ruleset nicely.\n"
+            f"Note that all fields in this patch will be directly copied to the ruleset obj, including `name` and `description`, so write when knowing the subject.\n",
             **override_kwargs(kwargs, default=None),
         )
 
         if ruleset_patch is None:
             return None
 
-        return ruleset_patch.apply(RuleSet(rules=rules, name="", description=""))
+        return RuleSet(rules=rules, **ruleset_patch.as_kwargs())
 
     async def check_string_against_rule(
         self,

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/capabilities/correct.py

@@ -2,7 +2,6 @@
 
 from typing import Optional, Type, Unpack, cast
 
-from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.capabilities.propose import Propose
 from fabricatio.capabilities.rating import Rating
 from fabricatio.config import configs
@@ -14,6 +13,7 @@ from fabricatio.models.kwargs_types import (
     BestKwargs,
     ValidateKwargs,
 )
+from fabricatio.rust_instances import TEMPLATE_MANAGER
 from fabricatio.utils import ok, override_kwargs
 
 

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/capabilities/rag.py

@@ -3,14 +3,16 @@
 try:
     from pymilvus import MilvusClient
 except ImportError as e:
-    raise RuntimeError("pymilvus is not installed. Have you installed `fabricatio[rag]` instead of `fabricatio`") from e
+    raise RuntimeError("pymilvus is not installed. Have you installed `fabricatio[rag]` instead of `fabricatio`?") from e
 from functools import lru_cache
 from operator import itemgetter
 from os import PathLike
 from pathlib import Path
 from typing import Any, Callable, Dict, List, Optional, Self, Union, Unpack, cast, overload
 
-from fabricatio._rust_instances import TEMPLATE_MANAGER
+from more_itertools.recipes import flatten, unique
+from pydantic import Field, PrivateAttr
+
 from fabricatio.config import configs
 from fabricatio.journal import logger
 from fabricatio.models.kwargs_types import (
@@ -23,9 +25,8 @@ from fabricatio.models.kwargs_types import (
 )
 from fabricatio.models.usages import EmbeddingUsage
 from fabricatio.models.utils import MilvusData
+from fabricatio.rust_instances import TEMPLATE_MANAGER
 from fabricatio.utils import ok
-from more_itertools.recipes import flatten, unique
-from pydantic import Field, PrivateAttr
 
 
 @lru_cache(maxsize=None)

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/capabilities/rating.py

@@ -4,16 +4,17 @@ from itertools import permutations
 from random import sample
 from typing import Dict, List, Optional, Set, Tuple, Union, Unpack, overload
 
-from fabricatio._rust_instances import TEMPLATE_MANAGER
+from more_itertools import flatten, windowed
+from pydantic import NonNegativeInt, PositiveInt
+
 from fabricatio.config import configs
 from fabricatio.journal import logger
 from fabricatio.models.generic import Display
 from fabricatio.models.kwargs_types import CompositeScoreKwargs, ValidateKwargs
 from fabricatio.models.usages import LLMUsage
 from fabricatio.parser import JsonCapture
+from fabricatio.rust_instances import TEMPLATE_MANAGER
 from fabricatio.utils import ok, override_kwargs
-from more_itertools import flatten, windowed
-from pydantic import NonNegativeInt, PositiveInt
 
 
 class Rating(LLMUsage):

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/capabilities/review.py

@@ -2,7 +2,6 @@
 
 from typing import Dict, Optional, Set, Unpack
 
-from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.capabilities.propose import Propose
 from fabricatio.capabilities.rating import Rating
 from fabricatio.config import configs
@@ -10,6 +9,7 @@ from fabricatio.models.extra.problem import Improvement
 from fabricatio.models.generic import Display, WithBriefing
 from fabricatio.models.kwargs_types import ReviewKwargs, ValidateKwargs
 from fabricatio.models.task import Task
+from fabricatio.rust_instances import TEMPLATE_MANAGER
 from fabricatio.utils import ok
 
 

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/capabilities/task.py

@@ -4,7 +4,7 @@ from types import CodeType
 from typing import Any, Dict, List, Optional, Tuple, Unpack
 
 import orjson
-from fabricatio._rust_instances import TEMPLATE_MANAGER
+
 from fabricatio.capabilities.propose import Propose
 from fabricatio.config import configs
 from fabricatio.journal import logger
@@ -13,6 +13,7 @@ from fabricatio.models.task import Task
 from fabricatio.models.tool import Tool, ToolExecutor
 from fabricatio.models.usages import ToolBoxUsage
 from fabricatio.parser import JsonCapture, PythonCapture
+from fabricatio.rust_instances import TEMPLATE_MANAGER
 
 
 class ProposeTask(Propose):

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/config.py

@@ -247,6 +247,8 @@ class TemplateConfig(BaseModel):
     fix_troubled_string_template: str = Field(default="fix_troubled_string")
     """The name of the fix troubled string template which will be used to fix a troubled string."""
 
+    rule_requirement_template: str = Field(default="rule_requirement")
+    """The name of the rule requirement template which will be used to generate a rule requirement."""
 class MagikaConfig(BaseModel):
     """Magika configuration class."""
 

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9.dev1}/python/fabricatio/models/action.py

@@ -15,6 +15,10 @@ from fabricatio.models.task import Task
 from fabricatio.models.usages import LLMUsage, ToolBoxUsage
 from pydantic import Field, PrivateAttr
 
+OUTPUT_KEY = "task_output"
+
+INPUT_KEY = "task_input"
+
 
 class Action(WithBriefing, LLMUsage):
     """Class that represents an action to be executed in a workflow.
@@ -88,6 +92,10 @@ class Action(WithBriefing, LLMUsage):
             return f"## Your personality: \n{self.personality}\n# The action you are going to perform: \n{super().briefing}"
         return f"# The action you are going to perform: \n{super().briefing}"
 
+    def to_task_output(self)->Self:
+        """Set the output key to OUTPUT_KEY and return the action instance."""
+        self.output_key=OUTPUT_KEY
+        return self
 
 class WorkFlow(WithBriefing, ToolBoxUsage):
     """Class that represents a sequence of actions to be executed for a task.
@@ -110,10 +118,10 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
     )
     """The sequence of actions to be executed, can be action classes or instances."""
 
-    task_input_key: str = Field(default="task_input")
+    task_input_key: str = Field(default=INPUT_KEY)
     """Key used to store the input task in the context dictionary."""
 
-    task_output_key: str = Field(default="task_output")
+    task_output_key: str = Field(default=OUTPUT_KEY)
     """Key used to extract the final result from the context dictionary."""
 
     extra_init_context: Dict[str, Any] = Field(default_factory=dict, frozen=True)

fabricatio-0.2.9.dev1/python/fabricatio/models/extra/__init__.py

@@ -0,0 +1 @@
+"""A module contains extra models for fabricatio."""

fabricatio-0.2.9.dev1/python/fabricatio/models/extra/patches.py

@@ -0,0 +1,20 @@
+"""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."""
+
+from typing import Optional, Type
+
+from fabricatio.models.extra.rule import RuleSet
+from fabricatio.models.generic import 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 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
+    @staticmethod
+    def ref_cls() -> Optional[Type[BaseModel]]:
+        """Get the reference class of the model."""
+        return RuleSet

fabricatio-0.2.9.dev1/python/fabricatio/models/extra/rule.py

@@ -0,0 +1,40 @@
+"""A module containing classes related to rule sets and rules.
+
+This module provides the `Rule` and `RuleSet` classes, which are used to define and manage
+individual rules and collections of rules, respectively. These classes are designed to
+facilitate the creation, organization, and application of rules in various contexts,
+ensuring clarity, consistency, and enforceability. The module supports detailed
+descriptions, examples, and metadata for each rule and rule set, making it suitable for
+complex rule management systems.
+"""
+
+from typing import List
+
+from fabricatio.models.generic import Language, PersistentAble, SketchedAble, WithBriefing
+
+
+class Rule(WithBriefing,Language, SketchedAble,PersistentAble):
+    """Represents a rule or guideline for a specific topic."""
+
+
+    violation_examples: List[str]
+    """A list of concrete examples demonstrating violations of this rule. Each example should
+    be a clear scenario or case that illustrates how the rule can be broken, including the
+    context, actions, and consequences of the violation. These examples should help in
+    understanding the boundaries of the rule."""
+
+    compliance_examples: List[str]
+    """A list of concrete examples demonstrating proper compliance with this rule. Each example
+    should be a clear scenario or case that illustrates how to correctly follow the rule,
+    including the context, actions, and positive outcomes of compliance. These examples should
+    serve as practical guidance for implementing the rule correctly."""
+
+
+class RuleSet( SketchedAble, PersistentAble, WithBriefing,Language):
+    """Represents a collection of rules and guidelines for a particular topic."""
+
+    rules: List[Rule]
+    """The collection of rules and guidelines contained in this rule set. Each rule should be
+    a well-defined, specific guideline that contributes to the overall purpose of the rule set.
+    The rules should be logically organized and consistent with each other, forming a coherent
+    framework for the topic or domain covered by the rule set."""