Opened 6 years ago

Closed 5 years ago

Last modified 4 years ago

#12048 closed (fixed)

MultiWidget does not define __deepcopy__

Reported by: powderflask <powderflask@…> Owned by: nobody
Component: Forms Version: master
Severity: Keywords:
Cc: ben@… Triage Stage: Design decision needed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

django.forms.MultiWidget defines an instance variable, widgets , which is a list of widgets. However, it does not override the deepcopy() method in the Widget base class to make a copy of this instance variable. A deepcopy of the widgets is needed when an instance when a django Form containing a Field that uses a MultiWidget is instantiated, otherwise all such forms have a reference to the same widgets list rather than their own copy.

The patch is simple - override deepcopy() in MultiWidget to make a copy of widgets. A proposed patch is attached.

Replicating the problem requires that we extend MultiWidget, make a deepcopy of the widget, then alter one of the widgets in some way. Here is a minimal example that demonstrates the issue - applying the patch fixes the issue.

from django import forms
from django.utils.encoding import StrAndUnicode, force_unicode
from django.utils.safestring import mark_safe

#####################################################
## Simplified ChoiceWithOtherWidget  
##   original downloaded from: http://www.djangosnippets.org/snippets/863/
#####################################################
class ChoiceWithOtherWidget(forms.MultiWidget):
    """MultiWidget for use with ChoiceWithOtherField."""
    def __init__(self, choices=[]):
        widgets = [
            forms.RadioSelect(choices=choices),
            forms.TextInput
        ]
        super(ChoiceWithOtherWidget, self).__init__(widgets)
    
    def _set_choices(self, choices):
        """ When choices are set for this widget, we want to pass those along to the Select widget"""
        self.widgets[0].choices = choices
    def _get_choices(self):
        """ The choices for this widget are the Select widget's choices"""
        return self.widgets[0].choices
    choices = property(_get_choices, _set_choices)
    
    def decompress(self, value):
        if not value:
            return [None, None]
        return value


#################################################
##  Minimal code to reproduces bug
#################################################
from copy import deepcopy

widget1 = ChoiceWithOtherWidget(choices=['A','B','C'])
widget2 = deepcopy(widget1)
widget2.choices=['X','Y','Z']

widget1.choices
widget2.choices

Here is the output from running the sample code above in a shell before the patch was applied:

>>> widget1 = ChoiceWithOtherWidget(choices=['A','B','C'])
>>> widget2 = deepcopy(widget1)
>>> widget2.choices=['X','Y','Z']
>>> 
>>> widget1.choices
['X', 'Y', 'Z']
>>> widget2.choices
['X', 'Y', 'Z']

... and after the patch was applied:

>>> widget1 = ChoiceWithOtherWidget(choices=['A','B','C'])
>>> widget2 = deepcopy(widget1)
>>> widget2.choices=['X','Y','Z']
>>> 
>>> widget1.choices
['A', 'B', 'C']
>>> widget2.choices
['X', 'Y', 'Z']

Attachments (1)

widgets.py.patch (598 bytes) - added by powderflask <powderflask@…> 6 years ago.
patch for MultiWidget deepcopy bug (django.forms.MultiWidget)

Download all attachments as: .zip

Change History (6)

Changed 6 years ago by powderflask <powderflask@…>

patch for MultiWidget deepcopy bug (django.forms.MultiWidget)

comment:1 Changed 6 years ago by jamstooks

  • Cc ben@… added
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

comment:2 Changed 5 years ago by jcd

  • Triage Stage changed from Unreviewed to Design decision needed

comment:3 Changed 5 years ago by lukeplant

  • Resolution set to fixed
  • Status changed from new to closed

(In [12739]) Fixed #12048 - MultiWidget does not define __deepcopy__

Thanks to powderflask for report, test case and initial patch

comment:4 Changed 5 years ago by lukeplant

(In [12740]) [1.1.X] Fixed #12048 - MultiWidget does not define __deepcopy__

Thanks to powderflask for report, test case and initial patch.

Backport of [12739] from trunk

comment:5 Changed 4 years ago by jacob

  • milestone 1.2 deleted

Milestone 1.2 deleted

Note: See TracTickets for help on using tickets.
Back to Top