10 common mistakes Python programmers make-Python Tutorial-php.cn

About Python

Python is an interpreted, object-oriented, high-level programming language with dynamic semantics. It has built-in advanced data structures and combines the advantages of dynamic typing and dynamic binding, which makes it very attractive in rapid application development and can be used as a script or glue language to connect existing components or services. Python supports modules and packages, thus encouraging program modularization and code reuse.

About this article

Python’s easy-to-learn syntax may cause Python developers – especially those new to programming – to overlook some of its subtleties and underestimate the language’s capabilities.

With that in mind, this article presents a “Top 10” list enumerating errors that even advanced Python developers sometimes struggle to catch.

Common Mistake 1: Abusing expressions as default values for function parameters

Python allows providing default optional values for function parameters. Although this is a feature of the language, it can lead to some confusion with mutable defaults. For example, take a look at the definition of this Python function:

>>> def foo(bar=[]):        # bar is optional and defaults to [] if not specified  
...    bar.append("baz")    # but this line could be problematic, as we&#39;ll see...  
...    return bar

Copy after login

A common mistake is to think that optional parameters will be set to the default specified value every time the function is called without optional parameters. In the code above, for example, one might expect that repeated calls to foo() (i.e. without explicitly specifying the bar parameter) would always return 'baz', since each call to foo() assumes that (without specifying the bar parameter) bar is set to [] (i.e. an empty list).

But let’s see what exactly happens when we do this:

>>> foo()  
["baz"]>>> foo()  
["baz", "baz"]>>> foo()  
["baz", "baz", "baz"]

Copy after login

Yeah? Why do we append the default value "baz" to the existing list every time foo() is called instead of creating a new list?

The answer is that the default values of function parameters are only evaluated once - when the function is defined. Therefore, the bar parameter is initialized to its default value (i.e., an empty list), i.e. when foo() is first defined, but will continue to be used when foo() is called (i.e., when the bar parameter is not specified) as bar was originally initialized parameters.

Here is a common solution:

>>> def foo(bar=None):  
...    if bar is None:        # or if not bar:  
...        bar = []  
...    bar.append("baz")  
...    return bar  
...  
>>> foo()  
["baz"]  
>>> foo()  
["baz"]  
>>> foo()  
["baz"]

Copy after login

Common Mistake 2: Using class variables incorrectly

Consider the following example:

>>> class A(object):  
...     x = 1 
...  
>>> class B(A):  
...     pass 
...  
>>> class C(A):  
...     pass 
...  
>>> print A.x, B.x, C.x  
1 1 1

Copy after login

Use it normally.

>>> B.x = 2

>>> print A.x, B.x, C.x

1 2 1

Well, it will be the same if I try again .

>>> A.x = 3

>>> print A.x, B.x, C.x

3 2 3

What$%#!&? ? We only changed A.x, why did C.x also change?

In Python, class variables are treated internally as dictionaries, which follow the often cited method resolution order (MRO). So in the above code, since the x attribute in class C is not found, it looks up to its base class (although Python supports multiple inheritance, there is only A in the above example). In other words, class C does not have its own x attribute, which is independent of A. Therefore, C.x is actually a reference to A.x.

Common Mistake 3: Specifying the wrong parameters for except

Suppose you have the following piece of code:

>>> try:  
...     l = ["a", "b"]  
...     int(l[2])  
... except ValueError, IndexError:  # To catch both exceptions, right?  
...     pass 
...  
Traceback (most recent call last):  
  File "<stdin>", line 3, in <module>  
IndexError: list index out of range

Copy after login

The problem here is that the except statement does not accept the exception list specified in this way. In contrast, in Python 2.x, using the syntax except Exception, e binds an exception object to the second optional argument (e in this case) for later use. Therefore, in the above example, the IndexError exception is not caught by the except statement, but is raised when it is bound to a parameter named IndexError.

The correct way to catch multiple exceptions in an except statement is to specify the first parameter as a tuple containing all the exceptions to be caught. And, for code portability, use the as keyword, because both Python 2 and Python 3 support this syntax:

>>> try:  
...     l = ["a", "b"]  
...     int(l[2])  
... except (ValueError, IndexError) as e:    
...     pass 
...  
>>>

Copy after login

Common mistake 4: Not understanding Python’s scope

Python is based on LEGB To perform analysis, LEGB is the abbreviation of Local, Enclosing, Global, Built-in. It seems like "knowing what the text means", right? In fact, there are some things that need to be paid attention to in Python. Let’s take a look at the following piece of code:

>>> x = 10 
>>> def foo():  
...     x += 1 
...     print x  
...  
>>> foo()  
Traceback (most recent call last):  
  File "<stdin>", line 1, in <module>  
  File "<stdin>", line 2, in foo  
UnboundLocalError: local variable &#39;x&#39; referenced before assignment

Copy after login

What’s wrong here?

The above problem occurs because when you assign a value to a variable in the scope, Python will automatically treat it as a local variable of the current scope, thereby hiding the variable with the same name in the external scope.

Many people are surprised when they get an UnboundLocalError after adding an assignment statement somewhere in the function body of code that was previously running normally. (You can learn more here)

尤其是当开发者使用 lists 时，这个问题就更加常见. 请看下面这个例子：

>>> lst = [1, 2, 3]  
>>> def foo1():  
...     lst.append(5)   # 没有问题...  
...  
>>> foo1()  
>>> lst  
[1, 2, 3, 5]  
  
>>> lst = [1, 2, 3]  
>>> def foo2():  
...     lst += [5]      # ... 但是这里有问题!  
...  
>>> foo2()

Copy after login

Traceback (most recent call last):

File "", line 1, in

File "", line 2, in foo

UnboundLocalError: local variable 'lst' referenced before assignment

嗯？为什么 foo2 报错，而foo1没有问题呢？

原因和之前那个例子的一样，不过更加令人难以捉摸。foo1 没有对 lst 进行赋值操作，而 foo2 做了。要知道， lst += [5] 是 lst = lst + [5] 的缩写，我们试图对 lst 进行赋值操作（Python把他当成了局部变量）。此外，我们对 lst 进行的赋值操作是基于 lst 自身（这再一次被Python当成了局部变量），但此时还未定义。因此出错！

常见错误 5：当迭代时修改一个列表（List）

下面代码中的问题应该是相当明显的：

>>> odd = lambda x : bool(x % 2)  
>>> numbers = [n for n in range(10)]  
>>> for i in range(len(numbers)):  
...     if odd(numbers[i]):  
...         del numbers[i]  # BAD: Deleting item from a list while iterating over it  
...

Copy after login

Traceback (most recent call last):

File "", line 2, in

IndexError: list index out of range

当迭代的时候，从一个列表（List）或者数组中删除元素，对于任何有经验的开发者来说，这是一个众所周知的错误。尽管上面的例子非常明显，但是许多高级开发者在更复杂的代码中也并非是故意而为之的。

幸运的是，Python包含大量简洁优雅的编程范例，若使用得当，能大大简化和精炼代码。这样的好处是能得到更简化和更精简的代码，能更好的避免程序中出现当迭代时修改一个列表（List）这样的bug。一个这样的范例是递推式列表（list comprehensions）。而且，递推式列表（list comprehensions）针对这个问题是特别有用的，通过更改上文中的实现，得到一段极佳的代码：

>>> odd = lambda x : bool(x % 2)  
>>> numbers = [n for n in range(10)]  
>>> numbers[:] = [n for n in numbers if not odd(n)]  # ahh, the beauty of it all  
>>> numbers  
[0, 2, 4, 6, 8]

Copy after login

常见错误 6: 不明白Python在闭包中是如何绑定变量的

看下面这个例子：

>>> def create_multipliers():  
...     return [lambda x : i * x for i in range(5)]  
>>> for multiplier in create_multipliers():  
...     print multiplier(2)  
...

Copy after login

你也许希望获得下面的输出结果：

但实际的结果却是：

惊讶吧!

这之所以会发生是由于Python中的“后期绑定”行为——闭包中用到的变量只有在函数被调用的时候才会被赋值。所以，在上面的代码中，任何时候，当返回的函数被调用时，Python会在该函数被调用时的作用域中查找 i 对应的值（这时，循环已经结束，所以 i 被赋上了最终的值——4）。

解决的方法有一点hack的味道：

>>> def create_multipliers():  
...     return [lambda x, i=i : i * x for i in range(5)]  
...  
>>> for multiplier in create_multipliers():  
...     print multiplier(2)  
...

Copy after login

在这里，我们利用了默认参数来生成一个匿名的函数以便实现我们想要的结果。有人说这个方法很巧妙，有人说它难以理解，还有人讨厌这种做法。但是，如果你是一个 Python 开发者，理解这种行为很重要。

常见错误 7: 创建循环依赖模块

让我们假设你有两个文件，a.py 和 b.py，他们之间相互引用，如下所示：

a.py:

import b  
def f():  
    return b.x    
print f()

Copy after login

b.py:

import a  
x = 1 
def g():  
    print a.f()

Copy after login

首先，让我们尝试引入 a.py：

>>> import a

可以正常工作。这也许是你感到很奇怪。毕竟，我们确实在这里引入了一个循环依赖的模块，我们推测这样会出问题的，不是吗？

答案就是在Python中，仅仅引入一个循环依赖的模块是没有问题的。如果一个模块已经被引入了，Python并不会去再次引入它。但是，根据每个模块要访问其他模块中的函数和变量位置的不同，就很可能会遇到问题。

所以，回到我们这个例子，当我们引入 a.py 时，再引入 b.py 不会产生任何问题，因为当引入的时候，b.py 不需要 a.py 中定义任何东西。b.py 中唯一引用 a.py 中的东西是调用 a.f()。但是那个调用是发生在g() 中的，并且 a.py 和 b.py 中都没有调用 g()。所以运行正常。

但是，如果我们尝试去引入b.py 会发生什么呢？（在这之前不引入a.py），如下所示:

>>> import b

Copy after login

Traceback (most recent call last):

File "", line 1, in

File "b.py", line 1, in

import a

File "a.py", line 6, in

print f()

File "a.py", line 4, in f

return b.x

AttributeError: 'module' object has no attribute 'x'

啊哦。出问题了！此处的问题是，在引入b.py的过程中，Python尝试去引入 a.py，但是a.py 要调用f()，而f() 有尝试去访问 b.x。但是此时 b.x 还没有被定义呢。所以发生了 AttributeError 异常。

至少，解决这个问题很简单，只需修改b.py，使其在g()中引入 a.py：

x = 1 
def g():  
    import a    # 只有当g()被调用的时候才会引入a  
    print a.f()

Copy after login

现在，当我们再引入b，没有任何问题：

>>> import b  
>>> b.g()  
1    # Printed a first time since module 'a' calls 'print f()' at the end  
1    # Printed a second time, this one is our call to 'g'

Copy after login

常见错误 8: 与Python标准库中的模块命名冲突

Copy after login

Python一个令人称赞的地方是它有丰富的模块可供我们“开箱即用”。但是，如果你没有有意识的注意的话，就很容易出现你写的模块和Python自带的标准库的模块之间发生命名冲突的问题（如，你也许有一个叫 email.py 的模块，但这会和标准库中的同名模块冲突）。

这可能会导致很怪的问题，例如，你引入了另一个模块，但这个模块要引入一个Python标准库中的模块，由于你定义了一个同名的模块，就会使该模块错误的引入了你的模块，而不是 stdlib 中的模块。这就会出问题了。

因此，我们必须要注意这个问题，以避免使用和Python标准库中相同的模块名。修改你包中的模块名要比通过 Python Enhancement Proposal (PEP) 给Python提建议来修改标准库的模块名容易多了。

常见错误 #9: 未能解决Python 2和Python 3之间的差异

请看下面这个 filefoo.py:

import sys  
def bar(i):  
    if i == 1:  
        raise KeyError(1)  
    if i == 2:  
        raise ValueError(2)  
  
def bad():  
    e = None 
    try:  
        bar(int(sys.argv[1]))  
    except KeyError as e:  
        print(&#39;key error&#39;)  
    except ValueError as e:  
        print(&#39;value error&#39;)  
    print(e)  
  
bad()

Copy after login

在Python 2中运行正常：

$ python foo.py 1

key error

$ python foo.py 2

value error

但是，现在让我们把它在Python 3中运行一下：

$ python3 foo.py 1

key error

Traceback (most recent call last):

File "foo.py", line 19, in

bad()

File "foo.py", line 17, in bad

print(e)

UnboundLocalError: local variable 'e' referenced before assignment

出什么问题了？ “问题”就是，在 Python 3 中，异常的对象在 except 代码块之外是不可见的。（这样做的原因是，它将保存一个对内存中堆栈帧的引用周期，直到垃圾回收器运行并且从内存中清除掉引用。了解更多技术细节请参考这里）。

一种解决办法是在 except 代码块的外部作用域中定义一个对异常对象的引用，以便访问。下面的例子使用了该方法，因此最后的代码可以在Python 2 和 Python 3中运行良好。

import sys  
def bar(i):  
    if i == 1:  
        raise KeyError(1)  
    if i == 2:  
        raise ValueError(2)  
def good():  
    exception = None 
    try:  
        bar(int(sys.argv[1]))  
    except KeyError as e:  
        exception = e  
        print(&#39;key error&#39;)  
    except ValueError as e:  
        exception = e  
        print(&#39;value error&#39;)  
    print(exception)  
  
good()

Copy after login

在Py3k中运行:

$ python3 foo.py 1

key error

$ python3 foo.py 2

value error

正常!

(顺便提一下, 我们的 Python Hiring Guide 讨论了当我们把代码从Python 2 迁移到 Python 3时的其他一些需要知道的重要差异。)

常见错误 10: 误用__del__方法

假设你有一个名为 calledmod.py 的文件：

import foo  
class Bar(object):  
           ...  
    def __del__(self):  
        foo.cleanup(self.myhandle)

Copy after login

并且有一个名为 another_mod.py 的文件：

import mod

mybar = mod.Bar()

你会得到一个 AttributeError 的异常。

为什么呢？因为，正如这里所说，当解释器退出的时候，模块中的全局变量都被设置成了 None。所以，在上面这个例子中，当 __del__ 被调用时，foo 已经被设置成了None。

解决方法是使用 atexit.register() 代替。用这种方式，当你的程序结束执行时（意思是正常退出），你注册的处理程序会在解释器退出之前执行。

了解了这些，我们可以将上面 mod.py 的代码修改成下面的这样：

import foo  
import atexit  
def cleanup(handle):  
    foo.cleanup(handle)  
class Bar(object):  
    def __init__(self):  
        ...  
        atexit.register(cleanup, self.myhandle)

Copy after login

这种实现方式提供了一个整洁并且可信赖的方法用来在程序退出之前做一些清理工作。很显然，它是由foo.cleanup 来决定对绑定在 self.myhandle 上对象做些什么处理工作的，但是这就是你想要的。

总结

Python是一门强大的并且很灵活的语言，它有很多机制和语言规范来显著的提高你的生产力。和其他任何一门语言或软件一样，如果对它能力的了解有限，这很可能会给你带来阻碍，而不是好处。正如一句谚语所说的那样 “knowing enough to be dangerous”（译者注：意思是自以为已经了解足够了，可以做某事了，但其实不是）。

熟悉Python的一些关键的细微之处，像本文中所提到的那些（但不限于这些），可以帮助我们更好的去使用语言，从而避免一些常见的陷阱。