Specify time unit for timeit CLI

[serhiy-storchaka]

BPO	18983
Nosy	@tim-one, @birkenfeld, @pitrou, @rbtcollins, @ezio-melotti, @berkerpeksag, @serhiy-storchaka, @vajrasky, @jstasiak, @pquentin
Files	issue18983.patch issue18983.patch issue18983_v2.patch issue18983_v3.patch issue18983_v4.patch issue18983_v5.patch issue18983_v5.patch issue18983_v6.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2015-03-17.21:01:41.998>
created_at = <Date 2013-09-08.21:15:56.832>
labels = ['easy', 'type-feature', 'library']
title = 'Specify time unit for timeit CLI'
updated_at = <Date 2015-03-17.21:01:41.997>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2015-03-17.21:01:41.997>
actor = 'rbcollins'
assignee = 'none'
closed = True
closed_date = <Date 2015-03-17.21:01:41.998>
closer = 'rbcollins'
components = ['Library (Lib)']
creation = <Date 2013-09-08.21:15:56.832>
creator = 'serhiy.storchaka'
dependencies = []
files = ['32862', '32874', '33058', '33064', '33066', '33067', '33068', '33095']
hgrepos = []
issue_num = 18983
keywords = ['patch', 'easy']
message_count = 27.0
messages = ['197322', '197333', '197345', '204541', '204606', '205612', '205697', '205720', '205723', '205731', '205736', '205737', '205738', '205914', '205922', '205923', '205931', '206834', '206869', '207990', '207995', '216024', '226093', '233346', '233348', '238337', '238338']
nosy_count = 13.0
nosy_names = ['tim.peters', 'georg.brandl', 'pitrou', 'rbcollins', 'ezio.melotti', 'python-dev', 'berker.peksag', 'serhiy.storchaka', 'Vincentdavis', 'vajrasky', 'jstasiak', 'Julian.Gindi', 'Quentin.Pradet']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue18983'
versions = ['Python 3.5']

[serhiy-storchaka]

Just an idea. Currently the timeit module in command line automatically choice most appropriate time unit for human readable output. But this makes the output less machine readable. I propose to add new option which specifies fixed time unit (usec, msec, sec).

[pitrou]

If you want the output to be machine readable, better go the full way and add a --json option, IMO.

[jstasiak]

My 2 cents - I'd split timeit.main function into processing part and argument parsing + data printing part so that you could use Python to call the first one to get the actual results (timings, numbers of loops etc.) and then present the data to the outside world in any needed format - no text parsing needed.

[JulianGindi]

I created a patch that allows users to specify a time unit output using the "-u" flag. Example usage:

python -m timeit -u "msec" '"-".join(str(n) for n in range(100))'

> 10000 loops, best of 3: 0.156 msec per loop

python -m timeit -u "sec" '"-".join(str(n) for n in range(100))'

> 10000 loops, best of 3: 0.000159 sec per loop

You can specify msec, sec, or usec. I am also interested in having a JSON option as mentioned by Antoine. Any thoughts?

[JulianGindi]

Updated patch to include unit tests.

[JulianGindi]

Just wanted to check to see if there was anything else I should do regarding this issue.

[JulianGindi]

Implemented proposed changes to patch. Simplified "for-loop" and implemented invalid input test.

[JulianGindi]

Incorporated updates suggested by serhiy.storchaka

[serhiy-storchaka]

It will be better to write error message to sys.stderr (see test_main_exception).

[JulianGindi]

Updated patch to log to stderr.

[JulianGindi]

Added newline after error message.

[serhiy-storchaka]

The patch is doubled.

[JulianGindi]

Whoops. Sorry about that. Super embarrassing.

[JulianGindi]

Re-uploaded the patch to remove duplication.

[serhiy-storchaka]

Besides too long line with sys.stderr.write last patch LGTM.

[serhiy-storchaka]

Ah, I forgot. This feature should be documented in Doc/library/timeit.rst.

[JulianGindi]

Updated documentation and fixed a few lines that were too long.

[JulianGindi]

Just wanted to check in and see if the documentation change I made is sufficient. I tried to copy the other entries for the command line arguments. Let me know if I can improve it in any way.

[serhiy-storchaka]

LGTM.

[JulianGindi]

What needs to be done to close this one out?

[vajrasky]

This feature is for Python 3.5. I think, we will not commit anything to Python 3.5 until Python 3.4 branch is created (in other world, released). So, be patient. :)

[pquentin]

The branch appears to exist now.

[JulianGindi]

Anything else need to be done on this patch?

[Vincentdavis]

Anything else need to be done on this patch?

[berkerpeksag]

I've added a couple of comments on Rietveld.

[python-dev]

New changeset 1ebf8d5b7d60 by Robert Collins in branch 'default':
Issue bpo-18983: Allow selection of output units in timeit.
https://hg.python.org/cpython/rev/1ebf8d5b7d60

[python-dev]

New changeset ed34dd00405e by Robert Collins in branch 'default':
Fix patch attribution for bpo-18983.
https://hg.python.org/cpython/rev/ed34dd00405e