<< Chapter < Page Chapter >> Page >

There are at least two different ways to use doctest :

  1. You can write the test code in a separate text file and use that file to perform the testing.
  2. You can embed the test code in one or more docstrings in a module and cause the test code to be executed each time you execute the module as ascript.

A simple example of each approach will be provided and explained in this module.

Discussion and sample code

An interactive session

Figure 1 shows a simple interactive session run on the Python interactive command line interface.

Figure 1 . Simple interactive session.
>>>2 + 3 5>>>

If you have forgotten what the text in Figure 1 means, see the earlier module titled Itse1359-1010-Getting Started .

An automated interactive session

This first example is provided solely to show how doctest works. It is not intended to be useful otherwise.

The test file named Py1359_1720_01

Listing 1 shows the contents of a test file named Py1359_1720_01.txt .

Listing 1 . Contents of the test file named Py1359_1720_01.txt.
>>>2 + 3 6

Note that the contents of the test file mirror the input and the output of the interactive session shown in Figure 1 except that the result of performing the computation was purposely specified incorrectly as 6 instead of 5. (When you create a doctest test file, you must specify the required output as shown in Listing 1 .)

Note that the doctest process is very picky regarding file names. Some file names that are valid for the operating system may not work when using doctest . However, if you restrict your file names to names that would be valid for variables, you should be okay.

Listing 2 shows the contents of a Windows batch file named Py1359_1720_01.bat that I used to perform the test. Although not a requirement, the use of such a batch file makes it convenient to performthe test more than once with a minimal typing effort.

The batch the named Py1359_1720_01

Listing 2 . Contents of the file named Py1359_1720_01.bat.
echo off rem set the pathpath=%path%;"C:\Program Files (x86)\Python34" rem perform the testpython -m doctest Py1359_1720_01.txt pause

(Some of the text in Listing 2 is peculiar to my machine. You can ignore the text shown in Listing 2 down to the command that begins with the word python .)

The third command that begins with the word python in Listing 2 executes the Python doctest module as a script and passes the name of the test file as a command-lineargument to the module.

According to Python v3.1.5 documentation -- Python Setup and Usage , "When called with -m module-name, the given module is located on the Python module path and executed as a script."

The syntax shown for the python command in Listing 2 is a command line shortcut for calling the testmod() function in the doctest module. (You will see more on this later.)

The output

The execution of the python command in Listing 2 produced the command line output shown in Figure 2 .

Figure 2 . Output produced by the test filenamed Py1359_1720_01.txt.
********************************************************************** File "Py1359_1720_01.txt", line 2, in Py1359_1720_01.txtFailed example: 2 + 3Expected: 6Got: 5********************************************************************** 1 items had failures:1 of 1 in Py1359_1720_01.txt ***Test Failed*** 1 failures.

Questions & Answers

who was the first nanotechnologist
Lizzy Reply
k
Veysel
technologist's thinker father is Richard Feynman but the literature first user scientist Nario Tagunichi.
Veysel
Norio Taniguchi
puvananathan
Interesting
Andr
I need help
Richard
anyone have book of Abdel Salam Hamdy Makhlouf book in pdf Fundamentals of Nanoparticles: Classifications, Synthesis
Naeem Reply
what happen with The nano material on The deep space.?
pedro Reply
It could change the whole space science.
puvananathan
the characteristics of nano materials can be studied by solving which equation?
sibaram Reply
plz answer fast
sibaram
synthesis of nano materials by chemical reaction taking place in aqueous solvents under high temperature and pressure is call?
sibaram
hydrothermal synthesis
ISHFAQ
how can chip be made from sand
Eke Reply
is this allso about nanoscale material
Almas
are nano particles real
Missy Reply
yeah
Joseph
Hello, if I study Physics teacher in bachelor, can I study Nanotechnology in master?
Lale Reply
no can't
Lohitha
where is the latest information on a no technology how can I find it
William
currently
William
where we get a research paper on Nano chemistry....?
Maira Reply
nanopartical of organic/inorganic / physical chemistry , pdf / thesis / review
Ali
what are the products of Nano chemistry?
Maira Reply
There are lots of products of nano chemistry... Like nano coatings.....carbon fiber.. And lots of others..
learn
Even nanotechnology is pretty much all about chemistry... Its the chemistry on quantum or atomic level
learn
Google
da
no nanotechnology is also a part of physics and maths it requires angle formulas and some pressure regarding concepts
Bhagvanji
hey
Giriraj
Preparation and Applications of Nanomaterial for Drug Delivery
Hafiz Reply
revolt
da
Application of nanotechnology in medicine
has a lot of application modern world
Kamaluddeen
yes
narayan
what is variations in raman spectra for nanomaterials
Jyoti Reply
ya I also want to know the raman spectra
Bhagvanji
I only see partial conversation and what's the question here!
Crow Reply
what about nanotechnology for water purification
RAW Reply
please someone correct me if I'm wrong but I think one can use nanoparticles, specially silver nanoparticles for water treatment.
Damian
yes that's correct
Professor
I think
Professor
Nasa has use it in the 60's, copper as water purification in the moon travel.
Alexandre
nanocopper obvius
Alexandre
what is the stm
Brian Reply
is there industrial application of fullrenes. What is the method to prepare fullrene on large scale.?
Rafiq
industrial application...? mmm I think on the medical side as drug carrier, but you should go deeper on your research, I may be wrong
Damian
STM - Scanning Tunneling Microscope.
puvananathan
Got questions? Join the online conversation and get instant answers!
Jobilize.com Reply

Get Jobilize Job Search Mobile App in your pocket Now!

Get it on Google Play Download on the App Store Now




Source:  OpenStax, Itse 1359 introduction to scripting languages: python. OpenStax CNX. Jan 22, 2016 Download for free at https://legacy.cnx.org/content/col11713/1.32
Google Play and the Google Play logo are trademarks of Google Inc.

Notification Switch

Would you like to follow the 'Itse 1359 introduction to scripting languages: python' conversation and receive update notifications?

Ask