Django Annoying

Common errors

• TypeError: 'dict' object is not callable when using JSONField default

  cause You've set a mutable dictionary directly as the `default` argument for `JSONField` (e.g., `JSONField(default={})`), leading to a shared default object and potential runtime errors when the system tries to call it as a callable.
  fix Provide a callable for the default, like `JSONField(default=dict)`. This ensures a fresh dictionary is created for each new model instance.

• Http404 is not caught or handled when using @render_to decorator

  cause When using `@render_to`, the decorator processes the return value of the view. If `Http404` is raised *after* the decorator's execution flow might have started or expects a dictionary, it can interfere with standard Django exception handling.
  fix Ensure `Http404` is raised before the decorator attempts to process a return value, typically at the beginning of the view or within a `get_object_or_404` call. Alternatively, if a non-dictionary (like an `HttpResponseRedirect` or a direct `HttpResponseNotFound`) is returned, `@render_to` will pass it through without processing.

Warnings

• deprecated The `annoying.decorators.signals` decorator is officially deprecated and will be removed in a future version. Django now includes native capabilities for signal handling, making this decorator redundant.
  Fix: Migrate to Django's built-in signal connection methods (e.g., `django.db.models.signals.post_save.connect`).
• deprecated The `annoying.decorators.autostrip` decorator is deprecated. Modern Django forms (CharField and Textarea) provide native stripping functionality by default (via `strip=True`).
  Fix: Remove the `autostrip` decorator and rely on Django's default form field behavior or explicitly set `strip=True` on `CharField` and `TextField`.
• gotcha Using a mutable object (like `dict` or `list`) directly as the `default` argument for `annoying.fields.JSONField` (or any Django field) will cause all model instances to share the *same* default object. Modifying it for one instance will affect all others.
  Fix: Always provide a callable (e.g., `default=dict` or `default=list`) for mutable default values in model fields to ensure each new instance gets its own independent default object.
• breaking As of recent versions, `django-annoying` has dropped support for unmaintained and unsupported versions of Django. It explicitly requires Django 1.11 or later.
  Fix: Ensure your Django project is running Django 1.11 or a more recent, supported version. Check the `django-annoying` release notes for specific compatibility details for your `django-annoying` version.

Install

• pip install django-annoying Install latest version

Imports

• render_to

  from annoying.decorators import render_to

• ajax_request

  from annoying.decorators import ajax_request

• JSONField

  from annoying.fields import JSONField

• AutoOneToOneField

  from annoying.fields import AutoOneToOneField

• get_object_or_None

  from annoying.functions import get_object_or_None

• signals
  wrong:

  from django.db.models import signals

  correct:

  from annoying.decorators import signals

  The `annoying.decorators.signals` is deprecated. Modern Django has native signal handling, or it may be confused with standard Django signals.
• autostrip
  wrong:

  from django import forms

  correct:

  from annoying.decorators import autostrip

  The `annoying.decorators.autostrip` is deprecated. Modern Django forms handle stripping natively.

Quickstart

This quickstart demonstrates the `render_to` decorator for simplifying view returns and the `JSONField` for storing JSON data in models. Remember to add 'annoying' to your `INSTALLED_APPS` in `settings.py`.

from django.shortcuts import render
from django.http import HttpResponse
from annoying.decorators import render_to

# views.py example

@render_to('my_app/my_template.html')
def my_view(request):
    context = {'message': 'Hello from django-annoying!'}
    return context # The decorator handles rendering this dict to a template

# models.py example
from django.db import models
from annoying.fields import JSONField

class MyModel(models.Model):
    data = JSONField(default=dict) # Use a callable for mutable defaults

    def __str__(self):
        return f"MyModel object with data: {self.data}"