Context Navigation

Ticket #15889: 15889-get_serializer-specific-exception_3.diff

File 15889-get_serializer-specific-exception_3.diff, 3.5 KB (added by Mathieu Agopian, 14 years ago)
integrated Alex's new feedbacks

diff --git a/django/core/serializers/__init__.py b/django/core/serializers/__init__.py
index 7afc94c..b52165f 100644

                To add your own serializers, use the SERIALIZATION_MODULES setting::
 from django.conf import settings
 from django.utils import importlib
+from django.core.serializers.base import SerializerDoesNotExist
 # Built-in serializers
 BUILTIN_SERIALIZERS = {
-…
+               def unregister_serializer(format):
 def get_serializer(format):
     if not _serializers:
         _load_serializers()
+    if format not in _serializers:
+        raise SerializerDoesNotExist(format)
     return _serializers[format].Serializer
 def get_serializer_formats():

diff --git a/django/core/serializers/base.py b/django/core/serializers/base.py
index cdcc7fa..6b532af 100644

                from django.db import models
 from django.utils.encoding import smart_str, smart_unicode
 from django.utils import datetime_safe
+class SerializerDoesNotExist(KeyError):
+    """A requested serializer was not found."""
+    pass
 class SerializationError(Exception):
     """Something bad happened during serialization."""
     pass

diff --git a/docs/topics/serialization.txt b/docs/topics/serialization.txt
index c8acc85..f0f17b2 100644

                This is useful if you want to serialize data directly to a file-like object
     out = open("file.xml", "w")
     xml_serializer.serialize(SomeModel.objects.all(), stream=out)
+.. note::
+    Calling :func:`~django.core.serializers.get_serializer` with an unknown
+    :ref:`format <serialization-formats>` will raise a
+    :class:`~django.core.serializers.SerializerDoesNotExist` exception.
 Subset of fields
 ~~~~~~~~~~~~~~~~

diff --git a/tests/regressiontests/serializers_regress/tests.py b/tests/regressiontests/serializers_regress/tests.py
index de57a6f..6b302f0 100644

                forward, backwards and self references.
 """
+from __future__ import with_statement
 import datetime
 import decimal
 try:
-…
+               except ImportError:
 from django.conf import settings
 from django.core import serializers, management
+from django.core.serializers import SerializerDoesNotExist
 from django.db import transaction, DEFAULT_DB_ALIAS, connection
 from django.test import TestCase
 from django.utils.functional import curry
-…
+               if connection.features.allows_primary_key_0:
 # Dynamically create serializer tests to ensure that all
 # registered serializers are automatically tested.
 class SerializerTests(TestCase):
+    pass
+    def test_get_unknown_serializer(self):
+        """
+        #15889: get_serializer('nonsense') raises a SerializerDoesNotExist
+        """
+        self.assertRaises(SerializerDoesNotExist,
+                          serializers.get_serializer, 'nonsense')
+        # subclasses KeyError for backwards compatibility
+        self.assertRaises(KeyError, serializers.get_serializer, 'nonsense')
+        # SerializerDoesNotExist is instantiated with the inexistent format
+        with self.assertRaises(SerializerDoesNotExist) as cm:
+            serializers.get_serializer('nonsense')
+        self.assertEqual(cm.exception.args, ('nonsense',))
 def serializerTest(format, self):