[Django] #37048: Backwards incompatible change to InclusionAdminNode

[Django]

#37048: Backwards incompatible change to InclusionAdminNode
----------------------------+-------------------------------------------
Reporter: Anže Pečar | Type: Bug
Status: new | Component: Template system
Version: dev | Severity: Normal
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
----------------------------+-------------------------------------------
#36728 introduced a backwards incompatible change to the
`InclusionAdminNode`: https://github.com/django/django/pull/20086/changes
#diff-f60f94cb07bce796697e9d0357602fd6675a9891eaa57b8bd4cb70ae4ee3dda4R14

Instantiating `InclusionAdminNode()` without the name argument causes a
crash. Example of usage from the django-unfold 3rd party library:
https://github.com/unfoldadmin/django-
unfold/blob/main/src/unfold/templatetags/unfold_list.py#L409-L414

From what I can tell the name argument is only used in the error message
so maybe we can make it optional?
--
Ticket URL: <https://code.djangoproject.com/ticket/37048>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#37048: Backwards incompatible change to InclusionAdminNode

---------------------------------+--------------------------------------
Reporter: Anže Pečar | Owner: (none)
Type: Bug | Status: closed

Component: Template system | Version: dev

Severity: Normal | Resolution: wontfix

Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

---------------------------------+--------------------------------------
Changes (by Jake Howard):

* resolution: => wontfix
* status: new => closed

Comment:

After some digging, `InclusionAdminNode` isn't a public API, so doesn't
have any compatibility guarantees. A similar backwards-incompatible change
was made to `parse_bits`. Neither are mentioned in the 6.1 release notes.

I spoke to Jacob at Djangocon Europe, and we agreed that since it's not
part of the public API, it's not something we should be fixing. The work-
around would be to change the arguments passed depending on the version,
which shouldn't be too much hassle.
--
Ticket URL: <https://code.djangoproject.com/ticket/37048#comment:1>

[Django]

#37048: Backwards incompatible change to InclusionAdminNode
---------------------------------+--------------------------------------
Reporter: Anže Pečar | Owner: (none)
Type: Bug | Status: closed
Component: Template system | Version: dev
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
---------------------------------+--------------------------------------

Comment (by Anže Pečar):

Since `InclusionAdminNode` is used in the wild should we at last include a
note about the change in the changelog?
--
Ticket URL: <https://code.djangoproject.com/ticket/37048#comment:2>

[Django]

#37048: Backwards incompatible change to InclusionAdminNode
---------------------------------+--------------------------------------
Reporter: Anže Pečar | Owner: (none)
Type: Bug | Status: closed
Component: Template system | Version: dev
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
---------------------------------+--------------------------------------

Comment (by Jacob Walls):

Sure, we can add it to the "Backwards incompatible changes in 6.1" section
in the release note. We usually add a disclaimer like "the undocumented
InclusionAdminNode ..."
--
Ticket URL: <https://code.djangoproject.com/ticket/37048#comment:3>