[Django] #29549: ModelForms doesn't validate CHOICES

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
6 messages Options
Reply | Threaded
Open this post in threaded view
|

[Django] #29549: ModelForms doesn't validate CHOICES

Django
#29549: ModelForms doesn't validate CHOICES
-------------------------------------+-------------------------------------
               Reporter:  Evgeny     |          Owner:  nobody
  Arshinov                           |
                   Type:             |         Status:  new
  Uncategorized                      |
              Component:  Database   |        Version:  1.11
  layer (models, ORM)                |
               Severity:  Normal     |       Keywords:
           Triage Stage:             |      Has patch:  0
  Unreviewed                         |
    Needs documentation:  0          |    Needs tests:  0
Patch needs improvement:  0          |  Easy pickings:  0
                  UI/UX:  0          |
-------------------------------------+-------------------------------------
 This is basically a sequel of #6967.

 For some reason, only form validation was considered in the original
 ticket, but data validation is not limited to that, but also includes data
 integrity checks running when one calls `model_instance.save()`.

 As a developer, I would expect `model_instance.save()` to validate the
 `choices` field against the list of possible choices, not least because
 the list is defined at the model level, participates in db migrations
 etc., so it should take effect on modal instances.

 I haven't been able to find any documentation or existing bug reports that
 clearly state that [choices
 https://docs.djangoproject.com/en/2.0/ref/models/fields/#choices] argument
 only affects the corresponding model form field presentation and does not
 ensure data integrity.

 In summary:
 1. I would like to know the rationale for ignoring `choices` during data
 integrity checks, in case I am missing something.
 2. Please consider providing an option to turn data integrity check on.
 3. If the current behavior is left intact, it should be explicitly
 documented in the official documentation.

--
Ticket URL: <https://code.djangoproject.com/ticket/29549>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

--
You received this message because you are subscribed to the Google Groups "Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/052.efbfc4fb45eb53d8ed9869793aca4308%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #29549: ModelForms doesn't validate CHOICES

Django
#29549: ModelForms doesn't validate CHOICES
-------------------------------------+-------------------------------------
     Reporter:  Evgeny Arshinov      |                    Owner:  nobody
         Type:  Uncategorized        |                   Status:  new
    Component:  Database layer       |                  Version:  1.11
  (models, ORM)                      |
     Severity:  Normal               |               Resolution:
     Keywords:                       |             Triage Stage:
                                     |  Unreviewed
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  0                    |                    UI/UX:  0
-------------------------------------+-------------------------------------

Comment (by Tim Graham):

 Did you mean to title the ticket "Model.save() doesn't validate CHOICES"?

 This is
 [https://docs.djangoproject.com/en/dev/ref/models/instances/#django.db.models.Model.clean
 documented]:

 > Note, however, that like Model.full_clean(), a model’s clean() method is
 not invoked when you call your model’s save() method.

 This is because of backwards compatibility (and probably performance
 considerations).

 There are ways to [https://stackoverflow.com/questions/4441539/why-doesnt-
 djangos-model-save-call-full-cleanchange change the behavior in your
 project].

--
Ticket URL: <https://code.djangoproject.com/ticket/29549#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

--
You received this message because you are subscribed to the Google Groups "Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/067.2897f8f751247c38fa6607431792b233%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #29549: Model.save() doesn't validate CHOICES (was: ModelForms doesn't validate CHOICES)

Django
In reply to this post by Django
#29549: Model.save() doesn't validate CHOICES
-------------------------------------+-------------------------------------
     Reporter:  Evgeny Arshinov      |                    Owner:  nobody
         Type:  Uncategorized        |                   Status:  new
    Component:  Database layer       |                  Version:  1.11
  (models, ORM)                      |
     Severity:  Normal               |               Resolution:
     Keywords:                       |             Triage Stage:
                                     |  Unreviewed
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  0                    |                    UI/UX:  0
-------------------------------------+-------------------------------------

Old description:

> This is basically a sequel of #6967.
>
> For some reason, only form validation was considered in the original
> ticket, but data validation is not limited to that, but also includes
> data integrity checks running when one calls `model_instance.save()`.
>
> As a developer, I would expect `model_instance.save()` to validate the
> `choices` field against the list of possible choices, not least because
> the list is defined at the model level, participates in db migrations
> etc., so it should take effect on modal instances.
>
> I haven't been able to find any documentation or existing bug reports
> that clearly state that [choices
> https://docs.djangoproject.com/en/2.0/ref/models/fields/#choices]
> argument only affects the corresponding model form field presentation and
> does not ensure data integrity.
>
> In summary:
> 1. I would like to know the rationale for ignoring `choices` during data
> integrity checks, in case I am missing something.
> 2. Please consider providing an option to turn data integrity check on.
> 3. If the current behavior is left intact, it should be explicitly
> documented in the official documentation.
New description:

 This is basically a sequel of #6967.

 For some reason, only form validation was considered in the original
 ticket, but data validation is not limited to that, but also includes data
 integrity checks running when one calls `model_instance.save()`.

 As a developer, I would expect `model_instance.save()` to validate the
 `choices` field against the list of possible choices, not least because
 the list is defined at the model level, participates in db migrations
 etc., so it should take effect on modal instances.

 I haven't been able to find any documentation or existing bug reports that
 clearly state that
 [https://docs.djangoproject.com/en/2.0/ref/models/fields/#choices choices]
 argument only affects the corresponding model form field presentation and
 does not ensure data integrity.

 In summary:
 1. I would like to know the rationale for ignoring `choices` during data
 integrity checks, in case I am missing something.
 2. Please consider providing an option to turn data integrity check on.
 3. If the current behavior is left intact, it should be explicitly
 documented in the official documentation.

--

Comment (by Evgeny Arshinov):

 Replying to [comment:1 Tim Graham]:
 > Did you mean to title the ticket "Model.save() doesn't validate
 CHOICES"?
 >

 Yes. Sorry for the incorrect title, I fixed that.

 > This is
 [https://docs.djangoproject.com/en/dev/ref/models/instances/#django.db.models.Model.clean
 documented]:
 >
 > > Note, however, that like Model.full_clean(), a model’s clean() method
 is not invoked when you call your model’s save() method.

 OK, I think I did not pay enough attention to the point that saving and
 validation are two different steps, as documented in the
 [https://docs.djangoproject.com/en/dev/ref/models/instances/#validating-
 objects model instance reference], and fields are generally validated
 during `clean()` except for explicitly documented cases like
 [https://docs.djangoproject.com/en/2.0/ref/models/fields/#unique unique]
 (which is validated in `save()`).

 However, it seems that many people stumble upon this issue. Maybe an
 explicit note could be added to the documentation for the choices
 parameter?

 >
 > This is because of backwards compatibility (and probably performance
 considerations).
 >
 > There are ways to [https://stackoverflow.com/questions/4441539/why-
 doesnt-djangos-model-save-call-full-cleanchange change the behavior in
 your project].

 OK, thank you for the direct link. We will consider using this approach in
 our project.

--
Ticket URL: <https://code.djangoproject.com/ticket/29549#comment:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

--
You received this message because you are subscribed to the Google Groups "Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/067.2dbd776c84183fe84eea4b2a007f88b4%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #29549: Document that Field.choices are enforced by model validation (was: Model.save() doesn't validate CHOICES)

Django
In reply to this post by Django
#29549: Document that Field.choices are enforced by model validation
-------------------------------------+-------------------------------------
     Reporter:  Evgeny Arshinov      |                    Owner:  Tim
         Type:                       |  Graham
  Cleanup/optimization               |                   Status:  assigned
    Component:  Documentation        |                  Version:  1.11
     Severity:  Normal               |               Resolution:
     Keywords:                       |             Triage Stage:  Accepted
    Has patch:  1                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  0                    |                    UI/UX:  0
-------------------------------------+-------------------------------------
Changes (by Tim Graham):

 * status:  new => assigned
 * component:  Database layer (models, ORM) => Documentation
 * owner:  nobody => Tim Graham
 * has_patch:  0 => 1
 * type:  Uncategorized => Cleanup/optimization
 * stage:  Unreviewed => Accepted


Comment:

 [https://github.com/django/django/pull/10161 PR]

--
Ticket URL: <https://code.djangoproject.com/ticket/29549#comment:3>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

--
You received this message because you are subscribed to the Google Groups "Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/067.3080d8982589b5e9f8309050ce8658a1%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #29549: Document that Field.choices are enforced by model validation

Django
In reply to this post by Django
#29549: Document that Field.choices are enforced by model validation
-------------------------------------+-------------------------------------
     Reporter:  Evgeny Arshinov      |                    Owner:  Tim
         Type:                       |  Graham
  Cleanup/optimization               |                   Status:  closed
    Component:  Documentation        |                  Version:  1.11
     Severity:  Normal               |               Resolution:  fixed
     Keywords:                       |             Triage Stage:  Accepted
    Has patch:  1                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  0                    |                    UI/UX:  0
-------------------------------------+-------------------------------------
Changes (by GitHub <noreply@…>):

 * status:  assigned => closed
 * resolution:   => fixed


Comment:

 In [changeset:"8b1d361f28c80cb0fa84a3714d711174bd25cdfa" 8b1d361f]:
 {{{
 #!CommitTicketReference repository=""
 revision="8b1d361f28c80cb0fa84a3714d711174bd25cdfa"
 Fixed #29549 -- Doc'd that Field.choices are enforced by model validation.
 }}}

--
Ticket URL: <https://code.djangoproject.com/ticket/29549#comment:4>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

--
You received this message because you are subscribed to the Google Groups "Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/067.29a4b7098fefda19440069858d35b4b6%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #29549: Document that Field.choices are enforced by model validation

Django
In reply to this post by Django
#29549: Document that Field.choices are enforced by model validation
-------------------------------------+-------------------------------------
     Reporter:  Evgeny Arshinov      |                    Owner:  Tim
         Type:                       |  Graham
  Cleanup/optimization               |                   Status:  closed
    Component:  Documentation        |                  Version:  1.11
     Severity:  Normal               |               Resolution:  fixed
     Keywords:                       |             Triage Stage:  Accepted
    Has patch:  1                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  0                    |                    UI/UX:  0
-------------------------------------+-------------------------------------

Comment (by Tim Graham <timograham@…>):

 In [changeset:"50dc9fad74b4992602584252207f38c5faecc2ba" 50dc9fad]:
 {{{
 #!CommitTicketReference repository=""
 revision="50dc9fad74b4992602584252207f38c5faecc2ba"
 [2.1.x] Fixed #29549 -- Doc'd that Field.choices are enforced by model
 validation.

 Backport of 8b1d361f28c80cb0fa84a3714d711174bd25cdfa from master
 }}}

--
Ticket URL: <https://code.djangoproject.com/ticket/29549#comment:5>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

--
You received this message because you are subscribed to the Google Groups "Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/067.8eb09b05f562e147d84426c7ad23139d%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.