在使用 pymysql 库连接 mysql 或 mariadb 数据库时，开发者可能会遇到一个令人困惑的 typeerror。即使数据库凭据在其他客户端中验证无误，代码在调用 pymysql.connect() 时仍可能抛出 typeerror: __init__() takes 1 positional argument but 5 were given。这个错误消息看似指出了参数数量不匹配，但实际的根本原因并非参数数量，而是参数的传递方式不符合 pymysql api 的要求。
错误现象解析
当您尝试以下列方式连接数据库时：
import pymysql as mdb db_host = 'some.server.co.uk' db_user = 'my_username' db_pass = 'my_password' db_name = 'my_db_name' # 错误示范：使用位置参数 db = mdb.connect(db_host, db_user, db_pass, db_name)
Python 解释器会报告 TypeError: __init__() takes 1 positional argument but 5 were given。这里的“1 positional argument”实际上指的是 self，即实例本身，而您提供的 db_host, db_user, db_pass, db_name 被解释为额外的四个位置参数，导致了类型错误。这表明 pymysql.connect() 函数的设计要求所有用户提供的参数都必须是关键字参数。
正确的连接方式：使用关键字参数
根据 PyMySQL 的官方文档，connect() 函数期望接收的是命名参数（即关键字参数），而不是位置参数。这意味着在调用 connect() 时，您需要明确指定每个参数的名称，例如 host、user、password 和 database。
以下是使用关键字参数正确连接数据库的示例：
import pymysql
# 假设这些配置来自您的 dbconfig 模块或环境变量
db_host = 'localhost' # 或 'some.server.co.uk'
db_user = 'your_username'
db_pass = 'your_password'
db_name = 'your_database_name'
db_port = 3306 # 默认端口，如果非默认则需指定
try:
# 正确示范：使用关键字参数
connection = pymysql.connect(
host=db_host,
user=db_user,
password=db_pass,
database=db_name,
port=db_port, # 可选，如果使用非标准端口
charset='utf8mb4', # 推荐指定字符集
cursorclass=pymysql.cursors.DictCursor # 可选，返回字典形式的结果
)
print("数据库连接成功！")
# 执行一些数据库操作
with connection.cursor() as cursor:
# 示例：创建表
sql_create_table = """
CREATE TABLE IF NOT EXISTS example_table (
id INT AUTO_INCREMENT PRIMARY KEY,
name VARCHAR(255) NOT NULL,
age INT
)
"""
cursor.execute(sql_create_table)
print("表 'example_table' 检查或创建完成。")
# 示例：插入数据
sql_insert = "INSERT INTO example_table (name, age) VALUES (%s, %s)"
cursor.execute(sql_insert, ('Alice', 30))
cursor.execute(sql_insert, ('Bob', 24))
connection.commit() # 提交事务
print("数据插入成功。")
# 示例：查询数据
sql_select = "SELECT id, name, age FROM example_table WHERE age > %s"
cursor.execute(sql_select, (25,))
result = cursor.fetchall()
print("\n查询结果 (年龄大于25):")
for row in result:
print(row)
except pymysql.Error as e:
print(f"数据库连接或操作失败: {e}")
finally:
if 'connection' in locals() and connection.open:
connection.close()
print("数据库连接已关闭。")
在上述代码中，我们明确指定了 host='localhost'、user='your_username' 等，确保了参数以正确的关键字形式传递。
关键参数说明
- host: 数据库服务器地址。
- user: 连接数据库的用户名。
- password: 用户密码。
- database: 要连接的数据库名称。
- port: 数据库服务器端口，默认为 3306。
- charset: 连接字符集，推荐使用 utf8mb4 以支持更广泛的字符。
- cursorclass: 指定游标类型，例如 pymysql.cursors.DictCursor 可以让 fetchall() 返回字典列表，方便处理。
注意事项与最佳实践
- 始终使用关键字参数： 这是避免 TypeError 的核心。
- 错误处理： 使用 try...except...finally 结构捕获 pymysql.Error 异常，确保连接能够被妥善关闭，即使发生错误。
- 资源管理： 数据库连接是宝贵的资源。确保在操作完成后通过 connection.close() 关闭连接。在 with 语句中使用 connection 对象（如果 PyMySQL 支持，或者手动管理 finally 块）是推荐的做法。
- 安全凭据管理： 避免在代码中硬编码敏感的数据库凭据。推荐使用环境变量、配置文件（如 dbconfig.py 或 .ini 文件）来存储和加载这些信息。
- 字符集： 明确指定 charset 参数有助于避免乱码问题，特别是处理多语言数据时。
- 游标类型： cursorclass 参数的选择会影响 fetch 方法返回的数据格式。DictCursor 返回字典，而默认游标返回元组，根据您的需求选择。
总结
PyMySQL TypeError: __init__() takes 1 positional argument but 5 were given 错误通常不是因为提供了错误的参数数量，而是因为没有按照 PyMySQL API 的要求使用关键字参数来传递连接信息。通过将 pymysql.connect() 的所有参数都明确指定为关键字参数，您可以轻松解决此问题，并建立一个稳定可靠的数据库连接。遵循本教程中的最佳实践，将有助于您编写更健壮、更安全的数据库交互代码。
