Use short description with properties in the admin

[Pablo Martín]

If you use a property in a list_display (e.g.) the name of the column will be a "pretty name" of the name of the property.

But this property could use "short_description" as follow (See patch)

[anonymous]

This needs a quick simple test, and perhaps a bullet point in the docs under the section on list_display - but otherwise looks like a good idea, as you shouldn't be penalized for making use of your methods as properties.

[Wiktor]

I've reviewed a patch and it works for the use case when property is not set with @property decorator.

So this will work:

    def test_label_for_property(self):
        class MockModelAdmin(object):
            def fget(self):
                return "this if from property"
            fget.short_description = 'property short description'
            test_from_property = property(fget=fget)

        self.assertEqual(
            label_for_field("test_from_property", Article, model_admin=MockModelAdmin),
            'property short description'
        )

but this will not:

    def test_label_for_property_decorator(self):
        class MockModelAdmin(object):
            @property
            def test_from_property(self):
                return "this if from property"
            test_from_property.short_description = 'property short description'

throwing

AttributeError: 'property' object has no attribute 'short_description'

[Wiktor]

In my opinion this needs decision/discussion, because setting short_description is limited to usage of property as a function, not as a decorator.

This is better then nothing on the other hand.

I may however send a pull request (patch + tests) if this is ok.

[Wiktor]

Pull request here: ​https://github.com/django/django/pull/1104

[Florian Apolloner <florian@…>]

In cec9558fba1bc6401ea2ec6d71b816b4dfd31b28:

Fixed #17308 -- Enabled the use of short_description on properties in the admin.