Admin changelist column CSS classes do not use short description, instead using str(list_display_function)

[JordanBright]

The column names in a changelist respect the short description but the CSS classes do not. This is particularly bad if you use a lambda as the class name becomes column-< ;function <lambda> at ... in the th and field-<function <lambda> at ... in the td.

I think this is caused by two functions in django/contrib/admin/templatetags/admin_list.py

result_headers uses field_name from for i, field_name in enumerate(cl.list_display) when it should be using text (from text, attr = label_for_field(...)) and doing something to make it a safe css class name, I think

items_for_result also uses field_name from for field_name in cl.list_display and it should probably just use whatever result_headers should be using.

To reproduce simply create a lambda function and put it in a list display then inspect the header and field classes in your browser. I'll attach a test case that reproduces it shortly.

[Manu]

New TestCase since previous one was passing 2 asserts that it shouldn't

[Tim Graham]

I didn't check if this patch fully resolves the ticket, but here's an initial ​pull request.

I came across this while debugging #23285. A test would occasionally fail because it was checking the ordering of strings like "2000" and "2008" in the response and sometimes they would appear elsewhere in the response such as <td class="field-<function callable_year at 0x7fe02000f230>">.

[Tim Graham]

I improved the patch to address both cases mention in the ticket description. I chose to use callable.__name__ instead of short_description as I didn't see why the short_description should be considered for a CSS class. In particular, I expect it would be more common to change the short_description than the callable's name, and I think less the CSS class changes, the better. Let me know if I missed something.

[Berker Peksag]

PR ​https://github.com/django/django/pull/5885 looks good to me.

[Tim Graham <timograham@…>]

In 37f7ef41:

Fixed #24316 -- Made ModelAdmin.list_display callables use an appropriate CSS class name.

Thanks Berker Peksag for the review.