Merge lp:~jameinel/maas/maasclient-multipart into lp:maas/trunk

[John A Meinel]

Support MAASClient.post(..., variable=['list', 'of', 'bytes']) which allows us to send in a list of content.

The multipart code already supported passing the same variable multiple times, but you can't expose that from a **kwargs style function.

For the Tag updates, we need to pass a list to the API. It turns out that MAASClient didn't actually support it via the .get()/.post() methods.

The fix is pretty straightforward, and the tests assert that Django properly understands the results.

The other way to do this is to have the get/post methods themselves translate a "x=[list]" argument into a series of [(x, item1), (x, item2), (x, item3)...], which is already supported by the multipart code. But this made the most sense to me.

[John A Meinel (jameinel)]

Note that this doesn't fix the 'MAASClient.get()' case. Where urlencode happily takes a list, str(lst) it, and then encodes the string formatted version.

But at least we can send a list easily via POST.

[Jeroen T. Vermeulen (jtv)]

Checking for a list seems dangerously fragile: what of tuples, result sets, generators..? Is there no better way to distinguish this special case?

[John A Meinel (jameinel)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 10/5/2012 12:25 PM, Jeroen T. Vermeulen wrote:
> Checking for a list seems dangerously fragile: what of tuples,
> result sets, generators..? Is there no better way to distinguish
> this special case?
>

Well, list is all I needed. :)

You can do:

try:
 iter(foo)
except TypeError

but then you still need to check for string and unicode first, because
both of them are also iterable,and you don't want to send stuff one
character at a time.

isinstance(obj, (list, tuple, set, ...)) is also a possibility, though
I would probably stick with "if someone needs X, they can add support
for X".

John
=:->

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.12 (Cygwin)
Comment: Using GnuPG with Mozilla - http://www.enigmail.net/

iEYEARECAAYFAlBunIsACgkQJdeBCYSNAAOVcACeLxLab12/sqr8yqsMt7I1Nwra
jeUAoKwoHGu7sB5zZjpt9B6NIOTs5JOY
=tS+u
-----END PGP SIGNATURE-----

[Gavin Panella (allenap)]

Remember your abc :)

  from collections import Mapping

  if isinstance(thing, Mapping):
      # Treat it like a dict.
      ...
  else:
      # Assume it's an iterable of (name, value) tuples.
      ...

Also, maascli.utils.urlencode is a less stupid version of
urllib.urlencode. It probably ought to move to apiclient.utils. Or the
standard library ;)

[lp:~jameinel/maas/maasclient-multipart]

1168. By John A Meinel on 2012-10-05

Switch to make_payloads, since that is a bit cleaner about instance checks.

[Gavin Panella (allenap)]

review: Approve

=== modified file 'src/apiclient/multipart.py'
--- src/apiclient/multipart.py	2012-09-24 11:13:39 +0000
+++ src/apiclient/multipart.py	2012-10-05 11:15:35 +0000
@@ -14,7 +14,10 @@
     'encode_multipart_data',
     ]
 
-from collections import Mapping
+from collections import (
+    Iterable,
+    Mapping,
+    )
 from email.generator import Generator
 from email.mime.application import MIMEApplication
 from email.mime.multipart import MIMEMultipart
@@ -59,16 +62,20 @@
     return payload
 
 
-def make_payload(name, content):
+def make_payloads(name, content):
     if isinstance(content, bytes):
-        return make_bytes_payload(name, content)
+        yield make_bytes_payload(name, content)
     elif isinstance(content, unicode):
-        return make_string_payload(name, content)
+        yield make_string_payload(name, content)
     elif isinstance(content, IOBase):
-        return make_file_payload(name, content)
+        yield make_file_payload(name, content)
     elif callable(content):
         with content() as content:
-            return make_payload(name, content)
+            yield make_payload(name, content)
+    elif isinstance(content, Iterable):
+        for part in content:
+            for payload in make_payloads(name, part):
+                yield payload
     else:
         raise AssertionError(
             "%r is unrecognised: %r" % (name, content))
@@ -77,8 +84,8 @@
 def build_multipart_message(data):
     message = MIMEMultipart("form-data")
     for name, content in data:
-        payload = make_payload(name, content)
-        message.attach(payload)
+        for payload in make_payloads(name, content):
+            message.attach(payload)
     return message
 
 

=== modified file 'src/apiclient/tests/test_multipart.py'
--- src/apiclient/tests/test_multipart.py	2012-09-22 19:43:13 +0000
+++ src/apiclient/tests/test_multipart.py	2012-10-05 11:15:35 +0000
@@ -116,3 +116,14 @@
         self.assertEqual(
             files_expected, files_observed,
             ahem_django_ahem)
+
+    def test_encode_multipart_data_list_params(self):
+        params_in = [
+            ("one", ["ABC", "XYZ"]),
+            ("one", "UVW"),
+            ]
+        body, headers = encode_multipart_data(params_in, [])
+        params_out, files_out = (
+            parse_headers_and_body_with_django(headers, body))
+        self.assertEqual({'one': ['ABC', 'XYZ', 'UVW']}, params_out)
+        self.assertSetEqual(set(), set(files_out))