django-select2-forms 3.0.0

安装 pyenv

这些说明假设您已经安装了 Homebrew，但没有安装 pyenv。

brew install pyenv
touch ~/.bash_profile

将以下行添加到您的 ~/bash_profile 或 .zshrc

eval "$(pyenv init -)"

重新加载您的 shell

. ~/.bash_profile

或者

. ~/.zshrc

Python 仓库设置

首先，克隆仓库并准备您的 Python 环境

git clone https://github.com/theatlantic/django-select2-forms.git
pyenv install 3.7.2
pyenv install 3.8.0
pyenv install 3.9.0
pyenv local 3.7.2 3.8.0 3.9.0
python -V

前一个命令的输出应该是 Python 3.7.2。

最后

python -m venv venv

激活您的环境

从基本目录

deactivate  # ignore: -bash: deactivate: command not found
. venv/bin/activate
pip install -U tox

运行测试

如果您尚未这样做，请通过 chromedriver 设置您的环境

brew install --cask chromedriver

运行所有测试

tox -- --selenosis-driver=chrome-headless

显示所有可用的 tox 命令

tox -av

只运行特定的环境

tox -e <environment-name> -- --selenosis-driver=chrome-headless  # example: tox -e py37-django22

只运行特定的测试

tox -- pytest -k test_something --selenosis-driver=chrome-headless

在特定环境中运行任意命令

tox -e py37-django22 -- python  # runs the Python REPL in that environment

设置开发环境

tox -e <pyXX-DjangoYY> --develop -r
. .tox/<pyXX-DjangoYY>/bin/activate

select2.fields.ForeignKey 示例

在以下两个示例中，一个“条目”只与一个作者相关联。下面的示例不使用 AJAX，而是使用客户端的 autocomplete 过滤功能，通过 html <select> 中的 <option> 元素（标签来自 Author.__str__()）。

@python_2_unicode_compatible
class Author(models.Model):
    name = models.CharField(max_length=100)

    def __str__(self):
        return self.name

class Entry(models.Model):
    author = select2.fields.ForeignKey(Author,
        overlay="Choose an author...",
        on_delete=models.CASCADE)

此更高级的示例通过 AJAX 使用 Author.name 字段自动完成，并将自动完成搜索限制为 Author.objects.filter(active=True)

class Author(models.Model):
    name = models.CharField(max_length=100)
    active = models.BooleanField()

class Entry(models.Model):
    author = select2.fields.ForeignKey(Author,
        limit_choices_to=models.Q(active=True),
        ajax=True,
        search_field='name',
        overlay="Choose an author...",
        js_options={
            'quiet_millis': 200,
        },
        on_delete=models.CASCADE)

select2.fields.ManyToManyField 示例

在以下基本示例中，条目可以有多个作者。此示例不通过 AJAX 进行作者名称查找，而是使用 Author.__unicode__() 为标签填充 <option> 元素。

@python_2_unicode_compatible
class Author(models.Model):
    name = models.CharField(max_length=100)

    def __str__(self):
        return self.name

class Entry(models.Model):
    authors = select2.fields.ManyToManyField(Author)

以下“厨房水槽”示例允许对作者进行排序，并使用 AJAX 在作者名称的两个变体上自动完成。

from django.db import models
from django.db.models import Q
import select2.fields
import select2.models

class Author(models.Model):
    name = models.CharField(max_length=100)
    alt_name = models.CharField(max_length=100, blank=True, null=True)

class Entry(models.Model):
    categories = select2.fields.ManyToManyField(Author,
        through='EntryAuthors',
        ajax=True,
        search_field=lambda q: Q(name__icontains=q) | Q(alt_name__icontains=q),
        sort_field='position',
        js_options={'quiet_millis': 200})

表单字段示例

如果您不需要使用 django-select2-forms 的ajax功能，您可以在不修改模型的情况下在Django表单中使用select2。select2表单字段存在于 select2.fields 模块中，并且与它们的标准Django对应类具有相同的名称（ChoiceField、MultipleChoiceField、ModelChoiceField、ModelMultipleChoiceField）。上面的第一个 ForeignKey 示例，是用django表单字段完成的。

class AuthorManager(models.Manager):
    def as_choices(self):
        for author in self.all():
            yield (author.pk, force_text(author))

@python_2_unicode_compatible
class Author(models.Model):
    name = models.CharField(max_length=100)
    objects = AuthorManager()

    def __str__(self):
        return self.name

class Entry(models.Model):
    author = models.ForeignKey(Author, on_delete=models.CASCADE)

class EntryForm(forms.ModelForm):
    author = select2.fields.ChoiceField(
        choices=Author.objects.as_choices(),
        overlay="Choose an author...")

    class Meta:
        model = Entry