jararaca 0.2.37a7__tar.gz → 0.2.37a9__tar.gz

{jararaca-0.2.37a7 → jararaca-0.2.37a9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jararaca
-Version: 0.2.37a7
+Version: 0.2.37a9
 Summary: A simple and fast API framework for Python
 Home-page: https://github.com/LuscasLeo/jararaca
 Author: Lucas S

{jararaca-0.2.37a7 → jararaca-0.2.37a9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "jararaca"
-version = "0.2.37a7"
+version = "0.2.37a9"
 description = "A simple and fast API framework for Python"
 authors = ["Lucas S <me@luscasleo.dev>"]
 readme = "README.md"

{jararaca-0.2.37a7 → jararaca-0.2.37a9}/src/jararaca/__init__.py

@@ -16,8 +16,10 @@ if TYPE_CHECKING:
     from jararaca.persistence.sort_filter import (
         FILTER_SORT_ENTITY_ATTR_MAP,
         FilterModel,
+        FilterRuleApplier,
         SortFilterRunner,
         SortModel,
+        SortRuleApplier,
     )
     from jararaca.presentation.hooks import (
         raises_200_on,
@@ -112,6 +114,8 @@ if TYPE_CHECKING:
     from .tools.app_config.interceptor import AppConfigurationInterceptor
 
     __all__ = [
+        "FilterRuleApplier",
+        "SortRuleApplier",
         "use_bus_message_controller",
         "ack",
         "nack",
@@ -210,6 +214,8 @@ if TYPE_CHECKING:
 __SPEC_PARENT__: str = __spec__.parent  # type: ignore
 # A mapping of {<member name>: (package, <module name>)} defining dynamic imports
 _dynamic_imports: "dict[str, tuple[str, str, str | None]]" = {
+    "FilterRuleApplier": (__SPEC_PARENT__, "persistence.sort_filter", None),
+    "SortRuleApplier": (__SPEC_PARENT__, "persistence.sort_filter", None),
     "use_bus_message_controller": (
         __SPEC_PARENT__,
         "messagebus.bus_message_controller",

{jararaca-0.2.37a7 → jararaca-0.2.37a9}/src/jararaca/persistence/utilities.py

@@ -72,9 +72,33 @@ class IdentifiableEntity(BaseEntity):
 
     @classmethod
     def from_identifiable(cls, model: Identifiable[T_BASEMODEL]) -> "Self":
+        """
+        Converts an Identifiable model instance to an instance of the calling class.
+        This method takes an instance of a class that implements the Identifiable interface
+        and uses its `id` and `data` attributes to create a new instance of the calling class.
+        Args:
+            model (Identifiable[T_BASEMODEL]): An instance of a class that implements the Identifiable interface.
+        Returns:
+            Self: A new instance of the calling class with attributes populated from the model.
+        Deprecated:
+            This method is deprecated and will be removed in a future release.
+        """
+
         return cls(**{"id": model.id, **model.data.model_dump()})
 
     def to_identifiable(self, MODEL: Type[T_BASEMODEL]) -> Identifiable[T_BASEMODEL]:
+        """
+        Converts the current instance to an Identifiable object of the specified model type.
+        Args:
+            MODEL (Type[T_BASEMODEL]): The model type to convert the current instance to.
+        Returns:
+            Identifiable[T_BASEMODEL]: An Identifiable object containing the id and data of the current instance.
+        Raises:
+            ValidationError: If the conversion fails due to validation errors.
+        Note:
+            This method is **deprecated** and may be removed in future versions.
+
+        """
         try:
             return Identifiable[MODEL].model_validate(  # type: ignore[valid-type]
                 {"id": self.id, "data": recursive_get_dict(self)}