[Python知识库]一次修改Python编码规范的引起的“血案“

简单来说就是因为如下代码, 导致了ZipOutputPath的一个函数异常, 导致zip包不能正确下载

有如下报错:

UnboundLocalError: local variable 'val' referenced before assignment

排查发现，错误发生点代码简化如下

修改代码编码规范中从函数内注释部分import time修改为加入到开头import time(根据标准库、第三方库、自研库的顺序, 由短到长进行导包)

#!usr/bin/python
# -*- coding:utf8 -*-
import time

def print_time():
    # import time
    time = time.time()
    
if __name__ == '__main__':
    print_time()
"""
修改的部分包含:
由注释导包处修改为从文件开头导包time
"""

规则1

导入部分(import)应该置于模块注释和文档字符串之后，模块全局变
量和常量声明之前

如果文件中定义了类似 all 、 version 这种全局变量（以两个下划线开头、以两个下划线结
尾），那么导入部分应该放在这类定义的后面，但 future 模块的导入例外， future 模块的
导入必须放在文档字符串之后，其他内容之前。

#!usr/bin/python
# -*- coding:utf8 -*-
"""This is a module
Functions of this module
"""
from __future__ import print_function
__all__ = ['hello', 'world']
__version__ = 'V1.0'
import os
import sys
from time import sleep

规则2

避免在无关的标识符或无关的概念之间重用名字， 避免因重名而导致
的意外赋值和错误引用

Python的函数/类定义和C语言不同，函数/类定义语句实际上是给一个名字赋值。因此重复定义 一个函
数/类的名字不会导致错误，后定义的会覆盖前面的。但是重复定义很容易掩盖编码问题，让同 一个名
字的函数/类在不同的执行阶段具有不同的含义，不利于可读性，应予以禁止。 Python在解析一个被引
用的名字时遵循LEGB顺序（Local - Enclosed - Global - Builtin），从内层一直查找到外层。内层定义
的变量会遮盖外层的同名变量。在代码修改时，同名的变量容易导致错误的引用，也不利于代码可读
性，应当尽量避免。
应避免重用名字的场景如下：

1. 标识符的命名避免和内置函数、内置类以及Python关键字重复。
2. 避免重复定义函数、类方法或类。
3. 标识符命名避免与当前导入的模块名称重名。
4. 避免在函数中定义与参数名称相同的变量，这可能导致潜在的错误。

下面代码具体分析

如下代码会引发错误
UnboundLocalError: local variable ‘time’ referenced before assignment
原因是local变量中只能去读time,并不能对time进行修改

#!usr/bin/python
# -*- coding:utf8 -*-
"""
legb error
"""
import time


def show_module_info():
    for key in globals():
        print("globals: ", key)


def print_time():
    # import time
    # for key in locals():
    #     print("locals: ", key)
    time = time.time()


if __name__ == '__main__':
    # show_module_info()
    # print_time()
    print_time()

如下代码不会报错,原因为local中每次调用都会有time变量, 而且重复调用不会发生问题

#!usr/bin/python
# -*- coding:utf8 -*-
"""
legb error
"""
import time


def show_module_info():
    for key in globals():
        print("globals: ", key)


def print_time():
    import time
    for key in locals():
        print("locals: ", key)
    time = time.time()


if __name__ == '__main__':
    show_module_info()
    print_time()
    print_time()

result

globals:  __name__
globals:  __doc__
globals:  __package__
globals:  __loader__
globals:  __spec__
globals:  __annotations__
globals:  __builtins__
globals:  __file__
globals:  __cached__
globals:  time
globals:  show_module_info
globals:  print_time
locals:  time
locals:  time

可以看到，第一次调用并没有发生错误,global作用就是可以在局部变量(函数中)修改全局变量time, 但是第二次调用却发生了错误,因为time此时是float类型

#!usr/bin/python
# -*- coding:utf8 -*-
"""
legb error
"""
import time


def show_module_info():
    for key in globals():
        print("globals: ", key)


def print_time():
    for key in locals():
        print("locals: ", key)
    global time
    time = time.time()


if __name__ == '__main__':
    show_module_info()
    print_time()
    print_time()

result

AttributeError: 'float' object has no attribute 'time'
globals:  __name__
globals:  __doc__
globals:  __package__
globals:  __loader__
globals:  __spec__
globals:  __annotations__
globals:  __builtins__
globals:  __file__
globals:  __cached__
globals:  time
globals:  show_module_info
globals:  print_time

总结: 编码规范需要灵活应用，用不好就是潘多拉魔盒