Make ModelDetailView show model properties

[Bostjan Kaluza]

Model properties (like one below) do not show in the admin documentation:

  class MyModel(models.Model):
      name = models.CharField(max_length=200)
      public = models.BooleanField(default=False)
      date_approved = models.DateTimeField(null=True, blank=True)

      @property
      def status(self):
      """
        returns the status of object
      """
      if self.date_approved and self.public:
        return "Public"
      elif self.public:
        return "Pending Approval"
      else:
        return "Private"

[Bostjan Kaluza]

It seem easy to fix. In file django/contrib/admindocs/views.py method ModelDetailView.get_context_data gathers model methods, but skips the properties as they are not methods. So we need to (1) add properties to the condition and (2) append the property to the list of fields.

# Gather model methods.
for func_name, func in model.__dict__.items():
    #
    # CHANGE 1: add isinstance(func, property) to the condition
    #
    # if inspect.isfunction(func): # old line
    if inspect.isfunction(func) or isinstance(func, property):
        try:
            for exclude in MODEL_METHODS_EXCLUDE:
                if func_name.startswith(exclude):
                    raise StopIteration
        except StopIteration:
            continue
        verbose = func.__doc__
        if verbose:
            verbose = utils.parse_rst(utils.trim_docstring(verbose), 'model', _('model:') + opts.model_name)

        #
        # CHANGE 2: If this is a property, show it as a 'field'
        #
        if isinstance(func, property):
            fields.append({
                'name': func_name,
                'data_type': get_return_data_type(func_name),
                'verbose': verbose or '',
            })
        # Else if a method has no arguments, show it as a 'field', otherwise
        # as a 'method with arguments'.
        elif func_has_no_args(func) and not func_accepts_kwargs(func) and not func_accepts_var_args(func):
            fields.append({
                'name': func_name,
                'data_type': get_return_data_type(func_name),
                'verbose': verbose or '',
            })
        else:
            arguments = get_func_full_args(func)
            # Join arguments with ', ' and in case of default value,
            # join it with '='. Use repr() so that strings will be
            # correctly displayed.
            print_arguments = ', '.join([
                '='.join(list(arg_el[:1]) + [repr(el) for el in arg_el[1:]])
                for arg_el in arguments
            ])
            methods.append({
                'name': func_name,
                'arguments': print_arguments,
                'verbose': verbose or '',
            })

[Bostjan Kaluza]

Pull request: ​https://github.com/django/django/pull/9929

[Tim Graham]

A test and documentation update are also required.

[humbertotm]

I'd be glad to work on the required test and documentation.

[humbertotm]

Pull request: ​https://github.com/django/django/pull/10004

Building on the fix provided by PR #9929, a unit test for the enhancement has been added. Additional documentation has not been added as the fix seems to fall within what is covered by ​The Django admin documentation generator. I will be glad to continue documenting with a bit of orientation.

Let me know if you have any comments regarding the unit test.

[Claude Paroz]

For the docs, something like with all the fields and methods available on it -> with all the fields, properties and methods available on it, with a versionchanged section stating that showing model properties has been added.

[humbertotm]

Replying to Claude Paroz:

For the docs, something like with all the fields and methods available on it -> with all the fields, properties and methods available on it, with a versionchanged section stating that showing model properties has been added.

Great! I'm on it.
Thanks!

[humbertotm]

Added documentation to PR. Let me know what you think, and how this can be improved.
Thanks!

[Tim Graham <timograham@…>]

In 747ff7a3:

Fixed #29385 -- Made admindocs ModelDetailView show model properties.

Original patch by bkaluza. Tests and docs by humbertotm.