Version 3

coreapi/__init__.py

@@ -1,12 +1,12 @@
 # coding: utf-8
-from coreapi import auth, codecs, exceptions, transports, utils
+from coreapi import auth, codecs, exceptions, transports, typesys, utils
 from coreapi.client import Client
-from coreapi.document import Array, Document, Link, Object, Error, Field
+from coreapi.document import Document, Link, Object, Error, Field, Array
 
 
-__version__ = '2.3.3'
+__version__ = '3.0.0'
 __all__ = [
-    'Array', 'Document', 'Link', 'Object', 'Error', 'Field',
+    'Document', 'Link', 'Object', 'Error', 'Field', 'Array',
     'Client',
-    'auth', 'codecs', 'exceptions', 'transports', 'utils',
+    'auth', 'codecs', 'exceptions', 'transports', 'typesys', 'utils',
 ]

coreapi/client.py

@@ -1,19 +1,14 @@
 from coreapi import codecs, exceptions, transports
 from coreapi.compat import string_types
-from coreapi.document import Document, Link
+from coreapi.document import Link
 from coreapi.utils import determine_transport, get_installed_codecs
-import collections
-import itypes
-
-
-LinkAncestor = collections.namedtuple('LinkAncestor', ['document', 'keys'])
 
 
 def _lookup_link(document, keys):
     """
     Validates that keys looking up a link are correct.
 
-    Returns a two-tuple of (link, link_ancestors).
+    Returns the Link.
     """
     if not isinstance(keys, (list, tuple)):
         msg = "'keys' must be a list of strings or ints."
@@ -28,17 +23,13 @@ def _lookup_link(document, keys):
     # 'node' is the link we're calling the action for.
     # 'document_keys' is the list of keys to the link's parent document.
     node = document
-    link_ancestors = [LinkAncestor(document=document, keys=[])]
     for idx, key in enumerate(keys):
         try:
             node = node[key]
         except (KeyError, IndexError, TypeError):
             index_string = ''.join('[%s]' % repr(key).strip('u') for key in keys)
             msg = 'Index %s did not reference a link. Key %s was not found.'
             raise exceptions.LinkLookupError(msg % (index_string, repr(key).strip('u')))
-        if isinstance(node, Document):
-            ancestor = LinkAncestor(document=node, keys=keys[:idx + 1])
-            link_ancestors.append(ancestor)
 
     # Ensure that we've correctly indexed into a link.
     if not isinstance(node, Link):
@@ -48,7 +39,7 @@ def _lookup_link(document, keys):
             msg % (index_string, type(node).__name__)
         )
 
-    return (node, link_ancestors)
+    return node
 
 
 def _validate_parameters(link, parameters):
@@ -95,7 +86,7 @@ def get_default_transports(auth=None, session=None):
     ]
 
 
-class Client(itypes.Object):
+class Client(object):
     def __init__(self, decoders=None, transports=None, auth=None, session=None):
         assert transports is None or auth is None, (
             "Cannot specify both 'auth' and 'transports'. "
@@ -106,8 +97,8 @@ def __init__(self, decoders=None, transports=None, auth=None, session=None):
             decoders = get_default_decoders()
         if transports is None:
             transports = get_default_transports(auth=auth, session=session)
-        self._decoders = itypes.List(decoders)
-        self._transports = itypes.List(transports)
+        self._decoders = list(decoders)
+        self._transports = list(transports)
 
     @property
     def decoders(self):
@@ -118,7 +109,7 @@ def transports(self):
         return self._transports
 
     def get(self, url, format=None, force_codec=False):
-        link = Link(url, action='get')
+        link = Link(url, method='get')
 
         decoders = self.decoders
         if format:
@@ -135,44 +126,27 @@ def get(self, url, format=None, force_codec=False):
         transport = determine_transport(self.transports, link.url)
         return transport.transition(link, decoders, force_codec=force_codec)
 
-    def reload(self, document, format=None, force_codec=False):
-        # Fallback for v1.x. To be removed in favour of explict `get` style.
-        return self.get(document.url, format=format, force_codec=force_codec)
-
-    def action(self, document, keys, params=None, validate=True, overrides=None,
-               action=None, encoding=None, transform=None):
-        if (action is not None) or (encoding is not None) or (transform is not None):
-            # Fallback for v1.x overrides.
-            # Will be removed at some point, most likely in a 2.1 release.
-            if overrides is None:
-                overrides = {}
-            if action is not None:
-                overrides['action'] = action
-            if encoding is not None:
-                overrides['encoding'] = encoding
-            if transform is not None:
-                overrides['transform'] = transform
-
+    def action(self, document, keys, params=None, validate=True, overrides=None):
         if isinstance(keys, string_types):
             keys = [keys]
 
         if params is None:
             params = {}
 
         # Validate the keys and link parameters.
-        link, link_ancestors = _lookup_link(document, keys)
+        link = _lookup_link(document, keys)
         if validate:
             _validate_parameters(link, params)
 
         if overrides:
             # Handle any explicit overrides.
             url = overrides.get('url', link.url)
-            action = overrides.get('action', link.action)
+            method = overrides.get('method', link.method)
+            method = overrides.get('action', method)  # TODO: Deprecate
             encoding = overrides.get('encoding', link.encoding)
-            transform = overrides.get('transform', link.transform)
             fields = overrides.get('fields', link.fields)
-            link = Link(url, action=action, encoding=encoding, transform=transform, fields=fields)
+            link = Link(url, method=method, encoding=encoding, fields=fields)
 
         # Perform the action, and return a new document.
         transport = determine_transport(self.transports, link.url)
-        return transport.transition(link, self.decoders, params=params, link_ancestors=link_ancestors)
+        return transport.transition(link, self.decoders, params=params)

coreapi/codecs/__init__.py

@@ -4,11 +4,14 @@
 from coreapi.codecs.display import DisplayCodec
 from coreapi.codecs.download import DownloadCodec
 from coreapi.codecs.jsondata import JSONCodec
+from coreapi.codecs.jsonschema import JSONSchemaCodec
+from coreapi.codecs.openapi import OpenAPICodec
 from coreapi.codecs.python import PythonCodec
 from coreapi.codecs.text import TextCodec
 
 
 __all__ = [
-    'BaseCodec', 'CoreJSONCodec', 'DisplayCodec',
-    'JSONCodec', 'PythonCodec', 'TextCodec', 'DownloadCodec'
+    'BaseCodec', 'CoreJSONCodec', 'DisplayCodec', 'JSONCodec',
+    'JSONSchemaCodec', 'OpenAPICodec', 'PythonCodec', 'TextCodec',
+    'DownloadCodec'
 ]

coreapi/codecs/base.py

@@ -1,7 +1,4 @@
-import itypes
-
-
-class BaseCodec(itypes.Object):
+class BaseCodec(object):
     media_type = None
 
     # We don't implement stubs, to ensure that we can check which of these
@@ -14,28 +11,6 @@ class BaseCodec(itypes.Object):
     # def encode(self, document, **options):
     #    pass
 
-    # The following will be removed at some point, most likely in a 2.1 release:
-    def dump(self, *args, **kwargs):
-        # Fallback for v1.x interface
-        return self.encode(*args, **kwargs)
-
-    def load(self, *args, **kwargs):
-        # Fallback for v1.x interface
-        return self.decode(*args, **kwargs)
-
-    @property
-    def supports(self):
-        # Fallback for v1.x interface.
-        if '+' not in self.media_type:
-            return ['data']
-
-        ret = []
-        if hasattr(self, 'encode'):
-            ret.append('encoding')
-        if hasattr(self, 'decode'):
-            ret.append('decoding')
-        return ret
-
     def get_media_types(self):
         # Fallback, while transitioning from `application/vnd.coreapi+json`
         # to simply `application/coreapi+json`.

coreapi/codecs/corejson.py

@@ -1,27 +1,25 @@
 from __future__ import unicode_literals
 from collections import OrderedDict
+from coreapi import typesys
 from coreapi.codecs.base import BaseCodec
 from coreapi.compat import force_bytes, string_types, urlparse
 from coreapi.compat import COMPACT_SEPARATORS, VERBOSE_SEPARATORS
-from coreapi.document import Document, Link, Array, Object, Error, Field
+from coreapi.document import Document, Link, Object, Error, Field
 from coreapi.exceptions import ParseError
-import coreschema
 import json
 
 
 # Schema encoding and decoding.
 # Just a naive first-pass at this point.
 
 SCHEMA_CLASS_TO_TYPE_ID = {
-    coreschema.Object: 'object',
-    coreschema.Array: 'array',
-    coreschema.Number: 'number',
-    coreschema.Integer: 'integer',
-    coreschema.String: 'string',
-    coreschema.Boolean: 'boolean',
-    coreschema.Null: 'null',
-    coreschema.Enum: 'enum',
-    coreschema.Anything: 'anything'
+    typesys.Object: 'object',
+    typesys.Array: 'array',
+    typesys.Number: 'number',
+    typesys.Integer: 'integer',
+    typesys.String: 'string',
+    typesys.Boolean: 'boolean',
+    typesys.Any: 'anything'
 }
 
 TYPE_ID_TO_SCHEMA_CLASS = {
@@ -32,16 +30,18 @@
 
 
 def encode_schema_to_corejson(schema):
-    if hasattr(schema, 'typename'):
-        type_id = schema.typename
+    for cls, type_id in SCHEMA_CLASS_TO_TYPE_ID.items():
+        if isinstance(schema, cls):
+            break
     else:
-        type_id = SCHEMA_CLASS_TO_TYPE_ID.get(schema.__class__, 'anything')
+        type_id = 'anything'
+
     retval = {
         '_type': type_id,
-        'title': schema.title,
-        'description': schema.description
+        'title': schema.title or '',
+        'description': schema.description or ''
     }
-    if hasattr(schema, 'enum'):
+    if getattr(schema, 'enum', None) is not None:
         retval['enum'] = schema.enum
     return retval
 
@@ -51,12 +51,15 @@ def decode_schema_from_corejson(data):
     title = _get_string(data, 'title')
     description = _get_string(data, 'description')
 
-    kwargs = {}
+    kwargs = {'title': title, 'description': description}
     if type_id == 'enum':
+        type_id = 'string'
         kwargs['enum'] = _get_list(data, 'enum')
+    elif 'enum' in data:
+        kwargs['enum'] = data['enum']
 
-    schema_cls = TYPE_ID_TO_SCHEMA_CLASS.get(type_id, coreschema.Anything)
-    return schema_cls(title=title, description=description, **kwargs)
+    schema_cls = TYPE_ID_TO_SCHEMA_CLASS.get(type_id, typesys.Any)
+    return schema_cls(**kwargs)
 
 
 # Robust dictionary lookups, that always return an item of the correct
@@ -196,8 +199,6 @@ def _document_to_primitive(node, base_url=None):
             ret['action'] = node.action
         if node.encoding:
             ret['encoding'] = node.encoding
-        if node.transform:
-            ret['transform'] = node.transform
         if node.title:
             ret['title'] = node.title
         if node.description:
@@ -224,9 +225,6 @@ def _document_to_primitive(node, base_url=None):
             for key, value in node.items()
         ])
 
-    elif isinstance(node, Array):
-        return [_document_to_primitive(value) for value in node]
-
     return node
 
 
@@ -264,7 +262,6 @@ def _primitive_to_document(data, base_url=None):
         url = urlparse.urljoin(base_url, url)
         action = _get_string(data, 'action')
         encoding = _get_string(data, 'encoding')
-        transform = _get_string(data, 'transform')
         title = _get_string(data, 'title')
         description = _get_string(data, 'description')
         fields = _get_list(data, 'fields')
@@ -278,7 +275,7 @@ def _primitive_to_document(data, base_url=None):
             for item in fields if isinstance(item, dict)
         ]
         return Link(
-            url=url, action=action, encoding=encoding, transform=transform,
+            url=url, method=action, encoding=encoding,
             title=title, description=description, fields=fields
         )
 
@@ -287,11 +284,6 @@ def _primitive_to_document(data, base_url=None):
         content = _get_content(data, base_url=base_url)
         return Object(content)
 
-    elif isinstance(data, list):
-        # Array
-        content = [_primitive_to_document(item, base_url) for item in data]
-        return Array(content)
-
     # String, Integer, Number, Boolean, null.
     return data
 

coreapi/codecs/display.py

@@ -4,7 +4,7 @@
 from __future__ import unicode_literals
 from coreapi.codecs.base import BaseCodec
 from coreapi.compat import console_style, string_types
-from coreapi.document import Document, Link, Array, Object, Error
+from coreapi.document import Document, Link, Object, Error
 import json
 
 
@@ -76,17 +76,6 @@ def _to_plaintext(node, indent=0, base_url=None, colorize=False, extra_offset=No
 
         return head if (not body) else head + '\n' + body
 
-    elif isinstance(node, Array):
-        head_indent = '    ' * indent
-        body_indent = '    ' * (indent + 1)
-
-        body = ',\n'.join([
-            body_indent + _to_plaintext(value, indent + 1, base_url=base_url, colorize=colorize)
-            for value in node
-        ])
-
-        return '[]' if (not body) else '[\n' + body + '\n' + head_indent + ']'
-
     elif isinstance(node, Link):
         return (
             colorize_keys('link(') +