Key validation in DictionaryField

Question

Key validation in DictionaryField

Sibyx opened this issue 4 years ago · comments

Jakub Dubec commented 4 years ago

I think, it will be very nice to have possibility to define a form field for the dictionary key in DictionaryField.

harlansgs · Answer 1 · Tue Oct 13 2020 06:33:53 GMT+0800 (China Standard Time)

What would constitute an invalid key?

Jakub Dubec · Answer 2 · Tue Oct 13 2020 06:54:44 GMT+0800 (China Standard Time)

@harlansgs Hi, I am thinking of possibility to do something like this:

Example request

{
  "my_typed_dict": {
    "b061bb03-1eaa-47d0-948f-3ce1f15bf3bb": 2.718,
    "0a8912f0-6c10-4505-bc27-bbb099d2e395": 42
  }
}

Example form

class AlbumForm(Form):
    my_typed_dict = DictionaryField(key_field=fields.UUIDFIeld(), value_field=fields.DecimalField())

I am still undecided if it makes sense to have such a "feature". What do you think?

bumblebee · Answer 3 · Wed Jul 14 2021 21:54:37 GMT+0800 (China Standard Time)

I would like to work on this.

Jakub Dubec · Answer 4 · Fri Jul 16 2021 17:22:03 GMT+0800 (China Standard Time)

@bumblebee211196 feel free to take the issue :) If you any questions don't hesitate to ask.

bumblebee · Answer 5 · Fri Jul 16 2021 22:11:50 GMT+0800 (China Standard Time)

@bumblebee211196 feel free to take the issue :) If you any questions don't hesitate to ask.

Sure!. Let me first collect a list of field types we can provide for the keys and values in the DictionaryField. We shall discuss on what to include and what not to include.

Jakub Dubec · Answer 6 · Sat Jul 17 2021 19:23:43 GMT+0800 (China Standard Time)

Hi @bumblebee211196, I think it is not necessary to specify allowed fields for dictionary keys and values. I am aware that not all fields are making sense as keys, but enforcing such limitations will be a needless complication. If we want to keep the codebase as simple and as fast as possible we can't do everything for the programmer (checking his logical errors). If you have a different opinion I am here to listen of course :)

bumblebee · Answer 7 · Mon Jul 26 2021 13:21:52 GMT+0800 (China Standard Time)

Hey @Sibyx I am currently working on other priority work. I will visit this back once I am done with that.

AMBER MURTUZA ANSARI · Answer 8 · Wed Oct 05 2022 14:29:07 GMT+0800 (China Standard Time)

hi,
i am beginner in python/django..can you help to get a issue to solve at my level?

Vrbitko · Answer 9 · Wed Oct 05 2022 20:08:04 GMT+0800 (China Standard Time)

Hello @Sibyx, is this issue still opened and free to take? Can i take it?

Jakub Dubec · Answer 10 · Wed Oct 05 2022 21:11:05 GMT+0800 (China Standard Time)

Hello @AmberAnsari89, feel free to take the issue. Basically all you need to know is stated in this issue so read it carefully. If you have any questions feel free to ask. Implementation is suppose to happen in the DictionaryField. Validation is executed in the to_python and you can mark validation error by raising DetailValidationError (if you have path to the key in a dictionary) or ValidationError if you have a generic error. Check existing implementation. Feel free to offer a PR so we can discuss the source code in the more practical way. Let me know if you are going to take the issue.

AMBER MURTUZA ANSARI · Answer 11 · Thu Oct 06 2022 00:03:03 GMT+0800 (China Standard Time)

thank you for your reply.. i ready to take the issue however i am new to open source area. so please help me with guidelines and source code and other details to do my analysis and get better insight.

AMBER MURTUZA ANSARI · Answer 12 · Fri Oct 07 2022 09:54:50 GMT+0800 (China Standard Time)

Hi, I went through the issue and want more insight about the changes...what exactly you want in place of dictionary field.i mean what structure of formfiield..

…

On Wed, 5 Oct, 2022, 6:41 pm Jakub Dubec, ***@***.***> wrote: Hello @AmberAnsari89 <https://github.com/AmberAnsari89>, feel free to take the issue. Basically all you need to know is stated in this issue so read it carefully. If you have any questions feel free to ask. Implementation is suppose to happen in the DictionaryField <https://github.com/Sibyx/django_api_forms/blob/master/django_api_forms/fields.py#L179>. Validation is executed in the to_python and you can mark validation error by raising DetailValidationError (if you have path to the key in a dictionary) or ValidationError if you have a generic error. Check existing implementation. Feel free to offer a PR so we can discuss the source code in the more practical way. Let me know if you are going to take the issue. — Reply to this email directly, view it on GitHub <#21 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AKUXK4VXLJX7K6267REVCKTWBV47JANCNFSM4SNQGRHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

Jakub Dubec · Answer 13 · Fri Oct 07 2022 15:39:09 GMT+0800 (China Standard Time)

You need to add new parameters to the DictionaryField constructor (check my example in this issue). Then in the to_python method you have to call validation (to_python methods for attributes from the constructor you created).