Login

EditInline for GenericForeignKey

Author:
king
Posted:
May 20, 2008
Language:
Python
Version:
.96
Score:
2 (after 2 ratings)

A simple InlineModelAdmin class that enables you to edit models that are bound by the instance via a generic foreign key (content_type, object_id pair)

Use like:

class PlacementInlineOptions( generic.GenericTabularInline ):
    model = Placement
    extra = 2 
    ct_field_name = 'target_ct'
    id_field_name = 'target_id'

Can be also found at #4667

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
from django.contrib.contenttypes.models import ContentType
from django.newforms.models import BaseModelFormSet, _modelformset_factory, save_instance
from django.contrib.admin.options import InlineModelAdmin, flatten_fieldsets
from django.db.models import ForeignKey
  
class GenericInlineFormset(BaseModelFormSet):
    """A formset for child objects related to a parent."""
    def __init__(self, instance=None, data=None, files=None):
        self.instance = instance
        self.rel_name = '-'.join( ( self.model._meta.app_label, self.model._meta.object_name.lower(), self.ct.name,  self.obj_id.name ) )
        super(GenericInlineFormset, self).__init__(queryset=self.get_queryset(), data=data, files=files, prefix=self.rel_name)
  
    def get_queryset(self):
        if self.instance is None:
            return []
        return self.model._default_manager.filter( **{ 
                self.ct.name : ContentType.objects.get_for_model(self.instance),
                self.obj_id.name : self.instance.pk 
            })
  
    def save_new(self, form, commit=True):
        kwargs = {
            self.ct.get_attname(): ContentType.objects.get_for_model(self.instance).pk,
            self.obj_id.get_attname(): self.instance.pk,
        }
        new_obj = self.model(**kwargs)
        return save_instance(form, new_obj, commit=commit)
  
class GenericInlineModelAdmin(InlineModelAdmin):
    ct_field_name = None
    id_field_name = None
    formset = GenericInlineFormset
  
    def get_formset( self, request, obj=None ):

        if self.declared_fieldsets:
            fields = flatten_fieldsets(self.declared_fieldsets)
        else:
            fields = None
  
        opts = model._meta
        # if there is no field called `ct_field_name` let the exception propagate
        ct = opts.get_field(ct_field_name)
        if not isinstance(ct, ForeignKey) or ct.rel.to != ContentType:
            raise Exception("fk_name '%s' is not a ForeignKey to ContentType" % (ct_field_name))
        obj_id = opts.get_field(id_field_name) # let the exception propagate
  
        FormSet = _modelformset_factory(self.model, form=self.form,
                                        formfield_callback=self.formfield_for_dbfield,
                                        formset=self.formset,
                                        extra=self.extra, fields=fields, exclude=[ct.name, obj_id.name] )
        FormSet.ct = ct
        FormSet.obj_id = obj_id     
        return FormSet 

class GenericStackedInline(GenericInlineModelAdmin):
    template = 'admin/edit_inline/stacked.html'
 
class GenericTabularInline(GenericInlineModelAdmin):
    template = 'admin/edit_inline/tabular.html'

More like this

  1. Template tag - list punctuation for a list of items by shapiromatron 11 months, 2 weeks ago
  2. JSONRequestMiddleware adds a .json() method to your HttpRequests by cdcarter 11 months, 3 weeks ago
  3. Serializer factory with Django Rest Framework by julio 1 year, 6 months ago
  4. Image compression before saving the new model / work with JPG, PNG by Schleidens 1 year, 7 months ago
  5. Help text hyperlinks by sa2812 1 year, 7 months ago

Comments

prufrocks (on June 5, 2008):

I'm a bit confused about how to use this. Does it require patch #4677 to be applied to my local copy of the NFA branch? I tried simply taking this snippet and creating a generic.py file inside django.contrib.admin. But when trying to use it, I get a NameError exception stating that "global name 'model' is not defined" at line 41.

#

zbyte64 (on June 11, 2008):

Im guessing this code no longer applies, I get the following error:

ImportError: cannot import name _modelformset_factory

#

Please login first before commenting.