`DataclassJSONField` implementation #77

ghost · 2022-11-07T22:17:54Z

as discussed in #75

WIP WIP WIP

Example

@dataclass
class MyDataclass(JsonSchemaMixin):
    id: int
    whatever: str


class MyModel(TimestampedModel):
    single = DataclassJSONField(MyDataclass, null=True)
    many = DataclassJSONField(MyDataclass, many=True, blank=True, default=list)

In [1]: m = MyModel.objects.first()

In [2]: m.single
Out[2]: MyDataclass(id=123, whatever='123')

In [3]: m.many
Out[3]: [MyDataclass(id=123, whatever='123'), MyDataclass(id=456, whatever='456')]

In [4]: m.single.whatever='hello'

In [5]: m.many[0].whatever='world'

In [6]: m.many.pop()
Out[6]: MyDataclass(id=456, whatever='456')

In [7]: m.save()

In [8]: m = MyModel.objects.first()

In [9]: m.single
Out[9]: MyDataclass(id=123, whatever='hello')

In [10]: m.many
Out[10]: [MyDataclass(id=123, whatever='world')]

ghost · 2022-11-07T22:18:13Z

django_jsonform/models/fields.py

@@ -24,6 +24,8 @@ class DjangoArrayField:


 class JSONField(DjangoJSONField):
+    form_class = JSONFormField


so it's overridable

ghost · 2022-11-07T22:21:20Z

django_jsonform/contrib/dataclasses/models/fields.py

+        self,
+        dataclass_cls: Type[DataclassJsonSchema],
+        *,
+        many: bool = False,


This many convention comes from Django Rest Framework

But we can consider making this a DataclassArrayJSONField instead

I'm going to leave this decision up to you. I'm not familiar with the dataclasses-jsonschema library. So, whatever you think works best, we can go with that.

ghost · 2022-11-07T22:21:36Z

django_jsonform/contrib/dataclasses/README.md

@@ -0,0 +1,3 @@
+# `django_jsonform.contrib.dataclasses`
+
+**Status:** experimental


ghost · 2022-11-07T22:22:53Z

django_jsonform/contrib/dataclasses/utils.py

+import dataclasses
+from typing import Type
+
+from dataclasses_jsonschema import JsonSchemaMixin


I don't think we should add this as a dependency to this project.

Need to research how to make this contrib module optional.

Maybe removing the contrib/__init__,py would work?

This is okay.

To make it an optional dependency, please modify the setup.cfg file and add this at the end:

+ + [options.extras_require] + contrib-dataclasses = dataclasses-jsonschema

Users who wish to use this feature can install the dependencies by:

pip install "django-jsonform[contrib-dataclasses]"

ghost · 2022-11-08T15:54:59Z

@bhch , I'm unsure if this should become it's own package django-dataclass-field. Thoughts?

bhch

I'm unsure if this should become it's own package django-dataclass-field. Thoughts?

Maybe.

If the goal is to have a dataclass interface to work with json data, why can't we write a function (or a method on JSONField) to convert the json data to a dataclass?

def json_to_dataclass(json_data, dataclass):
    return dataclass_instance

We can also accept a dataclass for the schema argument. And then do the conversions internally.

Anyway, I've reviewed the changes and left some comments.

bhch · 2022-11-08T07:35:30Z

django_jsonform/contrib/dataclasses/utils.py

+import dataclasses
+from typing import Type
+
+from dataclasses_jsonschema import JsonSchemaMixin


This is okay.

To make it an optional dependency, please modify the setup.cfg file and add this at the end:

+ + [options.extras_require] + contrib-dataclasses = dataclasses-jsonschema

Users who wish to use this feature can install the dependencies by:

pip install "django-jsonform[contrib-dataclasses]"

bhch · 2022-11-08T07:39:19Z

django_jsonform/contrib/dataclasses/utils.py

+
+    schema["type"] = "array"
+    schema["description"] = f"An array of {dataclass_cls.__name__} objects."
+    del schema["required"]


The code example in your comment above gives me KeyError: 'required'. Perhaps use this instead:

Suggested change

del schema["required"]

schema.pop("required", None)

bhch · 2022-11-08T12:26:10Z

django_jsonform/contrib/dataclasses/utils.py

+    schema["type"] = "array"
+    schema["description"] = f"An array of {dataclass_cls.__name__} objects."
+    del schema["required"]
+    schema["items"] = schema["properties"]["item"]


Line 21 also results in a KeyError: 'item'.

Hmm.. This shouldn't be happening.

What Python and dataclasses-jsonschema versions are you using?

Python: 3.8

dataclasses-jsonschema: 2.16.0

I'm using dataclasses-jsonschema[fast-validation]==2.16.0 and Python 3.10

Will have to try 3.8 later (or make a separate package and drop support for older versions)

I noticed you're supporting a lot of older Django versions too. I only tested with Django==4.1.3

Just tested with Python 3.10 and Django 4.1.3. Everything works fine this time.

bhch · 2022-11-08T12:27:54Z

django_jsonform/contrib/dataclasses/models/fields.py

+        self,
+        dataclass_cls: Type[DataclassJsonSchema],
+        *,
+        many: bool = False,


I'm going to leave this decision up to you. I'm not familiar with the dataclasses-jsonschema library. So, whatever you think works best, we can go with that.

dongyuzheng · 2022-11-11T16:47:46Z

FYI: I am @ghost. I had to delete my other account for logistics reasons.

I'm starting to lean towards making a separate package because I don't have time to investigate and support older Python/Django versions.

My next step is to fix the "required" fields, because on Admin, I can't submit empty for fields like x: int | None

dongyuzheng · 2022-11-11T16:59:04Z

@bhch does your library support json schema with anyOf? https://stackoverflow.com/questions/35450405/how-to-represent-sum-union-types-in-in-json-schema

Edit:

Looks like No. It fails here

bhch · 2022-11-11T17:10:44Z

Currently, anyOf doesn't work but it will be added (#39). I can't seem to come up with a good approach to create forms for anyOf/allOf/oneOf.

I'm starting to lean towards making a separate package because I don't have time to investigate and support older Python/Django versions.

That's understandable. I'd like to avoid breaking changes until the next major release (v3).

dongyuzheng · 2022-11-11T18:51:36Z

Another question @bhch , I noticed that the Django admin form sends Empty String for empty integer field, rather than null

I know this is probably because it's hard to tell the difference between null and no input and empty string.

One thing Swagger UI does is they have a tick box [] Send empty value to indicate sending a null.

Thoughts on adding this to the Form?

bhch · 2022-11-11T19:02:00Z

@dongyuzheng Okay, I'll add something similar to that. I've just created an issue for this: #78

Gary Zheng added 10 commits November 7, 2022 13:28

Start contrib.dataclasses folder

74986c4

basic DataclassJSONField without serdes

d8471d7

lint

58159b5

copy paste base functions

ac574a2

python side working

ecad317

lint

f7f66a0

move utils file, disable validation for now

cbf4141

disable validate on db rw

f36a11d

validation and cleanup

35472be

add validator for blank

b0c7f51

ghost commented Nov 7, 2022

View reviewed changes

django_jsonform/contrib/dataclasses/README.md

@@ -0,0 +1,3 @@

# `django_jsonform.contrib.dataclasses`

**Status:** experimental

Copy link

Author

ghost Nov 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO

ghost commented Nov 7, 2022

View reviewed changes

add deconstruct

b3434ad

ghost marked this pull request as ready for review November 7, 2022 22:42

bhch reviewed Nov 8, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`DataclassJSONField` implementation #77

`DataclassJSONField` implementation #77

ghost commented Nov 7, 2022 •

edited by ghost

ghost Nov 7, 2022

ghost Nov 7, 2022

bhch Nov 8, 2022

ghost Nov 7, 2022

ghost Nov 7, 2022

bhch Nov 8, 2022

ghost commented Nov 8, 2022

bhch left a comment

bhch Nov 8, 2022

bhch Nov 8, 2022

bhch Nov 8, 2022 •

edited

ghost Nov 8, 2022

bhch Nov 8, 2022

ghost Nov 8, 2022

bhch Nov 9, 2022

bhch Nov 8, 2022

dongyuzheng commented Nov 11, 2022 •

edited

dongyuzheng commented Nov 11, 2022 •

edited

bhch commented Nov 11, 2022 •

edited

dongyuzheng commented Nov 11, 2022

bhch commented Nov 11, 2022

		@@ -24,6 +24,8 @@ class DjangoArrayField:


		class JSONField(DjangoJSONField):
		form_class = JSONFormField

		@@ -0,0 +1,3 @@
		# `django_jsonform.contrib.dataclasses`

		Status: experimental

DataclassJSONField implementation #77

Are you sure you want to change the base?

DataclassJSONField implementation #77

Conversation

ghost commented Nov 7, 2022 • edited by ghost

WIP WIP WIP

Example

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Nov 8, 2022

bhch left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bhch Nov 8, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dongyuzheng commented Nov 11, 2022 • edited

dongyuzheng commented Nov 11, 2022 • edited

bhch commented Nov 11, 2022 • edited

dongyuzheng commented Nov 11, 2022

bhch commented Nov 11, 2022

`DataclassJSONField` implementation #77

`DataclassJSONField` implementation #77

ghost commented Nov 7, 2022 •

edited by ghost

bhch Nov 8, 2022 •

edited

dongyuzheng commented Nov 11, 2022 •

edited

dongyuzheng commented Nov 11, 2022 •

edited

bhch commented Nov 11, 2022 •

edited