Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Column ordering queryset passthrough #330

Merged
merged 4 commits into from
May 23, 2016
Merged

Column ordering queryset passthrough #330

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a2b694b
Column ordering queryset passthrough
thetarkus May 18, 2016
2a24511
Test for custom ordering, polishing
thetarkus May 19, 2016
c40080a
Docs, more polishing
thetarkus May 19, 2016
c051ef8
Clarify docs, add order_by to test Table
thetarkus May 20, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions django_tables2/columns/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,18 @@ def render(self, value):
"""
return value

def order(self, queryset, is_descending):
"""
Returns the queryset of the table.

This method can be overridden by :ref:`table.order_FOO` methods on the
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this reference point to anything?

Copy link
Contributor Author

@michaelmob michaelmob May 19, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

table.order_FOO is a placeholder name, so no, it doesn't point to a real function. Would you like me to rephrase it?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say to either add some documentation or do not reference it.

Of course, more documentation is better.

table or by subclassing `.Column`. Only overrides if second element
in return tuple is True.

:returns: Tuple (queryset, boolean)
"""
return (queryset, False)

@classmethod
def from_field(cls, field):
"""
Expand Down Expand Up @@ -527,6 +539,7 @@ def __init__(self, table):
for name, column in six.iteritems(table.base_columns):
self.columns[name] = bc = BoundColumn(table, column, name)
bc.render = getattr(table, 'render_' + name, column.render)
bc.order = getattr(table, 'order_' + name, column.order)

def iternames(self):
return (name for name, column in self.iteritems())
Expand Down
6 changes: 6 additions & 0 deletions django_tables2/tables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@ def order_by(self, aliases):
else:
accessors += bound_column.order_by
if hasattr(self, 'queryset'):
# Custom ordering
if bound_column:
self.queryset, custom = bound_column.order(self.queryset, alias[0] == '-')
if custom:
return
# Traditional ordering
translate = lambda accessor: accessor.replace(Accessor.SEPARATOR, QUERYSET_ACCESSOR_SEPARATOR)
if accessors:
self.queryset = self.queryset.order_by(*(translate(a) for a in accessors))
Expand Down