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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
|
from math import ceil
from typing import Optional
import django_filters as filters
from django.core.exceptions import ImproperlyConfigured
from django.test import TestCase
from django.views.generic import TemplateView
from django_filters.views import FilterView
import django_tables2 as tables
from .app.models import Person, Region
from .utils import build_request
MEMORY_DATA = [
{"name": "Queensland"},
{"name": "New South Wales"},
{"name": "Victoria"},
{"name": "Tasmania"},
]
class SimpleTable(tables.Table):
class Meta:
model = Region
exclude = ("id",)
class SimpleView(tables.SingleTableView):
table_class = SimpleTable
model = Region # required for ListView
class SingleTableViewTest(TestCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
for region in MEMORY_DATA:
Region.objects.create(name=region["name"])
def test_should_support_pagination_options(self):
class SimplePaginatedView(tables.SingleTableView):
table_class = SimpleTable
table_pagination = {"per_page": 1}
model = Region
response = SimplePaginatedView.as_view()(build_request())
table = response.context_data["table"]
self.assertEqual(table.paginator.num_pages, len(MEMORY_DATA))
self.assertEqual(table.paginator.per_page, 1)
def test_should_support_pagination_options_listView(self):
class SimplePaginatedView(tables.SingleTableView):
table_class = SimpleTable
paginate_by = 1
model = Region
response = SimplePaginatedView.as_view()(build_request())
table = response.context_data["table"]
self.assertEqual(table.paginator.num_pages, len(MEMORY_DATA))
self.assertEqual(table.paginator.per_page, 1)
def test_should_support_default_pagination(self):
total_records = 50
for i in range(1, total_records + 1):
Region.objects.create(name=f"region {i:02d} / {total_records}")
expected_per_page = 25
class PaginateDefault(tables.SingleTableMixin, TemplateView):
table_class = SimpleTable
template_name = "minimal.html"
def get_table_data(self):
return Region.objects.all()
response = PaginateDefault.as_view()(build_request())
response.render()
table = response.context_data["table"]
self.assertEqual(table.paginator.per_page, expected_per_page)
self.assertEqual(table.paginator.num_pages, 3)
self.assertEqual(len(table.page), expected_per_page)
# add one for the header row.
self.assertEqual(response.content.decode().count("<tr>"), expected_per_page + 1)
# in addition to New South Wales, Queensland, Tasmania and Victoria,
# 21 records should be displayed.
self.assertContains(response, f"21 / {total_records}")
self.assertNotContains(response, f"22 / {total_records}")
def test_should_support_default_pagination_with_table_options(self):
class Table(tables.Table):
class Meta:
model = Region
per_page = 2
class PaginateByDefinedOnView(tables.SingleTableView):
table_class = Table
model = Region
table_data = MEMORY_DATA
response = PaginateByDefinedOnView.as_view()(build_request())
table = response.context_data["table"]
self.assertEqual(table.paginator.per_page, 2)
self.assertEqual(len(table.page), 2)
def test_should_support_disabling_pagination_options(self):
class SimpleNotPaginatedView(tables.SingleTableView):
table_class = SimpleTable
table_data = MEMORY_DATA
table_pagination = False
model = Region # required for ListView
response = SimpleNotPaginatedView.as_view()(build_request())
table = response.context_data["table"]
self.assertFalse(hasattr(table, "page"))
def test_data_from_get_queryset(self):
class GetQuerysetView(SimpleView):
def get_queryset(self):
return Region.objects.filter(name__startswith="Q")
response = GetQuerysetView.as_view()(build_request())
table = response.context_data["table"]
self.assertEqual(len(table.rows), 1)
self.assertEqual(table.rows[0].get_cell("name"), "Queensland")
def test_should_support_explicit_table_data(self):
class ExplicitDataView(tables.SingleTableView):
table_class = SimpleTable
table_pagination = {"per_page": 1}
model = Region
table_data = MEMORY_DATA
response = ExplicitDataView.as_view()(build_request())
table = response.context_data["table"]
self.assertEqual(table.paginator.num_pages, len(MEMORY_DATA))
def test_paginate_by_on_view_class(self):
class Table(tables.Table):
class Meta:
model = Region
class PaginateByDefinedOnView(tables.SingleTableView):
table_class = Table
model = Region
paginate_by = 2
table_data = MEMORY_DATA
def get_queryset(self):
return Region.objects.all().order_by("name")
response = PaginateByDefinedOnView.as_view()(build_request())
table = response.context_data["table"]
self.assertEqual(table.paginator.per_page, 2)
def test_with_custom_paginator(self):
# defined in paginator_class
class View(tables.SingleTableView):
table_class = tables.Table
queryset = Region.objects.all()
paginator_class = tables.LazyPaginator
response = View.as_view()(build_request())
self.assertIsInstance(response.context_data["table"].paginator, tables.LazyPaginator)
# defined in table_pagination
class View(tables.SingleTableView):
table_class = tables.Table
queryset = Region.objects.all()
table_pagination = {"paginator_class": tables.LazyPaginator}
paginate_orphans = 10
response = View.as_view()(build_request())
paginator = response.context_data["table"].paginator
self.assertIsInstance(paginator, tables.LazyPaginator)
self.assertEqual(paginator.orphans, 10)
def test_get_paginate_by_has_priority_over_paginate_by(self):
class View(tables.SingleTableView):
table_class = tables.Table
queryset = Region.objects.all()
# This paginate_by should be ignored because get_paginated_by is overridden
paginate_by = 4
def get_paginate_by(self, queryset):
# Should paginate by 10
return 10
response = View.as_view()(build_request())
self.assertEqual(response.context_data["table"].paginator.per_page, 10)
def test_pass_queryset_to_get_paginate_by(self):
# defined in paginator_class
class View(tables.SingleTableView):
table_class = tables.Table
queryset = Region.objects.all()
def get_paginate_by(self, table_data):
# Should split table items into 2 pages
return ceil(len(table_data) / 2)
response = View.as_view()(build_request())
self.assertEqual(response.context_data["table"].paginator.num_pages, 2)
def test_should_pass_kwargs_to_table_constructor(self):
class PassKwargsView(SimpleView):
table_data = []
def get_table(self, **kwargs):
kwargs.update({"orderable": False})
return super().get_table(**kwargs)
response = SimpleView.as_view()(build_request("/"))
self.assertTrue(response.context_data["table"].orderable)
response = PassKwargsView.as_view()(build_request("/"))
self.assertFalse(response.context_data["table"].orderable)
def test_should_override_table_pagination(self):
class PrefixedTable(SimpleTable):
class Meta(SimpleTable.Meta):
prefix = "p_"
class PrefixedView(SimpleView):
table_class = PrefixedTable
class PaginationOverrideView(PrefixedView):
table_data = MEMORY_DATA
def get_table_pagination(self, table):
assert isinstance(table, tables.Table)
per_page = self.request.GET.get(f"{table.prefixed_per_page_field}_override")
if per_page is not None:
return {"per_page": per_page}
return super().get_table_pagination(table)
response = PaginationOverrideView.as_view()(build_request("/?p_per_page_override=2"))
self.assertEqual(response.context_data["table"].paginator.per_page, 2)
def test_using_get_queryset(self):
"""
Should not raise a value-error for a View using View.get_queryset()
(test for reverting regressing in #423)
"""
Person.objects.create(first_name="Anton", last_name="Sam")
class Table(tables.Table):
class Meta:
model = Person
fields = ("first_name", "last_name")
class TestView(tables.SingleTableView):
model = Person
table_class = Table
def get(self, request, *args, **kwargs):
self.get_table()
from django.http import HttpResponse
return HttpResponse()
def get_queryset(self):
return Person.objects.all()
TestView.as_view()(build_request())
def test_get_tables_class(self):
view = SimpleView()
table_class = view.get_table_class()
self.assertEqual(table_class, view.table_class)
def test_get_tables_class_auto(self):
class SimpleNoTableClassView(tables.SingleTableView):
model = Region
view = SimpleNoTableClassView()
table_class = view.get_table_class()
self.assertEqual(table_class.__name__, "RegionAutogeneratedTable")
def test_get_tables_class_raises_no_model(self):
class Table(tables.SingleTableView):
model = None
table_class = None
view = Table()
message = "You must either specify Table.table_class or Table.model"
with self.assertRaisesMessage(ImproperlyConfigured, message):
view.get_table_class()
class SingleTableMixinTest(TestCase):
def test_with_non_paginated_view(self):
"""
SingleTableMixin should not assume it is mixed with a ListView
Github issue #326
"""
class Table(tables.Table):
class Meta:
model = Region
class View(tables.SingleTableMixin, TemplateView):
table_class = Table
table_data = MEMORY_DATA
template_name = "dummy.html"
View.as_view()(build_request())
def test_should_paginate_by_default(self):
"""
When mixing SingleTableMixin with FilterView, the table should paginate by default
"""
total_records = 60
for i in range(1, total_records + 1):
Region.objects.create(name=f"region {i:02d} / {total_records}")
expected_per_page = 25
class RegionFilter(filters.FilterSet):
name = filters.CharFilter(lookup_expr="icontains")
class PaginateDefault(tables.SingleTableMixin, FilterView):
table_class = SimpleTable
model = Region
filterset_class = RegionFilter
template_name = "minimal.html"
response = PaginateDefault.as_view()(build_request())
response.render()
table = response.context_data["table"]
self.assertEqual(table.paginator.per_page, expected_per_page)
self.assertEqual(table.paginator.num_pages, 3)
self.assertEqual(len(table.page), expected_per_page)
self.assertEqual(response.content.decode().count("<tr>"), expected_per_page + 1)
class TableA(tables.Table):
class Meta:
model = Person
class TableB(tables.Table):
class Meta:
model = Region
exclude = ("id",)
class MultiTableMixinTest(TestCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
Person.objects.create(first_name="Jan Pieter", last_name="W")
NL_PROVICES = (
"Flevoland",
"Friesland",
"Gelderland",
"Groningen",
"Limburg",
"Noord-Brabant",
"Noord-Holland",
"Overijssel",
"Utrecht",
"Zeeland",
"Zuid-Holland",
)
for name in NL_PROVICES:
Region.objects.create(name=name)
def test_basic(self):
class View(tables.MultiTableMixin, TemplateView):
tables = (TableA, TableB)
tables_data = (Person.objects.all(), Region.objects.all())
template_name = "multiple.html"
response = View.as_view()(build_request("/"))
response.render()
html = response.rendered_content
self.assertIn("table_0-sort=first_name", html)
self.assertIn("table_1-sort=name", html)
self.assertIn("<td >Jan Pieter</td>", html)
self.assertIn("<td >Zuid-Holland</td>", html)
def test_supplying_instances(self):
class View(tables.MultiTableMixin, TemplateView):
tables = (TableA(Person.objects.all()), TableB(Region.objects.all()))
template_name = "multiple.html"
response = View.as_view()(build_request("/"))
response.render()
html = response.rendered_content
self.assertIn("table_0-sort=first_name", html)
self.assertIn("table_1-sort=name", html)
self.assertIn("<td >Jan Pieter</td>", html)
self.assertIn("<td >Zuid-Holland</td>", html)
def test_without_tables(self):
class View(tables.MultiTableMixin, TemplateView):
template_name = "multiple.html"
message = "No tables were specified. Define View.tables"
with self.assertRaisesMessage(ImproperlyConfigured, message):
View.as_view()(build_request("/"))
def test_with_empty_get_tables_list(self):
class View(tables.MultiTableMixin, TemplateView):
template_name = "multiple.html"
def get_tables(self):
return []
response = View.as_view()(build_request("/"))
response.render()
html = response.rendered_content
self.assertIn("<h1>Multiple tables using MultiTableMixin</h1>", html)
def test_with_empty_class_tables_list(self):
class View(tables.MultiTableMixin, TemplateView):
template_name = "multiple.html"
tables = []
response = View.as_view()(build_request("/"))
response.render()
html = response.rendered_content
self.assertIn("<h1>Multiple tables using MultiTableMixin</h1>", html)
def test_length_mismatch(self):
class View(tables.MultiTableMixin, TemplateView):
tables = (TableA, TableB)
tables_data = (Person.objects.all(),)
template_name = "multiple.html"
message = "len(View.tables_data) != len(View.tables)"
with self.assertRaisesMessage(ImproperlyConfigured, message):
View.as_view()(build_request("/"))
def test_table_pagination(self):
class View(tables.MultiTableMixin, TemplateView):
tables = (TableB(Region.objects.all()), TableB(Region.objects.all()))
template_name = "multiple.html"
table_pagination = {"per_page": 5}
response = View.as_view()(build_request("/?table_1-page=3"))
tableA, tableB = response.context_data["tables"]
self.assertEqual(tableA.page.number, 1)
self.assertEqual(tableB.page.number, 3)
def test_paginate_by(self):
class View(tables.MultiTableMixin, TemplateView):
tables = (TableB(Region.objects.all()), TableB(Region.objects.all()))
template_name = "multiple.html"
paginate_by = 5
response = View.as_view()(build_request("/?table_1-page=3"))
tableA, tableB = response.context_data["tables"]
self.assertEqual(tableA.page.number, 1)
self.assertEqual(tableB.page.number, 3)
def test_pass_table_data_to_get_paginate_by(self):
class View(tables.MultiTableMixin, TemplateView):
template_name = "multiple.html"
tables = (TableB, TableB)
tables_data = (Region.objects.all(), Region.objects.all())
def get_paginate_by(self, table_data) -> Optional[int]:
# Split data into 3 pages
return ceil(len(table_data) / 3)
response = View.as_view()(build_request())
for table in response.context_data["tables"]:
self.assertEqual(table.paginator.num_pages, 3)
def test_get_tables_data(self):
class View(tables.MultiTableMixin, TemplateView):
tables = (TableA, TableB)
template_name = "multiple.html"
def get_tables_data(self):
return [Person.objects.all(), Region.objects.all()]
response = View.as_view()(build_request("/"))
response.render()
html = response.rendered_content
self.assertIn("<td >Jan Pieter</td>", html)
self.assertIn("<td >Zuid-Holland</td>", html)
def test_table_prefix(self):
class View(tables.MultiTableMixin, TemplateView):
tables = (
TableB(Region.objects.all(), prefix="test_prefix"),
TableB(Region.objects.all()),
)
template_name = "multiple.html"
response = View.as_view()(build_request("/"))
tableA = response.context_data["tables"][0]
tableB = response.context_data["tables"][1]
self.assertEqual("test_prefix", tableA.prefix)
self.assertIn("table", tableB.prefix)
|