exclude-some-columns-from-report

README.rst

@@ -59,7 +59,7 @@ Installation
 Changes in your project
 =======================
 
-1. Now your table should extend of 'TableReport'
+1.a Now your table should extend of 'TableReport'
 
 ::
 
@@ -81,6 +81,15 @@ Changes in your project
 
         ...
 
+1.b If you want to exclude some columns from report (e.g. if it is a column of buttons), you should set 'exclude_from_report' - the names of columns (as well as property 'exclude' in `table <http://pypi.python.org/pypi/django-tables2/>`_)
+
+::
+
+    class MyTable(TableReport):
+
+        class Meta:
+            exclude_from_report = ('column1', ...)
+        ...
 
 2.a. If you use a traditional views, now you should use other RequestConfig and change a little your view:
 

django_tables2_reports/tables.py

@@ -17,6 +17,7 @@
 import csv
 import codecs
 import sys
+from functools import wraps
 
 PY3 = sys.version_info[0] == 3
 
@@ -81,6 +82,8 @@ def writerow(self, row):
 
 class TableReport(tables.Table):
 
+    exclude_from_report = ()  # the names of columns that should be excluded from report
+
     def __init__(self, *args, **kwargs):
         if not 'template' in kwargs:
             kwargs['template'] = 'django_tables2_reports/table.html'
@@ -90,6 +93,20 @@ def __init__(self, *args, **kwargs):
         self.formats = [(_('CSV Report'), 'csv')]
         if get_excel_support():
             self.formats.append((_('XLS Report'), 'xls'))
+        if hasattr(self, 'Meta'):
+            self.exclude_from_report = getattr(self.Meta, 'exclude_from_report', ())
+
+    def _with_exclude_from_report(method):
+        """ Put to 'exclude' columns from 'exclude_from_report', and revert this after method's call """
+        @wraps(method)
+        def with_exclude(self, *args, **kwargs):
+            origin_exclude = self.exclude
+            self.exclude = self.exclude_from_report
+            try:
+                return method(self, *args, **kwargs)
+            finally:
+                self.exclude = origin_exclude
+        return with_exclude
 
     def as_report(self, request, report_format='csv'):
         if report_format == 'csv':
@@ -98,6 +115,7 @@ def as_report(self, request, report_format='csv'):
             return self.as_xls(request)
         raise ValueError("This format %s is not accepted" % report_format)
 
+    @_with_exclude_from_report
     def as_csv(self, request):
         response = HttpResponse()
         csv_writer = UnicodeWriter(response, encoding=settings.DEFAULT_CHARSET)
@@ -116,6 +134,7 @@ def as_csv(self, request):
             csv_writer.writerow(csv_row)
         return response
 
+    @_with_exclude_from_report
     def as_xls(self, request):
         return self.as_csv(request)
 

django_tables2_reports/tests.py

@@ -136,6 +136,41 @@ def test_csv_no_pagination(self):
              'page 2,2\r\n')
         )
 
+    def test_exclude_from_report(self):
+        """Ensure that exclude-some-columns-from-report works."""
+        data = [
+            {
+                'name': 'page 1',
+                'item_num': 1,
+            },
+            {
+                'name': 'page 2',
+                'item_num': 2,
+            },
+        ]
+
+        class TableWithExclude(TableReportForTesting):
+            class Meta:
+                exclude_from_report = ('item_num',)
+
+        table = TableWithExclude(data)
+        table.exclude = ('name', )
+        self.assertEqual(table.exclude_from_report, ('item_num',))
+
+        response = table.as_csv(HttpRequest())
+        self.assertEqual(response.status_code, 200)
+        content = response.content
+        if PY3:
+            content = content.decode(settings.DEFAULT_CHARSET).replace('\x00', '')
+
+        self.assertEqual(table.exclude, ('name',))  # Attribute 'exclude_from_report' shouldn't overwrite 'exclude'
+        self.assertEqual(
+            content,
+            ('Name\r\n'
+             'page 1\r\n'
+             'page 2\r\n')
+        )
+
 
 @skipIf(
     not django_tables2_reports.utils.get_excel_support(),