config: defer initialization until ready() is called

README.md

@@ -8,8 +8,8 @@
 
 ## Requirements
 
-* [Django][django] 1.11+
-* [Dramatiq][dramatiq] 0.18+
+* [Django][django] 2.2+
+* [Dramatiq][dramatiq] 1.11+
 
 
 ## Example

django_dramatiq/apps.py

@@ -35,12 +35,11 @@ class DjangoDramatiqConfig(AppConfig):
     name = "django_dramatiq"
     verbose_name = "Django Dramatiq"
 
-    @classmethod
-    def initialize(cls):
+    def ready(self):
         global RATE_LIMITER_BACKEND
-        dramatiq.set_encoder(cls.select_encoder())
+        dramatiq.set_encoder(self.select_encoder())
 
-        result_backend_settings = cls.result_backend_settings()
+        result_backend_settings = self.result_backend_settings()
         if result_backend_settings:
             result_backend_path = result_backend_settings.get("BACKEND", "dramatiq.results.backends.StubBackend")
             result_backend_class = import_string(result_backend_path)
@@ -53,7 +52,7 @@ def initialize(cls):
             result_backend = None
             results_middleware = None
 
-        rate_limiter_backend_settings = cls.rate_limiter_backend_settings()
+        rate_limiter_backend_settings = self.rate_limiter_backend_settings()
         if rate_limiter_backend_settings:
             rate_limiter_backend_path = rate_limiter_backend_settings.get(
                 "BACKEND", "dramatiq.rate_limits.backends.stub.StubBackend"
@@ -62,12 +61,12 @@ def initialize(cls):
             rate_limiter_backend_options = rate_limiter_backend_settings.get("BACKEND_OPTIONS", {})
             RATE_LIMITER_BACKEND = rate_limiter_backend_class(**rate_limiter_backend_options)
 
-        broker_settings = cls.broker_settings()
+        broker_settings = self.broker_settings()
         broker_path = broker_settings["BROKER"]
         broker_class = import_string(broker_path)
         broker_options = broker_settings.get("OPTIONS", {})
         middleware = [
-            load_middleware(path, **cls.get_middleware_kwargs(path))
+            load_middleware(path, **self.get_middleware_kwargs(path))
             for path in broker_settings.get("MIDDLEWARE", [])
         ]
 
@@ -118,6 +117,3 @@ def tasks_database(cls):
     def select_encoder(cls):
         encoder = getattr(settings, "DRAMATIQ_ENCODER", DEFAULT_ENCODER)
         return import_string(encoder)()
-
-
-DjangoDramatiqConfig.initialize()

examples/basic/.gitignore

@@ -0,0 +1 @@
+db.sqlite3

examples/basic/basic/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for basic project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'basic.settings')
+
+application = get_asgi_application()

examples/basic/basic/settings.py

@@ -0,0 +1,140 @@
+"""
+Django settings for basic project.
+
+Generated by 'django-admin startproject' using Django 3.1.7.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.1/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/3.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'j*c$#8izhf4t&&%i0(&$#z*c2=txv9u*qyi8$uq&g+_7chwl-x'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'django_dramatiq',
+    'calc',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'basic.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'basic.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/3.1/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.1/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/3.1/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.1/howto/static-files/
+
+STATIC_URL = '/static/'
+
+# Dramatiq
+
+DRAMATIQ_BROKER = {
+    "BROKER": "dramatiq.brokers.redis.RedisBroker",
+    "OPTIONS": {
+        "url": "redis://localhost:6379",
+    },
+    "MIDDLEWARE": [
+        "dramatiq.middleware.Prometheus",
+        "dramatiq.middleware.AgeLimit",
+        "dramatiq.middleware.TimeLimit",
+        "dramatiq.middleware.Callbacks",
+        "dramatiq.middleware.Retries",
+        "django_dramatiq.middleware.DbConnectionsMiddleware",
+        "django_dramatiq.middleware.AdminMiddleware",
+    ]
+}

examples/basic/basic/urls.py

@@ -0,0 +1,22 @@
+"""basic URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/3.1/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import include, path
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+    path('', include('calc.urls')),
+]

examples/basic/basic/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for basic project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.1/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'basic.settings')
+
+application = get_wsgi_application()

examples/basic/calc/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

examples/basic/calc/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class CalcConfig(AppConfig):
+    name = 'calc'

examples/basic/calc/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

examples/basic/calc/tasks.py

@@ -0,0 +1,5 @@
+import dramatiq
+
+@dramatiq.actor
+def add(x, y):
+    add.logger.debug("x + y = %s", x + y)

examples/basic/calc/templates/calc.html

@@ -0,0 +1,12 @@
+<form action="" method="POST">
+  {% csrf_token %}
+  <label>
+    a: <input type="number" name="a" />
+  </label>
+  <br/>
+  <label>
+    b: <input type="number" name="b" />
+  </label>
+  <br/>
+  <button type="submit">Add</button>
+</form>

examples/basic/calc/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

examples/basic/calc/urls.py

@@ -0,0 +1,7 @@
+from django.urls import path
+
+from . import views
+
+urlpatterns = [
+    path('', views.calc, name='calc'),
+]

examples/basic/calc/views.py

@@ -0,0 +1,9 @@
+from django.shortcuts import render
+
+from .tasks import add
+
+
+def calc(req):
+    if req.method == "POST":
+        add.send(float(req.POST["a"]), float(req.POST["b"]))
+    return render(req, "calc.html")

examples/basic/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'basic.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

setup.py

@@ -31,14 +31,13 @@ def rel(*xs):
     ],
     install_requires=[
         "django>=2.2",
-        "dramatiq>=0.18.0",
+        "dramatiq>=1.11",
     ],
     classifiers=[
         "Environment :: Web Environment",
         "Operating System :: OS Independent",
         "Framework :: Django",
         "Framework :: Django :: 2.2",
-        "Framework :: Django :: 3.1",
         "Framework :: Django :: 3.2",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3.6",

tests/test_admin_middleware.py

@@ -1,3 +1,5 @@
+from threading import Event
+
 import dramatiq
 from dramatiq import Middleware
 from dramatiq.middleware import SkipMessage
@@ -7,26 +9,29 @@
 
 def test_admin_middleware_keeps_track_of_tasks(transactional_db, broker, worker):
     # Given an actor
+    evt = Event()
+
     @dramatiq.actor
     def do_work():
-        pass
+        evt.set()
 
     # When I send it a delayed message
-    do_work.send_with_options(delay=1000)
+    do_work.send_with_options(delay=250)
 
     # Then a Task should be stored to the database
     task = Task.tasks.get()
     assert task
     assert task.status == Task.STATUS_DELAYED
 
     # When I join on the broker
-    broker.join(do_work.queue_name)
+    evt.wait()
+    broker.join(do_work.queue_name, fail_fast=True)
     worker.join()
 
     # And reload the task
     task.refresh_from_db()
 
-    # The the Task's status should be updated
+    # Then the Task's status should be updated
     assert task.status == Task.STATUS_DONE