summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Kuchling <amk@amk.ca>2015-04-21 23:43:33 (GMT)
committerAndrew Kuchling <amk@amk.ca>2015-04-21 23:43:33 (GMT)
commit333518e01df0ce011962ca8629e766a59316e1cb (patch)
treea70ad45819e811c872b5db7eab6649cd6e4806f6
parentb6076fb13c6bf97f4fae76da478a26e0f4f24879 (diff)
downloadcpython-333518e01df0ce011962ca8629e766a59316e1cb.zip
cpython-333518e01df0ce011962ca8629e766a59316e1cb.tar.gz
cpython-333518e01df0ce011962ca8629e766a59316e1cb.tar.bz2
#15183: clarify timeit documentation to say that setup statement isn't timed
-rw-r--r--Doc/library/timeit.rst2
-rwxr-xr-xLib/timeit.py3
2 files changed, 4 insertions, 1 deletions
diff --git a/Doc/library/timeit.rst b/Doc/library/timeit.rst
index 503a705..70df409 100644
--- a/Doc/library/timeit.rst
+++ b/Doc/library/timeit.rst
@@ -94,6 +94,8 @@ The module defines three convenience functions and a public class:
method. The :meth:`.repeat` method is a convenience to call :meth:`.timeit`
multiple times and return a list of results.
+ The execution time of *setup* is excluded from the overall timed execution run.
+
The *stmt* and *setup* parameters can also take objects that are callable
without arguments. This will embed calls to them in a timer function that
will then be executed by :meth:`.timeit`. Note that the timing overhead is a
diff --git a/Lib/timeit.py b/Lib/timeit.py
index 9cec000..cf7446d 100755
--- a/Lib/timeit.py
+++ b/Lib/timeit.py
@@ -14,7 +14,8 @@ Command line usage:
Options:
-n/--number N: how many times to execute 'statement' (default: see below)
-r/--repeat N: how many times to repeat the timer (default 3)
- -s/--setup S: statement to be executed once initially (default 'pass')
+ -s/--setup S: statement to be executed once initially (default 'pass').
+ Execution time of this setup statement is NOT timed.
-p/--process: use time.process_time() (default is time.perf_counter())
-t/--time: use time.time() (deprecated)
-c/--clock: use time.clock() (deprecated)