python3使用timeit库做函数性能时间测试

# ++++++++++++++++++++++++++++++++++++++++++++++++++++++
# <read-code-notes: 2021/6/9/9:48>
# NOTE: 使用timeit库做函数性能时间测试。
参考官方文档很好理解：https://docs.python.org/zh-cn/3/library/timeit.html#module-timeit

该模块定义了三个便利函数和一个公共类：

timeit.timeit(stmt='pass', setup='pass', timer=<default timer>, number=1000000, globals=None)
    使用给定语句、 setup码和timer函数创建一个Timer实例，并执行 number 次其 timeit() 方法。可选的 globals 参数指定用于执行代码的命名空间。
    在 3.5 版更改: 添加可选参数 globals 。

timeit.repeat(stmt='pass', setup='pass', timer=<default timer>, repeat=5, number=1000000, globals=None)
    使用给定语句、 setup 代码和 timer 函数创建一个 Timer 实例，并使用给定的 repeat 计数和 number 执行运行其 repeat() 方法。可选的 globals 参数指定用于执行代码的命名空间。
    在 3.5 版更改: 添加可选参数 globals 。
    在 3.7 版更改: repeat 的默认值由 3 更改为 5 。

timeit.default_timer()
    默认的计时器，总是 time.perf_counter() 。
    在 3.3 版更改: time.perf_counter() 现在是默认计时器。

class timeit.Timer(stmt='pass', setup='pass', timer=<timer function>, globals=None)
    用于小代码片段的计数执行速度的类。
    构造函数接受一个将计时的语句、一个用于设置的附加语句和一个定时器函数。两个语句都默认为 'pass' ；计时器函数与平台有关（请参阅模块文档字符串）。 stmt 和 setup 也可能包含多个以 ; 或换行符分隔的语句，只要它们不包含多行字符串文字即可。该语句默认在 timeit 的命名空间内执行；可以通过将命名空间传递给 globals 来控制此行为。
    要测量第一个语句的执行时间，请使用 timeit() 方法。 repeat() 和 autorange() 方法是方便的方法来调用 timeit() 多次。
    setup 的执行时间从总体计时执行中排除。
    stmt 和 setup 参数也可以使用不带参数的可调用对象。这将在一个计时器函数中嵌入对它们的调用，然后由 timeit() 执行。请注意，由于额外的函数调用，在这种情况下，计时开销会略大一些。
    在 3.5 版更改: 添加可选参数 globals 。

    timeit(number=1000000)
        执行 number 次主要语句。这将执行一次 setup 语句，然后返回执行主语句多次所需的时间，以秒为单位测量为浮点数。参数是通过循环的次数，默认为一百万。要使用的主语句、 setup 语句和 timer 函数将传递给构造函数。
        注解：默认情况下， timeit() 暂时关闭 garbage collection 。这种方法的优点在于它使独立时序更具可比性。缺点是GC可能是所测量功能性能的重要组成部分。如果是这样，可以在 setup 字符串中的第一个语句重新启用GC。例如:
        timeit.Timer('for i in range(10): oct(i)', 'gc.enable()').timeit()

    autorange(callback=None)
        自动决定调用多少次 timeit() 。
        这是一个便利函数，它反复调用 timeit() ，以便总时间 >= 0.2 秒，返回最终（循环次数，循环所用的时间）。它调用 timeit() 的次数以序列 1, 2, 5, 10, 20, 50, ... 递增，直到所用的时间至少为0.2秒。
        如果给出 callback 并且不是 None ，则在每次试验后将使用两个参数调用它： callback(number, time_taken) 。
        3.6 新版功能.

    repeat(repeat=5, number=1000000)
        调用 timeit() 几次。
        这是一个方便的函数，它反复调用 timeit() ，返回结果列表。第一个参数指定调用 timeit() 的次数。第二个参数指定 timeit() 的 number 参数。
        注解：从结果向量计算并报告平均值和标准差这些是很诱人的。但是，这不是很有用。在典型情况下，最低值给出了机器运行给定代码段的速度的下限；结果向量中较高的值通常不是由Python的速度变化引起的，而是由于其他过程干扰你的计时准确性。所以结果的 min() 可能是你应该感兴趣的唯一数字。之后，你应该看看整个向量并应用常识而不是统计。
        在 3.7 版更改: repeat 的默认值由 3 更改为 5 。

    print_exc(file=None)
        帮助程序从计时代码中打印回溯。
        典型使用:
        t = Timer(...)       # outside the try/except
        try:
            t.timeit(...)    # or t.repeat(...)
        except Exception:
            t.print_exc()
        与标准回溯相比，优势在于将显示已编译模板中的源行。可选的 file 参数指向发送回溯的位置；它默认为 sys.stderr 。

命令行界面：
从命令行调用程序时，使用以下表单:
python -m timeit [-n N] [-r N] [-u U] [-s S] [-h] [statement ...]
如果了解以下选项：
-n N, --number=N
    执行 '语句' 多少次

-r N, --repeat=N
    重复计时器的次数（默认为5）

-s S, --setup=S
    最初要执行一次的语句（默认为 pass ）

-p, --process
    测量进程时间，而不是 wallclock 时间，使用 time.process_time() 而不是 time.perf_counter() ，这是默认值
    3.3 新版功能.

-u, --unit=U
    指定定时器输出的时间单位；可以选择 nsec，usec，msec或sec
    3.5 新版功能.

-v, --verbose
    打印原始计时结果；重复更多位数精度

-h, --help
    打印一条简短的使用信息并退出

可以通过将每一行指定为单独的语句参数来给出多行语句；通过在引号中包含参数并使用前导空格可以缩进行。多个 -s 选项的处理方式相似。

如果未给出 -n，则会通过尝试按序列 1, 2, 5, 10, 20, 50, ... 递增的数值来计算合适的循环次数，直到总计时间至少为 0.2 秒。

default_timer() 测量可能受到在同一台机器上运行的其他程序的影响，因此在需要精确计时时最好的做法是重复几次计时并使用最佳时间。 -r 选项对此有利；在大多数情况下，默认的 5 次重复可能就足够了。 你可以使用 time.process_time() 来测量CPU时间。

注解：执行 pass 语句会产生一定的基线开销。这里的代码不会试图隐藏它，但你应该知道它。可以通过不带参数调用程序来测量基线开销，并且Python版本之间可能会有所不同。

# ++++++++++++++++++++++++++++++++++++++++++++++++++++++
示例1：
自己设置重复次数number,不自己设置则系统根据程序耗时自动设置。

$ python3 -m timeit --number 100 '"-".join(str(n) for n in range(100))'
100 loops, best of 3: 17.9 usec per loop
$ python3 -m timeit '"-".join([str(n) for n in range(100)])'
10000 loops, best of 5: 27.5 usec per loop
$ python3 -m timeit '"-".join(map(str, range(100)))'
10000 loops, best of 5: 23.2 usec per loop

示例2：

import timeit

strlist = ["test str" for n in range(10000)]

def join_test():
    return "".join(strlist)

def plus_test():
    result = ""
    for i in strlist:
        result = result + i
    return result

if __name__ == "__main__":
    jointimer = timeit.timeit()
    # print(jointimer)
    # exit()
    jointimer = timeit.Timer("join_test()", "from __main__ import join_test")

    print("jointime:", jointimer.timeit(number=1000))
    plustimer = timeit.Timer("plus_test()", "from __main__ import plus_test")
    print("plustime:", plustimer.timeit(number=1000))