OpenAPI schemas: Ensure lazy field descriptions are converted to str(). (encode#6832)

chrisv2 · carltongibson · commit ca727872c8a6 · 2019-07-25T15:30:20.000+02:00
diff --git a/rest_framework/schemas/openapi.py b/rest_framework/schemas/openapi.py
@@ -377,7 +377,7 @@ def _map_serializer(self, serializer):
             if field.default and field.default != empty:  # why don't they use None?!
                 schema['default'] = field.default
             if field.help_text:
-                schema['description'] = field.help_text
+                schema['description'] = str(field.help_text)
             self._map_field_validators(field.validators, schema)
 
             properties[field.field_name] = schema
diff --git a/tests/schemas/test_openapi.py b/tests/schemas/test_openapi.py
@@ -1,6 +1,7 @@
 import pytest
 from django.conf.urls import url
 from django.test import RequestFactory, TestCase, override_settings
+from django.utils.translation import gettext_lazy as _
 
 from rest_framework import filters, generics, pagination, routers, serializers
 from rest_framework.compat import uritemplate
@@ -52,6 +53,15 @@ def test_list_field_mapping(self):
             with self.subTest(field=field):
                 assert inspector._map_field(field) == mapping
 
+    def test_lazy_string_field(self):
+        class Serializer(serializers.Serializer):
+            text = serializers.CharField(help_text=_('lazy string'))
+
+        inspector = AutoSchema()
+
+        data = inspector._map_serializer(Serializer())
+        assert isinstance(data['properties']['text']['description'], str), "description must be str"
+
 
 @pytest.mark.skipif(uritemplate is None, reason='uritemplate not installed.')
 class TestOperationIntrospection(TestCase):
