[Django] #21437: removed rel_name attribute from BaseInlineFormSet

28 views
Skip to first unread message

Django

unread,
Nov 14, 2013, 11:35:25 AM11/14/13
to django-...@googlegroups.com
#21437: removed rel_name attribute from BaseInlineFormSet
-------------------------------+--------------------
Reporter: jerzyk | Owner: nobody
Type: Bug | Status: new
Component: Uncategorized | Version: 1.6
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------
django 1.6 removed rel_name atribute from BaseInlineFormSet without
depreciation path or even without note in backward incompatible changes.

--
Ticket URL: <https://code.djangoproject.com/ticket/21437>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Nov 14, 2013, 11:59:20 AM11/14/13
to django-...@googlegroups.com
#21437: removed rel_name attribute from BaseInlineFormSet
-------------------------------+--------------------------------------

Reporter: jerzyk | Owner: nobody
Type: Bug | Status: new
Component: Uncategorized | Version: 1.6
Severity: Normal | Resolution:
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 akaariai):

* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0


Comment:

The self.rel_name attribute was never used inside Django, and it wasn't
part of the public API. I am not sure what our policy of mentioning such
changes in release notes is.

It seems you can get the same value by
form.fk.related.get_accessor_name(). Unfortunately in some model
inheritance cases that wont work, you need to reconstruct the
RelatedObject by hand.

--
Ticket URL: <https://code.djangoproject.com/ticket/21437#comment:1>

Django

unread,
Nov 14, 2013, 2:46:16 PM11/14/13
to django-...@googlegroups.com
#21437: removed rel_name attribute from BaseInlineFormSet
-------------------------------+--------------------------------------

Reporter: jerzyk | Owner: nobody
Type: Bug | Status: new
Component: Uncategorized | Version: 1.6
Severity: Normal | Resolution:
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 jerzyk):

imho private API is everything that starts with underscore in the classes,
everything else is public, documented or not. in the current 1.6 release
notes there are comments about private APIs too.

I suppose it is too late for depreciation path, so update to the release
notes should be fine.

--
Ticket URL: <https://code.djangoproject.com/ticket/21437#comment:2>

Django

unread,
Nov 14, 2013, 2:57:33 PM11/14/13
to django-...@googlegroups.com
#21437: removed rel_name attribute from BaseInlineFormSet
-------------------------------+------------------------------------

Reporter: jerzyk | Owner: nobody
Type: Bug | Status: new
Component: Uncategorized | Version: 1.6
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------+------------------------------------
Changes (by akaariai):

* stage: Unreviewed => Accepted


Comment:

Django doesn't distinguish between private and public api with underscore
(this is mainly for historical reasons). Instead anything that is
documented is public API, what isn't is private.

I guess release notes mention is OK.

--
Ticket URL: <https://code.djangoproject.com/ticket/21437#comment:3>

Django

unread,
Nov 14, 2013, 3:04:15 PM11/14/13
to django-...@googlegroups.com
#21437: removed rel_name attribute from BaseInlineFormSet
-------------------------------+------------------------------------

Reporter: jerzyk | Owner: nobody
Type: Bug | Status: new
Component: Uncategorized | Version: 1.6
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------+------------------------------------

Comment (by aaugustin):

Our policy is not to mention changes to private APIs in the release notes.
That's why they're called "private".

We make exceptions when we have overwhelming evidence that an API is
widely used even though it's private. I'm talking about stuff like
`Model._meta` or `Form._errors`.

`rel_name` is a fairly obscure API deep inside formsets with no clear
purpose. I don't believe it crosses the threshold for a mention in the
releases notes.

-0 because I don't want to get down a path where we're eventually expected
to document any change we do to any private API anywhere in Django.

--
Ticket URL: <https://code.djangoproject.com/ticket/21437#comment:4>

Django

unread,
Nov 14, 2013, 3:18:58 PM11/14/13
to django-...@googlegroups.com
#21437: removed rel_name attribute from BaseInlineFormSet
-------------------------------+------------------------------------
Reporter: jerzyk | Owner: nobody
Type: Bug | Status: closed
Component: Uncategorized | Version: 1.6
Severity: Normal | Resolution: wontfix

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------+------------------------------------
Changes (by akaariai):

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


Comment:

OK for me. I'll bounce this to wontfix then. (I am on flip-flop mood
today...)

--
Ticket URL: <https://code.djangoproject.com/ticket/21437#comment:5>

Reply all
Reply to author
Forward
0 new messages