database-wrapper-pgsql 0.1.33__tar.gz → 0.1.38__tar.gz

{database_wrapper_pgsql-0.1.33 → database_wrapper_pgsql-0.1.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: database_wrapper_pgsql
-Version: 0.1.33
+Version: 0.1.38
 Summary: database_wrapper for PostgreSQL database
 Author-email: Gints Murans <gm@gm.lv>
 License: GNU General Public License v3.0 (GPL-3.0)
@@ -32,11 +32,11 @@ 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.33
+Requires-Dist: database_wrapper==0.1.38
 Requires-Dist: psycopg[binary]>=3.2.0
 Requires-Dist: psycopg[pool]>=3.2.0
 
-# database_wrapper
+# database_wrapper_pgsql
 
 _Part of the `database_wrapper` package._
 

{database_wrapper_pgsql-0.1.33 → database_wrapper_pgsql-0.1.38}/README.md

@@ -1,4 +1,4 @@
-# database_wrapper
+# database_wrapper_pgsql
 
 _Part of the `database_wrapper` package._
 

database_wrapper_pgsql-0.1.38/database_wrapper_pgsql/db_wrapper_pgsql.py

@@ -0,0 +1,131 @@
+import logging
+from typing import Any, overload
+
+from psycopg import Cursor, sql
+from psycopg.rows import class_row
+
+from database_wrapper import DataModelType, DBWrapper
+
+from .db_wrapper_pgsql_mixin import DBWrapperPgSQLMixin
+from .connector import (
+    # Sync
+    PgConnectionType,
+    PgCursorType,
+    PgSQL,
+)
+
+
+class DBWrapperPgSQL(DBWrapperPgSQLMixin, DBWrapper):
+    """
+    Sync database wrapper for postgres
+    """
+
+    # Override db instance
+    db: PgSQL
+    """ PostgreSQL database connector """
+
+    dbConn: PgConnectionType | None = None
+    """ PostgreSQL connection object """
+
+    #######################
+    ### Class lifecycle ###
+    #######################
+
+    # Meta methods
+    # We are overriding the __init__ method for the type hinting
+    def __init__(
+        self,
+        db: PgSQL | None = None,
+        dbConn: PgConnectionType | None = None,
+        logger: logging.Logger | None = None,
+    ):
+        """
+        Initializes a new instance of the DBWrapper class.
+
+        Args:
+            db (MySQL): The PostgreSQL connector.
+            dbConn (MySqlConnection, optional): The PostgreSQL connection object. Defaults to None.
+            logger (logging.Logger, optional): The logger object. Defaults to None.
+        """
+        super().__init__(db, dbConn, logger)
+
+    ###############
+    ### Setters ###
+    ###############
+
+    def updateDb(self, db: PgSQL) -> None:
+        """
+        Updates the database backend object.
+
+        Args:
+            db (DatabaseBackend): The new database backend object.
+        """
+        self.db = db
+
+    def updateDbConn(self, dbConn: PgConnectionType) -> None:
+        """
+        Updates the database connection object.
+
+        Args:
+            dbConn (Any): The new database connection object.
+        """
+        self.dbConn = dbConn
+
+    ######################
+    ### Helper methods ###
+    ######################
+
+    @overload
+    def createCursor(self) -> PgCursorType: ...
+
+    @overload
+    def createCursor(
+        self,
+        emptyDataClass: DataModelType,
+    ) -> Cursor[DataModelType]: ...
+
+    def createCursor(
+        self,
+        emptyDataClass: DataModelType | None = None,
+    ) -> Cursor[DataModelType] | PgCursorType:
+        """
+        Creates a new cursor object.
+
+        Args:
+            emptyDataClass (DBDataModel | None, optional): The data model to use for the cursor.
+                Defaults to None.
+
+        Returns:
+            PgAsyncCursorType | AsyncCursor[DBDataModel]: The created cursor object.
+        """
+        assert self.db is not None, "Database connection is not set"
+
+        # First we need connection
+        if self.dbConn is None:
+            self.dbConn = self.db.connection
+
+        # Lets make sure we have a connection
+        if self.dbConn is None:
+            raise Exception("Failed to get connection")
+
+        if emptyDataClass is None:
+            return self.dbConn.cursor()
+
+        return self.dbConn.cursor(row_factory=class_row(emptyDataClass.__class__))
+
+    def logQuery(
+        self,
+        cursor: Cursor[Any],
+        query: sql.SQL | sql.Composed,
+        params: tuple[Any, ...],
+    ) -> None:
+        """
+        Logs the given query and parameters.
+
+        Args:
+            cursor (Any): The database cursor.
+            query (Any): The query to log.
+            params (tuple[Any, ...]): The parameters to log.
+        """
+        queryString = query.as_string(self.dbConn)
+        logging.getLogger().debug(f"Query: {queryString}")

database_wrapper_pgsql-0.1.38/database_wrapper_pgsql/db_wrapper_pgsql_async.py

@@ -0,0 +1,141 @@
+import logging
+from typing import Any, overload
+
+from psycopg import AsyncCursor, sql
+from psycopg.rows import class_row
+
+from database_wrapper import DataModelType, DBWrapperAsync
+
+from .db_wrapper_pgsql_mixin import DBWrapperPgSQLMixin
+from .connector import (
+    # Async
+    PgAsyncConnectionType,
+    PgAsyncCursorType,
+    PgSQLWithPoolingAsync,
+)
+
+
+class DBWrapperPgSQLAsync(DBWrapperPgSQLMixin, DBWrapperAsync):
+    """
+    Async database wrapper for postgres
+
+    This is meant to be used in async environments.
+    Also remember to call close() when done as we cannot do that in __del__.
+    """
+
+    # Override db instance
+    db: PgSQLWithPoolingAsync
+    """ Async PostgreSQL database connector """
+
+    dbConn: PgAsyncConnectionType | None = None
+    """ Async PostgreSQL connection object """
+
+    #######################
+    ### Class lifecycle ###
+    #######################
+
+    # Meta methods
+    # We are overriding the __init__ method for the type hinting
+    def __init__(
+        self,
+        db: PgSQLWithPoolingAsync | None = None,
+        dbConn: PgAsyncConnectionType | None = None,
+        logger: logging.Logger | None = None,
+    ):
+        """
+        Initializes a new instance of the DBWrapper class.
+
+        Args:
+            db (MySQL): The PostgreSQL database connector.
+            dbConn (MySqlConnection, optional): The PostgreSQL connection object. Defaults to None.
+            logger (logging.Logger, optional): The logger object. Defaults to None.
+        """
+        super().__init__(db, dbConn, logger)
+
+    async def close(self) -> None:
+        if hasattr(self, "dbConn") and self.dbConn and hasattr(self, "db") and self.db:
+            await self.db.returnConnection(self.dbConn)
+
+        await super().close()
+
+    ###############
+    ### Setters ###
+    ###############
+
+    def updateDb(self, db: PgSQLWithPoolingAsync) -> None:
+        """
+        Updates the database backend object.
+
+        Args:
+            db (DatabaseBackend): The new database backend object.
+        """
+        self.db = db
+
+    def updateDbConn(self, dbConn: PgAsyncConnectionType) -> None:
+        """
+        Updates the database connection object.
+
+        Args:
+            dbConn (Any): The new database connection object.
+        """
+        self.dbConn = dbConn
+
+    ######################
+    ### Helper methods ###
+    ######################
+
+    @overload
+    async def createCursor(self) -> PgAsyncCursorType: ...
+
+    @overload
+    async def createCursor(
+        self,
+        emptyDataClass: DataModelType,
+    ) -> AsyncCursor[DataModelType]: ...
+
+    async def createCursor(
+        self,
+        emptyDataClass: DataModelType | None = None,
+    ) -> AsyncCursor[DataModelType] | PgAsyncCursorType:
+        """
+        Creates a new cursor object.
+
+        Args:
+            emptyDataClass (DBDataModel | None, optional): The data model to use for the cursor.
+                Defaults to None.
+
+        Returns:
+            PgAsyncCursorType | AsyncCursor[DBDataModel]: The created cursor object.
+        """
+        assert self.db is not None, "Database connection is not set"
+
+        # First we need connection
+        if self.dbConn is None:
+            status = await self.db.newConnection()
+            if not status:
+                raise Exception("Failed to create new connection")
+
+            (pgConn, _pgCur) = status
+            self.dbConn = pgConn
+
+        if emptyDataClass is None:
+            return self.dbConn.cursor()
+
+        return self.dbConn.cursor(row_factory=class_row(emptyDataClass.__class__))
+
+    def logQuery(
+        self,
+        cursor: AsyncCursor[Any],
+        query: sql.SQL | sql.Composed,
+        params: tuple[Any, ...],
+    ) -> None:
+        """
+        Logs the given query and parameters.
+
+        Args:
+            cursor (Any): The database cursor.
+            query (Any): The query to log.
+            params (tuple[Any, ...]): The parameters to log.
+        """
+        queryString = query.as_string(self.dbConn)
+        logging.getLogger().debug(f"Query: {queryString}")

database_wrapper_pgsql-0.1.38/database_wrapper_pgsql/db_wrapper_pgsql_mixin.py

@@ -0,0 +1,171 @@
+from typing import Any, cast
+
+from psycopg import sql
+
+from database_wrapper import OrderByItem, DataModelType
+
+
+class DBWrapperPgSQLMixin:
+    """
+    Mixin for providing methods that can be used by both sync and async versions of the DBWrapperPgSQL class.
+    """
+
+    ######################
+    ### Helper methods ###
+    ######################
+
+    def makeIdentifier(self, schema: str | None, name: str) -> sql.Identifier | str:
+        """
+        Creates a SQL identifier object from the given name.
+
+        Args:
+            name (str): The name to create the identifier from.
+
+        Returns:
+            sql.Identifier: The created SQL identifier object.
+        """
+        if schema:
+            return sql.Identifier(schema, name)
+
+        return sql.Identifier(name)
+
+    def turnDataIntoModel(
+        self,
+        emptyDataClass: DataModelType,
+        dbData: dict[str, Any],
+    ) -> DataModelType:
+        """
+        Turns the given data into a data model.
+        By default we are pretty sure that there is no factory in the cursor,
+        So we need to create a new instance of the data model and fill it with data
+
+        Args:
+            emptyDataClass (DataModelType): The data model to use.
+            dbData (dict[str, Any]): The data to turn into a model.
+
+        Returns:
+            DataModelType: The data model filled with data.
+        """
+
+        return cast(DataModelType, dbData)
+
+    #####################
+    ### Query methods ###
+    #####################
+
+    def filterQuery(
+        self,
+        schemaName: str | None,
+        tableName: str,
+    ) -> sql.SQL | sql.Composed | str:
+        """
+        Creates a SQL query to filter data from the given table.
+
+        Args:
+            schemaName (str): The name of the schema to filter data from.
+            tableName (str): The name of the table to filter data from.
+
+        Returns:
+            sql.SQL | sql.Composed: The created SQL query object.
+        """
+        return sql.SQL("SELECT * FROM {table}").format(
+            table=self.makeIdentifier(schemaName, tableName)
+        )
+
+    def orderQuery(
+        self,
+        orderBy: OrderByItem | None = None,
+    ) -> sql.SQL | sql.Composed | None:
+        """
+        Creates a SQL query to order the results by the given column.
+
+        Args:
+            orderBy (OrderByItem | None, optional): The column to order the results by. Defaults to None.
+
+        Returns:
+            Any: The created SQL query object.
+
+        TODO: Fix return type
+        """
+        if orderBy is None:
+            return None
+
+        orderList = [
+            f"{item[0]} {item[1] if len(item) > 1 and item[1] != None else 'ASC'}"
+            for item in orderBy
+        ]
+        return sql.SQL("ORDER BY %s" % ", ".join(orderList))  # type: ignore
+
+    def limitQuery(
+        self,
+        offset: int = 0,
+        limit: int = 100,
+    ) -> sql.Composed | sql.SQL | None:
+        if limit == 0:
+            return None
+
+        return sql.SQL("LIMIT {} OFFSET {}").format(limit, offset)
+
+    def _formatFilterQuery(
+        self,
+        query: sql.SQL | sql.Composed | str,
+        qFilter: sql.SQL | sql.Composed | None,
+        order: sql.SQL | sql.Composed | None,
+        limit: sql.SQL | sql.Composed | None,
+    ) -> sql.Composed:
+
+        if isinstance(query, str):
+            query = sql.SQL(query)  # type: ignore
+
+        queryParts: list[sql.Composable] = [query]
+        if qFilter is not None:
+            queryParts.append(qFilter)
+        if order is not None:
+            queryParts.append(order)
+        if limit is not None:
+            queryParts.append(limit)
+
+        return sql.SQL(" ").join(queryParts)
+
+    def _formatInsertQuery(
+        self,
+        tableIdentifier: sql.Identifier | str,
+        storeData: dict[str, Any],
+        returnKey: sql.Identifier | str,
+    ) -> sql.Composed:
+        keys = storeData.keys()
+        values = list(storeData.values())
+
+        return sql.SQL(
+            "INSERT INTO {table} ({columns}) VALUES ({values}) RETURNING {id_key}"
+        ).format(
+            table=tableIdentifier,
+            columns=sql.SQL(", ").join(map(sql.Identifier, keys)),
+            values=sql.SQL(", ").join(sql.Placeholder() * len(values)),
+            id_key=returnKey,
+        )
+
+    def _formatUpdateQuery(
+        self,
+        tableIdentifier: sql.Identifier | str,
+        updateKey: sql.Identifier | str,
+        updateData: dict[str, Any],
+    ) -> sql.Composed:
+        keys = updateData.keys()
+        set_clause = sql.SQL(", ").join(
+            sql.Identifier(key) + sql.SQL(" = %s") for key in keys
+        )
+        return sql.SQL("UPDATE {table} SET {set_clause} WHERE {id_key} = %s").format(
+            table=tableIdentifier,
+            set_clause=set_clause,
+            id_key=updateKey,
+        )
+
+    def _formatDeleteQuery(
+        self,
+        tableIdentifier: sql.Identifier | str,
+        deleteKey: sql.Identifier | str,
+    ) -> sql.Composed:
+        return sql.SQL("DELETE FROM {table} WHERE {id_key} = %s").format(
+            table=tableIdentifier, id_key=deleteKey
+        )

{database_wrapper_pgsql-0.1.33 → database_wrapper_pgsql-0.1.38}/database_wrapper_pgsql.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: database_wrapper_pgsql
-Version: 0.1.33
+Version: 0.1.38
 Summary: database_wrapper for PostgreSQL database
 Author-email: Gints Murans <gm@gm.lv>
 License: GNU General Public License v3.0 (GPL-3.0)
@@ -32,11 +32,11 @@ 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.33
+Requires-Dist: database_wrapper==0.1.38
 Requires-Dist: psycopg[binary]>=3.2.0
 Requires-Dist: psycopg[pool]>=3.2.0
 
-# database_wrapper
+# database_wrapper_pgsql
 
 _Part of the `database_wrapper` package._
 

{database_wrapper_pgsql-0.1.33 → database_wrapper_pgsql-0.1.38}/database_wrapper_pgsql.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ database_wrapper_pgsql/__init__.py
 database_wrapper_pgsql/connector.py
 database_wrapper_pgsql/db_wrapper_pgsql.py
 database_wrapper_pgsql/db_wrapper_pgsql_async.py
+database_wrapper_pgsql/db_wrapper_pgsql_mixin.py
 database_wrapper_pgsql/py.typed
 database_wrapper_pgsql.egg-info/PKG-INFO
 database_wrapper_pgsql.egg-info/SOURCES.txt

{database_wrapper_pgsql-0.1.33 → database_wrapper_pgsql-0.1.38}/database_wrapper_pgsql.egg-info/requires.txt

@@ -1,3 +1,3 @@
-database_wrapper==0.1.33
+database_wrapper==0.1.38
 psycopg[binary]>=3.2.0
 psycopg[pool]>=3.2.0

{database_wrapper_pgsql-0.1.33 → database_wrapper_pgsql-0.1.38}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "database_wrapper_pgsql"
-version = "0.1.33"
+version = "0.1.38"
 description = "database_wrapper for PostgreSQL database"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -35,7 +35,7 @@ classifiers = [
 ]
 keywords = ["database", "wrapper", "python", "postgresql", "pgsql"]
 dependencies = [
-    "database_wrapper == 0.1.33",
+    "database_wrapper == 0.1.38",
     "psycopg[binary] >= 3.2.0",
     "psycopg[pool] >= 3.2.0",
 ]