[Django] #23160: KeyError when performing a RenameModel migration operation for a model with self-referential FK field

40 views
Skip to first unread message

Django

unread,
Aug 3, 2014, 1:54:05 PM8/3/14
to django-...@googlegroups.com
#23160: KeyError when performing a RenameModel migration operation for a model with
self-referential FK field
----------------------------+----------------------
Reporter: whitews@… | Owner: nobody
Type: Bug | Status: new
Component: Migrations | Version: 1.7-rc-2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
----------------------------+----------------------
I'm simply trying to rename a model which has a relationship to itself.
Running the RenameModel operation yields the following traceback:

$ python manage.py migrate myapp
Operations to perform:
Apply all migrations: myapp
Running migrations:
Applying myapp.0002_rename_Foo_to_Bar...Traceback (most recent call
last):
File "manage.py", line 10, in <module>
execute_from_command_line(sys.argv)
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/core/management/__init__.py", line
385, in execute_from_command_line
utility.execute()
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/core/management/__init__.py", line
377, in execute
self.fetch_command(subcommand).run_from_argv(self.argv)
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/core/management/base.py", line 288,
in run_from_argv
self.execute(*args, **options.__dict__)
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/core/management/base.py", line 338,
in execute
output = self.handle(*args, **options)
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/core/management/commands/migrate.py",
line 160, in handle
executor.migrate(targets, plan, fake=options.get("fake", False))
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/db/migrations/executor.py", line
63, in migrate
self.apply_migration(migration, fake=fake)
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/db/migrations/executor.py", line
91, in apply_migration
if self.detect_soft_applied(migration):
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/db/migrations/executor.py", line
134, in detect_soft_applied
project_state = self.loader.project_state((migration.app_label,
migration.name), at_end=True)
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/db/migrations/loader.py", line 268,
in project_state
return self.graph.make_state(nodes=nodes, at_end=at_end,
real_apps=list(self.unmigrated_apps))
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/db/migrations/graph.py", line 147,
in make_state
project_state = self.nodes[node].mutate_state(project_state)
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/db/migrations/migration.py", line
76, in mutate_state
operation.state_forwards(self.app_label, new_state)
File "/usr/local/lib/python2.7/dist-
packages/Django-1.7c2-py2.7.egg/django/db/migrations/operations/models.py",
line 132, in state_forwards
for name, field in state.models[related_key].fields:
KeyError: ('myapp', 'foo')

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

Django

unread,
Aug 3, 2014, 2:12:38 PM8/3/14
to django-...@googlegroups.com
#23160: KeyError when performing a RenameModel migration operation for a model with
self-referential FK field
---------------------------------+--------------------------------------
Reporter: whitews@… | Owner: charettes
Type: Bug | Status: assigned
Component: Migrations | Version: 1.7-rc-2
Severity: Release blocker | 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 charettes):

* status: new => assigned
* needs_better_patch: => 0
* needs_tests: => 0
* owner: nobody => charettes
* needs_docs: => 0
* severity: Normal => Release blocker


Old description:

New description:

--

Comment:

Reproduced against master.

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

Django

unread,
Aug 3, 2014, 2:20:42 PM8/3/14
to django-...@googlegroups.com
#23160: KeyError when performing a RenameModel migration operation for a model with
self-referential FK field
---------------------------------+--------------------------------------
Reporter: whitews@… | Owner: charettes
Type: Bug | Status: assigned
Component: Migrations | Version: 1.7-rc-2
Severity: Release blocker | 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 bmispelon):

Same here.

For what it's worth, you can trigger the error with one simple model:
{{{#!python
class Foo(models.Model):
parent = models.ForeignKey('self')
}}}

Renaming that model to `Bar` and running `makemigrations` works: the
autodetector asks if the model was renamed.
However, running `migrate` after that fails with the reported `KeyError`.

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

Django

unread,
Aug 3, 2014, 3:05:21 PM8/3/14
to django-...@googlegroups.com
#23160: KeyError when performing a RenameModel migration operation for a model with
self-referential FK field
---------------------------------+-------------------------------------

Reporter: whitews@… | Owner: charettes
Type: Bug | Status: assigned
Component: Migrations | Version: 1.7-rc-2
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

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

* has_patch: 0 => 1
* stage: Unreviewed => Accepted


Comment:

Created a [https://github.com/django/django/pull/3012 PR with tests].

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

Django

unread,
Aug 3, 2014, 3:09:15 PM8/3/14
to django-...@googlegroups.com
#23160: KeyError when performing a RenameModel migration operation for a model with
self-referential FK field
---------------------------------+-------------------------------------
Reporter: whitews@… | Owner: charettes
Type: Bug | Status: assigned
Component: Migrations | Version: 1.7-rc-2

Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

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

Comment (by anonymous):

Verified the PR from charettes fixes the issue. Thanks!

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

Django

unread,
Aug 3, 2014, 3:24:57 PM8/3/14
to django-...@googlegroups.com
#23160: KeyError when performing a RenameModel migration operation for a model with
self-referential FK field
-------------------------------------+-------------------------------------

Reporter: whitews@… | Owner: charettes
Type: Bug | Status: assigned
Component: Migrations | Version: 1.7-rc-2
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Ready for
Has patch: 1 | checkin
Needs tests: 0 | Needs documentation: 0
Easy pickings: 0 | Patch needs improvement: 0
| UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by charettes):

* stage: Accepted => Ready for checkin


Comment:

Marking RFC per Florian's comment on IRC. Will just wait for the CI build
to complete and I'll merge/backport to 1.7.x.

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

Django

unread,
Aug 3, 2014, 3:30:12 PM8/3/14
to django-...@googlegroups.com
#23160: KeyError when performing a RenameModel migration operation for a model with
self-referential FK field
-------------------------------------+-------------------------------------
Reporter: whitews@… | Owner: charettes
Type: Bug | Status: closed
Component: Migrations | Version: 1.7-rc-2
Severity: Release blocker | Resolution: fixed

Keywords: | Triage Stage: Ready for
Has patch: 1 | checkin
Needs tests: 0 | Needs documentation: 0
Easy pickings: 0 | Patch needs improvement: 0
| UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Simon Charette <charette.s@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"cbb29af1aa1ebe11b38e73a6f34df9cd171d6c5b"]:
{{{
#!CommitTicketReference repository=""
revision="cbb29af1aa1ebe11b38e73a6f34df9cd171d6c5b"
Fixed #23160 -- Correctly rename models with self referential fields.

Thanks to whitews AT gmail for the report.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/23160#comment:6>

Django

unread,
Aug 3, 2014, 4:36:08 PM8/3/14
to django-...@googlegroups.com
#23160: KeyError when performing a RenameModel migration operation for a model with
self-referential FK field
-------------------------------------+-------------------------------------
Reporter: whitews@… | Owner: charettes
Type: Bug | Status: closed
Component: Migrations | Version: 1.7-rc-2

Severity: Release blocker | Resolution: fixed
Keywords: | Triage Stage: Ready for
Has patch: 1 | checkin
Needs tests: 0 | Needs documentation: 0
Easy pickings: 0 | Patch needs improvement: 0
| UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Simon Charette <charette.s@…>):

In [changeset:"1b00738f73444693dd94958f3fc53c089f4d96e7"]:
{{{
#!CommitTicketReference repository=""
revision="1b00738f73444693dd94958f3fc53c089f4d96e7"
Fixed a MySQL test failure introduced by cbb29af1aa.

Seems like unlike other backends MySQL get_constraints fails when dealing
with a non-existing table. refs #23160.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/23160#comment:7>

Django

unread,
Aug 3, 2014, 5:03:36 PM8/3/14
to django-...@googlegroups.com
#23160: KeyError when performing a RenameModel migration operation for a model with
self-referential FK field
-------------------------------------+-------------------------------------
Reporter: whitews@… | Owner: charettes
Type: Bug | Status: closed
Component: Migrations | Version: 1.7-rc-2

Severity: Release blocker | Resolution: fixed
Keywords: | Triage Stage: Ready for
Has patch: 1 | checkin
Needs tests: 0 | Needs documentation: 0
Easy pickings: 0 | Patch needs improvement: 0
| UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Simon Charette <charette.s@…>):

In [changeset:"99f3a65c730f643d35d959aa9a693101b2d21efd"]:
{{{
#!CommitTicketReference repository=""
revision="99f3a65c730f643d35d959aa9a693101b2d21efd"
[1.7.x] Fixed a MySQL test failure introduced by cbb29af1aa.

Seems like unlike other backends MySQL get_constraints fails when dealing
with a non-existing table. refs #23160.

Backport of 1b00738f73 from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/23160#comment:9>

Django

unread,
Aug 3, 2014, 5:03:37 PM8/3/14
to django-...@googlegroups.com
#23160: KeyError when performing a RenameModel migration operation for a model with
self-referential FK field
-------------------------------------+-------------------------------------
Reporter: whitews@… | Owner: charettes
Type: Bug | Status: closed
Component: Migrations | Version: 1.7-rc-2

Severity: Release blocker | Resolution: fixed
Keywords: | Triage Stage: Ready for
Has patch: 1 | checkin
Needs tests: 0 | Needs documentation: 0
Easy pickings: 0 | Patch needs improvement: 0
| UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Simon Charette <charette.s@…>):

In [changeset:"6b2473d3e8048158dbc8c886d755cbf948325077"]:
{{{
#!CommitTicketReference repository=""
revision="6b2473d3e8048158dbc8c886d755cbf948325077"
[1.7.x] Fixed #23160 -- Correctly rename models with self referential
fields.

Thanks to whitews AT gmail for the report.

Backport of cbb29af1aa from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/23160#comment:8>

Reply all
Reply to author
Forward
0 new messages