Let model extensions define new fields #1774

Merged

hansegucker merged 7 commits from feature/extensible-models into master

2020-01-19 11:31:28 +01:00

nik commented

2020-01-18 23:39:27 +01:00

Owner

This MR extends the ExtensibleModel to accept fields in addition to properties and methods. It leverages django-jsonstore in order to aggregate those fields in one extended_data JSONField, so as to not need migrations when apps add additional fields. Apps should use this feature sparsely, and for more complex additions, add their own model with a ForeignKey instead.

The following example put in model_extensions.py of an app adds a field for the t-shirt size of a person:

from jsonstore import CharField

from .models import Person


Person.field(shirt_size=CharField(verbose_name="T-Shirt size", default="7XL"))

The fields are transparent to all known parts of Django. They are accessed like any other field, and even automagically show up in forms or a ModelAdmin:

Filtering on JSONField is fully supported.

Advances #141.

This MR extends the `ExtensibleModel` to accept fields in addition to properties and methods. It leverages `django-jsonstore` in order to aggregate those fields in one `extended_data` `JSONField`, so as to not need migrations when apps add additional fields. Apps should use this feature sparsely, and for more complex additions, add their own model with a `ForeignKey` instead. The following example put in `model_extensions.py` of an app adds a field for the t-shirt size of a person: ``` from jsonstore import CharField from .models import Person Person.field(shirt_size=CharField(verbose_name="T-Shirt size", default="7XL")) ``` The fields are transparent to all known parts of Django. They are accessed like any other field, and even automagically show up in forms or a `ModelAdmin`: ![Skjermdump_fra_2020-01-18_23-28-48](/uploads/aadb0f56b3b0215f827c58e6644c8da2/Skjermdump_fra_2020-01-18_23-28-48.png) Filtering on `JSONField` is fully supported. Advances #141.

nik commented

2020-01-18 23:39:28 +01:00

Author

Owner

changed milestone to %"2.0a1"

nik commented

2020-01-18 23:53:44 +01:00

Author

Owner

changed the description

nik commented

2020-01-19 00:21:29 +01:00

Author

Owner

added 1 commit

445b1ca0 - Hide JSON field from forms and ModelAdmin by default

Compare with previous version

added 1 commit <ul><li>445b1ca0 - Hide JSON field from forms and ModelAdmin by default</li></ul> [Compare with previous version](/AlekSIS/AlekSIS/merge_requests/129/diffs?diff_id=1164&start_sha=7083b335f00aa8db460e7a92f8bfab480f09ea4b)

nik commented

2020-01-19 00:22:59 +01:00

Author

Owner

added 1 commit

f041ec8d - Fix typo

Compare with previous version

added 1 commit <ul><li>f041ec8d - Fix typo</li></ul> [Compare with previous version](/AlekSIS/AlekSIS/merge_requests/129/diffs?diff_id=1165&start_sha=445b1ca0a528b1df23a5e4fecaaf9aed4ed9c9a8)

nik commented

2020-01-19 09:28:35 +01:00

Author

Owner

added 1 commit

9d866ef4 - Hide JSON field from forms and ModelAdmin by default

Compare with previous version

added 1 commit <ul><li>9d866ef4 - Hide JSON field from forms and ModelAdmin by default</li></ul> [Compare with previous version](/AlekSIS/AlekSIS/merge_requests/129/diffs?diff_id=1166&start_sha=f041ec8d0b361c457bbc2fd4a0ae8d9bf994e9fe)