mysql-api 0.1.0__tar.gz

mysql_api-0.1.0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: mysql-api
+Version: 0.1.0
+Summary: 封装mysql操作
+Author: LiuWei
+Author-email: 183074632@qq.com
+Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: pymysql (>=1.1.1,<2.0.0)
+Requires-Dist: sqlalchemy (>=2.0.36,<3.0.0)
+Description-Content-Type: text/markdown
+
+### Mysql 数据库封装

mysql_api-0.1.0/README.md

@@ -0,0 +1 @@
+### Mysql 数据库封装

mysql_api-0.1.0/mysql_api/exception.py

@@ -0,0 +1,24 @@
+"""mysql_api exception module."""
+
+class MySQLAPIError(Exception):
+    """Base class for mysql_api exceptions."""
+
+
+class MySQLAPIConnectionError(MySQLAPIError):
+    """Exception raised when there is a connection error."""
+
+
+class MySQLAPIQueryError(MySQLAPIError):
+    """Exception raised when there is a query error."""
+
+
+class MySQLAPIAddError(MySQLAPIError):
+    """Exception raised when there is an add error."""
+
+
+class MySQLAPIUploadError(MySQLAPIError):
+    """Exception raised when there is an upload error."""
+
+
+class MySQLAPIDeleteError(MySQLAPIError):
+    """Exception raised when there is a delete error."""

mysql_api-0.1.0/mysql_api/mysql_database.py

@@ -0,0 +1,110 @@
+"""Mysql 数据库模块."""
+import logging
+from typing import Union, Dict
+
+from sqlalchemy import create_engine, text
+from sqlalchemy.exc import DatabaseError
+from sqlalchemy.orm import sessionmaker, scoped_session
+from sqlalchemy.orm.decl_api import DeclarativeMeta
+
+from mysql_api.exception import MySQLAPIAddError, MySQLAPIQueryError
+
+
+# pylint: disable=R0913, R0917
+# noinspection SqlNoDataSourceInspection
+class MySQLDatabase:
+    """MySQLDatabase class."""
+
+    def __init__(self, user_name, password, database_name: str = "cyg", host: str = "127.0.0.1", port: int = 3306):
+        self.logger = logging.getLogger(__name__)
+        self.engine = create_engine(
+            f"mysql+pymysql://{user_name}:{password}@{host}:{port}/{database_name}?charset=utf8mb4", echo=True
+        )
+        self.session = scoped_session(sessionmaker(bind=self.engine))
+
+    @staticmethod
+    def create_database(user_name: str, password: str, db_name: str, host: str = "127.0.0.1", port: int = 3306):
+        """创建数据库.
+
+        Args:
+            user_name: 用户名.
+            password: 密码.
+            host: 数据库服务地址ip.
+            port:端口号.
+            db_name: 要创建的数据库名称.
+        """
+        engine = create_engine(f"mysql+pymysql://{user_name}:{password}@{host}:{port}", echo=True)
+        with engine.connect() as con:
+            con.execute(text(f"CREATE DATABASE IF NOT EXISTS {db_name}"))
+
+    def create_table(self, declarative_base: DeclarativeMeta):
+        """在执行数据库下创建数据表.
+
+        Args:
+            declarative_base: SQLAlchemy的declarative_base对象.
+        """
+        declarative_base.metadata.create_all(self.engine)
+
+    def add_data(self, model_cls, data: dict):
+        """向指定数据表添加一行数据.
+
+        Args:
+            model_cls: 数据表模型class.
+            data: 要添加的数据, 键值对形式.
+
+        Raises:
+            MySQLAPIAddError: 添加数据失败抛出异常.
+        """
+        with self.session() as session:
+            try:
+                new_instance = model_cls(**data)
+                session.add(new_instance)
+                session.commit()
+            except DatabaseError as e:
+                session.rollback()
+                raise MySQLAPIAddError(f"Failed to add data to {model_cls.__name__}: {e}") from e
+
+    def update_data(
+            self, model_cls, key: str, key_value: Union[str, int, float],
+            update_values: Dict[str, Union[str, int, float]]
+    ):
+        """向指定数据表更新数据.
+
+        Args:
+            model_cls: 数据表模型class.
+            key: 要更新的字段名.
+            key_value: key字段的值.
+            update_values: 要更新的字段值.
+
+        Raises:
+            MySQLAPIAddError: 更新数据失败抛出异常.
+        """
+        with self.session() as session:
+            try:
+                if instances := self.query_data(model_cls, **{key: key_value}):
+                    for instance in instances:
+                        for field, value in update_values.items():
+                            setattr(instance, field, value)
+                        session.commit()
+            except DatabaseError as e:
+                session.rollback()
+                raise MySQLAPIAddError(f"Failed to add data to {model_cls.__name__}: {e}") from e
+
+    def query_data(self, model_cls, **filters: Dict[str, Union[int, str, float]]):
+        """查询指定模型的数据.
+
+        Args:
+            model_cls: SQLAlchemy 模型类.
+            filters: 查询条件，以关键字参数传入.
+
+        Returns:
+            list: 查询结果列表.
+
+        Raises:
+            MySQLAPIQueryError: 查询失败抛出异常.
+        """
+        with self.session() as session:
+            try:
+                return session.query(model_cls).filter_by(**filters).all()
+            except DatabaseError as e:
+                raise MySQLAPIQueryError(f"Failed to query data for {model_cls.__name__}: {e}") from e

mysql_api-0.1.0/pyproject.toml

@@ -0,0 +1,16 @@
+[tool.poetry]
+name = "mysql-api"
+version = "0.1.0"
+description = "封装mysql操作"
+authors = ["LiuWei <183074632@qq.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = ">=3.8"
+sqlalchemy = "^2.0.36"
+pymysql = "^1.1.1"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"