add type annotations for RabbitQueue and enum for queue type

airtai · Dec 21, 2024 · 10df170 · 10df170
1 parent 684ef1a
commit 10df170
Show file tree

Hide file tree

Showing 14 changed files with 292 additions and 53 deletions.
diff --git a/docs/docs/SUMMARY.md b/docs/docs/SUMMARY.md
@@ -934,6 +934,7 @@ search:
                     - [ExchangeType](api/faststream/rabbit/schemas/ExchangeType.md)
                     - [RabbitExchange](api/faststream/rabbit/schemas/RabbitExchange.md)
                     - [RabbitQueue](api/faststream/rabbit/schemas/RabbitQueue.md)
+                    - [RabbitQueueType](api/faststream/rabbit/schemas/RabbitQueueType.md)
                     - [ReplyConfig](api/faststream/rabbit/schemas/ReplyConfig.md)
                     - constants
                         - [ExchangeType](api/faststream/rabbit/schemas/constants/ExchangeType.md)
@@ -942,7 +943,16 @@ search:
                     - proto
                         - [BaseRMQInformation](api/faststream/rabbit/schemas/proto/BaseRMQInformation.md)
                     - queue
+                        - [ClassicQueueArgs](api/faststream/rabbit/schemas/queue/ClassicQueueArgs.md)
+                        - [CommonQueueArgs](api/faststream/rabbit/schemas/queue/CommonQueueArgs.md)
+                        - [QueueClassicTypeSpecificArgs](api/faststream/rabbit/schemas/queue/QueueClassicTypeSpecificArgs.md)
+                        - [QueueQuorumTypeSpecificArgs](api/faststream/rabbit/schemas/queue/QueueQuorumTypeSpecificArgs.md)
+                        - [QueueStreamTypeSpecificArgs](api/faststream/rabbit/schemas/queue/QueueStreamTypeSpecificArgs.md)
+                        - [QuorumQueueArgs](api/faststream/rabbit/schemas/queue/QuorumQueueArgs.md)
                         - [RabbitQueue](api/faststream/rabbit/schemas/queue/RabbitQueue.md)
+                        - [RabbitQueueType](api/faststream/rabbit/schemas/queue/RabbitQueueType.md)
+                        - [SharedQueueClassicAndQuorumArgs](api/faststream/rabbit/schemas/queue/SharedQueueClassicAndQuorumArgs.md)
+                        - [StreamQueueArgs](api/faststream/rabbit/schemas/queue/StreamQueueArgs.md)
                     - reply
                         - [ReplyConfig](api/faststream/rabbit/schemas/reply/ReplyConfig.md)
                 - security

diff --git a/docs/docs/en/api/faststream/rabbit/schemas/RabbitQueueType.md b/docs/docs/en/api/faststream/rabbit/schemas/RabbitQueueType.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.rabbit.schemas.RabbitQueueType
diff --git a/docs/docs/en/api/faststream/rabbit/schemas/queue/ClassicQueueArgs.md b/docs/docs/en/api/faststream/rabbit/schemas/queue/ClassicQueueArgs.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.rabbit.schemas.queue.ClassicQueueArgs
diff --git a/docs/docs/en/api/faststream/rabbit/schemas/queue/CommonQueueArgs.md b/docs/docs/en/api/faststream/rabbit/schemas/queue/CommonQueueArgs.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.rabbit.schemas.queue.CommonQueueArgs
diff --git a/docs/docs/en/api/faststream/rabbit/schemas/queue/QueueClassicTypeSpecificArgs.md b/docs/docs/en/api/faststream/rabbit/schemas/queue/QueueClassicTypeSpecificArgs.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.rabbit.schemas.queue.QueueClassicTypeSpecificArgs
diff --git a/docs/docs/en/api/faststream/rabbit/schemas/queue/QueueQuorumTypeSpecificArgs.md b/docs/docs/en/api/faststream/rabbit/schemas/queue/QueueQuorumTypeSpecificArgs.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.rabbit.schemas.queue.QueueQuorumTypeSpecificArgs
diff --git a/docs/docs/en/api/faststream/rabbit/schemas/queue/QueueStreamTypeSpecificArgs.md b/docs/docs/en/api/faststream/rabbit/schemas/queue/QueueStreamTypeSpecificArgs.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.rabbit.schemas.queue.QueueStreamTypeSpecificArgs
diff --git a/docs/docs/en/api/faststream/rabbit/schemas/queue/QuorumQueueArgs.md b/docs/docs/en/api/faststream/rabbit/schemas/queue/QuorumQueueArgs.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.rabbit.schemas.queue.QuorumQueueArgs
diff --git a/docs/docs/en/api/faststream/rabbit/schemas/queue/RabbitQueueType.md b/docs/docs/en/api/faststream/rabbit/schemas/queue/RabbitQueueType.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.rabbit.schemas.queue.RabbitQueueType
diff --git a/.../docs/en/api/faststream/rabbit/schemas/queue/SharedQueueClassicAndQuorumArgs.md b/.../docs/en/api/faststream/rabbit/schemas/queue/SharedQueueClassicAndQuorumArgs.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.rabbit.schemas.queue.SharedQueueClassicAndQuorumArgs
diff --git a/docs/docs/en/api/faststream/rabbit/schemas/queue/StreamQueueArgs.md b/docs/docs/en/api/faststream/rabbit/schemas/queue/StreamQueueArgs.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.rabbit.schemas.queue.StreamQueueArgs
diff --git a/faststream/rabbit/broker/broker.py b/faststream/rabbit/broker/broker.py
@@ -27,6 +27,7 @@
     RABBIT_REPLY,
     RabbitExchange,
     RabbitQueue,
+    RabbitQueueType,
 )
 from faststream.rabbit.security import parse_security
 from faststream.rabbit.subscriber.asyncapi import AsyncAPISubscriber
@@ -475,7 +476,7 @@ async def _connect(  # type: ignore[override]
             if max_consumers:
                 c = AsyncAPISubscriber.build_log_context(
                     None,
-                    RabbitQueue(""),
+                    RabbitQueue("", queue_type=RabbitQueueType.Classic),
                     RabbitExchange(""),
                 )
                 self._log(f"Set max consumers to {max_consumers}", extra=c)

diff --git a/faststream/rabbit/schemas/__init__.py b/faststream/rabbit/schemas/__init__.py
@@ -1,7 +1,7 @@
 from faststream.rabbit.schemas.constants import ExchangeType
 from faststream.rabbit.schemas.exchange import RabbitExchange
 from faststream.rabbit.schemas.proto import BaseRMQInformation
-from faststream.rabbit.schemas.queue import RabbitQueue
+from faststream.rabbit.schemas.queue import RabbitQueue, RabbitQueueType
 from faststream.rabbit.schemas.reply import ReplyConfig
 
 __all__ = (
@@ -10,7 +10,10 @@
     "ExchangeType",
     "RabbitExchange",
     "RabbitQueue",
+    "RabbitQueueType",
     "ReplyConfig",
 )
 
-RABBIT_REPLY = RabbitQueue("amq.rabbitmq.reply-to", passive=True)
+RABBIT_REPLY = RabbitQueue(
+    "amq.rabbitmq.reply-to", passive=True, queue_type=RabbitQueueType.Classic
+)