[Django] #22254: Testing documentation doesn't make it clear that django.setup() needs to be called with setup_test_environment
Django
called with setup_test_environment
--------------------------------+-------------------------
Reporter: peter.landry@… | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.7-alpha-2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------+-------------------------
https://docs.djangoproject.com/en/dev/topics/testing/advanced/#running-
tests-outside-the-test-runner
It's not specific to testing, but it seems that we should mention the
necessity of calling `django.setup()` in the directions for running tests
outside of `manage.py`. I've submitted a pull request with a simple
documentation change: https://github.com/django/django/pull/2419
This may require some more discussion, though. As mjtamlyn points out,
another solution could be to include `django.setup()` in
`setup_test_environment()`. The call to `django.setup()` could also be
moved into the example for using `setup_test_environment()` rather than a
warning in its own.
--
Ticket URL: <https://code.djangoproject.com/ticket/22254>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
called with setup_test_environment
Reporter: peter.landry@… | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.7-alpha-2
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 mjtamlyn):
* needs_docs: => 0
* needs_better_patch: => 0
* needs_tests: => 0
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/22254#comment:1>
Django
called with setup_test_environment
Reporter: peter.landry@… | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.7-alpha-2
Keywords: app-loading | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by aaugustin):
* keywords: => app-loading
--
Ticket URL: <https://code.djangoproject.com/ticket/22254#comment:2>
Django
called with setup_test_environment
Reporter: peter.landry@… | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.7-alpha-2
Keywords: app-loading | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by peter.landry@…):
Perhaps it would be better to add instructions or information regarding
`django.setup()` in
https://docs.djangoproject.com/en/dev/ref/applications/, then just make a
reference in the testing docs to it in a warning about using django
outside of manage.py?
--
Ticket URL: <https://code.djangoproject.com/ticket/22254#comment:3>
Django
called with setup_test_environment
Reporter: peter.landry@… | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version:
Component: Documentation | 1.7-alpha-2
Severity: Normal | Resolution:
Keywords: app-loading | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
Changes (by timo):
* needs_better_patch: 0 => 1
* has_patch: 0 => 1
* type: Uncategorized => Cleanup/optimization
Comment:
Yes, it seems like we should enhance the documentation of
`django.setup()`. There's some mentions of it in the 1.7 release notes and
a couple other places like `docs/ref/django-admin.txt` and
`docs/intro/tutorial01.txt`.
--
Ticket URL: <https://code.djangoproject.com/ticket/22254#comment:4>
Django
called with setup_test_environment
Reporter: peter.landry@… | Owner: aaugustin
Type: | Status: assigned
Cleanup/optimization | Version:
Component: Documentation | 1.7-alpha-2
Keywords: app-loading | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Changes (by aaugustin):
* status: new => assigned
* owner: nobody => aaugustin
* severity: Normal => Release blocker
Comment:
Indeed, django.setup() isn't correctly documented. Sorry about that.
--
Ticket URL: <https://code.djangoproject.com/ticket/22254#comment:5>
Django
called with setup_test_environment
Reporter: peter.landry@… | Owner: aaugustin
Type: | Status: assigned
Cleanup/optimization | Version:
Component: Documentation | 1.7-alpha-2
Severity: Release blocker | Resolution:
Keywords: app-loading | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Comment (by aaugustin):
https://github.com/django/django/pull/2609 documents django.setup(). Can I
haz review?
I'm not convinced it's worth duplicating that information wherever
setup_test_environment() is useful. If you hit `RuntimeError: App registry
isn't ready yet.` Google will tell you how to fix it in 10 seconds. I'll
let someone else deal with that part if you want to.
--
Ticket URL: <https://code.djangoproject.com/ticket/22254#comment:6>
Django
called with setup_test_environment
Reporter: peter.landry@… | Owner: aaugustin
Type: | Status: assigned
Cleanup/optimization | Version:
Component: Documentation | 1.7-alpha-2
Severity: Release blocker | Resolution:
Has patch: 1 | checkin
Needs tests: 0 | Needs documentation: 0
Easy pickings: 0 | Patch needs improvement: 0
| UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by timo):
* needs_better_patch: 1 => 0
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/22254#comment:7>
Django
called with setup_test_environment
Reporter: peter.landry@… | Owner:
Type: | Status: new
Cleanup/optimization | Version:
Component: Documentation | 1.7-alpha-2
Keywords: app-loading | Triage Stage:
Has patch: 0 | Unreviewed
Needs tests: 0 | Needs documentation: 0
Easy pickings: 0 | Patch needs improvement: 0
| UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => new
* owner: aaugustin =>
* has_patch: 1 => 0
* severity: Release blocker => Normal
* stage: Ready for checkin => Unreviewed
Comment:
`django.setup()` is now properly documented, so we can re-evaluate if
something needs to be done for `setup_test_environment()`.
--
Ticket URL: <https://code.djangoproject.com/ticket/22254#comment:8>
Django
called with setup_test_environment
Reporter: peter.landry@… | Owner: Tim
Type: | Graham <timograham@…>
Cleanup/optimization | Status: closed
Component: Documentation | Version:
Severity: Normal | 1.7-alpha-2
Keywords: app-loading | Resolution: fixed
Has patch: 0 | Triage Stage:
Needs tests: 0 | Unreviewed
Easy pickings: 0 | Needs documentation: 0
| Patch needs improvement: 0
| UI/UX: 0
-------------------------------------+-------------------------------------
* owner: => Tim Graham <timograham@…>
* status: new => closed
* resolution: => fixed
Comment:
In [changeset:"26b03f25265227498a2559af807918fe2a1d246f"]:
{{{
#!CommitTicketReference repository=""
revision="26b03f25265227498a2559af807918fe2a1d246f"
Fixed #22254 -- Noted the requirement of calling django.setup() when
running
Thanks Peter Landry for the report.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/22254#comment:9>
Django
called with setup_test_environment
Reporter: peter.landry@… | Owner: Tim
Type: | Graham <timograham@…>
Cleanup/optimization | Status: closed
Component: Documentation | Version:
Severity: Normal | 1.7-alpha-2
Keywords: app-loading | Resolution: fixed
Has patch: 0 | Triage Stage:
Needs tests: 0 | Unreviewed
Easy pickings: 0 | Needs documentation: 0
| Patch needs improvement: 0
| UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Tim Graham <timograham@…>):
In [changeset:"305ab00087a29ff400e815187b5568f84d2d8739"]:
{{{
#!CommitTicketReference repository=""
revision="305ab00087a29ff400e815187b5568f84d2d8739"
[1.7.x] Fixed #22254 -- Noted the requirement of calling django.setup()
when running
Thanks Peter Landry for the report.
Backport of 26b03f2526 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/22254#comment:10>