Allow test runner to execute individual doctests

[David Larlet]

For the moment, you can specify a test case or even a single test method in this test case but you can't use more than one doctest file easily and run tests file by file for instance.

The attached patch allow you to run doctests from your tests/ directory one by one:

python manage.py test app.doctest_filename_without_extension

Or all at once:

python manage.py test app

You just need doctests files with ".txt" extension. Comments are welcome.

Update: doctests can already be split across files using __tests__. However, the ability to execute tests on a fine grained level would be useful.

[Simon Greenhill <dev@…>]

Sounds like a rather good idea. I'll move to RFC and see what core says

[David Larlet]

Thanks Simon, I know there are a lot of improvements to do (better error handling, documentation, etc) but I'd like to know if core is interested in this approach before spending too much time on this.

[Malcolm Tredinnick]

Let's not do this. It introduces "yet another way" to specify tests. Multiple doctests can already be specified via the __tests__ variable, so what we need is a way to identify them. Possibly <app_name>.<test_key> where test_key is the key name in the __tests__ dictionary might be most straightforward here.

Russell probably needs to have some input, too, since I have a recollection he's thought about this in the past.

[Triagers: please use "design decision needed" for these types of tickets, not "ready for checkin", which is for non-controversial, fully complete stuff.]

[Russell Keith-Magee]

I'm all in favour of the idea of greater granularity for running doctests. However, as Malcolm rightly points out, doctests already provide a multi-file option through the __tests__ dictionary. The Django test runner should supplement, not replace this approach.

Invoking parts of a __tests__ dictionary would certainly be a valuable contribution, but it doesn't completely solve the problem. Doctests can be defined inline on a method or class (the classic sense of a doctest); it would be nice to be able to invoke these individual tests, too.

I'll mark this as accepted, but for the concept, not the provided implementation. I've updated the ticket to better reflect the accepted idea.

[David Larlet]

Ok, I'll try to do something with __tests__, thanks for your suggestions. Inline doctests looks a bit trickier at first sight.

[Russell Keith-Magee]

Reverting to nobody since no progress has been made for a while.

[David Larlet]

Since [12255], I think this issue should be fixed by a snippet and is not anymore required as a trunk addition. As I understand it, it's now as easy as overriding DjangoTestSuiteRunner.build_suite with a call to doctests or whatever.

[Russell Keith-Magee]

@david - no this is still a trunk problem. The new class-based structure will make this easier to do as a snippet while you wait for a final patch to hit trunk, but that doesn't remove the need for a solution in trunk.

[Russell Keith-Magee]

(In [12364]) Fixed #6364 -- Added the ability to run individual doctests.