#33422: Document @isolate_apps
-------------------------------------+-------------------------------------
Reporter: Adam Johnson | Owner:
Type: | Christopher Adams
Cleanup/optimization | Status: assigned
Component: Testing framework | Version: dev
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 Christopher Adams):
* owner: nobody => Christopher Adams
* status: new => assigned
Comment:
Cool, happy to take this on.
Looks like there's already some kind of instructions written on how to use
this function, with no caveat about it being a private API. In fact, the
instruction seems to encourage developers to actively use the function.
This is located in the contributing guide however, so I don't know what
normative authoritative weight that recommendation has. Here's the source,
at "Unit tests > Tips for writing tests > Isolating model registration":
https://docs.djangoproject.com/en/dev/internals/contributing/writing-code
/unit-tests/#django.test.utils.isolate_apps
I did just write a PR to include the function spec in the
`django.test.utils` section of the Django documentation, which is where I
would have expected it to be. Here's my PR:
https://github.com/django/django/pull/15735
@adam: want to take a quick look and see if this is what you are looking
for?
For the moment, I did not include a warning about `isolate_apps` having an
unstable API, because the reference in "Tips for writing tests" did not
have that warning. Let me know if you want me to add that however.
--
Ticket URL: <https://code.djangoproject.com/ticket/33422#comment:6>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/0107018100dd1529-7c280a5b-9163-49ef-815b-241dd6abf306-000000%40eu-central-1.amazonses.com.
