Add some precisions to documentation about REST framework version requirements and multi-table inheritance. Fixes #235.

Catch attempts to use multi-table inheritance and raise an explicit error. Closes #230.

Author: spectras

README.rst

@@ -28,7 +28,7 @@ Features
 * **Reliable** - more than 300 test cases and counting. |coverage| |build|
 * **Compatible** with Django 1.4 to 1.8, running Python 2.7, 3.3 or 3.4.
 
-Django-hvad also features support for `Django REST framework`_, including
+Django-hvad also features support for `Django REST framework`_ 3.1 or newer, including
 translation-aware serializers.
 
 Example Uses

docs/public/models.rst

@@ -187,6 +187,12 @@ following restrictions:
 
 The ``__init__`` method and signals for the concrete model will still be called.
 
+Multi-table Inheritance
+=======================
+
+Unfortunately, multi-table inheritance is not supported, and unlikely to be.
+Please read :issue:`230` about the issues with multi-table inheritance.
+
 .. _custom-managers:
 
 *****************************

docs/public/restframework.rst

@@ -20,6 +20,9 @@ hvad providing the following extensions:
 - :ref:`TranslationsMixin` can be plugged into a `ModelSerializer` to add a
   dictionary of all available translations. Writing is supported as well.
 
+.. note:: Support for REST framework requires Django REST Framework version 3.1
+          or newer.
+
 --------
 
 .. _TranslatableModelSerializer:

hvad/models.py

@@ -78,6 +78,12 @@ class of the translations table
         base = scan_bases.pop()
         if not issubclass(base, TranslatableModel) or base is TranslatableModel:
             continue
+        if not base._meta.abstract:
+            raise TypeError(
+                'Multi-table inheritance of translatable models is not supported. '
+                'Concrete model %s is not a valid base model for %s.' % (
+                    base._meta.model_name if django.VERSION >= (1, 6) else base._meta.module_name,
+                    model._meta.model_name if django.VERSION >= (1, 6) else model._meta.module_name))
         try:
             # The base may have translations model, then just inherit that
             translation_bases.append(base._meta.translations_model)
@@ -92,7 +98,7 @@ class of the translations table
     meta['db_tablespace'] = model._meta.db_tablespace
     meta['managed'] = model._meta.managed
     if model._meta.order_with_respect_to in fields:
-        raise ImproperlyConfigured(
+        raise ValueError(
             'Using a translated fields in %s.Meta.order_with_respect_to is ambiguous '
             'and hvad does not support it.' %
             model._meta.model_name if django.VERSION >= (1, 6) else model._meta.module_name)

hvad/tests/basic.py

@@ -37,9 +37,16 @@ class InvalidModel2(object):
         self.assertRaises(ImproperlyConfigured, type,
                           'InvalidModel2', bases, attrs)
 
+    def test_multi_table_raises(self):
+        with self.assertRaises(TypeError):
+            class InvalidModel3(Normal):
+                translations = TranslatedFields(
+                    other_translated = models.CharField(max_length=250)
+                )
+
     def test_order_with_respect_to_raises(self):
-        with self.assertRaises(ImproperlyConfigured):
-            class InvalidModel3(TranslatableModel):
+        with self.assertRaises(ValueError):
+            class InvalidModel4(TranslatableModel):
                 translations = TranslatedFields(
                     translated_field = models.CharField(max_length=250)
                 )

setup.py

@@ -1,8 +1,8 @@
 from setuptools import setup, find_packages
 from hvad import __version__ as version
 
-with open('README.rst') as f:
-    long_description = f.read()
+with open('README.rst', 'rb') as f:
+    long_description = f.read().decode('utf-8')
 
 setup(
     name = 'django-hvad',