Create Django Transport

docs/includes/introduction.txt

@@ -93,6 +93,8 @@ Transport Comparison
 +---------------+----------+------------+------------+---------------+--------------+-----------------------+
 | *Pyro*        | Virtual  | Yes        | Yes [#f1]_ | No            | No           | No                    |
 +---------------+----------+------------+------------+---------------+--------------+-----------------------+
+| *Django*      | Virtual  | Yes        | Yes        | Yes           | Yes          | Yes                   |
++---------------+----------+------------+------------+---------------+--------------+-----------------------+
 
 
 .. [#f1] Declarations only kept in memory, so exchanges/queues
@@ -264,4 +266,3 @@ There are some concepts you should be familiar with before starting:
                 zero or more words. For example `"*.stock.#"` matches the
                 routing keys `"usd.stock"` and `"eur.stock.db"` but not
                 `"stock.nasdaq"`.
-

docs/reference/index.rst

@@ -42,6 +42,7 @@ Kombu Transports
     kombu.transport.virtual.exchange
     kombu.transport.azurestoragequeues
     kombu.transport.azureservicebus
+    kombu.transport.django
     kombu.transport.pyamqp
     kombu.transport.librabbitmq
     kombu.transport.qpid

docs/reference/kombu.transport.django.rst

@@ -0,0 +1,39 @@
+==============================================
+ Django Transport - ``kombu.transport.django``
+==============================================
+
+.. currentmodule:: kombu.transport.django
+
+.. automodule:: kombu.transport.django
+
+    .. contents::
+        :local:
+
+    Transport
+    ---------
+
+    .. autoclass:: Transport
+        :members:
+        :undoc-members:
+
+    Channel
+    -------
+
+    .. autoclass:: Channel
+        :members:
+        :undoc-members:
+
+Django Transport Migrations - ``kombu.transport.django.models``
+===============================================================
+
+.. currentmodule:: kombu.transport.django
+
+.. automodule:: kombu.transport.django.migrations
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: kombu.transport.django.migrations.0001_initial
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/userguide/connections.rst

@@ -147,6 +147,9 @@ All of these are valid URLs:
     # Using Pyro with name server running on 'localhost'
     pyro://localhost/kombu.broker
 
+    # Using Django
+    django:///
+
 
 The query part of the URL can also be used to set options, e.g.:
 

kombu/transport/__init__.py

@@ -45,6 +45,7 @@ def supports_librabbitmq() -> bool | None:
     'azureservicebus': 'kombu.transport.azureservicebus:Transport',
     'pyro': 'kombu.transport.pyro:Transport',
     'gcpubsub': 'kombu.transport.gcpubsub:Transport',
+    'django': 'kombu.transport.django.transport.Transport',
 }
 
 _transport_cache = {}

kombu/transport/django/apps.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from django.apps import AppConfig
+
+
+class KombuConfig(AppConfig):
+    """Django app config."""
+
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "kombu.transport.django"
+    label = "kombu"

kombu/transport/django/migrations/0001_initial.py

@@ -0,0 +1,111 @@
+"""The initial migration for the Django transport."""
+
+# Generated by Django 5.1.5 on 2025-01-20 18:26
+
+from __future__ import annotations
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """The initial migration."""
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="Exchange",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=200, unique=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Queue",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=200, unique=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Message",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("visible", models.BooleanField(db_index=True, default=True)),
+                (
+                    "sent_at",
+                    models.DateTimeField(auto_now_add=True, db_index=True, null=True),
+                ),
+                ("message", models.TextField()),
+                ("version", models.PositiveIntegerField(default=1)),
+                ("priority", models.PositiveIntegerField(default=0)),
+                ("ttl", models.IntegerField(blank=True, null=True)),
+                (
+                    "queue",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="messages",
+                        to="kombu.queue",
+                    ),
+                ),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Binding",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("routing_key", models.CharField(max_length=255, null=True)),
+                (
+                    "exchange",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="bindings",
+                        to="kombu.exchange",
+                    ),
+                ),
+                (
+                    "queue",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="bindings",
+                        to="kombu.queue",
+                    ),
+                ),
+            ],
+        ),
+    ]

kombu/transport/django/migrations/__init__.py

@@ -0,0 +1,3 @@
+"""The migration files for the Django transport."""
+
+from __future__ import annotations

kombu/transport/django/models.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+from datetime import timedelta
+
+from django.db import models
+from django.utils import timezone
+
+
+class Queue(models.Model):
+    """The queue."""
+
+    name = models.CharField(max_length=200, unique=True)
+
+    def __str__(self):
+        return self.name
+
+
+class Message(models.Model):
+    """The message."""
+
+    visible = models.BooleanField(default=True, db_index=True)
+    sent_at = models.DateTimeField(null=True, db_index=True, auto_now_add=True)
+    message = models.TextField()
+    version = models.PositiveIntegerField(default=1)
+    priority = models.PositiveIntegerField(default=0)
+    ttl = models.IntegerField(
+        null=True, blank=True
+    )  # TTL in seconds (null means no TTL)
+    queue = models.ForeignKey(Queue, on_delete=models.CASCADE, related_name="messages")
+
+    def __str__(self):
+        return f"{self.sent_at} {self.message} {self.queue_id}"
+
+    def is_expired(self):
+        if self.ttl is None:
+            return False  # No TTL set, so not expired
+        expiration_time = self.sent_at + timedelta(seconds=self.ttl)
+        return expiration_time < timezone.now()
+
+
+class Exchange(models.Model):
+    """The exchange."""
+
+    name = models.CharField(max_length=200, unique=True)
+
+    def __str__(self):
+        return f"{self.name}"
+
+
+class Binding(models.Model):
+    """The binding."""
+
+    queue = models.ForeignKey(Queue, on_delete=models.CASCADE, related_name="bindings")
+    exchange = models.ForeignKey(
+        Exchange, on_delete=models.CASCADE, related_name="bindings"
+    )
+    routing_key = models.CharField(max_length=255, null=True)
+
+    def __str__(self):
+        return f"Binding: {self.queue.name} -> {self.exchange.name} with routing_key {self.routing_key}"