database-wrapper-mysql 0.1.28__tar.gz

database_wrapper_mysql-0.1.28/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.1
+Name: database_wrapper_mysql
+Version: 0.1.28
+Summary: database_wrapper for MySQL database
+Author-email: Gints Murans <gm@gm.lv>
+License: GNU General Public License v3.0 (GPL-3.0)
+Project-URL: Homepage, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Documentation, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Changes, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Code, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Issue Tracker, https://github.com/gintsmurans/py_database_wrapper/issues
+Project-URL: Download, https://pypi.org/project/database_wrapper/
+Keywords: database,wrapper,python,mysql,mariadb
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+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
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Front-Ends
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: database_wrapper==0.1.28
+Requires-Dist: mysqlclient>=2.2.2
+
+# database_wrapper
+
+_Part of the `database_wrapper` package._
+
+This python package is a database wrapper for [MySQL](https://www.mysql.com/) and [MariaDB](https://mariadb.org/) databases.
+
+## Installation
+
+```bash
+pip install database_wrapper[mysql]
+```
+
+## Usage
+
+```python
+from database_wrapper_mysql import MySQL, DBWrapperMySQL
+
+db = MySQL({
+    "hostname": "localhost",
+    "port": 3306,
+    "username": "root",
+    "password": "your_password",
+    "database": "my_database"
+})
+db.open()
+dbWrapper = DBWrapperMySQL(db=db)
+
+# Simple query
+aModel = MyModel()
+res = await dbWrapper.getByKey(
+    aModel,
+    "id",
+    3005,
+)
+if res:
+    print(f"getByKey: {res.toDict()}")
+else:
+    print("No results")
+
+# Raw query
+res = await dbWrapper.getAll(
+    aModel,
+    """
+        SELECT t1.*, t2.name AS other_name
+        FROM my_table AS t1
+        LEFT JOIN other_table AS t2 ON t1.other_id = t2.id
+    """
+)
+async for record in res:
+    print(f"getAll: {record.toDict()}")
+else:
+    print("No results")
+
+db.close()
+```

database_wrapper_mysql-0.1.28/README.md

@@ -0,0 +1,55 @@
+# database_wrapper
+
+_Part of the `database_wrapper` package._
+
+This python package is a database wrapper for [MySQL](https://www.mysql.com/) and [MariaDB](https://mariadb.org/) databases.
+
+## Installation
+
+```bash
+pip install database_wrapper[mysql]
+```
+
+## Usage
+
+```python
+from database_wrapper_mysql import MySQL, DBWrapperMySQL
+
+db = MySQL({
+    "hostname": "localhost",
+    "port": 3306,
+    "username": "root",
+    "password": "your_password",
+    "database": "my_database"
+})
+db.open()
+dbWrapper = DBWrapperMySQL(db=db)
+
+# Simple query
+aModel = MyModel()
+res = await dbWrapper.getByKey(
+    aModel,
+    "id",
+    3005,
+)
+if res:
+    print(f"getByKey: {res.toDict()}")
+else:
+    print("No results")
+
+# Raw query
+res = await dbWrapper.getAll(
+    aModel,
+    """
+        SELECT t1.*, t2.name AS other_name
+        FROM my_table AS t1
+        LEFT JOIN other_table AS t2 ON t1.other_id = t2.id
+    """
+)
+async for record in res:
+    print(f"getAll: {record.toDict()}")
+else:
+    print("No results")
+
+db.close()
+```

database_wrapper_mysql-0.1.28/database_wrapper_mysql/__init__.py

@@ -0,0 +1,24 @@
+"""
+database_wrapper_mysql package - MySQL database wrapper
+
+Part of the database_wrapper package
+"""
+
+# Copyright 2024 Gints Murans
+
+import logging
+
+from .db_wrapper_mysql import DBWrapperMysql
+from .connector import MyConfig, MySQL
+
+# Set the logger to a quiet default, can be enabled if needed
+logger = logging.getLogger("database_wrapper_mysql")
+if logger.level == logging.NOTSET:
+    logger.setLevel(logging.WARNING)
+
+
+__all__ = [
+    "DBWrapperMysql",
+    "MyConfig",
+    "MySQL",
+]

database_wrapper_mysql-0.1.28/database_wrapper_mysql/connector.py

@@ -0,0 +1,101 @@
+from typing import Any, NotRequired, TypedDict
+
+from MySQLdb.connections import Connection as MySqlConnection
+from MySQLdb.cursors import DictCursor as MySqlDictCursor
+
+from database_wrapper import DatabaseBackend
+
+
+class MyConfig(TypedDict):
+    hostname: str
+    port: NotRequired[int]
+    username: str
+    password: str
+    database: str
+    charset: NotRequired[str]
+    collation: NotRequired[str]
+    kwargs: NotRequired[dict[str, Any]]
+
+
+class MySQL(DatabaseBackend):
+    """
+    MySQL database backend
+
+    :param config: Configuration for MySQL
+    :type config: MyConfig
+
+    Defaults:
+        port = 0 - See comment below
+        charset = utf8
+        collation = utf8_general_ci
+    """
+
+    config: MyConfig
+
+    connection: MySqlConnection
+    cursor: MySqlDictCursor
+
+    def open(self):
+        # Free resources
+        if hasattr(self, "connection") and self.connection:
+            self.close()
+
+        # Set defaults
+        if "port" not in self.config or not self.config["port"]:
+            self.config["port"] = 0
+
+        if "charset" not in self.config or not self.config["charset"]:
+            self.config["charset"] = "utf8"
+
+        if "collation" not in self.config or not self.config["collation"]:
+            self.config["collation"] = "utf8_general_ci"
+
+        if "kwargs" not in self.config or not self.config["kwargs"]:
+            self.config["kwargs"] = {}
+
+        self.logger.debug("Connecting to DB")
+        self.connection = MySqlConnection(
+            host=self.config["hostname"],
+            user=self.config["username"],
+            passwd=self.config["password"],
+            db=self.config["database"],
+            # By default, when port is not specified, Python library passes 0 to
+            # MySQL C API function mysql_real_connect as port number.
+            #
+            # At https://dev.mysql.com/doc/c-api/8.0/en/mysql-real-connect.html
+            # is written "If port is not 0, the value is used as the port number
+            # for the TCP/IP connection."
+            #
+            # We keep the same behavior not to break services that have port
+            # number unspecified.
+            port=self.config.get("port", 0),
+            connect_timeout=self.connectionTimeout,
+            use_unicode=True,
+            charset=self.config["charset"],
+            collation=self.config["collation"],
+            cursorclass=MySqlDictCursor,
+            **self.config["kwargs"],
+        )
+        self.cursor = self.connection.cursor(MySqlDictCursor)
+
+    def lastInsertId(self) -> int:
+        assert self.cursor, "Cursor is not initialized"
+        return self.cursor.lastrowid
+
+    def affectedRows(self) -> int:
+        assert self.cursor, "Cursor is not initialized"
+        return self.cursor.rowcount
+
+    def commit(self) -> None:
+        """Commit DB queries"""
+        assert self.connection, "Connection is not initialized"
+
+        self.logger.debug("Commit DB queries..")
+        self.connection.commit()
+
+    def rollback(self) -> None:
+        """Rollback DB queries"""
+        assert self.connection, "Connection is not initialized"
+
+        self.logger.debug("Rollback DB queries..")
+        self.connection.rollback()

database_wrapper_mysql-0.1.28/database_wrapper_mysql/db_wrapper_mysql.py

@@ -0,0 +1,66 @@
+import logging
+from typing import Any
+
+from MySQLdb.connections import Connection as MySqlConnection
+from MySQLdb.cursors import DictCursor as MySqlDictCursor
+
+from database_wrapper import DBWrapper
+
+from .connector import MySQL
+
+
+class DBWrapperMysql(DBWrapper):
+    """Base model for all RV4 models"""
+
+    # Override db instance
+    db: MySQL
+
+    #######################
+    ### Class lifecycle ###
+    #######################
+
+    # Meta methods
+    def __init__(
+        self,
+        db: MySQL,
+        dbConn: MySqlConnection | None = None,
+        logger: logging.Logger | None = None,
+    ):
+        """
+        Initializes a new instance of the DBWrapper class.
+
+        Args:
+            db (MySQL): The MySQL object.
+            logger (logging.Logger, optional): The logger object. Defaults to None.
+        """
+        super().__init__(db, dbConn, logger)
+
+    ######################
+    ### Helper methods ###
+    ######################
+
+    def logQuery(
+        self,
+        cursor: MySqlDictCursor,
+        query: Any,
+        params: tuple[Any, ...],
+    ) -> None:
+        """
+        Logs the given query and parameters.
+
+        Args:
+            query (Any): The query to log.
+            params (tuple[Any, ...]): The parameters to log.
+        """
+        queryString = cursor.mogrify(query, params)
+        self.logger.debug(f"Query: {queryString}")
+
+    #####################
+    ### Query methods ###
+    #####################
+
+    def limitQuery(self, offset: int = 0, limit: int = 100) -> str:
+        return f"LIMIT {offset},{limit}"
+
+    async def createCursor(self, emptyDataClass: Any | None = None) -> MySqlDictCursor:
+        return self.db.connection.cursor(MySqlDictCursor)

database_wrapper_mysql-0.1.28/database_wrapper_mysql.egg-info/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.1
+Name: database_wrapper_mysql
+Version: 0.1.28
+Summary: database_wrapper for MySQL database
+Author-email: Gints Murans <gm@gm.lv>
+License: GNU General Public License v3.0 (GPL-3.0)
+Project-URL: Homepage, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Documentation, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Changes, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Code, https://github.com/gintsmurans/py_database_wrapper
+Project-URL: Issue Tracker, https://github.com/gintsmurans/py_database_wrapper/issues
+Project-URL: Download, https://pypi.org/project/database_wrapper/
+Keywords: database,wrapper,python,mysql,mariadb
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+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
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Front-Ends
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: database_wrapper==0.1.28
+Requires-Dist: mysqlclient>=2.2.2
+
+# database_wrapper
+
+_Part of the `database_wrapper` package._
+
+This python package is a database wrapper for [MySQL](https://www.mysql.com/) and [MariaDB](https://mariadb.org/) databases.
+
+## Installation
+
+```bash
+pip install database_wrapper[mysql]
+```
+
+## Usage
+
+```python
+from database_wrapper_mysql import MySQL, DBWrapperMySQL
+
+db = MySQL({
+    "hostname": "localhost",
+    "port": 3306,
+    "username": "root",
+    "password": "your_password",
+    "database": "my_database"
+})
+db.open()
+dbWrapper = DBWrapperMySQL(db=db)
+
+# Simple query
+aModel = MyModel()
+res = await dbWrapper.getByKey(
+    aModel,
+    "id",
+    3005,
+)
+if res:
+    print(f"getByKey: {res.toDict()}")
+else:
+    print("No results")
+
+# Raw query
+res = await dbWrapper.getAll(
+    aModel,
+    """
+        SELECT t1.*, t2.name AS other_name
+        FROM my_table AS t1
+        LEFT JOIN other_table AS t2 ON t1.other_id = t2.id
+    """
+)
+async for record in res:
+    print(f"getAll: {record.toDict()}")
+else:
+    print("No results")
+
+db.close()
+```

database_wrapper_mysql-0.1.28/database_wrapper_mysql.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+database_wrapper_mysql/__init__.py
+database_wrapper_mysql/connector.py
+database_wrapper_mysql/db_wrapper_mysql.py
+database_wrapper_mysql/py.typed
+database_wrapper_mysql.egg-info/PKG-INFO
+database_wrapper_mysql.egg-info/SOURCES.txt
+database_wrapper_mysql.egg-info/dependency_links.txt
+database_wrapper_mysql.egg-info/requires.txt
+database_wrapper_mysql.egg-info/top_level.txt

database_wrapper_mysql-0.1.28/database_wrapper_mysql.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

database_wrapper_mysql-0.1.28/database_wrapper_mysql.egg-info/requires.txt

@@ -0,0 +1,2 @@
+database_wrapper==0.1.28
+mysqlclient>=2.2.2

database_wrapper_mysql-0.1.28/database_wrapper_mysql.egg-info/top_level.txt

@@ -0,0 +1 @@
+database_wrapper_mysql

database_wrapper_mysql-0.1.28/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools >= 61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "database_wrapper_mysql"
+version = "0.1.28"
+description = "database_wrapper for MySQL database"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "GNU General Public License v3.0 (GPL-3.0)"}
+authors = [
+    {name = "Gints Murans", email = "gm@gm.lv"}
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+    "Topic :: Database",
+    "Topic :: Database :: Front-Ends",
+    "Topic :: Software Development",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+keywords = ["database", "wrapper", "python", "mysql", "mariadb"]
+dependencies = [
+    "database_wrapper == 0.1.28",
+    "mysqlclient >= 2.2.2"
+]
+
+[project.urls]
+Homepage = "https://github.com/gintsmurans/py_database_wrapper"
+Documentation = "https://github.com/gintsmurans/py_database_wrapper"
+Changes = "https://github.com/gintsmurans/py_database_wrapper"
+Code = "https://github.com/gintsmurans/py_database_wrapper"
+"Issue Tracker" = "https://github.com/gintsmurans/py_database_wrapper/issues"
+Download = "https://pypi.org/project/database_wrapper/"
+
+[tool.setuptools.package-data]
+database_wrapper_mysql = ["py.typed"]

database_wrapper_mysql-0.1.28/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+