Merge pull request #101 from rohithasrk/str-rep

Fixes #96: Improve string representation of sortedm2m relationships

README.rst

@@ -77,6 +77,16 @@ Specifies how the field is called in the intermediate database table by which
 the relationship is ordered. You can change its name if you have a legacy
 database that you need to integrate into your application.
 
+``base_class``
+~~~~~~~~~~~~~~
+
+**Default:** ``None``
+
+You can set the ``base_class``, which is the base class of the through model of
+the sortedm2m relationship between models to an abstract base class containing
+a ``__str__`` method to improve the string representations of sortedm2m
+relationships.
+
 Migrating a ``ManyToManyField`` to be a ``SortedManyToManyField``
 =================================================================
 

example/testapp/models.py

@@ -16,10 +16,16 @@ def __str__(self):
         return self.plate
 
 
+@python_2_unicode_compatible
+class BaseCarThrough(object):
+    def __str__(self):
+        return str(self.car) + " in " + str(self.parkingarea)
+
+
 @python_2_unicode_compatible
 class ParkingArea(models.Model):
     name = models.CharField(max_length=50)
-    cars = SortedManyToManyField(Car)
+    cars = SortedManyToManyField(Car, base_class=BaseCarThrough)
 
     def __str__(self):
         return self.name

sortedm2m/fields.py

@@ -214,13 +214,19 @@ class SortedManyToManyField(_ManyToManyField):
     Accept a boolean ``sorted`` attribute which specifies if relation is
     ordered or not. Default is set to ``True``. If ``sorted`` is set to
     ``False`` the field will behave exactly like django's ``ManyToManyField``.
+
+    Accept a class ``base_class`` attribute which specifies the base class of
+    the intermediate model. It allows to customize the intermediate model.
     '''
-    def __init__(self, to, sorted=True, **kwargs):
+    def __init__(self, to, sorted=True, base_class=None, **kwargs):
         self.sorted = sorted
         self.sort_value_field_name = kwargs.pop(
             'sort_value_field_name',
             SORT_VALUE_FIELD_NAME)
 
+        # Base class of through model
+        self.base_class = base_class
+
         super(SortedManyToManyField, self).__init__(to, **kwargs)
         if self.sorted:
             self.help_text = kwargs.get('help_text', None)
@@ -377,16 +383,19 @@ def get_intermediate_model_to_field(self, klass):
 
     def create_intermediate_model_from_attrs(self, klass, attrs):
         name = self.get_intermediate_model_name(klass)
-        return type(str(name), (models.Model,), attrs)
+        base_classes = (self.base_class, models.Model) if self.base_class else (models.Model,)
+
+        return type(str(name), base_classes, attrs)
 
     def create_intermediate_model(self, klass):
         # Construct and return the new class.
         from_field_name, from_field = self.get_intermediate_model_from_field(klass)
         to_field_name, to_field = self.get_intermediate_model_to_field(klass)
         sort_value_field_name, sort_value_field = self.get_intermediate_model_sort_value_field(klass)
-
-        meta = self.get_intermediate_model_meta_class(
-            klass, from_field_name, to_field_name, sort_value_field_name)
+        meta = self.get_intermediate_model_meta_class(klass,
+                                                      from_field_name,
+                                                      to_field_name,
+                                                      sort_value_field_name)
 
         attrs = {
             'Meta': meta,

sortedm2m_tests/models.py

@@ -8,8 +8,14 @@
 from sortedm2m.fields import SortedManyToManyField
 
 
+class BaseBookThrough(object):
+
+    def __str__(self):
+        return "Relationship to {0}".format(self.book.name)
+
+
 class Shelf(models.Model):
-    books = SortedManyToManyField('Book', related_name='shelves')
+    books = SortedManyToManyField('Book', related_name='shelves', base_class=BaseBookThrough)
 
 
 @python_2_unicode_compatible
@@ -23,7 +29,8 @@ def __str__(self):
 class DoItYourselfShelf(models.Model):
     books = SortedManyToManyField(Book,
         sort_value_field_name='diy_sort_number',
-        related_name='diy_shelves')
+        related_name='diy_shelves',
+        base_class=BaseBookThrough)
 
 
 class Store(models.Model):

sortedm2m_tests/test_field.py

@@ -9,7 +9,7 @@
 from sortedm2m.compat import get_field, get_rel
 
 from .models import (
-    Book, Shelf, DoItYourselfShelf, Store, MessyStore, SelfReference)
+    Book, Shelf, DoItYourselfShelf, Store, MessyStore, SelfReference, BaseBookThrough)
 
 
 str_ = six.text_type
@@ -191,6 +191,13 @@ def get_ids(queryset):
             return [obj.id for obj in queryset]
         self.assertEqual(get_ids(shelf.books.all()), get_ids(books))
 
+    def test_base_class_str(self):
+        shelf = self.model.objects.create()
+        shelf.books.add(self.books[0])
+        through_model = shelf.books.through
+        instance = through_model.objects.all()[0]
+        self.assertEqual(str(instance), "Relationship to {0}".format(instance.book.name))
+
 
 class TestStringReference1(TestSortedManyToManyField):
     '''