Merge branch 'master' of github.com:core-api/python-client

tomchristie · tomchristie · commit eec37eb85fac · 2016-01-12T09:27:55.000Z
diff --git a/coreapi/__init__.py b/coreapi/__init__.py
@@ -49,9 +49,9 @@ def get(url):
     return session.get(url)
 
 
-def action(document, keys, params=None):
+def action(document, keys, params=None, action=None, inplace=None):
     session = _default_session
-    return session.action(document, keys, params)
+    return session.action(document, keys, params, action=action, inplace=inplace)
 
 
 def load(bytestring, content_type=None):
diff --git a/coreapi/commandline.py b/coreapi/commandline.py
@@ -128,10 +128,20 @@ def validate_params(ctx, param, value):
     return value
 
 
+def validate_inplace(ctx, param, value):
+    if value is None:
+        return
+    if value.lower() not in ('true', 'false'):
+        raise click.BadParameter('"--inplace" needs to be one of "true" or "false"')
+    return value.lower() == 'true'
+
+
 @click.command(help='Interact with the current document, given a PATH to a link.')
 @click.argument('path', nargs=-1)
 @click.option('--param', '-p', multiple=True, callback=validate_params, help='Parameter in the form <field name>=<value>.')
-def action(path, param):
+@click.option('--action', '-a', help='Set the link action explicitly.', default=None)
+@click.option('--inplace', '-i', callback=validate_inplace, help='Set the inplace boolean explicitly.', default=None)
+def action(path, param, action, inplace):
     if not path:
         click.echo('Missing PATH to a link in the document.')
         sys.exit(1)
@@ -145,7 +155,7 @@ def action(path, param):
 
     session = get_session()
     keys = coerce_key_types(doc, path)
-    doc = session.action(doc, keys, params=params)
+    doc = session.action(doc, keys, params=params, action=action, inplace=inplace)
     click.echo(dump_to_console(doc))
     write_to_store(doc)
 
diff --git a/coreapi/document.py b/coreapi/document.py
@@ -173,7 +173,7 @@ def __init__(self, url=None, action=None, inplace=None, fields=None):
             raise TypeError("Argument 'action' must be a string.")
         if (inplace is not None) and (not isinstance(inplace, bool)):
             raise TypeError("Argument 'inplace' must be a boolean.")
-        if (fields is not None) and (not isinstance(fields, list)):
+        if (fields is not None) and (not isinstance(fields, (list, tuple))):
             raise TypeError("Argument 'fields' must be a list.")
         if (fields is not None) and any([
             not (isinstance(item, string_types) or isinstance(item, Field))
diff --git a/coreapi/sessions.py b/coreapi/sessions.py
@@ -38,7 +38,7 @@ def get_accept_header(self):
         """
         Return an 'Accept' header for the given codecs.
         """
-        return ', '.join([codec.media_type for codec in self.codecs])
+        return ', '.join([codec.media_type for codec in self.decoders])
 
     def negotiate_decoder(self, content_type=None):
         """
@@ -112,7 +112,7 @@ def get(self, url):
         link = Link(url, action='get')
         return transport.transition(link, session=self)
 
-    def action(self, document, keys, params=None):
+    def action(self, document, keys, params=None, action=None, inplace=None):
         if isinstance(keys, string_types):
             keys = [keys]
 
@@ -123,6 +123,12 @@ def action(self, document, keys, params=None):
         link, link_ancestors = validate_keys_to_link(document, keys)
         validate_parameters(link, params)
 
+        if action is not None or inplace is not None:
+            # Handle any explicit overrides.
+            action = link.action if (action is None) else action
+            inplace = link.inplace if (inplace is None) else inplace
+            link = Link(link.url, action, inplace, link.fields)
+
         # Perform the action, and return a new document.
         transport = self.determine_transport(link.url)
         return transport.transition(link, params, session=self, link_ancestors=link_ancestors)
diff --git a/coreapi/transport.py b/coreapi/transport.py
@@ -105,9 +105,10 @@ def handle_inplace_replacements(self, document, link, link_ancestors):
         * Make an inline replacement and then return the modified document tree.
         * Return the new document as-is.
         """
-        inplace = link.inplace
-        if inplace is None and link.action.lower() in ('put', 'patch', 'delete'):
-            inplace = True
+        if link.inplace is None:
+            inplace = link.action.lower() in ('put', 'patch', 'delete')
+        else:
+            inplace = link.inplace
 
         if inplace:
             root = link_ancestors[0].document
diff --git a/tests/test_integration.py b/tests/test_integration.py
@@ -72,6 +72,9 @@ def test_get_session():
         credentials={'example.org': 'abc'},
         headers={'user-agent': 'foo'}
     )
+
+    assert len(session.codecs) == 3
     assert len(session.transports) == 1
+
     assert session.transports[0].credentials == {'example.org': 'abc'}
     assert session.transports[0].headers == {'user-agent': 'foo'}
diff --git a/tests/test_transitions.py b/tests/test_transitions.py
@@ -63,3 +63,17 @@ def test_delete(doc):
     new = session.action(doc, ['nested', 'delete'])
     assert new == {}
     assert new.title == 'original'
+
+
+# Test overrides
+
+def test_override_action(doc):
+    new = session.action(doc, ['nested', 'follow'], action='put')
+    assert new == {'nested': {'new': 123, 'foo': None}}
+    assert new.title == 'original'
+
+
+def test_override_inplace(doc):
+    new = session.action(doc, ['nested', 'update'], params={'foo': 456}, inplace=False)
+    assert new == {'new': 123, 'foo': 456}
+    assert new.title == 'new'
