Fixed #35628 -- Allowed compatible GeneratedFields for ModelAdmin.date_hierarchy.

[john-parton]

Fixed #35628, allow GeneratedField with appropriate output_field for date_hierarchy.

Trac ticket number

This is the basic fix for https://code.djangoproject.com/ticket/35628# , but without tests/docs. Will add tests/docs if approach is deemed appropriate.

Branch description

Essentially, there's a check to make sure that date_hierarchy is a DateField or DateTimeField, but there is no technical reason to prohibit a GeneratedField with output_field set to DateField or DateTimeField.

This adjusts the check to allow that specific case through.

Checklist

• This PR targets the main branch.
• The commit message is written in past tense, mentions the ticket number, and ends with a period.
• I have checked the "Has patch" ticket flag in the Trac system.
• I have added or updated relevant tests.
• I have added or updated relevant docs, including release notes if applicable.
• I have attached screenshots in both light and dark modes for any UI changes.

[john-parton]

As an alternate implementation, we could do something like

if field.get_internal_type() in {"DateField", "DateTimeField"}:
    ...

This would also permit user defined date fields that don't explicitly subclass DateField or DateTimeField so long as the user defines the get_internal_type method.

However, I tried to keep the structure of the code roughly the same.

[john-parton]

I added a release note.

Is there a way that I can render out those pages locally so that I can make sure they're formatted nicely?

I don't think it's necessary to add a 'version changed' note to the date_hierarchy docs. I think a typical user of the GeneratedField will just assume it's going to work.

[sarahboyce]

I added a release note.

Thank you! This is a special case where the release note belongs in the 5.0.8 release notes (as this is a release blocker for a monthly release of 5.0). Something like

* Fixed a bug in Django 5.0 where a system check would crash when
  ``ModelAdmin.date_hierarchy`` was set to a ``GeneratedField`` with an
  ``output_field`` of a ``DateField`` or a ``DateTimeField``
  (:ticket:`35628`).

You might need to rebase with the latest main

Is there a way that I can render out those pages locally so that I can make sure they're formatted nicely?

Yes, see this guide also have the requirements of docs/requirements.txt installed 👍

I don't think it's necessary to add a 'version changed' note to the date_hierarchy docs. I think a typical user of the GeneratedField will just assume it's going to work.

Correct 👍

[john-parton]

• Rewrote the tests using the assertion pattern discussed previously
• Moved release note to 5.0.8 bugfixes section
• Squashed my commit and cherry-picked it against main

[john-parton]

Fixed linter errors, squashed, force-pushed.

[sarahboyce]

Thank you @john-parton ⭐ this looks good to me

[pauloxnet]

LGTM