Python开发中常见的坑（持续更新）

前言

        在Python开发过程中，新手和资深开发者都可能遇到的“坑”.这些坑部分和使用的开发语言特色有深深的联系.

        在这个文章中,列举一下,哪些坑是较常出现的.欢迎大家在评论中举出没发现的坑,我及时作个补充.

目录

前言

坑的类型

1 语法陷阱 

变量命名错误

缩进错误 

自定义对象属性访问或方法调用错误

变量作用域问题

2 类型相关错误 

动态类型误用

类型检查不足 

3 逻辑错误 

4 资源管理不当 

5 模块导入问题 

6 并发编程误区 

---

坑的类型

1. 语法陷阱
2. 类型相关错误
3. 逻辑错误
4. 资源管理不当
5. 异常处理
6. 模块导入问题
7. 并发编程误区
8. 设计模式不恰当

1 语法陷阱 

变量命名错误

有些变量名是不能被使用的,具有特殊含义 .

保留字 如 if、else、while 等。

内置函数名  如print、len、type, list, sum 等

以数字开头的变量名 变量名不能以数字开头，必须以字母或下划线开头。

包含特殊字符的变量名 变量名不能包含空格、连字符（-）、句点（.）等特殊字符，只能由字母、数字和下划线组成。

Python模块名 不建议使用Python标准库或第三方库的模块名作为变量名，以免引起命名冲突。而且从模块的引用顺序,会导致优先引用本地创建的同名模块,导致引用错误.

缩进错误 

Python用缩进来分层,若大量的代码写在一块,容易混淆,导致代码层次不清晰.

自定义对象属性访问或方法调用错误

代码在编写过程中,使用了不存在的属性或者方法,不会马上报错，只有真正执行到那个代码位置时,才会引发语法错误.

变量作用域问题

全局变量和局部变量的混淆，在函数内部未正确使用global关键字声明全局变量。

# 定义一个变量，但变量名拼写错误
my_variable = 10
print(my_varible)  # 此处使用了错误的变量名

# 定义一个函数，但函数名拼写错误
def greet(name):
    print("Hello, " + name + "!")

gree("Alice")  # 此处调用函数时使用了错误的函数名


# 使用了 Python 保留字作为变量名
from = 10  # 使用了保留字 "from" 作为变量名

# 在标识符中包含了不允许的特殊字符
my-variable = 20  # 标识符包含了连字符 "-"
my@variable = 30   # 标识符包含了 "@" 符号
1st_variable = 40  # 标识符以数字开头

缩进错误

# 缩进错误导致的语法错误
if True:
print("This line is not properly indented")  # 此处缩进错误，应该缩进一个Tab或四个空格

# 缩进错误导致的逻辑错误
def greet(name):
    print("Hello, " + name + "!")

    # 缩进错误导致的逻辑错误，应该与上一行语句保持相同的缩进级别
  print("How are you?")  # 此处缩进错误，会导致函数逻辑混乱

变量作用域问题

# 全局作用域与局部作用域
x = 10  # 全局变量

def func():
    # 局部作用域
    y = 20  # 局部变量
    print(x)  # 可以访问全局变量 x
    print(y)  # 可以访问局部变量 y

func()
print(x)  # 在函数外部也可以访问全局变量 x
print(y)  # 但在函数外部无法访问局部变量 y，会导致 NameError

# 嵌套作用域
def outer():
    outer_var = "outer variable"

    def inner():
        inner_var = "inner variable"
        print(outer_var)  # 在内部函数可以访问外部函数的变量
        print(inner_var)

    inner()

outer()
print(outer_var)  # 在外部函数外部无法访问外部函数的变量，会导致 NameError
print(inner_var)  # 在外部函数外部无法访问内部函数的变量，会导致 NameError

2 类型相关错误 

动态类型误用

于Python是动态类型语言，可能出现将不同类型的对象进行非法操作的错误，例如字符串与整数相加、列表与字典混合操作等。

类型检查不足 

忘记对输入数据做类型检查或假设了错误的数据类型，导致运行时TypeError。

# 动态类型误用示例

# 例 1: 意外的类型转换
x = "10"  # 字符串类型
y = 5     # 整数类型

result = x + y  # 意图是将字符串 "10" 和整数 5 相加，但实际上会导致 TypeError
print(result)   # TypeError: can only concatenate str (not "int") to str

# 例 2: 意外的列表元素类型
my_list = [1, 2, 3, 4, 5]  # 包含整数类型的列表

my_list.append("6")  # 意图是在列表末尾添加字符串 "6"，但会改变列表元素的类型
print(my_list)       # [1, 2, 3, 4, 5, '6']

# 例 3: 意外的函数参数类型
def add(a, b):
    return a + b

result = add("10", 5)  # 意图是将字符串 "10" 和整数 5 相加，但会导致 TypeError
print(result)          # TypeError: can only concatenate str (not "int") to str

3 逻辑错误 

混淆逻辑运算符  在条件语句或循环中，使用逻辑运算符（如and、or、not）时容易造成混淆，导致逻辑判断出错。

循环逻辑错误 在编写循环时，循环条件不正确或循环体内部逻辑错误会导致程序陷入死循环或提前跳出循环。

索引错误  在处理列表、字典等数据结构时，容易出现索引错误，例如访问不存在的索引或键，导致程序抛出异常。

作用域问题  变量的作用域不清晰或变量重名等问题会导致程序逻辑混乱，造成意外的结果。 

4 资源管理不当 

文件/数据库连接打开后未关闭：没有正确地使用with语句来自动关闭文件、数据库连接或其他资源，可能导致资源泄露或系统资源耗尽。

 错误样例

# 未关闭文件的示例
file = open("example.txt", "r")
data = file.read()
# 忘记关闭文件

正确样例

 使用 with 语句自动关闭文件

with open("example.txt", "r") as file:
    data = file.read()

5 模块导入问题 

循环导入 两个模块相互引用造成无限递归导入。

导入路径错误 找不到模块或包，尤其是在大型项目中，路径配置不当。

6 并发编程误区 

多线程/多进程同步问题   没有正确处理锁、信号量等同步机制，导致数据竞争或死锁。

异步IO操作 对于异步编程模型的理解不足，比如asyncio库的使用不当，也可能产生难以预料的问题。