Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
webstack-django-sorting
Advanced tools
webstack-django-sorting
is a Django app which allows for easy sorting of
data tables. You don't need to change anything to your views to use it. It
provides sorting links for table headers. It is the perfect companion of
django-pagination.
There are other powerful projects to sort tables such as
django-tables2 but I don't like the
high level render_table
tag because it requires to define the CSS in
Table
classes or to write custom templates.
A demonstration of the features is provided in testproj
directory. The file
testproj/README.md
provides information on how to use it.
To upgrade to webstack-django-sorting
v1.0.0+, you must remove the old middleware
webstack_django_sorting.middleware.SortingMiddleware
from MIDDLEWARE_CLASSES
list.
The provide is available on PyPI:
pip install webstack_django_sorting
The project provides examples of integration with Django and Jinja2 templates.
Add the application to the INSTALLED_APPS
list:
INSTALLED_APPS = [
# ...
'webstack_django_sorting',
]
Check the request context processor is loaded in TEMPLATES
options:
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
# ...
'django.template.context_processors.request',
# ...
],
},
},
]
Add this line at the top of your template to load the sorting tags:
{% load sorting_tags %}
Decide on a variable that you would like to sort, and use the autosort tag on that variable before iterating over it:
{% autosort object_list %}
You can pass the option nulls=first
(or nulls=last
) to explicitly define
the ordering of NULL (not supported by all databases,
Indexing ASC, DESC and NULLS FIRST/LAST)
Now, you want to display different headers with links to sort your objects_list:
<tr>
<th>{% anchor first_name _("Name") %}</th>
<th>{% anchor creation_date _("Creation") %}</th>
</tr>
The first argument is a field or an attribute of the objects list, and the second one (optional) is a title that would be displayed. The previous snippet will be rendered like this in French:
<tr>
<th><a href="/path/to/your/view/?sort=first_name" title="Nom">Nom</a></th>
<th><a href="/path/to/your/view/?sort=creation_date" title="Création">Création</a></th>
</tr>
An optional 3rd argument allows you to sort first by descending
(e.g. show most recent dates first) {% anchor some_date _("Date") desc %}
If your application doesn't support internationalization, you can use a
simple {% anchor first_name Name %}
.
Define the environment in the TEMPLATES
options:
TEMPLATES = {
{
"BACKEND": "django.template.backends.jinja2.Jinja2",
"DIRS": [],
"APP_DIRS": True,
"OPTIONS": {
"environment": "testproj.testapp.jinja2.env.JinjaEnvironment",
},
},
]
Your environment file should add sorting_anchor
and sort_queryset
to globals:
from jinja2.environment import Environment
from webstack_django_sorting.jinja2_globals import sorting_anchor, sort_queryset
class JinjaEnvironment(Environment):
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.globals["sorting_anchor"] = sorting_anchor
self.globals["sort_queryset"] = sort_queryset
Now, you can generate header links to sort your queryset.
<tr>
<th>{{ sorting_anchor(request, "created_on", "Date") }}</th>
<!--...-->
<tr>
The queryset should be wrapped with sort_queryset
to use the GET request arguments for sorting:
{% for secret_file in sort_queryset(request, secret_files) %}
<!--...-->
{% endfor %}
That's it!
The library provides a few settings that you can define in the Django settings of your project:
DEFAULT_SORT_UP
, the HTML character to display the up symbol in the column headers (' ↑' by default).DEFAULT_SORT_DOWN
, the HTML character to display the down symbol in the column headers (' ↓' by default).SORTING_INVALID_FIELD_RAISES_404
, if true, a 404 response will be returned on invalid use of query parameters (false by default).FAQs
Easy sorting of tables with Django
We found that webstack-django-sorting demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.