Feature: Migrate to PyYAML for yaml generator. (#845)

* Feature: Migrate to PyYAML for yaml generator.

Closes #833

* Chore: Update swagger ui and redoc dependencies.

docs/conf.py

@@ -185,7 +185,7 @@
     ('py:class', 'Exception'),
     ('py:class', 'collections.OrderedDict'),
 
-    ('py:class', 'ruamel.yaml.dumper.SafeDumper'),
+    ('py:class', 'yaml.CSafeDumper'),
     ('py:class', 'rest_framework.serializers.Serializer'),
     ('py:class', 'rest_framework.renderers.BaseRenderer'),
     ('py:class', 'rest_framework.parsers.BaseParser'),

package.json

@@ -10,6 +10,6 @@
   },
   "private": true,
   "devDependencies": {
-    "cspell": "^6.2.3"
+    "cspell": "^6.30.0"
   }
 }

requirements/base.txt

@@ -2,7 +2,7 @@ coreapi>=2.3.3
 coreschema>=0.0.4
 djangorestframework>=3.10.3
 django>=2.2.16
-ruamel.yaml>=0.16.13
+pyyaml>=5.1
 inflection>=0.3.1
 packaging>=21.0
 pytz>=2021.1

src/drf_yasg/codecs.py

@@ -4,7 +4,7 @@
 from collections import OrderedDict
 
 from django.utils.encoding import force_bytes
-from ruamel import yaml
+import yaml
 
 from . import openapi
 from .errors import SwaggerValidationError
@@ -126,22 +126,17 @@ def _dump_dict(self, spec):
 
 
 YAML_MAP_TAG = u'tag:yaml.org,2002:map'
+YamlDumper = getattr(yaml, 'CSafeDumper', yaml.SafeDumper)
+YamlLoader = getattr(yaml, 'CSafeLoader', yaml.SafeLoader)
 
 
-class SaneYamlDumper(yaml.SafeDumper):
+class SaneYamlDumper(YamlDumper):
     """YamlDumper class usable for dumping ``OrderedDict`` and list instances in a standard way."""
 
     def ignore_aliases(self, data):
         """Disable YAML references."""
         return True
 
-    def increase_indent(self, flow=False, indentless=False, **kwargs):
-        """https://stackoverflow.com/a/39681672
-
-        Indent list elements.
-        """
-        return super(SaneYamlDumper, self).increase_indent(flow=flow, indentless=False, **kwargs)
-
     def represent_odict(self, mapping, flow_style=None):  # pragma: no cover
         """https://gist.github.com/miracle2k/3184458
 
@@ -204,11 +199,12 @@ def yaml_sane_dump(data, binary):
         Dumper=SaneYamlDumper,
         default_flow_style=False,
         encoding='utf-8' if binary else None,
-        allow_unicode=binary
+        allow_unicode=binary,
+        sort_keys=False,
     )
 
 
-class SaneYamlLoader(yaml.SafeLoader):
+class SaneYamlLoader(YamlLoader):
     def construct_odict(self, node, deep=False):
         self.flatten_mapping(node)
         return OrderedDict(self.construct_pairs(node))
@@ -223,7 +219,7 @@ def yaml_sane_load(stream):
     :param stream: YAML stream (can be a string or a file-like object)
     :rtype: OrderedDict
     """
-    return yaml.load(stream, Loader=SaneYamlLoader)
+    return yaml.load(stream, Loader=YamlLoader)
 
 
 class OpenAPICodecYaml(_OpenAPICodec):

src/drf_yasg/static/drf-yasg/swagger-ui-dist/index.css

@@ -0,0 +1,16 @@
+html {
+    box-sizing: border-box;
+    overflow: -moz-scrollbars-vertical;
+    overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    margin: 0;
+    background: #fafafa;
+}

src/drf_yasg/static/drf-yasg/swagger-ui-dist/oauth2-redirect.html

@@ -13,7 +13,7 @@
         var isValid, qp, arr;
 
         if (/code|token|error/.test(window.location.hash)) {
-            qp = window.location.hash.substring(1);
+            qp = window.location.hash.substring(1).replace('?', '&');
         } else {
             qp = location.search.substring(1);
         }
@@ -38,7 +38,7 @@
                     authId: oauth2.auth.name,
                     source: "auth",
                     level: "warning",
-                    message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server"
+                    message: "Authorization may be unsafe, passed state was changed in server. The passed state wasn't returned from auth server."
                 });
             }
 
@@ -58,7 +58,7 @@
                     authId: oauth2.auth.name,
                     source: "auth",
                     level: "error",
-                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server"
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server."
                 });
             }
         } else {
@@ -67,9 +67,13 @@
         window.close();
     }
 
-    window.addEventListener('DOMContentLoaded', function () {
-      run();
-    });
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
 </script>
 </body>
 </html>

src/drf_yasg/static/drf-yasg/swagger-ui-dist/swagger-initializer.js

@@ -0,0 +1,20 @@
+window.onload = function() {
+  //<editor-fold desc="Changeable Configuration Block">
+
+  // the following lines will be replaced by docker/configurator, when it runs in a docker-container
+  window.ui = SwaggerUIBundle({
+    url: "https://petstore.swagger.io/v2/swagger.json",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  });
+
+  //</editor-fold>
+};