Removing data from documents. Drop 'Array'.

core-api · tomchristie · Jan 29, 2018 · Jan 30, 2018 · Jan 30, 2018 · Jan 30, 2018
commit 15dcdc9cbde6015963977814da205c22c89d55a9
diff --git a/coreapi/__init__.py b/coreapi/__init__.py
@@ -1,12 +1,12 @@
 # coding: utf-8
 from coreapi import auth, codecs, exceptions, transports, 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
 
 
 __version__ = '2.3.3'
 __all__ = [
-    'Array', 'Document', 'Link', 'Object', 'Error', 'Field',
+    'Document', 'Link', 'Object', 'Error', 'Field',
     'Client',
     'auth', 'codecs', 'exceptions', 'transports', 'utils',
 ]
diff --git a/coreapi/codecs/corejson.py b/coreapi/codecs/corejson.py
@@ -3,7 +3,7 @@
 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
@@ -222,9 +222,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
 
 
@@ -284,11 +281,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
 

diff --git a/coreapi/codecs/display.py b/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(') +

diff --git a/coreapi/codecs/python.py b/coreapi/codecs/python.py
@@ -3,7 +3,7 @@
 # It may move into a utility function in the future.
 from __future__ import unicode_literals
 from coreapi.codecs.base import BaseCodec
-from coreapi.document import Document, Link, Array, Object, Error, Field
+from coreapi.document import Document, Link, Object, Error, Field
 
 
 def _to_repr(node):
@@ -31,11 +31,6 @@ def _to_repr(node):
             for key, value in node.items()
         ])
 
-    elif isinstance(node, Array):
-        return '[%s]' % ', '.join([
-            _to_repr(value) for value in node
-        ])
-
     elif isinstance(node, Link):
         args = "url=%s" % repr(node.url)
         if node.action:
@@ -71,10 +66,7 @@ class PythonCodec(BaseCodec):
     media_type = 'text/python'
 
     def encode(self, document, **options):
-        # Object and Array only have the class name wrapper if they
-        # are the outermost element.
+        # Object only has the class name wrapper if it is the outermost element.
         if isinstance(document, Object):
             return 'Object(%s)' % _to_repr(document)
-        elif isinstance(document, Array):
-            return 'Array(%s)' % _to_repr(document)
         return _to_repr(document)
diff --git a/coreapi/document.py b/coreapi/document.py
@@ -8,8 +8,6 @@
 def _to_immutable(value):
     if isinstance(value, dict):
         return Object(value)
-    elif isinstance(value, list):
-        return Array(value)
     return value
 
 
@@ -169,20 +167,6 @@ def links(self):
         ])
 
 
-class Array(itypes.List):
-    """
-    An immutable list type container.
-    """
-    def __init__(self, *args):
-        self._data = [_to_immutable(value) for value in list(*args)]
-
-    def __repr__(self):
-        return _repr(self)
-
-    def __str__(self):
-        return _str(self)
-
-
 class Link(itypes.Object):
     """
     Links represent the actions that a client may perform.
@@ -295,8 +279,10 @@ def title(self):
     def get_messages(self):
         messages = []
         for value in self.values():
-            if isinstance(value, Array):
+            if isinstance(value, list):
                 messages += [
                     item for item in value if isinstance(item, string_types)
                 ]
+            elif isinstance(value, string_types):
+                messages += [value]
         return messages
diff --git a/coreapi/transports/http.py b/coreapi/transports/http.py
@@ -3,7 +3,7 @@
 from collections import OrderedDict
 from coreapi import exceptions, utils
 from coreapi.compat import cookiejar, urlparse
-from coreapi.document import Document, Object, Link, Array, Error
+from coreapi.document import Document, Object, Error
 from coreapi.transports.base import BaseTransport
 from coreapi.utils import guess_filename, is_file, File
 import collections
@@ -242,13 +242,6 @@ def _coerce_to_error_content(node):
             (key, _coerce_to_error_content(value))
             for key, value in node.data.items()
         ])
-    elif isinstance(node, Array):
-        # Strip Links from Arrays.
-        return [
-            _coerce_to_error_content(item)
-            for item in node
-            if not isinstance(item, Link)
-        ]
     return node
 
 

diff --git a/tests/test_document.py b/tests/test_document.py
@@ -1,6 +1,6 @@
 # coding: utf-8
 from coreapi import Client
-from coreapi import Array, Document, Object, Link, Error, Field
+from coreapi import Document, Object, Link, Error, Field
 from coreapi.exceptions import LinkLookupError
 import pytest
 
@@ -13,7 +13,6 @@ def doc():
         content={
             'integer': 123,
             'dict': {'key': 'value'},
-            'list': [1, 2, 3],
             'link': Link(
                 url='/',
                 action='post',
@@ -28,11 +27,6 @@ def obj():
     return Object({'key': 'value', 'nested': {'abc': 123}})
 
 
-@pytest.fixture
-def array():
-    return Array([{'a': 1}, {'b': 2}, {'c': 3}])
-
-
 @pytest.fixture
 def link():
     return Link(
@@ -95,23 +89,6 @@ def test_object_does_not_support_key_deletion(obj):
         del obj['key']
 
 
-# Arrays are immutable.
-
-def test_array_does_not_support_item_assignment(array):
-    with pytest.raises(TypeError):
-        array[1] = 456
-
-
-def test_array_does_not_support_property_assignment(array):
-    with pytest.raises(TypeError):
-        array.integer = 456
-
-
-def test_array_does_not_support_item_deletion(array):
-    with pytest.raises(TypeError):
-        del array[1]
-
-
 # Links are immutable.
 
 def test_link_does_not_support_property_assignment():
@@ -134,10 +111,6 @@ def test_document_dictionaries_coerced_to_objects(doc):
     assert isinstance(doc['dict'], Object)
 
 
-def test_document_lists_coerced_to_arrays(doc):
-    assert isinstance(doc['list'], Array)
-
-
 # The `delete` and `set` methods return new instances.
 
 def test_document_delete(doc):
@@ -172,56 +145,13 @@ def test_object_set(obj):
         assert obj[key] is new[key]
 
 
-def test_array_delete(array):
-    new = array.delete(1)
-    assert array is not new
-    assert len(new) == len(array) - 1
-    assert new[0] is array[0]
-    assert new[1] is array[2]
-
-
-def test_array_set(array):
-    new = array.set(1, 456)
-    assert array is not new
-    assert len(new) == len(array)
-    assert new[0] is array[0]
-    assert new[1] == 456
-    assert new[2] is array[2]
-
-
-# The `delete_in` and `set_in` functions return new instances.
-
-def test_delete_in():
-    nested = Object({'key': [{'abc': 123}, {'def': 456}], 'other': 0})
-
-    assert nested.delete_in(['key', 0]) == {'key': [{'def': 456}], 'other': 0}
-    assert nested.delete_in(['key']) == {'other': 0}
-    assert nested.delete_in([]) is None
-
-
-def test_set_in():
-    nested = Object({'key': [{'abc': 123}, {'def': 456}], 'other': 0})
-    insert = Object({'xyz': 789})
-
-    assert (
-        nested.set_in(['key', 0], insert) ==
-        {'key': [{'xyz': 789}, {'def': 456}], 'other': 0}
-    )
-    assert (
-        nested.set_in(['key'], insert) ==
-        {'key': {'xyz': 789}, 'other': 0}
-    )
-    assert nested.set_in([], insert) == {'xyz': 789}
-
-
 # Container types have a uniquely identifying representation.
 
 def test_document_repr(doc):
     assert repr(doc) == (
         "Document(url='http://example.org', title='Example', content={"
         "'dict': {'key': 'value'}, "
         "'integer': 123, "
-        "'list': [1, 2, 3], "
         "'nested': {'child': Link(url='/123')}, "
         "'link': Link(url='/', action='post', "
         "fields=['optional', Field('required', required=True, location='path')])"
@@ -235,11 +165,6 @@ def test_object_repr(obj):
     assert eval(repr(obj)) == obj
 
 
-def test_array_repr(array):
-    assert repr(array) == "Array([{'a': 1}, {'b': 2}, {'c': 3}])"
-    assert eval(repr(array)) == array
-
-
 def test_link_repr(link):
     assert repr(link) == "Link(url='/', action='post', fields=[Field('required', required=True), 'optional'])"
     assert eval(repr(link)) == link
@@ -259,11 +184,6 @@ def test_document_str(doc):
                 key: "value"
             }
             integer: 123
-            list: [
-                1,
-                2,
-                3
-            ]
             nested: {
                 child()
             }
@@ -291,32 +211,14 @@ def test_object_str(obj):
     """)
 
 
-def test_array_str(array):
-    assert str(array) == _dedent("""
-        [
-            {
-                a: 1
-            },
-            {
-                b: 2
-            },
-            {
-                c: 3
-            }
-        ]
-    """)
-
-
 def test_link_str(link):
     assert str(link) == "link(required, [optional])"
 
 
 def test_error_str(error):
     assert str(error) == _dedent("""
         <Error>
-            messages: [
-                "failed"
-            ]
+            messages: ["failed"]
     """)
 
 
@@ -340,7 +242,6 @@ def test_document_equality(doc):
     assert doc == {
         'integer': 123,
         'dict': {'key': 'value'},
-        'list': [1, 2, 3],
         'link': Link(
             url='/',
             action='post',
@@ -354,14 +255,10 @@ def test_object_equality(obj):
     assert obj == {'key': 'value', 'nested': {'abc': 123}}
 
 
-def test_array_equality(array):
-    assert array == [{'a': 1}, {'b': 2}, {'c': 3}]
-
-
 # Container types support len.
 
 def test_document_len(doc):
-    assert len(doc) == 5
+    assert len(doc) == 4
 
 
 def test_object_len(obj):