django-tables2

This release is yanked because it should have been released as 3.0 because of the breaking changes.

Changes:

• Remove deprecated RelatedLinkColumn and NullBooleanField support (#1016) NullBooleanField was removed in django 4.0
• Export DateColumn/DateTimeColumn/TimeColumn in ISO format (#1022 by @spapas)
• Rename querystring template tag to querystring_replace (#1021 by @federicobond)
• Use string annotation_format in inspect.signature to prevent runtime errors with type annotations (#1027) by @mschoettle
• Add optional context_object_name to TemplateColumn and make extra_context optionally callable (#931) fixes: #928

• Pass request to the template rendered in TemplateColumn (#1014) Fixes: #1008
• Do not generate error when table data model is subclass of table model (#1015) Fixes #1010 by @sjoerdjob
• Update supported Python and Django versions (#1011) by @dyve Supported Django versions: 4.2, 5.1, 5.2, 6.0 Supported Python versions: 3.10, 3.11, 3.12, 3.13, 3.14

• Update django.po for Ukrainian 🇺🇦 (#934) by @DmytroLitvinov

Correct packaging mistakes:

• Remove upper bound for python_requires

• Add python_requires to setup.py (#982) Fixes: #980

• Add TimeColumn to built-in columns (#937) by @philipphanemann Add support to pass args/kwargs to callables from Accessor (#940), fixes: #939 by @JordanHyatt
• Drop support for Django 3.2, 4.1 and python 3.8
• Add support for Django 5.1 and python 3.12
• Explicitly set Column.accessor when binding a column to allow column methods like order_by to use its value (#979)

• Update docs dependencies; fix docs search; add readthedocs.yaml (#935)
• Add example on how to use Accessor to documentation in custom-data.rst (#917) by @ruddra
• Use pre-commit in ci, add isort, flake8, pyupgrade (#932)
• Add support for Django 5.0 and Python 3.12 (#930)
• Add missing {% load l10n %} in templates (#919) by @tvanekeris

• Fix bootstrap5-responsive template to extend bootstrap5 (#909) by @mschoettle
• Add support for django 4.2
• Drop python 3.7 and django 4.0 support (#920)

• Assign request to table before anything else in RequestConfig.configure() (#888) fixes: #865
• Add type hints to get_context_data (#895) by @mschoettle
• Document hidden table attributes setting (#897) by @mschoettle
• Fix building of the docs (#900) by @danielroseman
• Add template bootstrap5-responsive.html (#896) by @mschoettle

• Assign request to table before anything else in RequestConfig.configure() (#888) fixes: #865

• TableMixinBase: implement get_paginate_by (#811) by @Alirezaja1384

• Dropped support for python 3.6, added support for python 3.11
• Add django_tables2/bootstrap4-responsive.html (#874) by @botlabsDev
• Pass record/value to LinkColumn's attrs callables too (#852) by @wsldankers
• Add template bootstrap5.html to support bootstrap 5 (#880, fixes #796

• Add Persian (Farsi) locale (#806) by @Alirezaja1384
• Improved error message if openpyxl is not installed (#816)
• Use correct mime type for xlsx (fixes: #810)
• Add support for django 4.0, drop support for python 3.5 (#822)

• Add support for django 3.2 and python 3.9, drop support for django 3.0
• Add Django 3.0 and 3.1 trove classifiers #803 by @Asday
• Strip leading and trailing whitespace from TemplateColumn.value() #794 by @jeremystretch
• Providing link for django-bootstrap3 #793 by @TareqMonwer
• Fix for crash on windows while deleting temp file #788

• Removed deprecation warnings with django==3.1 regarding JSONField #785

• Use table.default for empty ManyToMany relations (#773) fixes: #769
• Pass record/value to CheckboxColumn's attrs callables too (#774), fixes: #762

• Fix popping the extra_context of TemplateColumn #767 by @bernhardmiller
• Fix typo for the translation of the word 'next' in greek [#759]](https://github.com/jieter/django-tables2/pull/759) by @orfeasa
• Add format_html import to prevent NameError #752 by @MBfromOK
• Fixed Russian translation #768 by @Real-Gecko

• Fixed the LazyPaginator in a simpler more predictable way: an attempt to show a non-existent page, shows the first page. #743

• Add ability to pass tablib.Dataset kwargs via TableExport and ExportMixin #720 by @powderflask
• Drop django==2.1 support, add optional tablib requirements #738
• Short-circuit Accessor.resolve() if the context contains the exact accessor #722, fixes #717
• Fixed yaml export #732 by @sg3-141-592
• Made Table docstring visible in docs #742
• Removed the TableBase construct in favor of using the metaclass keyword argument, as all supported python versions support it. #742
• LazyPaginator with non-existent page number should not result in a crash #741

• Fix backwards-compatibility with legacy separators in order_by clauses (#715 by @federicobond)

• Use __ as accessor-separator, add linkify Meta option #702). This will currently emit a warning but falls back to using . as separator. The next major version will raise a ValueError if used with . as separator.
• Add request attribute to table instance (#705 by @rubickcz).
• Append ellipsis for LazyPaginator if not on last page (#707 by @tuky)

• Made ManyToManyColumn use table.default instead of a local value #680 by @srtab
• Removed invalid scope attribute in <tr> element of bootstrap4.html. #691 by @vlt
• Fixed an issue with incorrectly disabled pagination where SingleTableMixin was not used together with ListView #678 by @nieuwenhuys

• Dropped support for python 2.7 (and django 1.11).
• Removed django_tables2.utils.ucfirst, use django.utils.text.capfirst instead.
• Removed class="thead-default" from bootstrap4 template (#671)
• Included columns with visible=False in export (#677)
• Fixed pagination when the number of pages is equal to page range plus one (#655)

• Add optional 'table' kwarg to row_attrs callables

• Fixes issue with wrong time format for TimeColumn #650 by @IgorCode

• The ValueError raised if the QuerySet passed to a table instance did not match the value declared in Meta.model is now turned into a warning (fixes #643)
• Make sure the templates do not raise errors when thead/tfoot attributes are not defined #624 by @intiocean

• Improvements in packaging and publishing helper scripts reducing the package size considerably #630 by @wtayyeb (fixes #629)
• Documentation improvements fixing #625, #631

• Make sure the value of the class attribute in <th> has consistent ordering (fixes #627)
• Make sure that pagination block is available in template regardless of pagination status #622 by @apocalyptech

• Fixed a regression which did not allow Table.Meta.order_by to be a list.

Not much changed in this final version, but quite a lot if you are still on 1.21.2. Some breaking changes were introduced in version 2.0.0a0, so before upgrading from 1.21.2, please have a look through them carefully.

• Consider ExportMixin.export_trigger_param in export_url template tag #609 by @soerenbe

• Change order of logic in get_table_pagination to make sure we are able to override the paginator using View.paginator_class attribute.

• The klass argument to Table.paginate() is renamed to paginator_class
• Table views/mixins now take ListView attributes paginator_class and paginate_orphans into account.

• Fixed a bug in the implementation of #606

• Added the ability to change the html attributes for thead, tbody, tfoot tags #606 by @roelbouwman

• Added LazyPaginator to prevent making .count() queries (#604).

• Added linkify_item keyword argument to ManyToManyColumn, fixes #594
• Fixed an encoding issue in README.md preventing installation in some environments.

• Add linkify keyword argument to all columns, to allow wrapping the content in a <a> tag. It accepts one of these ways to define the link:
  • True to use the record return value of record.get_absolute_url(),
  • a callable to use its return value
  • a dict which is passed on to django.urls.reverse()
  • a (viewname, args) or (viewname, kwargs)-tuple which is also passed on to django.urls.reverse(). Implementation should be backwards compatible, so all use of LinkColumn and RelatedLinkColum should still work. #590

Hello from DjangoCon Europe!

• Fix table prefix being overwritten in MultiTableView, #576 by @ETinLV, (fixes #572)
• Fix empty_text cannot be translated (fixes #579)

• Another round of template cleanup.
• Fresh screenshots
• Prevent crash in RelatedLinkColumn for records without get_absolute_url().
• Raise ValueError when Table.Meta.model != QuerySet.Model.
• Raise TypeError when incorrect types are used for Table.Meta attributes (fixes #517)
• Fix: Table.Meta.sequence with extra_columns can leads to KeyError (fixes #486)

• Fixed translation of 'previous' for some languages (fixes #563)

• Cleaned up templates to add consistency in what is presented across all templates.
• Added bootstrap4.html template
• Fixed translation inconsistencies.

breaking changes 2.0.0

• Appearance of the paginators might be different from the current 1.x templates. Use a custom template if you need to keep the appearance the same.
• Removed the template argument to the table constructor, use template_name instead.
• Stopped adding column names to the class attribute of table cells (<td> tags) by default. Previous behavior can be restored by using this method on your custom table:

class MyTable(tables.Table):
    # columns
    def get_column_class_names(self, classes_set, bound_column):
        classes_set = super(MyTable, self).get_column_class_names(classes_set, bound_column)
        classes_set.add(bound_column.name)
        return classes_set

• verbose_names derived from model fields are not passed through title() anymore, only the first character is converted to upper case. This follows Django's convention for verbose field names: "The convention is not to capitalize the first letter of the verbose_name. Django will automatically capitalize the first letter where it needs to." (Fixes #475 and #491)

• Moved table instantiation from get_context_data to get_tables #554 by @sdolemelipone
• Pass request as kwarg to template.render(), rather than as part of context. (fixes #552)

• Do not perform extra COUNT() queries for non-paginated tables. Fixes #551

• Add new method paginated_rows to Table to replace fallback to non-paginated rows in templates.
• Prevent mutation of the template context {% render_table %} is called from (fixes #547) Possible breaking change: the context variables of the template {% render_table %} is called from is no longer available in the table's template. The table variable has an attribute context, which is the context of the calling template. Use {{ table.context.variable }} instead of {{ variable }}.

• Define and use get_table_data in MultiTableMixin #538 by @vCra (fixes #528)
• Added {% export_url <format> %} template tag.
• Allow passing a TableData-derived class to the data argument of the Table constructor, instead of a QuerySet or list of dicts.

• BoundColumn.attrs does not evaluate current_value as bool #536 by @pachewise (fixes #534)
• Allow more flexible access to cell values (especially useful for django templates) (fixes #485)

• Follow relations when detecting column type for fields in Table.Meta.fields (fixes #498)
• Renamed Table.Meta.template to template_name (with deprecation warning for the former) #542 (fixes #520)
• Added Czech translation #533 by @OndraRehounek
• Added table_factory #532 by @ZuluPro

• Fix typo in setup.py for extras_require.

• Dropped support for Django 1.8, 1.9 and 1.10.
• Add extra_context argument to TemplateColumn #509 by @ad-m
• Remove unnecessary cast of record to str #514, fixes #511
• Use django.test.TestCase for all tests, and remove dependency on pytest and reorganized some tests #515
• Remove traces of django-haystack tests from the tests, there were no actual tests.

This is the last version supporting Django 1.8, 1.9 and 1.10. Django 1.8 is only supported until April 2018, so consider upgrading to Django 1.11!

• Added tf dictionary to Column.attrs with default values for the footer, so footers now have class attribute by default #501 by @mpasternak

• Added as=varname keyword argument to the {% querystring %} template tag, fixes #481
• Updated the tutorial to reflect current state of Django a bit better.
• Used OrderedDict rather than dict as the parent for utils.AttributeDict to make the rendered html more consistent across python versions.
• Allow reading column attrs from a column's attribute, allowing easier reuse of custom column attributes (fixes #241)
• value and record are optionally passed to the column attrs callables for data rows. #503, fixes #500

• Added a row_counter variable to the template context in TemplateColumn (fixes #448)

• Do not fail if orderable=False is passed to ManyToManyColumn()

• Added separator argument to ManyToManyColumn.
• Allow mark_safe()'d strings from ManyToManyColumn.tranform()
• Disabled ordering on ManyToManyColumns by default.

• Made positional data argument to the table __init__() a keyword argument to make inheritance easier. Will raise a TypeError if omitted.

• Allow export file name customization #484 by @federicobond
• Fixed a bug where template columns were not rendered for pinned rows (#483 by @khirstinova, fixes #482)

• Added Hungarian translation #471 by @hmikihth.
• Added TemplateColumn.value() and enhanced export docs (fixes #470)
• Fixed display of pinned rows if table has no data. #477 by @khirstinova