add support for django 3.1 JSONField #85

xi · 2020-07-20T14:08:41Z

see https://docs.djangoproject.com/en/3.1/releases/3.1/#jsonfield-for-all-supported-database-backends

berinhard

Hi @xi thanks for your PR!!! The code looks great but can I ask you for 2 improvements:

Can you fix the error raised by CI?
Can you add an unit test to ensure support for Django's JSONField? It should be very similar to the existing one for postgres' JSONField implementation.

If you have any questions, don't hesitate on pinging me for help =)

xi · 2020-07-20T16:29:50Z

Can you fix the error raised by CI?

Unfortunately I was not able to figure out what I need to change. The output only says that black would reformat a file, but not what it would change about that file. Running black locally did not result in the message.

Can you add an unit test to ensure support for Django's JSONField?

I pushed a test. I could not figure out how to run the tests locally so I am waiting for the results from CI.

berinhard

Thanks @xi for updating your PR!!! It was very useful no only because of the changes you're introducing, but also because it exposed for us a gap in our docs when it comes to code contributions (running tests, link, etc). We've opened #86 so future contributors won't have the same problems you had.

I think there are a few things preventing us from merging your PR:

Wait for Improve contributing instructions and utilitaries #86 to be merged so we can rely on the make lint command or the pre-commit hooks to make sure the code format is right;
Updates to the CHANGELOG.md;
Wait for the official Django 3.1 release to go live. For now it's still under the alpha version. Once we have it released, we'll be able to easily configure our tox.ini by adding the django31 dependency;

Thanks a lot!

xi · 2020-07-22T17:43:47Z

Updates to the CHANGELOG.md;

done

Wait for the official Django 3.1 release to go live.

Why wait? The change should be fully backwards compatible. (I am fine if you prefer waiting, I just wanted to make sure there is no misunderstanding)

see https://docs.djangoproject.com/en/3.1/releases/3.1/#jsonfield-for-all-supported-database-backends

berinhard

@xi I actually forgot to mention we were waiting to release the new 1.1.1 version.

Now I'm good with merging this in. @anapaulagomes or @amureki can take a look as well?

anapaulagomes

LGTM! 👍

amureki

👍

xi · 2020-07-22T20:45:58Z

I think I made a mistake when rebasing and the changelog entry is now in the wrong release (1.1.1). I won't be able to fix it until monday so maybe someone else could do it.

amureki · 2020-07-23T07:04:28Z

@xi oh, no worries, we missed this somehow. :) Good catch! I put a PR here: #92

snicoletbcg · 2020-08-20T11:59:32Z

Hi,
Thanks for this patch wich is eactly what i needed but i'm not sure this was correctly merged into 1.1.1 since i got the following error:

TypeError: <class 'django.db.models.fields.json.JSONField'> is not supported by baker.

also in baker.generators i've saw that:

try:
    from django.contrib.postgres.fields import JSONField
except ImportError:
    JSONField = None

xi · 2020-08-20T13:11:22Z

Hi @snicoletbcg. This patch is not yet included in 1.1.1. You will have to wait for the next release.

In the meantime you could use this workaround:

from django.contrib.postgres.fields import JSONField as PostgresJSONField
from django.db.models import JSONField
from model_bakery import baker

baker.generators.add(
    JSONField, baker.generators.default_mapping[PostgresJSONField]
)

snicoletbcg · 2020-08-20T14:11:00Z

Hi @xi ,
thank you for your answer,
i've put

model_bakery = { git = "https://github.com/model-bakers/model_bakery.git", rev = "06c9fd8" }

into my pyproject.toml (poetry) and it worked perfectly (maybe it can help someone else)

and then

poetry update

it worked fine, thank you again

israelst

I have suggested an import fixing at #106

israelst · 2020-09-21T12:29:59Z

tests/generic/models.py

@@ -89,7 +89,16 @@ class Person(models.Model):
    id_document = models.CharField(unique=True, max_length=10)

    try:
-        from django.contrib.postgres.fields import ArrayField, HStoreField, JSONField
+        from django.models import JSONField


I guess the correct import is django.db.models, isn't it?

israelst · 2020-09-21T12:30:14Z

tests/test_filling_fields.py

@@ -19,14 +19,19 @@
 from model_bakery.random_gen import gen_related
 from tests.generic import generators, models

+try:
+    from django.models import JSONField


I guess the correct import is django.db.models, isn't it?

berinhard requested changes Jul 20, 2020

View reviewed changes

xi force-pushed the add-cross-db-json-field branch from 8d56ec4 to 401bc99 Compare July 20, 2020 16:25

berinhard mentioned this pull request Jul 21, 2020

Improve contributing instructions and utilitaries #86

Merged

berinhard requested changes Jul 22, 2020

View reviewed changes

xi force-pushed the add-cross-db-json-field branch from 401bc99 to 1825192 Compare July 22, 2020 17:40

xi force-pushed the add-cross-db-json-field branch from 1825192 to 7787ecb Compare July 22, 2020 17:47

add support for django 3.1 JSONField

234f90a

see https://docs.djangoproject.com/en/3.1/releases/3.1/#jsonfield-for-all-supported-database-backends

xi force-pushed the add-cross-db-json-field branch from 7787ecb to 234f90a Compare July 22, 2020 18:04

berinhard approved these changes Jul 22, 2020

View reviewed changes

anapaulagomes approved these changes Jul 22, 2020

View reviewed changes

amureki approved these changes Jul 22, 2020

View reviewed changes

berinhard merged commit d696a57 into model-bakers:master Jul 22, 2020

amureki pushed a commit that referenced this pull request Jul 23, 2020

Fix changelog for 1.1.1 (refs #85)

ef725a8

berinhard pushed a commit that referenced this pull request Jul 24, 2020

Fix changelog for 1.1.1 (refs #85) (#92)

2dada1f

israelst reviewed Sep 21, 2020

View reviewed changes

marcosschroh mentioned this pull request Jul 11, 2023

TypeError: <class 'jsonfield.fields.JSONField'> is not supported by baker. #425

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add support for django 3.1 JSONField #85

add support for django 3.1 JSONField #85

xi commented Jul 20, 2020

berinhard left a comment

xi commented Jul 20, 2020

berinhard left a comment •

edited

Loading

xi commented Jul 22, 2020

berinhard left a comment •

edited

Loading

anapaulagomes left a comment

amureki left a comment

xi commented Jul 22, 2020

amureki commented Jul 23, 2020

snicoletbcg commented Aug 20, 2020

xi commented Aug 20, 2020 •

edited

Loading

snicoletbcg commented Aug 20, 2020

israelst left a comment

israelst Sep 21, 2020

israelst Sep 21, 2020

add support for django 3.1 JSONField #85

add support for django 3.1 JSONField #85

Conversation

xi commented Jul 20, 2020

berinhard left a comment

Choose a reason for hiding this comment

xi commented Jul 20, 2020

berinhard left a comment • edited Loading

Choose a reason for hiding this comment

xi commented Jul 22, 2020

berinhard left a comment • edited Loading

Choose a reason for hiding this comment

anapaulagomes left a comment

Choose a reason for hiding this comment

amureki left a comment

Choose a reason for hiding this comment

xi commented Jul 22, 2020

amureki commented Jul 23, 2020

snicoletbcg commented Aug 20, 2020

xi commented Aug 20, 2020 • edited Loading

snicoletbcg commented Aug 20, 2020

israelst left a comment

Choose a reason for hiding this comment

israelst Sep 21, 2020

Choose a reason for hiding this comment

israelst Sep 21, 2020

Choose a reason for hiding this comment

berinhard left a comment •

edited

Loading

berinhard left a comment •

edited

Loading

xi commented Aug 20, 2020 •

edited

Loading