feat(mysql): move to pymysql

Author: cofin

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ exclude: "^docs/conf.py"
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
       - id: check-added-large-files
@@ -19,7 +19,7 @@ repos:
 
   # Ruff replaces black, flake8, autoflake and isort
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.11.11" # make sure this is always consistent with hatch configs
+    rev: "v0.12.9" # make sure this is always consistent with hatch configs
     hooks:
       - id: ruff
         args: [--config, ./pyproject.toml]

docs/supported-databases/mysql.rst

@@ -16,13 +16,13 @@ Usage Example
 .. code-block:: python
 
     import pytest
-    import mysql.connector
+    import pymysql
     from pytest_databases.docker.mysql import MySQLService
 
     pytest_plugins = ["pytest_databases.docker.mysql"]
 
     def test(mysql_service: MySQLService) -> None:
-        with mysql.connector.connect(
+        with pymysql.connect(
             host=mysql_service.host,
             port=mysql_service.port,
             user=mysql_service.user,
@@ -33,7 +33,7 @@ Usage Example
             resp = cursor.fetchone()
             assert resp is not None and resp[0] == 1
 
-    def test(mysql_connection: mysql.connector.MySQLConnection) -> None:
+    def test(mysql_connection: pymysql.Connection) -> None:
         with mysql_connection.cursor() as cursor:
             cursor.execute("CREATE TABLE if not exists simple_table as SELECT 1 as the_value")
             cursor.execute("select * from simple_table")

pyproject.toml

@@ -65,7 +65,7 @@ keydb = ["redis"]
 mariadb = ["mariadb"]
 minio = ["minio"]
 mssql = ["pymssql"]
-mysql = ["mysql-connector-python"]
+mysql = ["pymysql"]
 oracle = ["oracledb"]
 postgres = ["psycopg>=3"]
 redis = ["redis"]

src/pytest_databases/docker/mysql.py

@@ -4,7 +4,7 @@
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
-import mysql.connector
+import pymysql
 import pytest
 
 from pytest_databases._service import DockerService, ServiceContainer
@@ -13,7 +13,7 @@
 if TYPE_CHECKING:
     from collections.abc import Generator
 
-    from mysql.connector.abstracts import MySQLConnectionAbstract
+    from pymysql import Connection
 
     from pytest_databases.types import XdistIsolationLevel
 
@@ -50,23 +50,23 @@ def _provide_mysql_service(
 
     def check(_service: ServiceContainer) -> bool:
         try:
-            conn = mysql.connector.connect(
+            conn = pymysql.connect(
                 host=_service.host,
                 port=_service.port,
                 user=user,
                 database=database,
                 password=password,
             )
-        except mysql.connector.errors.OperationalError as exc:
-            if "Lost connection" in exc.msg:  # type: ignore
+        except pymysql.OperationalError as exc:
+            if "Lost connection" in str(exc):
                 return False
             raise
 
         try:
             with conn.cursor() as cursor:
                 cursor.execute("select 1 as is_available")
                 resp = cursor.fetchone()
-            return resp is not None and resp[0] == 1  # type: ignore
+            return resp is not None and resp[0] == 1
         finally:
             with contextlib.suppress(Exception):
                 conn.close()
@@ -166,41 +166,41 @@ def mysql_8_service(
 
 
 @pytest.fixture(scope="session")
-def mysql_56_connection(mysql_56_service: MySQLService) -> Generator[MySQLConnectionAbstract, None, None]:
-    with mysql.connector.connect(
+def mysql_56_connection(mysql_56_service: MySQLService) -> Generator[Connection, None, None]:
+    with pymysql.connect(
         host=mysql_56_service.host,
         port=mysql_56_service.port,
         user=mysql_56_service.user,
         database=mysql_56_service.db,
         password=mysql_56_service.password,
     ) as conn:
-        yield conn  # type: ignore
+        yield conn
 
 
 @pytest.fixture(scope="session")
-def mysql_57_connection(mysql_57_service: MySQLService) -> Generator[MySQLConnectionAbstract, None, None]:
-    with mysql.connector.connect(
+def mysql_57_connection(mysql_57_service: MySQLService) -> Generator[Connection, None, None]:
+    with pymysql.connect(
         host=mysql_57_service.host,
         port=mysql_57_service.port,
         user=mysql_57_service.user,
         database=mysql_57_service.db,
         password=mysql_57_service.password,
     ) as conn:
-        yield conn  # type: ignore
+        yield conn
 
 
 @pytest.fixture(scope="session")
-def mysql_connection(mysql_8_connection: MySQLConnectionAbstract) -> MySQLConnectionAbstract:
+def mysql_connection(mysql_8_connection: Connection) -> Connection:
     return mysql_8_connection
 
 
 @pytest.fixture(scope="session")
-def mysql_8_connection(mysql_8_service: MySQLService) -> Generator[MySQLConnectionAbstract, None, None]:
-    with mysql.connector.connect(
+def mysql_8_connection(mysql_8_service: MySQLService) -> Generator[Connection, None, None]:
+    with pymysql.connect(
         host=mysql_8_service.host,
         port=mysql_8_service.port,
         user=mysql_8_service.user,
         database=mysql_8_service.db,
         password=mysql_8_service.password,
     ) as conn:
-        yield conn  # type: ignore
+        yield conn

tests/test_mysql.py

@@ -13,11 +13,11 @@
 )
 def test_service_fixture(pytester: pytest.Pytester, service_fixture: str) -> None:
     pytester.makepyfile(f"""
-    import mysql.connector
+    import pymysql
     pytest_plugins = ["pytest_databases.docker.mysql"]
 
     def test({service_fixture}):
-        with mysql.connector.connect(
+        with pymysql.connect(
             host={service_fixture}.host,
             port={service_fixture}.port,
             user={service_fixture}.user,