Repository: carpentries/amy

Issue:
CSV renderer doesn't expand generator
@jduckles reports:

When trying to download the following from the API as CSV:
https://amy.software-carpentry.org/api/v1/reports/workshops_over_time/

I get a file that makes me think the CSV generate method isn't being run over the object, the object is just getting dumped.

```
<generator object _only_latest_date at 0x7f2f49cdebd0>
```



Discussion:

Resolving patch:
diff --git a/api/views.py b/api/views.py
--- a/api/views.py
+++ b/api/views.py
@@ -18,6 +18,7 @@
 from rest_framework.views import APIView
 from rest_framework.viewsets import ViewSet
 from rest_framework_csv.renderers import CSVRenderer
+from rest_framework_yaml.renderers import YAMLRenderer
 
 from workshops.models import (
     Badge,
@@ -234,9 +235,12 @@ class ReportsViewSet(ViewSet):
     queryset1 = Event.objects.past_events().order_by('start')
     queryset2 = Award.objects.order_by('awarded')
 
-    # YAML renderer is turned off because it has problems reading our
-    # accumulative generator (lol)
-    renderer_classes = (BrowsableAPIRenderer, JSONRenderer, CSVRenderer)
+    renderer_classes = (BrowsableAPIRenderer, JSONRenderer, CSVRenderer,
+                        YAMLRenderer)
+
+    # YAML and CSV renderers don't understand generators (>.<) so we had to
+    # turn the `accumulate` generator results into a list
+    formats_requiring_lists = ('csv', 'yaml')
 
     def _add_counts(self, a, b):
         c = b
@@ -255,6 +259,19 @@ def _only_latest_date(self, iterable):
             prev_ = next_
         yield next_
 
+    def listify(self, iterable, request, format=None):
+        """Some renderers require lists instead of any iterables for rendering.
+        This function conditionally turns iterables into lists based on the
+        format requested by browser."""
+        # choose either '?format=...' or '/url.format' or None
+        format_ = (request.query_params.get('format') or format or '').lower
+
+        if format_ in self.formats_requiring_lists:
+            # list-ify the generator for renderers requiring lists
+            return list(iterable)
+
+        return iterable
+
     @list_route(methods=['GET'])
     def workshops_over_time(self, request, format=None):
         """Cumulative number of workshops run by Software Carpentry over
@@ -264,6 +281,9 @@ def workshops_over_time(self, request, format=None):
 
         # run a cumulative generator over the data
         data = accumulate(serializer.data, self._add_counts)
+
+        data = self.listify(data, request, format)
+
         return Response(data)
 
     @list_route(methods=['GET'])
@@ -276,6 +296,9 @@ def learners_over_time(self, request, format=None):
 
         # run a cumulative generator over the data
         data = accumulate(serializer.data, self._add_counts)
+
+        data = self.listify(data, request, format)
+
         return Response(data)
 
     @list_route(methods=['GET'])
@@ -294,6 +317,8 @@ def instructors_over_time(self, request, format=None):
         # particular date
         data = self._only_latest_date(data)
 
+        data = self.listify(data, request, format)
+
         return Response(data)
 
     @list_route(methods=['GET'])


Test patch: