Skip to content

Use faster CSafeDumper #1371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Use faster CSafeDumper #1371

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions drf_spectacular/renderers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
from uuid import UUID

import yaml

try
from yaml import CSafeDumper as SafeDumper
except ImportError:
from yaml import SafeDumper

from django.utils.safestring import SafeString
from rest_framework.exceptions import ErrorDetail
from rest_framework.renderers import BaseRenderer, JSONRenderer
Expand All @@ -15,7 +21,7 @@ class OpenApiYamlRenderer(BaseRenderer):

def render(self, data, accepted_media_type=None, renderer_context=None):
# disable yaml advanced feature 'alias' for clean, portable, and readable output
class Dumper(yaml.SafeDumper):
class Dumper(SafeDumper):
def ignore_aliases(self, data):
return True

Expand Down Expand Up @@ -51,7 +57,9 @@ def uuid_representer(dumper, data):
Dumper.add_representer(UUID, uuid_representer)

def safestring_representer(dumper, data):
return dumper.represent_str(data)
# CSafeDumper needs actually a str instance, not a SafeString one.
# str(SafeString()) still returns SafeString.
return dumper.represent_str(super(SafeString, data).__str__())
Dumper.add_representer(SafeString, safestring_representer)

def ordereddict_representer(dumper, data):
Expand Down