跳至内容

代码优化

Python代码优化

三个基本原则:

三个基本原则:
	1、不要过早的进行优化
		很多人一开始写代码就奔着性能优化的目标,“让正确的程序更快要比让快速的程序正确容易得多”。因此,优化的前提是代码能正常工作。过早地进行优化可能会忽视对总体性能指标的把握,在得到全局结果前不要主次颠倒。
		
	2、权衡优化的代价
		优化是有代价的,想解决所有性能的问题是几乎不可能的。通常面临的选择是时间换空间或空间换时间。另外,开发代价也需要考虑。
		
	3、不优化无关紧要的代码
		如果对代码的每一部分都去优化,这些修改会使代码难以阅读和理解。如果你的代码运行速度很慢,首先要找到代码运行慢的位置,通常是内部循环,专注于运行慢的地方进行优化。在其他地方,一点时间上的损失没有什么影响。

避免全局变量:


# 不推荐写法。代码耗时:26.8秒
    import math

    size = 10000
    for x in range(size):
    for y in range(size):
    z = math.sqrt(x) + math.sqrt(y)
            
    许多程序员刚开始会用 Python 语言写一些简单的脚本当编写脚本时通常习惯了直接将其写为全局变量例如上面的代码但是由于全局变量和局部变量实现方式不同定义在全局范围内的代码运行速度会比定义在函数中的慢不少通过将脚本语句放入到函数中通常可带来 15% - 30% 的速度提升
    
# 推荐写法。代码耗时:20.6秒
    import math

    def main():  # 定义到函数中,以减少全部变量使用
        size = 10000
        for x in range(size):
            for y in range(size):
                z = math.sqrt(x) + math.sqrt(y)

    main()

避免模块和函数属性访问

# 不推荐写法。代码耗时:14.5秒
    import math

    def computeSqrt(size: int):
        result = []
        for i in range(size):
            result.append(math.sqrt(i))
        return result

    def main():
        size = 10000
        for _ in range(size):
            result = computeSqrt(size)

    main()
    
    每次使用.属性访问操作符时会触发特定的方法如__getattribute__()和__getattr__()这些方法会进行字典操作因此会带来额外的时间开销通过from import语句可以消除属性访问
    
# 第一次优化写法。代码耗时:10.9秒
    from math import sqrt

    def computeSqrt(size: int):
        result = []
        for i in range(size):
            result.append(sqrt(i))  # 避免math.sqrt的使用
        return result

    def main():
        size = 10000
        for _ in range(size):
            result = computeSqrt(size)

    main()
    
    在第 1 节中我们讲到局部变量的查找会比全局变量更快因此对于频繁访问的变量sqrt通过将其改为局部变量可以加速运行
    
# 第二次优化写法。代码耗时:9.9秒
    import math

    def computeSqrt(size: int):
        result = []
        sqrt = math.sqrt  # 赋值给局部变量
        for i in range(size):
            result.append(sqrt(i))  # 避免math.sqrt的使用
        return result

    def main():
        size = 10000
        for _ in range(size):
            result = computeSqrt(size)

    main()
    
    除了math.sqrt外computeSqrt函数中还有.的存在那就是调用list的append方法通过将该方法赋值给一个局部变量可以彻底消除computeSqrt函数中for循环内部的.使用
    
# 推荐写法。代码耗时:7.9秒
    import math

    def computeSqrt(size: int):
        result = []
        append = result.append
        sqrt = math.sqrt    # 赋值给局部变量
        for i in range(size):
            append(sqrt(i))  # 避免 result.append 和 math.sqrt 的使用
        return result

    def main():
        size = 10000
        for _ in range(size):
            result = computeSqrt(size)

    main()

避免类内属性访问

# 不推荐写法。代码耗时:10.4秒
    import math
    from typing import List

    class DemoClass:
        def __init__(self, value: int):
            self._value = value

        def computeSqrt(self, size: int) -> List[float]:
            result = []
            append = result.append
            sqrt = math.sqrt
            for _ in range(size):
                append(sqrt(self._value))
            return result

    def main():
        size = 10000
        for _ in range(size):
            demo_instance = DemoClass(size)
            result = demo_instance.computeSqrt(size)

    main()
    
    避免的原则也适用于类内属性访问self._value的速度会比访问一个局部变量更慢一些通过将需要频繁访问的类内属性赋值给一个局部变量可以提升代码运行速度

# 推荐写法。代码耗时:8.0秒
    import math
    from typing import List

    class DemoClass:
        def __init__(self, value: int):
            self._value = value

        def computeSqrt(self, size: int) -> List[float]:
            result = []
            append = result.append
            sqrt = math.sqrt
            value = self._value
            for _ in range(size):
                append(sqrt(value))  # 避免 self._value 的使用
            return result

    def main():
        size = 10000
        for _ in range(size):
            demo_instance = DemoClass(size)
            demo_instance.computeSqrt(size)

    main()

避免不必要的抽象

# 不推荐写法,代码耗时:0.55秒
    class DemoClass:
        def __init__(self, value: int):
            self.value = value

        @property
        def value(self) -> int:
            return self._value

        @value.setter
        def value(self, x: int):
            self._value = x

    def main():
        size = 1000000
        for i in range(size):
            demo_instance = DemoClass(size)
            value = demo_instance.value
            demo_instance.value = i

    main()
    
    任何时候当你使用额外的处理层比如装饰器属性访问描述器去包装代码时都会让代码变慢大部分情况下需要重新进行审视使用属性访问器的定义是否有必要使用getter/setter函数对属性进行访问通常是 C/C++ 程序员遗留下来的代码风格如果真的没有必要就使用简单属性

# 推荐写法,代码耗时:0.33秒
    class DemoClass:
        def __init__(self, value: int):
            self.value = value  # 避免不必要的属性访问器

    def main():
        size = 1000000
        for i in range(size):
            demo_instance = DemoClass(size)
            value = demo_instance.value
            demo_instance.value = i

    main()

避免数据复制

# 不推荐写法,代码耗时:6.5秒
    def main():
        size = 10000
        for _ in range(size):
            value = range(size)
            value_list = [x for x in value]
            square_list = [x * x for x in value_list]

    main()
    上面的代码中value_list完全没有必要这会创建不必要的数据结构或复制
    
# 推荐写法,代码耗时:4.8秒
    def main():
        size = 10000
        for _ in range(size):
            value = range(size)
            square_list = [x * x for x in value]  # 避免无意义的复制

    main()
    另外一种情况是对 Python 的数据共享机制过于偏执并没有很好地理解或信任 Python 的内存模型滥用 copy.deepcopy()之类的函数通常在这些代码中是可以去掉复制操作的
    交换值时不使用中间变量
    
# 不推荐写法,代码耗时:0.07秒
    def main():
        size = 1000000
        for _ in range(size):
            a = 3
            b = 5
            temp = a
            a = b
            b = temp

    main()
	上面的代码在交换值时创建了一个临时变量temp如果不借助中间变量代码更为简洁且运行速度更快
    
# 推荐写法,代码耗时:0.06秒
    def main():
        size = 1000000
        for _ in range(size):
            a = 3
            b = 5
            a, b = b, a  # 不借助中间变量

    main()
    字符串拼接用join而不是+
    
# 不推荐写法,代码耗时:2.6秒
    import string
    from typing import List

    def concatString(string_list: List[str]) -> str:
        result = ''
        for str_i in string_list:
            result += str_i
        return result

    def main():
        string_list = list(string.ascii_letters * 100)
        for _ in range(10000):
            result = concatString(string_list)

    main()
    
    当使用a + b拼接字符串时由于 Python 中字符串是不可变对象其会申请一块内存空间将a和b分别复制到该新申请的内存空间中因此如果要拼接 图片 个字符串会产生 图片 个中间结果每产生一个中间结果都需要申请和复制一次内存严重影响运行效率而使用join()拼接字符串时会首先计算出需要申请的总的内存空间然后一次性地申请所需内存并将每个字符串元素复制到该内存中去

# 推荐写法,代码耗时:0.3秒
    import string
    from typing import List

    def concatString(string_list: List[str]) -> str:
        return ''.join(string_list)  # 使用 join 而不是 +

    def main():
        string_list = list(string.ascii_letters * 100)
        for _ in range(10000):
            result = concatString(string_list)

    main()

利用if条件的短路特性

# 不推荐写法,代码耗时:0.05秒
    from typing import List

    def concatString(string_list: List[str]) -> str:
        abbreviations = {'cf.', 'e.g.', 'ex.', 'etc.', 'flg.', 'i.e.', 'Mr.', 'vs.'}
        abbr_count = 0
        result = ''
        for str_i in string_list:
            if str_i in abbreviations:
                result += str_i
        return result

    def main():
        for _ in range(10000):
            string_list = ['Mr.', 'Hat', 'is', 'Chasing', 'the', 'black', 'cat', '.']
            result = concatString(string_list)

    main()
    
    if 条件的短路特性是指对if a and b这样的语句 当a为False时将直接返回不再计算b对于if a or b这样的语句当a为True时将直接返回不再计算b因此 为了节约运行时间对于or语句应该将值为True可能性比较高的变量写在or前而and应该推后

# 推荐写法,代码耗时:0.03秒
    from typing import List

    def concatString(string_list: List[str]) -> str:
        abbreviations = {'cf.', 'e.g.', 'ex.', 'etc.', 'flg.', 'i.e.', 'Mr.', 'vs.'}
        abbr_count = 0
        result = ''
        for str_i in string_list:
            if str_i[-1] == '.' and str_i in abbreviations:  # 利用 if 条件的短路特性
                result += str_i
        return result

    def main():
        for _ in range(10000):
            string_list = ['Mr.', 'Hat', 'is', 'Chasing', 'the', 'black', 'cat', '.']
            result = concatString(string_list)

    main()

循环优化

用for循环代替while循环
# 不推荐写法。代码耗时:6.7秒
    def computeSum(size: int) -> int:
        sum_ = 0
        i = 0
        while i < size:
            sum_ += i
            i += 1
        return sum_

    def main():
        size = 10000
        for _ in range(size):
            sum_ = computeSum(size)

    main()
   
    Python 的for循环比while循环快不少
    
# 推荐写法。代码耗时:4.3秒
    def computeSum(size: int) -> int:
        sum_ = 0
        for i in range(size):  # for 循环代替 while 循环
            sum_ += i
        return sum_

    def main():
        size = 10000
        for _ in range(size):
            sum_ = computeSum(size)

    main()
    
使用隐式for循环代替显式for循环
针对上面的例子更进一步可以用隐式for循环来替代显式for循环
# 推荐写法。代码耗时:1.7秒
    def computeSum(size: int) -> int:
        return sum(range(size))  # 隐式 for 循环代替显式 for 循环

    def main():
        size = 10000
        for _ in range(size):
            sum = computeSum(size)

    main()
    
减少内层for循环的计算
# 不推荐写法。代码耗时:12.8秒
    import math

    def main():
        size = 10000
        sqrt = math.sqrt
        for x in range(size):
            for y in range(size):
                z = sqrt(x) + sqrt(y)

    main()
	上面的代码中sqrt(x)位于内侧for循环 每次训练过程中都会重新计算一次增加了时间开销
    
# 推荐写法。代码耗时:7.0秒
    import math

    def main():
        size = 10000
        sqrt = math.sqrt
        for x in range(size):
            sqrt_x = sqrt(x)  # 减少内层 for 循环的计算
            for y in range(size):
                z = sqrt_x + sqrt(y)

    main()

使用numba.jit

	numba可以将 Python 函数 JIT 编译为机器码执行大大提高代码运行速度关于numba的更多信息见下面的主页 http://numba.pydata.org/


# 推荐写法。代码耗时:0.62秒
    import numba

    @numba.jit
    def computeSum(size: float) -> int:
        sum = 0
        for i in range(size):
            sum += i
        return sum

    def main():
        size = 10000
        for _ in range(size):
            sum = computeSum(size)

    main()

选择合适的数据结构

    Python 内置的数据结构如str, tuple, list, set, dict底层都是 C 实现的速度非常快自己实现新的数据结构想在性能上达到内置的速度几乎是不可能的

    list类似于 C++ 中的std::vector是一种动态数组其会预分配一定内存空间当预分配的内存空间用完又继续向其中添加元素时会申请一块更大的内存空间然后将原有的所有元素都复制过去之后销毁之前的内存空间再插入新元素删除元素时操作类似当已使用内存空间比预分配内存空间的一半还少时会另外申请一块小内存做一次元素复制之后销毁原有大内存空间因此如果有频繁的新增删除操作新增删除的元素数量又很多时list的效率不高此时应该考虑使用collections.dequecollections.deque是双端队列同时具备栈和队列的特性能够在两端进行O1复杂度的插入和删除操作

    list的查找操作也非常耗时当需要在list频繁查找某些元素或频繁有序访问这些元素时可以使用bisect维护list对象有序并在其中进行二分查找提升查找的效率

    另外一个常见需求是查找极小值或极大值此时可以使用heapq模块将list转化为一个堆使得获取最小值的时间复杂度是O1 
    下面的网页给出了常用的 Python 数据结构的各项操作的时间复杂度
        TimeComplexity - Python Wiki
        wiki.python.org
最后更新于