Default to JSON-flavoured OpenAPI

core-api · tomchristie · Jan 29, 2018 · Jan 30, 2018 · Jan 30, 2018 · Jan 30, 2018
commit b3fa5c2b89c0046c86e8f09af4e6bad4fadf958d
diff --git a/coreapi/__init__.py b/coreapi/__init__.py
@@ -1,12 +1,12 @@
 # coding: utf-8
 from coreapi import auth, codecs, exceptions, transports, typesys, utils
 from coreapi.client import Client
-from coreapi.document import Document, Link, Object, Error, Field
+from coreapi.document import Document, Link, Object, Error, Field, Array
 
 
 __version__ = '3.0.0'
 __all__ = [
-    'Document', 'Link', 'Object', 'Error', 'Field',
+    'Document', 'Link', 'Object', 'Error', 'Field', 'Array',
     'Client',
     'auth', 'codecs', 'exceptions', 'transports', 'typesys', 'utils',
 ]
diff --git a/coreapi/codecs/openapi.py b/coreapi/codecs/openapi.py
@@ -1,73 +1,76 @@
 from coreapi.codecs import BaseCodec, JSONSchemaCodec
-from coreapi.compat import dict_type, urlparse
+from coreapi.compat import VERBOSE_SEPARATORS, dict_type, urlparse
 from coreapi.document import Document, Link, Field
+from coreapi.exceptions import ParseError
 from coreapi.schemas import OpenAPI
-import yaml
+import json
 
 
 METHODS = [
     'get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'
 ]
 
 
-def represent_odict(dump, tag, mapping, flow_style=None):
-    """Like BaseRepresenter.represent_mapping, but does not issue the sort().
-    """
-    value = []
-    node = yaml.MappingNode(tag, value, flow_style=flow_style)
-    if dump.alias_key is not None:
-        dump.represented_objects[dump.alias_key] = node
-    best_style = True
-    if hasattr(mapping, 'items'):
-        mapping = mapping.items()
-    for item_key, item_value in mapping:
-        node_key = dump.represent_data(item_key)
-        node_value = dump.represent_data(item_value)
-        if not (isinstance(node_key, yaml.ScalarNode) and not node_key.style):
-            best_style = False
-        if not (isinstance(node_value, yaml.ScalarNode) and not node_value.style):
-            best_style = False
-        value.append((node_key, node_value))
-    if flow_style is None:
-        if dump.default_flow_style is not None:
-            node.flow_style = dump.default_flow_style
-        else:
-            node.flow_style = best_style
-    return node
-
-
-def represent_list(dump, tag, sequence, flow_style=None):
-    value = []
-    node = yaml.SequenceNode(tag, value, flow_style=flow_style)
-    if dump.alias_key is not None:
-        dump.represented_objects[dump.alias_key] = node
-    best_style = True
-    for item in sequence:
-        node_item = dump.represent_data(item)
-        if not (isinstance(node_item, yaml.ScalarNode) and not node_item.style):
-            best_style = False
-        value.append(node_item)
-    if flow_style is None:
-        if dump.default_flow_style is not None:
-            node.flow_style = dump.default_flow_style
-        else:
-            node.flow_style = best_style
-    return node
-
-
-class CustomSafeDumper(yaml.SafeDumper):
-    def increase_indent(self, flow=False, indentless=False):
-        return super(CustomSafeDumper, self).increase_indent(flow, False)
-
-
-CustomSafeDumper.add_multi_representer(
-    dict_type,
-    lambda dumper, value: represent_odict(dumper, u'tag:yaml.org,2002:map', value)
-)
-CustomSafeDumper.add_multi_representer(
-    list,
-    lambda dumper, value: represent_list(dumper, u'tag:yaml.org,2002:seq', value)
-)
+# def represent_odict(dump, tag, mapping, flow_style=None):
+#     """Like BaseRepresenter.represent_mapping, but does not issue the sort().
+#     """
+#     value = []
+#     node = yaml.MappingNode(tag, value, flow_style=flow_style)
+#     if dump.alias_key is not None:
+#         dump.represented_objects[dump.alias_key] = node
+#     best_style = True
+#     if hasattr(mapping, 'items'):
+#         mapping = mapping.items()
+#     for item_key, item_value in mapping:
+#         node_key = dump.represent_data(item_key)
+#         node_value = dump.represent_data(item_value)
+#         if not (isinstance(node_key, yaml.ScalarNode) and not node_key.style):
+#             best_style = False
+#         if not (isinstance(node_value, yaml.ScalarNode) and not node_value.style):
+#             best_style = False
+#         value.append((node_key, node_value))
+#     if flow_style is None:
+#         if dump.default_flow_style is not None:
+#             node.flow_style = dump.default_flow_style
+#         else:
+#             node.flow_style = best_style
+#     return node
+#
+#
+# def represent_list(dump, tag, sequence, flow_style=None):
+#     value = []
+#     node = yaml.SequenceNode(tag, value, flow_style=flow_style)
+#     if dump.alias_key is not None:
+#         dump.represented_objects[dump.alias_key] = node
+#     best_style = True
+#     for item in sequence:
+#         node_item = dump.represent_data(item)
+#         if not (isinstance(node_item, yaml.ScalarNode) and not node_item.style):
+#             best_style = False
+#         value.append(node_item)
+#     if flow_style is None:
+#         if dump.default_flow_style is not None:
+#             node.flow_style = dump.default_flow_style
+#         else:
+#             node.flow_style = best_style
+#     return node
+#
+#
+# class CustomSafeDumper(yaml.SafeDumper):
+#     def increase_indent(self, flow=False, indentless=False):
+#         return super(CustomSafeDumper, self).increase_indent(flow, False)
+#
+#
+# CustomSafeDumper.add_multi_representer(
+#     dict_type,
+#     lambda dumper, value: represent_odict(dumper, u'tag:yaml.org,2002:map', value)
+# )
+# CustomSafeDumper.add_multi_representer(
+#     list,
+#     lambda dumper, value: represent_list(dumper, u'tag:yaml.org,2002:seq', value)
+# )
+#
+# return yaml.dump(openapi, Dumper=CustomSafeDumper, default_flow_style=False)
 
 
 def _relative_url(base_url, url):
@@ -89,7 +92,11 @@ class OpenAPICodec(BaseCodec):
     format = 'openapi'
 
     def decode(self, bytestring, **options):
-        data = yaml.safe_load(bytestring)
+        try:
+            data = json.loads(bytestring.decode('utf-8'))
+        except ValueError as exc:
+            raise ParseError('Malformed JSON. %s' % exc)
+
         openapi = OpenAPI(data)
         title = openapi.lookup(['info', 'title'])
         description = openapi.lookup(['info', 'description'])
@@ -190,7 +197,14 @@ def encode(self, document, **options):
             }],
             'paths': paths
         })
-        return yaml.dump(openapi, Dumper=CustomSafeDumper, default_flow_style=False)
+
+        kwargs = {
+            'ensure_ascii': False,
+            'indent': 4,
+            'separators': VERBOSE_SEPARATORS
+        }
+
+        return json.dumps(openapi, **kwargs)
 
     def get_paths(self, document):
         paths = dict_type()

diff --git a/coreapi/compat.py b/coreapi/compat.py
@@ -41,6 +41,37 @@ def b64encode(input_string):
         return base64.b64encode(input_string.encode('ascii')).decode('ascii')
 
 
+try:
+    import coreschema
+except ImportError:
+    # Temporary shim, to support 'coreschema' until it's fully deprecated.
+    def coreschema_to_typesys(item):
+        return item
+else:
+    def coreschema_to_typesys(item):
+        from coreapi import typesys
+
+        # We were only ever using the type and title/description,
+        # so we don't both to include the full set of keyword arguments here.
+        if isinstance(item, coreschema.String):
+            return typesys.string(title=item.title, description=item.description)
+        elif isinstance(item, coreschema.Integer):
+            return typesys.integer(title=item.title, description=item.description)
+        elif isinstance(item, coreschema.Number):
+            return typesys.number(title=item.title, description=item.description)
+        elif isinstance(item, coreschema.Boolean):
+            return typesys.boolean(title=item.title, description=item.description)
+        elif isinstance(item, coreschema.Enum):
+            return typesys.enum(title=item.title, description=item.description, enum=item.enum)
+        elif isinstance(item, coreschema.Array):
+            return typesys.array(title=item.title, description=item.description)
+        elif isinstance(item, coreschema.Object):
+            return typesys.obj(title=item.title, description=item.description)
+        elif isinstance(item, coreschema.Anything):
+            return typesys.any(title=item.title, description=item.description)
+
+        return item
+
 def force_bytes(string):
     if isinstance(string, string_types):
         return string.encode('utf-8')

diff --git a/coreapi/document.py b/coreapi/document.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 from __future__ import unicode_literals
 from collections import OrderedDict
-from coreapi.compat import string_types
+from coreapi.compat import coreschema_to_typesys, string_types
 import itypes
 
 
@@ -235,7 +235,7 @@ def __init__(self, name, required=False, location='', schema=None, description=N
         self.name = name
         self.required = required
         self.location = location
-        self.schema = schema
+        self.schema = coreschema_to_typesys(schema)
         self.description = description
         self.example = example
 
@@ -296,3 +296,8 @@ def get_messages(self):
             elif isinstance(value, string_types):
                 messages += [value]
         return messages
+
+
+class Array(object):
+    def __init__(self):
+        assert False, 'Array is deprecated'
diff --git a/coreapi/typesys.py b/coreapi/typesys.py
@@ -1,4 +1,4 @@
-from coreapi.compat import dict_type
+from coreapi.compat import dict_type, string_types
 import re
 # from typing import Any, Dict, List, Optional, Tuple, Union, overload  # noqa
 
@@ -207,7 +207,7 @@ def __init__(self, value):
 
         # Ensure all property keys are strings.
         errors = {}
-        if any(not isinstance(key, str) for key in value.keys()):
+        if any(not isinstance(key, string_types) for key in value.keys()):
             self.error('invalid_key')
 
         # Properties

diff --git a/requirements.txt b/requirements.txt
@@ -2,7 +2,6 @@
 itypes
 requests
 uritemplate
-pyyaml
 
 # Testing requirements
 coverage