show_hidden_initial=True produces invalid HTML

[geber@…]

When you have a model like this:

class MyModel(models.Model):
    datetime = models.TimestampField(_('Affected Time Start'), default=datetime.datetime.now)

And a Form like this:

class MyModelForm(forms.ModelForm):
    class Meta:
        model = MyModel
        fields = ('datetime',)

The generated HTML (in my case with prefix=2) looks like that:

<input type="text" name="2-datetime" value="2009-08-04 11:13:40" id="id_2-datetime" /><input type="hidden" name="initial-2-datetime" value="2009-08-04 11:13:40.694547" id="id_2-datetime" />

Obviously, the HTML ID is the same in the hidden field, which causes some JS-trouble.

Hope you'll fix it soon.

Cheers.

[dc]

This bug is valid for any field with show_hidden_initial=True

Another test case:

from django import forms
from django.db import models

class MyModel(models.Model):
    # callable default sets show_hidden_initial to True
    field1 = models.IntegerField(default=lambda: 0)
    class Meta:
        app_label = 'dummy'

class MyForm(forms.ModelForm):
    field2 = forms.CharField(max_length=50, show_hidden_initial=True)
    class Meta:
        model = MyModel

print MyForm()

Outputs duplicate ids:

<tr><th><label for="id_datetime">Datetime:</label></th><td><input type="text" name="datetime" value="1" id="id_datetime" /><input type="hidden" name="initial-datetime" value="1" id="id_datetime" /></td></tr>
<tr><th><label for="id_field2">Field2:</label></th><td><input id="id_field2" type="text" name="field2" maxlength="50" /><input type="hidden" name="initial-field2" id="id_field2" /></td></tr>

Looks like __unicode__() or as_hidden() in ​BoundField must be fixed.

[dc]

Ok, i think better render id differently in as_widget() method if only_initial is True. Does we really need id for the hidden initial field?

[anonymous]

I've just encountered this issue myself. I'm conflicted on what the solution should be. Since the <name> field gets 'initial-' prefixed to it, it seems like it would be consistent ti prefix the 'initial-' on the id. However, in practice that has issues. I have jquery code that finds dom objects by searching for them like this:

row.find('[id$=foo]')

ie, this finds a dom element whose name ends in 'foo'. Once I started using show_hidden_initial, my jquery code broke since it now finds two items whose name ends in 'foo'. I suspect other folks might do similar types of selectors. Adding 'initial-' to the front of the hidden initial input wouldn't help in this situation. Of course I could do a more compex jquery selector and ignore stuff that starts with initial-.

Getting rid of the id altogether on the hidden initial element fixes my issue, but leaves one in the unpleasant situation of never being able to find that hidden initial element in your dom - or at least not with a lot of trouble. So I don't really think it's a great solution. It seems like the most complete solution would allow the user to specify a "hidden initial auto id" when they instantiate a form, similar to the way they can specify the auto_id argument when they instantiate a form.

[Margie Roginski]

Sorry, the above comment by "anonymous" is by me, forgot to log in before making it.

[Mark Lavin]

While it's a shame that it doesn't help your jQuery selector I think using the 'initial-' prefix is a consistent with how the field names are generated. I added a patch that generates prefix to the id on the hidden initial field. I think as long as it is clear and consistent how the names and ids will be generated people can make the rest of their project work as far as selecting the elements and not generating conflicting names/ids.

[Karen Tracey]

(In [11826]) Fixed #11632: Fixed the id for hidden initial widget so that it is different from the id for its visible counterpart. Thanks geber@… and Mark Lavin.

[Karen Tracey]

(In [11827]) [1.1.X] Fixed #11632: Fixed the id for hidden initial widget so that it is different from the id for its visible counterpart. Thanks geber@… and Mark Lavin.

r11826 from trunk.

[Karen Tracey]

Reopening to fix broken test resulting from this fix.

[Karen Tracey]

(In [11835]) Fixed #11632: Fixed a test broken by r11826 that relied on the exact (invalid HTML) id of an initial hidden input field.

[Karen Tracey]

(In [11836]) [1.1.X] Fixed #11632: Fixed a test broken by r11827 that relied on the exact (invalid HTML) id of an initial hidden input field.

[Margie Roginski]

Replying to mlavin:

While it's a shame that it doesn't help your jQuery selector I think using the 'initial-' prefix is a consistent with how the field names are generated. I added a patch that generates prefix to the id on the hidden initial field. I think as long as it is clear and consistent how the names and ids will be generated people can make the rest of their project work as far as selecting the elements and not generating conflicting names/ids.

Thanks for putting the patch in, Mark. I agree that prefixing with initial- is a good and consistent fix.

[Jacob]

Milestone 1.2 deleted