1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
|
from django.contrib.auth import get_user_model
from django.template import Context, Template
from django.test import TestCase
from django.utils.translation import gettext_lazy as _
import django_tables2 as tables
from .app.models import Person
from .utils import build_request, parse
User = get_user_model()
data = [
{"name": "Adrian", "country": "Australia"},
{"name": "Roy", "country": "Brazil"},
{"name": "Audrey", "country": "Chile"},
{"name": "Bassie", "country": "Belgium"},
]
class DynamicColumnsTest(TestCase):
def test_dynamically_adding_columns(self):
"""
When adding columns to self.base_columns, they were actually added to
the class attribute `Table.base_columns`, and not to the instance
attribute, `table.base_columns`
issue #403
"""
class MyTable(tables.Table):
name = tables.Column()
# this is obvious:
self.assertEqual(list(MyTable(data).columns.columns.keys()), ["name"])
self.assertEqual(
list(
MyTable(data, extra_columns=[("country", tables.Column())]).columns.columns.keys()
),
["name", "country"],
)
# this new instance should not have the extra columns added to the first instance.
self.assertEqual(list(MyTable(data).columns.columns.keys()), ["name"])
def test_dynamically_removing_columns(self):
class MyTable(tables.Table):
name = tables.Column()
# this is obvious:
self.assertEqual(list(MyTable(data).columns.columns.keys()), ["name"])
self.assertEqual(
list(
MyTable(
data, extra_columns=[("country", tables.Column()), ("name", None)]
).columns.columns.keys()
),
["country"],
)
# this new instance should not have the extra columns added to the first instance.
self.assertEqual(list(MyTable(data).columns.columns.keys()), ["name"])
def test_sorting_on_dynamically_added_columns(self):
class MyTable(tables.Table):
name = tables.Column()
table = MyTable(
data,
order_by="-country",
extra_columns=[("country", tables.Column(verbose_name=_("country")))],
)
root = parse(table.as_html(build_request()))
self.assertEqual(root.find(".//tbody/tr/td[2]").text, "Chile")
self.assertEqual(root.find(".//tbody/tr[4]/td[2]").text, "Australia")
def test_dynamically_override_auto_generated_columns(self):
for name, country in data:
Person.objects.create(first_name=name, last_name=country)
queryset = Person.objects.all()
class MyTable(tables.Table):
class Meta:
model = Person
fields = ("first_name", "last_name")
self.assertEqual(
list(MyTable(queryset).columns.columns.keys()), ["first_name", "last_name"]
)
table = MyTable(
queryset,
extra_columns=[("first_name", tables.Column(attrs={"td": {"style": "color: red;"}}))],
)
# we still should have two columns
self.assertEqual(list(table.columns.columns.keys()), ["first_name", "last_name"])
# the attrs should be applied to the `first_name` column
self.assertEqual(
table.columns["first_name"].attrs["td"], {"style": "color: red;", "class": None}
)
def test_dynamically_add_column_with_sequence(self):
class MyTable(tables.Table):
name = tables.Column()
class Meta:
sequence = ("...", "name")
self.assertEqual(
list(
MyTable(data, extra_columns=[("country", tables.Column())]).columns.columns.keys()
),
["country", "name"],
)
# override sequence with an argument.
self.assertEqual(
list(
MyTable(
data, extra_columns=[("country", tables.Column())], sequence=("name", "...")
).columns.columns.keys()
),
["name", "country"],
)
def test_dynamically_hide_columns(self):
class MyTable(tables.Table):
name = tables.Column(orderable=False)
country = tables.Column(orderable=False)
def before_render(self, request):
if request.user.username == "Bob":
self.columns.hide("country")
else:
self.columns.show("country")
template = Template("{% load django_tables2 %}{% render_table table %}")
re_Name = r"<th >\s*Name\s*</th>"
re_Country = r"<th >\s*Country\s*</th>"
table = MyTable(data)
request = build_request(user=User.objects.create(username="Bob"))
html = table.as_html(request)
self.assertRegex(html, re_Name)
self.assertNotRegex(html, re_Country)
html = template.render(Context({"request": request, "table": table}))
self.assertRegex(html, re_Name)
self.assertNotRegex(html, re_Country)
request = build_request(user=User.objects.create(username="Alice"))
html = table.as_html(request)
self.assertRegex(html, re_Name)
self.assertRegex(html, re_Country)
html = template.render(Context({"request": request, "table": table}))
self.assertRegex(html, re_Name)
self.assertRegex(html, re_Country)
def test_sequence_and_extra_columns(self):
"""
https://github.com/jieter/django-tables2/issues/486
The exact moment the '...' is expanded is crucial here.
"""
add_occupation_column = True
class MyTable(tables.Table):
class Meta:
model = Person
fields = ("first_name", "friends")
sequence = ("first_name", "...", "friends")
def __init__(self, data, *args, **kwargs):
kwargs["extra_columns"] = kwargs.get("extra_columns", [])
if add_occupation_column:
kwargs["extra_columns"].append(
("occupation", tables.RelatedLinkColumn(orderable=False))
)
super().__init__(data, *args, **kwargs)
table = MyTable(Person.objects.all())
self.assertEqual([c.name for c in table.columns], ["first_name", "occupation", "friends"])
add_occupation_column = False
table = MyTable(Person.objects.all())
self.assertEqual([c.name for c in table.columns], ["first_name", "friends"])
def test_change_attributes(self):
"""
https://github.com/jieter/django-tables2/issues/574
"""
class Table(tables.Table):
mycolumn = tables.Column(orderable=False)
def __init__(self, *args, **kwargs):
self.base_columns["mycolumn"].verbose_name = "Monday"
super().__init__(*args, **kwargs)
table = Table([])
self.assertEqual(table.columns["mycolumn"].verbose_name, "Monday")
|