Opened 17 years ago

Last modified 15 years ago

#6364 closed

Allow test runner to execute individual doctests — at Version 5

Reported by: David Larlet Owned by: David Larlet
Component: Testing framework Version: dev
Severity: Keywords: testing
Cc: Russell Keith-Magee, Dan Fairs, Robin, David Larlet Triage Stage: Accepted
Has patch: yes Needs documentation: yes
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no

Description (last modified by Russell Keith-Magee)

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.

Change History (6)

by David Larlet, 17 years ago

Attachment: patch_django_6364.diff added

comment:1 by David Larlet, 17 years ago

Owner: changed from nobody to David Larlet

comment:2 by Simon Greenhill <dev@…>, 17 years ago

Has patch: set
Needs documentation: set
Triage Stage: UnreviewedReady for checkin

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

comment:3 by David Larlet, 17 years ago

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.

comment:4 by Malcolm Tredinnick, 17 years ago

Cc: Russell Keith-Magee added
Triage Stage: Ready for checkinDesign decision needed

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.]

comment:5 by Russell Keith-Magee, 17 years ago

Description: modified (diff)
Patch needs improvement: set
Summary: Allow fine grained tests for doctests (allow splitting into many files)Allow test runner to execute individual doctests
Triage Stage: Design decision neededAccepted

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.

Note: See TracTickets for help on using tickets.
Back to Top