and3rson / django-searchable-select Goto Github PK

View Code? Open in Web Editor NEW

107.0 8.0 29.0 117 KB

A better and faster multiple selection widget with suggestions

License: MIT License

Python 69.15% CSS 10.67% JavaScript 18.00% HTML 2.18%

django widget django-searchable-select choice python

django-searchable-select's Introduction

django-searchable-select

A better and faster multiple selection widget with suggestions for Django

This project is looking for maintainers!

Please open an issue to request write access.

What is this?

This plugin provides a replacement for standard multi-choice select on Django admin pages.

You can use this as custom widget for ManyToManyField.

Features

Filtering is performed on server side and thus significantly improves performance.
Uses Twitter Typeahead to provide suggestion completion.
Works great with ManyToMany fields that can be chosen from thousands of thousands of choices, e. g. User - City relations.

Before

After

Installation

Install django-searchable-select.
```
$ pip install django-searchable-select
```

Add 'searchableselect' to your settings.

# settings.py

INSTALLED_APPS = (
    # ...
    'searchableselect',
    # ...
)

Add URL pattern required for the suggesting engine to your root urls.py.

# urls.py

urlpatterns = patterns(
    '',
    # ...
    url('^searchableselect/', include('searchableselect.urls')),
    # ...
)

Use the widget in your model admin class:

from django import models, forms
from searchableselect.widgets import SearchableSelect
from models import Traveler

class TravelerForm(forms.ModelForm):
    class Meta:
        model = Traveler
        exclude = ()
        widgets = {
            'cities_visited': SearchableSelect(model='cities.City', search_field='name', many=True, limit=10)
        }


class TravelerAdmin(admin.ModelAdmin):
    form = TravelerForm

admin.site.register(Traveler, TravelerAdmin)

Remember to always initialize SearchableSelect with three keyword arguments: model, search_field and many.

model is the string in form APP_NAME.MODEL_NAME representing your model in the project, e. g. 'cities.City'
search_field is the field within model that will be used to perform filtering, e. g. 'name'
many must be True for ManyToManyField and False for ForeignKey.
limit (optional) specifies the maximum count of entries to retrieve.

Example app

Just run the project from example directory, head to http://127.0.0.1:8000, login as admin/admin and try adding Cats!

Supported versions

Python 2.7.x: Django 1.7, 1.8, 1.9, 1.10
Python 3.x: Django 1.8, 1.9, 1.10, 2.0

Testing

In order to support multiple Django and Python versions we use:

py.test - test runner
tox - handy tool to test app with different versions of Pythons & libraries
selenium
coverage

Install them via pip install -r requirements/dev.txt

To test things in specific environment, run the following commands:

# Clear previous coverage data.
coverage erase

# This command can be ran multiple times.
tox -e <python_ver>-<django_ver>
# Possible python_ver values: `py27`, `py36`
# Possible django_ver values: `17`, `18`, `19`, `110`, '20'
# Values can be comma-separated, e. g. `-e py27-17,py27-18,py36-18`
# If you omit `-e ...` parameter, all environments will be tests.
# Also - not problems with running this within a virtualenv.
# Check tox.ini for these values.

# Run this once all tests passed on all environment.
coverage combine

# Render HTML with coverage info.
coverage html
# ...or simply display % of covered SLOC for each file.
coverage report

To add a new Django version for testing, add it into tox.ini, lines 3-4.

Why do we need tox and coverage combine? Because different versions of Python & libraries lead to different code execution: for example, consider this code:

import sys
if sys.version_info.major == 2:
    foo = 'spam'  # Not covered in Python 3.x, leads to coverage < 100%
else:
    foo = 'eggs'  # Not covered in Python 2.x, leads to coverage < 100%

Using tox and coverage combine we're able to "merge" coverage info from across different environments.

Known issues

Not tested with empty fields.
Tests sometimes fail randomly due to some Selenium timeout issue. Weird.

Contributing

I'm looking forward to bug reports and any kind of contribution.

License

You are free to use this where you want as long as you keep the author reference. Please see LICENSE for more info.

django-searchable-select's People

Contributors

Stargazers

Watchers

django-searchable-select's Issues

make it possible to customize widget

@and3rson haven't checked yet but it seems that it is not supporting attrs that other widgets have.

It would be very helpful I think

Front end integration

Is there support for front end integration ? It seems it doesn't have.

Is Django 1.11 supported on Python 2.7?

I wonder if this project supports Django 1.11 on Python 2.7 since I can't find this combination in supported versions section of the README file.

How to filter with ForienKey field


Class Model(model.Models):
      city = models.CharField()
      country = models.ForeignKey(Country)

      def __str__(self):
             return '{0}'.format(self.city)

Here i want to filter with country
Please help me

support multiple search fields

@and3rson I think it would be great if

widgets = {
    'user': SearchableSelect(model='users.User',
                             search_field='email',
                             many=False, limit=10),
}

will be

widgets = {
    'user': SearchableSelect(model='users.User',
                             search_field=['email', 'first_name', 'last_name'],
                             many=False, limit=10),
}

If you agree I will make it.

Integration with Add related record (+)

Hello,

I noticed on the homepage readme you also have the (+) button. Right now it just inserts the unique ID into the form field and that's it. Is there any way to have it automatically create the relationship + tag view ?

No updated release to reflect the added render=None argument

The render=None fix has been made, but there has not been an updated release to resolve this problem.

Can this be used for Model forms outside admin?

Hello. Could this be used for model forms outside the admin app? Thanks!

error occurs when unicode search

error log:

Internal Server Error: /searchableselect/filter
Traceback (most recent call last):
  File "C:\Anaconda3\envs\djangoadmin2\lib\site-packages\django\core\handlers\exception.py", line 39, in inner
    response = get_response(request)
  File "C:\Anaconda3\envs\djangoadmin2\lib\site-packages\django\core\handlers\base.py", line 249, in _legacy_get_response
    response = self._get_response(request)
  File "C:\Anaconda3\envs\djangoadmin2\lib\site-packages\django\core\handlers\base.py", line 187, in _get_response
    response = self.process_exception_by_middleware(e, request)
  File "C:\Anaconda3\envs\djangoadmin2\lib\site-packages\django\core\handlers\base.py", line 185, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
  File "C:\Anaconda3\envs\djangoadmin2\lib\site-packages\django\contrib\auth\decorators.py", line 23, in _wrapped_view
    return view_func(request, *args, **kwargs)
  File "C:\Anaconda3\envs\djangoadmin2\lib\site-packages\searchableselect\views.py", line 25, in filter_models
    in values
  File "C:\Anaconda3\envs\djangoadmin2\lib\site-packages\searchableselect\views.py", line 24, in <listcomp>
    for value
NameError: name 'unicode' is not defined

change

dict(pk=value.pk, name=unicode(value))

from django.utils.encoding import smart_str
... ...
dict(pk=value.pk, name=smart_str(value))

will be ok.

What if I want to narrow the options within the select?

Let's an author can only select the post that belongs to he/she.

How could this be done?

can't use with django 1.10

File "[...edited...] /site-packages/searchableselect/widgets.py", line 2, in <module>
from django.db.models.loading import get_model

ImportError: No module named 'django.db.models.loading'

After fixing this import following this approach, other import errors will appair. Apparently many things moved arround in Django.

Not able to render in django 1.11

Below is the error I got in django 1.11, however I worked fine in 1.10, Can you please point me from where the error i am getting, so that I can try to fix it?

Traceback (most recent call last):
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/core/handlers/exception.py", line 41, in inner
    response = get_response(request)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/core/handlers/base.py", line 217, in _get_response
    response = self.process_exception_by_middleware(e, request)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/core/handlers/base.py", line 215, in _get_response
    response = response.render()
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/response.py", line 107, in render
    self.content = self.rendered_content
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/response.py", line 84, in rendered_content
    content = template.render(context, self._request)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/backends/django.py", line 66, in render
    return self.template.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 207, in render
    return self._render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/test/utils.py", line 107, in instrumented_test_render
    return self.nodelist.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/loader_tags.py", line 177, in render
    return compiled_parent._render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/test/utils.py", line 107, in instrumented_test_render
    return self.nodelist.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/loader_tags.py", line 177, in render
    return compiled_parent._render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/test/utils.py", line 107, in instrumented_test_render
    return self.nodelist.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/loader_tags.py", line 177, in render
    return compiled_parent._render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/test/utils.py", line 107, in instrumented_test_render
    return self.nodelist.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/loader_tags.py", line 72, in render
    result = block.nodelist.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/loader_tags.py", line 72, in render
    result = block.nodelist.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/defaulttags.py", line 216, in render
    nodelist.append(node.render_annotated(context))
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/loader_tags.py", line 216, in render
    return template.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 209, in render
    return self._render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/test/utils.py", line 107, in instrumented_test_render
    return self.nodelist.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/defaulttags.py", line 216, in render
    nodelist.append(node.render_annotated(context))
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/defaulttags.py", line 216, in render
    nodelist.append(node.render_annotated(context))
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/loader_tags.py", line 216, in render
    return template.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 209, in render
    return self._render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/test/utils.py", line 107, in instrumented_test_render
    return self.nodelist.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/defaulttags.py", line 216, in render
    nodelist.append(node.render_annotated(context))
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/defaulttags.py", line 216, in render
    nodelist.append(node.render_annotated(context))
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/defaulttags.py", line 322, in render
    return nodelist.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/defaulttags.py", line 322, in render
    return nodelist.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 1046, in render
    return render_value_in_context(output, context)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/template/base.py", line 1024, in render_value_in_context
    value = force_text(value)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/utils/encoding.py", line 78, in force_text
    s = six.text_type(s)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/utils/html.py", line 376, in <lambda>
    klass.__unicode__ = lambda self: mark_safe(klass_unicode(self))
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/forms/boundfield.py", line 41, in __str__
    return self.as_widget()
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/forms/boundfield.py", line 120, in as_widget
    **kwargs
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/forms/widgets.py", line 220, in render
    context = self.get_context(name, value, attrs)
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/django/contrib/admin/widgets.py", line 281, in get_context
    'rendered_widget': self.widget.render(name, value, attrs),
  File "/Users/sheeshmohsin/envdashboard/lib/python2.7/site-packages/searchableselect/widgets.py", line 55, in render
    final_attrs = self.build_attrs(attrs, name=name)
TypeError: build_attrs() got an unexpected keyword argument 'name'

some fields have no value so only blue rectangle is displayed

ImportError: cannot import name 'url' from 'django.conf.urls' on Django 4.0

I discovered your project today while researching some stuff and tried to include it into my project. This failed as Django 4.0 removed the django.conf.urls.url method which had been deprecated in Django 3.0.

For this reason I am currently using a workaround in my urls.py file:

from django.urls import path, include
from searchableselect.views import filter_models as searchable_select_filter_models

urlpatterns = [
    # Original solution does not work for Django 4.0.
    # path("searchableselect/", include("searchableselect.urls")),
    path(
        "searchable-select/",
        searchable_select_filter_models,
        name="searchable-select-filter",
    ),
]

As far as I have seen, the other functionality seems to work with Django 4.0.

nesting like user__first_name

@and3rson I think it would be great if

widgets = {
    'user': SearchableSelect(model='users.User',
                             search_field='email',
                             many=False, limit=10),
}

will be

widgets = {
    'user': SearchableSelect(model='users.Student',
                             search_field=['user__email', 'user__first_name', 'user__last_name'],
                             many=False, limit=10),
}

If you agree I will make it.

A maximum of 5 selections are listed for a foreign key.

Although views.filter_models limits the result to 10 items, only 5 show up in the selection. I've changed the array slice from 10 to 30 items (for example) but still only see 5. I added a print() statement to verify that I'm actually retrieving more than 5 items in filter_models.

My assumption is that there's a limit somewhere within JQuery or elsewhere but I don't know where it is/can't find it.

It would be better if there were a parameter to limit the results rather than the hard coded array slice value, especially since there seems to be another limit elsewhere.

Django 1.10.5
Problem occurs in both Safari 10.0.3 and Chrome 56.0.2924.87 (64-bit) on macOS 10.12.3.

NOTE: This is for a foreign key (with ~76k rows).

render() got an unexpected keyword argument 'renderer'

The error information:

Request Method:	GET
http://127.0.0.1:8000/order/form/
2.1.10
TypeError
render() got an unexpected keyword argument 'renderer'
C:\my_env_python\django\lib\site-packages\django\forms\boundfield.py in as_widget, line 93
C:\my_env_python\django\Scripts\python.exe
3.6.5

the code:

project=forms.ModelChoiceField(Project.objects.filter(is_active=True),
                                   widget=SearchableSelect(model='projectmanagement.Project',search_field='project__name',many=False,limit=1))

I have tried to test the first using SearchableSelect for many days, but it always happen this error.

Internal Server Error: /order/form/
Traceback (most recent call last):
File "C:\my_env_python\django\lib\site-packages\django\core\handlers\exception.py", line 34, in inner
response = get_response(request)
File "C:\my_env_python\django\lib\site-packages\django\core\handlers\base.py", line 156, in _get_response
response = self.process_exception_by_middleware(e, request)
File "C:\my_env_python\django\lib\site-packages\django\core\handlers\base.py", line 154, in _get_response
response = response.render()
File "C:\my_env_python\django\lib\site-packages\django\template\response.py", line 106, in render
self.content = self.rendered_content
File "C:\my_env_python\django\lib\site-packages\django\template\response.py", line 83, in rendered_content
content = template.render(context, self._request)
File "C:\my_env_python\django\lib\site-packages\django\template\backends\django.py", line 61, in render
return self.template.render(context)
File "C:\my_env_python\django\lib\site-packages\django\template\base.py", line 171, in render
return self._render(context)
File "C:\my_env_python\django\lib\site-packages\django\template\base.py", line 163, in _render
return self.nodelist.render(context)
File "C:\my_env_python\django\lib\site-packages\django\template\base.py", line 937, in render
bit = node.render_annotated(context)
File "C:\my_env_python\django\lib\site-packages\django\template\base.py", line 904, in render_annotated
return self.render(context)
File "C:\my_env_python\django\lib\site-packages\django\template\loader_tags.py", line 150, in render
return compiled_parent._render(context)
File "C:\my_env_python\django\lib\site-packages\django\template\base.py", line 163, in _render
return self.nodelist.render(context)
File "C:\my_env_python\django\lib\site-packages\django\template\base.py", line 937, in render
bit = node.render_annotated(context)
File "C:\my_env_python\django\lib\site-packages\django\template\base.py", line 904, in render_annotated
return self.render(context)
File "C:\my_env_python\django\lib\site-packages\django\template\loader_tags.py", line 62, in render
result = block.nodelist.render(context)
File "C:\my_env_python\django\lib\site-packages\django\template\base.py", line 937, in render
bit = node.render_annotated(context)
File "C:\my_env_python\django\lib\site-packages\django\template\base.py", line 904, in render_annotated
return self.render(context)
File "C:\my_env_python\django\lib\site-packages\django\template\base.py", line 993, in render
return render_value_in_context(output, context)
File "C:\my_env_python\django\lib\site-packages\django\template\base.py", line 972, in render_value_in_context
value = str(value)
File "C:\my_env_python\django\lib\site-packages\django\utils\html.py", line 397, in
klass.str = lambda self: mark_safe(klass_str(self))
File "C:\my_env_python\django\lib\site-packages\django\forms\forms.py", line 142, in str
return self.as_table()
File "C:\my_env_python\django\lib\site-packages\django\forms\forms.py", line 284, in as_table
errors_on_separate_row=False,
File "C:\my_env_python\django\lib\site-packages\django\forms\forms.py", line 243, in _html_output
'field_name': bf.html_name,
File "C:\my_env_python\django\lib\site-packages\django\utils\html.py", line 397, in
klass.str = lambda self: mark_safe(klass_str(self))
File "C:\my_env_python\django\lib\site-packages\django\forms\boundfield.py", line 33, in str
return self.as_widget()
File "C:\my_env_python\django\lib\site-packages\django\forms\boundfield.py", line 93, in as_widget
renderer=self.form.renderer,
TypeError: render() got an unexpected keyword argument 'renderer'

AttributeError: type object 'MyModel' has no attribute 'split'

Hey, I am not sure if I misunderstood the docs but when I add widgets = {'myfield': SearchableSelect(model='MyModel', search_field='myfield', many=True, limit=10)} to my form it throws this error. Any pointers would be highly appreciated 😄

search display 'Nothing found'

When I try to find an item on the field, nothing is found.
Django shows django.core.exceptions.FieldError: Related Field got invalid lookup: icontains
and the error seem to be at the line 27 on the view,
values = model.objects.filter(**{'{}__icontains'.format(search_field): value})[:limit]
I'm working with Django 2.0.1

multiple fields can be displayed while many=False

TypeError: unorderable types: str() >= int()

When I start typing it shows nothing found and the server gives the above error.