Context Navigation

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

File 15889-get_serializer-specific-exception.diff, 3.3 KB (added by Mathieu Agopian, 13 years ago)
patch + tests + docs

diff --git a/django/core/serializers/__init__.py b/django/core/serializers/__init__.py
index 7afc94c..30bdfe0 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 SerializerNotFound
 # Built-in serializers
 BUILTIN_SERIALIZERS = {
-…
+               def unregister_serializer(format):
     del _serializers[format]
 def get_serializer(format):
+    if format not in get_serializer_formats():
+        raise SerializerNotFound()
     if not _serializers:
         _load_serializers()
     return _serializers[format].Serializer

diff --git a/django/core/serializers/base.py b/django/core/serializers/base.py
index cdcc7fa..64fc3d7 100644

                from django.db import models
 from django.utils.encoding import smart_str, smart_unicode
 from django.utils import datetime_safe
+class SerializerNotFound(Exception):
+    """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..80d2885 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.base.SerializerNotFound` exception.
 Subset of fields
 ~~~~~~~~~~~~~~~~

diff --git a/tests/regressiontests/serializers_regress/tests.py b/tests/regressiontests/serializers_regress/tests.py
index de57a6f..00d2a23 100644

                except ImportError:
 from django.conf import settings
 from django.core import serializers, management
+from django.core.serializers.base import SerializerNotFound
 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):
+        self.assertRaises(SerializerNotFound,
+                          serializers.get_serializer, 'unknown')
 def serializerTest(format, self):
-…
+               for format in serializers.get_serializer_formats():
     setattr(SerializerTests, 'test_' + format + '_serializer_fields', curry(fieldsTest, format))
     if format != 'python':
         setattr(SerializerTests, 'test_' + format + '_serializer_stream', curry(streamTest, format))
+# Regression test for #15889 -- serializers.get_serializer('unknown') used to
+# raise a KeyError, should now raise a SerializerNotFound.
+class GetSerializerTests(TestCase):
+    pass