feat: ack_first added deprecated and docstrings to Ack_Policy

airtai · Nov 19, 2024 · ad8d6b4 · ad8d6b4
1 parent d64f9f5
commit ad8d6b4
Show file tree

Hide file tree

Showing 7 changed files with 142 additions and 9 deletions.
diff --git a/faststream/confluent/broker/registrator.py b/faststream/confluent/broker/registrator.py
@@ -10,7 +10,7 @@
     overload,
 )
 
-from typing_extensions import Doc, override
+from typing_extensions import Doc, deprecated, override
 
 from faststream._internal.broker.abc_broker import ABCBroker
 from faststream._internal.constants import EMPTY
@@ -161,7 +161,13 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
-        ] = True,
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
+        ] = EMPTY,
         auto_commit_interval_ms: Annotated[
             int,
             Doc(
@@ -428,7 +434,13 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
-        ] = True,
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
+        ] = EMPTY,
         auto_commit_interval_ms: Annotated[
             int,
             Doc(
@@ -695,7 +707,13 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
-        ] = True,
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
+        ] = EMPTY,
         auto_commit_interval_ms: Annotated[
             int,
             Doc(
@@ -965,7 +983,13 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
-        ] = True,
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
+        ] = EMPTY,
         auto_commit_interval_ms: Annotated[
             int,
             Doc(
@@ -1130,7 +1154,23 @@ def subscriber(
         "SpecificationDefaultSubscriber",
         "SpecificationBatchSubscriber",
     ]:
-        if ack_policy is AckPolicy.ACK_FIRST:
+        if (
+            auto_commit is not EMPTY and auto_commit
+            and ack_policy is not EMPTY and ack_policy is not ack_policy.ACK_FIRST
+        ) or (
+            auto_commit is not EMPTY and not auto_commit
+            and ack_policy is ack_policy.ACK_FIRST
+        ):
+            msg = "You can't use conflict settings ('auto_commit' and 'ack_policy')"
+            raise SetupError(msg)
+
+        if auto_commit is not EMPTY and auto_commit and ack_policy is EMPTY:
+            ack_policy = AckPolicy.DO_NOTHING
+
+        elif auto_commit is not EMPTY and not auto_commit and ack_policy is EMPTY:
+            ack_policy = AckPolicy.REJECT_ON_ERROR
+
+        elif ack_policy is AckPolicy.ACK_FIRST:
             auto_commit = True
             ack_policy = AckPolicy.DO_NOTHING
 

diff --git a/faststream/confluent/fastapi/fastapi.py b/faststream/confluent/fastapi/fastapi.py
@@ -699,6 +699,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,
@@ -1089,6 +1095,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,
@@ -1469,6 +1481,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,
@@ -1862,6 +1880,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,

diff --git a/faststream/confluent/router.py b/faststream/confluent/router.py
@@ -9,7 +9,7 @@
     Union,
 )
 
-from typing_extensions import Doc
+from typing_extensions import Doc, deprecated
 
 from faststream._internal.broker.router import (
     ArgsContainer,
@@ -247,6 +247,12 @@ def __init__(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,

diff --git a/faststream/kafka/broker/registrator.py b/faststream/kafka/broker/registrator.py
@@ -13,7 +13,7 @@
 
 from aiokafka import ConsumerRecord
 from aiokafka.coordinator.assignors.roundrobin import RoundRobinPartitionAssignor
-from typing_extensions import Doc, override
+from typing_extensions import Doc, deprecated, override
 
 from faststream._internal.broker.abc_broker import ABCBroker
 from faststream._internal.constants import EMPTY
@@ -167,6 +167,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,
@@ -533,6 +539,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,
@@ -899,6 +911,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,
@@ -1268,6 +1286,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,

diff --git a/faststream/kafka/fastapi/fastapi.py b/faststream/kafka/fastapi/fastapi.py
@@ -710,6 +710,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,
@@ -1196,6 +1202,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,
@@ -1682,6 +1694,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,
@@ -2171,6 +2189,12 @@ def subscriber(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,

diff --git a/faststream/kafka/router.py b/faststream/kafka/router.py
@@ -10,7 +10,7 @@
 )
 
 from aiokafka.coordinator.assignors.roundrobin import RoundRobinPartitionAssignor
-from typing_extensions import Doc
+from typing_extensions import Doc, deprecated
 
 from faststream._internal.broker.router import (
     ArgsContainer,
@@ -255,6 +255,12 @@ def __init__(
             periodically committed in the background.
             """,
             ),
+            deprecated(
+                """
+            This option is deprecated and will be removed in 0.7.0 release.
+            Please, use `ack_policy=AckPolicy.ACK_FIRST` instead.
+            """,
+            ),
         ] = True,
         auto_commit_interval_ms: Annotated[
             int,

diff --git a/faststream/middlewares/acknowledgement/conf.py b/faststream/middlewares/acknowledgement/conf.py
@@ -3,7 +3,16 @@
 
 class AckPolicy(str, Enum):
     ACK_FIRST = "ack_first"
+    """Ack message on consume"""
+
     ACK = "ack"
+    """Ack message after all process"""
+
     REJECT_ON_ERROR = "reject_on_error"
+    """Reject message on unhandled exceptions"""
+
     NACK_ON_ERROR = "nack_on_error"
+    """Nack message on unhandled exceptions"""
+
     DO_NOTHING = "do_nothing"
+    """Not create AcknowledgementMiddleware"""