fabricatio 0.2.7.dev3__cp312-cp312-win_amd64.whl → 0.2.7.dev5__cp312-cp312-win_amd64.whl

fabricatio/models/generic.py

@@ -23,6 +23,7 @@ from pydantic import (
     PrivateAttr,
     SecretStr,
 )
+from pydantic.json_schema import GenerateJsonSchema, JsonSchemaValue
 
 
 class Base(BaseModel):
@@ -94,7 +95,7 @@ class WithRef[T](Base):
         """Get the referenced object."""
         return ok(self._reference, "_reference is None")
 
-    def update_ref[S](self: S, reference: T | S) -> S:  # noqa: PYI019
+    def update_ref[S: "WithRef"](self: S, reference: T | S) -> S:  # noqa: PYI019
         """Update the reference of the object."""
         if isinstance(reference, self.__class__):
             self._reference = reference.referenced
@@ -138,6 +139,61 @@ class PersistentAble(Base):
         return self.model_validate_json(Path(path).read_text(encoding="utf-8"))
 
 
+class ModelHash(Base):
+    """Class that provides a hash value for the object."""
+
+    def __hash__(self) -> int:
+        """Calculates a hash value for the ArticleBase object based on its model_dump_json representation."""
+        return hash(self.model_dump_json())
+
+
+class UpdateFrom(Base):
+    """Class that provides a method to update the object from another object."""
+
+    def update_pre_check(self, other: Self) -> Self:
+        """Pre-check for updating the object from another object."""
+        if not isinstance(other, self.__class__):
+            raise TypeError(f"Cannot update from a non-{self.__class__.__name__} instance.")
+
+        return self
+
+    @abstractmethod
+    def update_from_inner(self, other: Self) -> Self:
+        """Updates the current instance with the attributes of another instance."""
+
+    @final
+    def update_from(self, other: Self) -> Self:
+        """Updates the current instance with the attributes of another instance."""
+        return self.update_pre_check(other).update_from_inner(other)
+
+
+class ResolveUpdateConflict(Base):
+    """Class that provides a method to update the object from another object."""
+
+    @abstractmethod
+    def resolve_update_conflict(self, other: Self) -> str:
+        """Resolve the update conflict between two objects.
+
+        Args:
+            other (Self): The other object to resolve the update conflict with.
+
+        Returns:
+            str: The resolved update conflict.
+        """
+
+
+class Introspect(Base):
+    """Class that provides a method to introspect the object."""
+
+    @abstractmethod
+    def introspect(self) -> str:
+        """Internal introspection of the object.
+
+        Returns:
+            str: The internal introspection of the object.
+        """
+
+
 class WithBriefing(Named, Described):
     """Class that provides a briefing based on the name and description."""
 
@@ -172,6 +228,23 @@ class WithBriefing(Named, Described):
                 raise TypeError(f"{system_msg_like} is not a dict or str")
 
 
+class ReverseGenerate(GenerateJsonSchema):
+    """Class that provides a reverse JSON schema of the model."""
+
+    def _sort_recursive(self, value: Any, parent_key: str | None = None) -> Any:
+        if isinstance(value, dict):
+            sorted_dict: dict[str, JsonSchemaValue] = {}
+            # Reverse all keys regardless of parent_key
+            keys = reversed(value.keys())
+            for key in keys:
+                sorted_dict[key] = self._sort_recursive(value[key], parent_key=key)
+            return sorted_dict
+        if isinstance(value, list):
+            # Reverse list order and process each item
+            return [self._sort_recursive(item, parent_key) for item in reversed(value)]
+        return value
+
+
 class WithFormatedJsonSchema(Base):
     """Class that provides a formatted JSON schema of the model."""
 
@@ -183,8 +256,8 @@ class WithFormatedJsonSchema(Base):
             str: The JSON schema of the model in a formatted string.
         """
         return orjson.dumps(
-            cls.model_json_schema(),
-            option=orjson.OPT_INDENT_2 | orjson.OPT_SORT_KEYS,
+            cls.model_json_schema(schema_generator=ReverseGenerate),
+            option=orjson.OPT_INDENT_2,
         ).decode()
 
 
@@ -374,7 +447,7 @@ class PrepareVectorization(Base):
         """
         max_length = max_length or configs.embedding.max_sequence_length
         chunk = self._prepare_vectorization_inner()
-        if len(chunk) > max_length:
+        if max_length and len(chunk) > max_length:
             logger.error(err := f"Chunk exceeds maximum sequence length {max_length}.")
             raise ValueError(err)
 
@@ -457,7 +530,7 @@ class ScopedConfig(Base):
         """Fallback to another instance's attribute values if the current instance's attributes are None.
 
         Args:
-            other (LLMUsage): Another instance from which to copy attribute values.
+            other (ScopedConfig): Another instance from which to copy attribute values.
 
         Returns:
             Self: The current instance, allowing for method chaining.
@@ -477,7 +550,7 @@ class ScopedConfig(Base):
         """Hold to another instance's attribute values if the current instance's attributes are None.
 
         Args:
-            others (LLMUsage | Iterable[LLMUsage]): Another instance or iterable of instances from which to copy attribute values.
+            others (Union[ScopedConfig, Iterable[ScopedConfig]]): Another instance or iterable of instances from which to copy attribute values.
 
         Returns:
             Self: The current instance, allowing for method chaining.

fabricatio-0.2.7.dev5.dist-info/METADATA

@@ -0,0 +1,181 @@
+Metadata-Version: 2.4
+Name: fabricatio
+Version: 0.2.7.dev5
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Pydantic :: 2
+Classifier: Typing :: Typed
+Requires-Dist: appdirs>=1.4.4
+Requires-Dist: asyncio>=3.4.3
+Requires-Dist: asyncstdlib>=3.13.0
+Requires-Dist: json-repair>=0.39.1
+Requires-Dist: litellm>=1.60.0
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: magika>=0.5.1
+Requires-Dist: more-itertools>=10.6.0
+Requires-Dist: orjson>=3.10.15
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pydantic-settings>=2.7.1
+Requires-Dist: pymitter>=1.0.0
+Requires-Dist: questionary>=2.1.0
+Requires-Dist: regex>=2024.11.6
+Requires-Dist: rich>=13.9.4
+Requires-Dist: pymilvus>=2.5.4 ; extra == 'rag'
+Requires-Dist: fabricatio[calc,plot,rag] ; extra == 'full'
+Requires-Dist: sympy>=1.13.3 ; extra == 'calc'
+Requires-Dist: matplotlib>=3.10.1 ; extra == 'plot'
+Provides-Extra: rag
+Provides-Extra: full
+Provides-Extra: calc
+Provides-Extra: plot
+License-File: LICENSE
+Summary: A LLM multi-agent framework.
+Keywords: ai,agents,multi-agent,llm,pyo3
+Author-email: Whth <zettainspector@foxmail.com>
+Requires-Python: >=3.12, <3.13
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/Whth/fabricatio
+Project-URL: Repository, https://github.com/Whth/fabricatio
+Project-URL: Issues, https://github.com/Whth/fabricatio/issues
+
+# Fabricatio
+
+![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
+![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)
+![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
+
+## Overview
+
+Fabricatio is a streamlined Python library for building LLM applications using an event-based agent structure. It leverages Rust for performance-critical tasks, Handlebars for templating, and PyO3 for Python bindings.
+
+## Features
+
+- **Event-Driven Architecture**: Robust task management through an EventEmitter pattern.
+- **LLM Integration & Templating**: Seamlessly interact with large language models and dynamic content generation.
+- **Async & Extensible**: Fully asynchronous execution with easy extension via custom actions and workflows.
+
+## Installation
+
+### Using UV (Recommended)
+
+```bash
+# Install uv if not already installed
+pip install uv
+
+# Clone the repository
+git clone https://github.com/Whth/fabricatio.git
+cd fabricatio
+
+# Install the package in development mode with uv
+uv --with-editable . maturin develop --uv -r
+```
+
+### Building Distribution
+
+```bash
+# Build distribution packages
+make bdist
+```
+
+## Usage
+
+### Basic Example
+
+```python
+import asyncio
+from fabricatio import Action, Role, Task, logger, WorkFlow
+from typing import Any
+
+class Hello(Action):
+    name: str = "hello"
+    output_key: str = "task_output"
+
+    async def _execute(self, task_input: Task[str], **_) -> Any:
+        ret = "Hello fabricatio!"
+        logger.info("executing talk action")
+        return ret
+
+async def main() -> None:
+    role = Role(
+        name="talker",
+        description="talker role",
+        registry={Task.pending_label: WorkFlow(name="talk", steps=(Hello,))}
+    )
+
+    task = Task(name="say hello", goals="say hello", description="say hello to the world")
+    result = await task.delegate()
+    logger.success(f"Result: {result}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+### Examples
+
+For various usage scenarios, refer to the following examples:
+- Simple Chat
+- Retrieval-Augmented Generation (RAG)
+- Article Extraction
+- Propose Task
+- Code Review
+- Write Outline
+
+_(For full example details, please check our detailed documentation, see [Examples](./examples))_
+
+## Configuration
+
+The configuration for Fabricatio is managed via environment variables or TOML files. For example:
+
+```toml
+[llm]
+api_endpoint = "https://api.openai.com"
+api_key = "your_openai_api_key"
+timeout = 300
+max_retries = 3
+model = "gpt-3.5-turbo"
+temperature = 1.0
+stop_sign = ["\n\n\n", "User:"]
+top_p = 0.35
+generation_count = 1
+stream = false
+max_tokens = 8192
+```
+
+## Development Setup
+
+1. **Clone the Repository**:
+    ```bash
+    git clone https://github.com/Whth/fabricatio.git
+    cd fabricatio
+    ```
+2. **Install Dependencies**:
+    ```bash
+    uv --with-editable . maturin develop --uv -r
+    ```
+3. **Run Tests**:
+    ```bash
+    make test
+    ```
+
+## Contributing
+
+Contributions are welcome! Follow these steps:
+1. Fork the repository.
+2. Create your feature branch (`git checkout -b feature/new-feature`).
+3. Commit your changes (`git commit -am 'Add new feature'`).
+4. Push to the branch (`git push origin feature/new-feature`).
+5. Create a new Pull Request.
+
+## License
+
+Fabricatio is licensed under the MIT License. See [LICENSE](LICENSE) for details.
+
+## Acknowledgments
+
+Special thanks to the contributors and maintainers of:
+- [PyO3](https://github.com/PyO3/pyo3)
+- [Maturin](https://github.com/PyO3/maturin)
+- [Handlebars.rs](https://github.com/sunng87/handlebars-rust)

{fabricatio-0.2.7.dev3.dist-info → fabricatio-0.2.7.dev5.dist-info}/RECORD

@@ -1,7 +1,7 @@
-fabricatio-0.2.7.dev3.dist-info/METADATA,sha256=6O8sm_fbzBC9kYdt9UKzf8ZoXEfFcLGWKHOgJMvC52Q,14236
-fabricatio-0.2.7.dev3.dist-info/WHEEL,sha256=jABKVkLC9kJr8mi_er5jOqpiQUjARSLXDUIIxDqsS50,96
-fabricatio-0.2.7.dev3.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
-fabricatio/actions/article.py,sha256=AgxNKIRLXF9T-TdrhLPE8NWmT8QZXz1QvFnouvuoRBc,7684
+fabricatio-0.2.7.dev5.dist-info/METADATA,sha256=ANxpgCb6nTOneCJ-RdQ7ejNoefGzRdKyfQIvwVfCJiU,5259
+fabricatio-0.2.7.dev5.dist-info/WHEEL,sha256=jABKVkLC9kJr8mi_er5jOqpiQUjARSLXDUIIxDqsS50,96
+fabricatio-0.2.7.dev5.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio/actions/article.py,sha256=cv1pyGOvgMVMaHJqVDKY6h5_u1XtVw3lzJCDFqx4aoc,8073
 fabricatio/actions/article_rag.py,sha256=PiOFxI6VTmLXm3BK-01g_KH1mTE9uOtnA-CwUjt16AU,1456
 fabricatio/actions/output.py,sha256=K7xsBH8MjXRH6JOy3ZO94KCQzX2jNrwPPK_rRXVkS0E,1161
 fabricatio/actions/rag.py,sha256=QBdzEM8MloM_ahx5pTBZAETm9_631lTe_0ih_he_Iuo,2759
@@ -20,11 +20,12 @@ fabricatio/fs/__init__.py,sha256=PCf0s_9KDjVfNw7AfPoJzGt3jMq4gJOfbcT4pb0D0ZY,588
 fabricatio/journal.py,sha256=stnEP88aUBA_GmU9gfTF2EZI8FS2OyMLGaMSTgK4QgA,476
 fabricatio/models/action.py,sha256=UlflniS__MMrUXglu_U3PDFAtKEjVsKEix17AT9oP3M,8769
 fabricatio/models/events.py,sha256=QvlnS8FEELg6KNabcJMeh2GV_y0ZBzKOPphcteKYWYU,4183
+fabricatio/models/extra/article_base.py,sha256=Y4ZdC1yabs7jCNKwc-P8GpAJShGJx7EcLyhXuJ194Fo,11469
 fabricatio/models/extra/article_essence.py,sha256=DUESuK4CGgkRvIMoJCv4l8MNp5MawRYoNOtLCrFRPXY,9229
-fabricatio/models/extra/article_main.py,sha256=F6rhHMICErzvtRIEWdxS5AoY9thLhUUeDofoJbNF9ZI,13984
-fabricatio/models/extra/article_outline.py,sha256=0t-aI3OtY1O1_dhwDDm1y4kUdqoh4bmQ8voNe6MDU4w,12452
-fabricatio/models/extra/article_proposal.py,sha256=eXtomW88urP9M4aKbVNN9dct0GH-fBwYOM_Rcq3d7j4,1771
-fabricatio/models/generic.py,sha256=TXNPGeVOWJnCKJ6KZU8T-SWQ913woX4Xt1BLJ0x4V9M,16820
+fabricatio/models/extra/article_main.py,sha256=l6HO3PajaesEET6Evd2A7OOpHRelGYr4y88JyoPmP3Y,8498
+fabricatio/models/extra/article_outline.py,sha256=VV6RUY7VzKwqCXoykDi-vL2nqHouOuo1Q3hLdCdNDpQ,7740
+fabricatio/models/extra/article_proposal.py,sha256=p0NPzqg9x6t65DZqdF52Z1P0JwP6kwo2_eP-NsXgifU,1720
+fabricatio/models/generic.py,sha256=yEpP4cvvmB0sDbs36pIl2KYFsnNRKq7V0m3HqoSQc7o,19492
 fabricatio/models/kwargs_types.py,sha256=chJ-rHaeBVRUPuORHuGR3DdNxxTUrotz0eflPEh4l4w,5474
 fabricatio/models/role.py,sha256=mmQbJ6GKr2Gx3wtjEz8d-vYoXs09ffcEkT_eCXaDd3E,2782
 fabricatio/models/task.py,sha256=8NaR7ojQWyM740EDTqt9stwHKdrD6axCRpLKo0QzS-I,10492
@@ -41,6 +42,6 @@ fabricatio/workflows/rag.py,sha256=-YYp2tlE9Vtfgpg6ROpu6QVO8j8yVSPa6yDzlN3qVxs,5
 fabricatio/_rust.pyi,sha256=dGTGV7viu3YAGl1cRKIWrdHPc1hlwk3_hbaDaswxdVo,3831
 fabricatio/_rust_instances.py,sha256=2GwF8aVfYNemRI2feBzH1CZfBGno-XJJE5imJokGEYw,314
 fabricatio/__init__.py,sha256=SzBYsRhZeL77jLtfJEjmoHOSwHwUGyvMATX6xfndLDM,1135
-fabricatio/_rust.cp312-win_amd64.pyd,sha256=JqLbZHAa0qBcJyWzAWC4Px5MTCxV9VN_BMsfm4saGus,1840128
-fabricatio-0.2.7.dev3.data/scripts/tdown.exe,sha256=2sqdWL-XEloL8IsQRQ9wZ_4O0aaLO02jgeb8KWCLgdM,3402752
-fabricatio-0.2.7.dev3.dist-info/RECORD,,
+fabricatio/_rust.cp312-win_amd64.pyd,sha256=db4DHfetEQMNh7hqmL6All-asJooQxFIIXZkoWKAx4c,1835008
+fabricatio-0.2.7.dev5.data/scripts/tdown.exe,sha256=xZcDsLIn9rJZcM8iDNgS-eNK4ckH5rufC6mU6I2vmOo,3399680
+fabricatio-0.2.7.dev5.dist-info/RECORD,,