Skip to main content

Better ArrayField widget for admin

Project description

Django better admin ArrayField

image

Actions Status

image

Better ArrayField widget for admin

Supported Python versions: Python 3.5 Python 3.6 Python 3.7 Python 3.8

Supported Django versions: 2.0, 2.1, 2.2, 3.0, 3.1

might work with different django/python versions as well but I did not test that.

It changes comma separated widget to list based in admin panel.

Before: Alt text

After: Alt text

Quickstart

Install Django better admin ArrayField:

pip install django-better-admin-arrayfield

Add it to your `INSTALLED_APPS`:

INSTALLED_APPS = (
    ...
    'django_better_admin_arrayfield',
    ...
)

Usage

django_better_admin_arrayfield.models.fields.ArrayField is a drop-in replacement for standard Django ArrayField.

Import it like below and use it in your model class definition.

from django_better_admin_arrayfield.models.fields import ArrayField

Import DynamicArrayMixin like below

from django_better_admin_arrayfield.admin.mixins import DynamicArrayMixin

In your admin class add DynamicArrayMixin: ...

class MyModelAdmin(admin.ModelAdmin, DynamicArrayMixin):

That's it.

Custom subwidget

By default the subwidget (the one used for each item in the array) will be TextInput. If you want something else, you can use your own specifying it in the formfield_overrides of your Admin model:

class MyWidget(DynamicArrayWidget):
    def __init__(self, *args, **kwargs):
        kwargs['subwidget_form'] = MyForm
        super().__init__(*args, **kwargs)

class MyModelAdmin(models.ModelAdmin, DynamicArrayMixin):
    ...
    formfield_overrides = {
        DynamicArrayField: {'widget': MyWidget},
    }

If you wanted to have Textarea as the subwidget, you can simply use the included drop-in widget replacement:

from django_better_admin_arrayfield.forms.widgets import DynamicArrayTextareaWidget

class MyModelAdmin(models.ModelAdmin, DynamicArrayMixin):
    ...
    formfield_overrides = {
        DynamicArrayField: {'widget': DynamicArrayTextareaWidget},
    }

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Pre-commit hooks

Install pre-commit black hook

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements_dev.txt
(myenv) $ pre-commit install

Credits

Inspired by: https://stackoverflow.com/a/49370480/4638248

Tools used in rendering this package:

History

1.4.2 (2020-12-08)

  • Adjust template to better match django style

1.4.1 (2020-12-08)

  • Allow submitting empty array field

1.4.0 (2020-10-04)

  • allow choosing subwidget for DynamicArrayWidget

1.3.0 (2020-07-09)

  • Handle default values in form field

1.2.1 (2020-07-09)

  • Fix tests requirements

1.2.0 (2020-07-09)

  • handle default values in model fields

1.1.0 (2020-04-28)

  • Add spanish translations

1.0.7 (2020-04-27)

  • Add possibility to i18n strings

1.0.6 (2020-04-15)

  • Remove debugging print statements
  • use default_app_config for easier integration
  • Support dynamically-added inline forms

1.0.5 (2019-12-30)

  • Add python 3.8 and Django 3.0 to tests

1.0.4 (2019-09-02)

  • Can add item after removing everything from the list

1.0.3 (2019-09-02)

  • Can add item after removing everything from the list
  • Do not call static at startup time

1.0.2 (2019-04-03)

  • If field is required empty list raises ValidationError on clean.

1.0.1 (2019-02-23)

  • Empty list is no longer recognized as changed.

1.0.0 (2019-02-21)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-better-admin-arrayfield-1.4.2.tar.gz (13.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page