database-wrapper-sqlite 0.2.17__tar.gz → 0.2.23__tar.gz

{database_wrapper_sqlite-0.2.17 → database_wrapper_sqlite-0.2.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: database_wrapper_sqlite
-Version: 0.2.17
+Version: 0.2.23
 Summary: database_wrapper for PostgreSQL database
 Author-email: Gints Murans <gm@gm.lv>
 License: GNU General Public License v3.0 (GPL-3.0)
@@ -32,7 +32,7 @@ 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.2.17
+Requires-Dist: database_wrapper==0.2.23
 
 # database_wrapper_sqlite
 

{database_wrapper_sqlite-0.2.17 → database_wrapper_sqlite-0.2.23}/database_wrapper_sqlite/__init__.py

@@ -9,7 +9,8 @@ Part of the database_wrapper package
 import logging
 
 # from .db_wrapper_sqlite import DBWrapperSqlite
-from .connector import Sqlite, SqliteConfig
+from .connector import Sqlite, SqliteConfig, SqliteTypedDictCursor
+from .db_wrapper_sqlite import DBWrapperSqlite
 
 # Set the logger to a quiet default, can be enabled if needed
 logger = logging.getLogger("database_wrapper_sqlite")
@@ -18,7 +19,12 @@ if logger.level == logging.NOTSET:
 
 
 __all__ = [
-    # "DBWrapperSqlite",
-    "SqliteConfig",
-    "Sqlite",
+    # Wrappers
+    DBWrapperSqlite,
+    # Connectors
+    Sqlite,
+    # Connection and Cursor types
+    SqliteTypedDictCursor,
+    # Helpers
+    SqliteConfig,
 ]

database_wrapper_sqlite-0.2.23/database_wrapper_sqlite/connector.py

@@ -0,0 +1,114 @@
+import sqlite3
+from typing import Any, NotRequired, TypedDict, cast
+
+from database_wrapper import DatabaseBackend
+
+
+def dict_factory(cursor: sqlite3.Cursor, row: tuple) -> dict[str, Any]:
+    fields = [col[0] for col in cursor.description]
+    return dict(zip(fields, row, strict=False))
+
+
+class SqliteConfig(TypedDict):
+    database: str
+    timeout: NotRequired[float]
+    isolation_level: NotRequired[str | None]
+    kwargs: NotRequired[dict[str, Any]]
+
+
+class SqliteTypedDictCursor(sqlite3.Cursor):
+    """
+    Type hint wrapper only. At runtime, this is just a sqlite3.Cursor
+    that happens to produce dicts because of the row_factory.
+    """
+
+    def fetchone(self) -> dict[str, Any] | None:
+        return super().fetchone()  # type: ignore
+
+    def fetchall(self) -> list[dict[str, Any]]:
+        return super().fetchall()  # type: ignore
+
+    def __iter__(self) -> "SqliteTypedDictCursor":
+        return self
+
+    def __next__(self) -> dict[str, Any]:
+        return super().__next__()  # type: ignore
+
+
+class Sqlite(DatabaseBackend):
+    """
+    SQLite database backend
+
+    :param config: Configuration for SQLite
+    :type config: SqliteConfig
+    """
+
+    config: SqliteConfig
+    connection: sqlite3.Connection
+    cursor: SqliteTypedDictCursor
+
+    ##################
+    ### Connection ###
+    ##################
+
+    def open(self) -> None:
+        self.logger.debug("Connecting to DB")
+
+        if "kwargs" not in self.config:
+            self.config["kwargs"] = {}
+
+        # Default timeout to 5.0 seconds if not specified
+        timeout = self.config.get("timeout", 5.0)
+
+        # Default isolation_level to None (autocommit mode via library, though SQLite is tricky with this)
+        # or leave as default. Let's respect config or default to standard.
+        isolation_level = self.config.get("isolation_level", None)
+
+        self.connection = sqlite3.connect(
+            self.config["database"],
+            timeout=timeout,
+            isolation_level=isolation_level,
+            **self.config["kwargs"],
+        )
+
+        # Set row factory to return dicts
+        self.connection.row_factory = dict_factory
+
+        # Create cursor
+        self.cursor = cast(SqliteTypedDictCursor, self.connection.cursor())
+
+    def ping(self) -> bool:
+        try:
+            self.cursor.execute("SELECT 1")
+            self.cursor.fetchone()
+        except Exception as e:
+            self.logger.debug(f"Error while pinging the database: {e}")
+            return False
+
+        return True
+
+    ############
+    ### Data ###
+    ############
+
+    def last_insert_id(self) -> int:
+        assert self.cursor, "Cursor is not initialized"
+        return self.cursor.lastrowid or 0
+
+    def affected_rows(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_sqlite-0.2.23/database_wrapper_sqlite/db_wrapper_sqlite.py

@@ -0,0 +1,76 @@
+import logging
+from typing import Any
+
+from database_wrapper import DBWrapper
+
+from .connector import SqliteTypedDictCursor
+
+
+class DBWrapperSqlite(DBWrapper):
+    """Wrapper for SQLite database"""
+
+    db_cursor: SqliteTypedDictCursor | None
+    """ SQLite cursor object """
+
+    #######################
+    ### Class lifecycle ###
+    #######################
+
+    # Meta methods
+    # We are overriding the __init__ method for the type hinting
+    def __init__(
+        self,
+        db_cursor: SqliteTypedDictCursor | None = None,
+        logger: logging.Logger | None = None,
+    ):
+        """
+        Initializes a new instance of the DBWrapper class.
+
+        Args:
+            db_cursor (SqliteTypedDictCursor): The SQLite database cursor object.
+            logger (logging.Logger, optional): The logger object. Defaults to None.
+        """
+        super().__init__(db_cursor, logger)
+
+    ###############
+    ### Setters ###
+    ###############
+
+    def set_db_cursor(self, db_cursor: SqliteTypedDictCursor | None) -> None:
+        """
+        Updates the database cursor object.
+
+        Args:
+            db_cursor (SqliteTypedDictCursor): The new database cursor object.
+        """
+        super().set_db_cursor(db_cursor)
+
+    ######################
+    ### Helper methods ###
+    ######################
+
+    def log_query(
+        self,
+        cursor: SqliteTypedDictCursor,
+        query: Any,
+        params: tuple[Any, ...],
+    ) -> None:
+        """
+        Logs the given query and parameters.
+
+        Args:
+            cursor (SqliteTypedDictCursor): The cursor used to execute the query.
+            query (Any): The query to log.
+            params (tuple[Any, ...]): The parameters to log.
+        """
+        # sqlite3 does not support mogrify, so we just log query and params
+        logging.getLogger().debug(f"Query: {query} with params: {params}")
+
+    #####################
+    ### Query methods ###
+    #####################
+
+    def limit_query(self, offset: int = 0, limit: int = 100) -> str | None:
+        if limit == 0:
+            return None
+        return f"LIMIT {limit} OFFSET {offset}"

{database_wrapper_sqlite-0.2.17 → database_wrapper_sqlite-0.2.23}/database_wrapper_sqlite.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: database_wrapper_sqlite
-Version: 0.2.17
+Version: 0.2.23
 Summary: database_wrapper for PostgreSQL database
 Author-email: Gints Murans <gm@gm.lv>
 License: GNU General Public License v3.0 (GPL-3.0)
@@ -32,7 +32,7 @@ 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.2.17
+Requires-Dist: database_wrapper==0.2.23
 
 # database_wrapper_sqlite
 

{database_wrapper_sqlite-0.2.17 → database_wrapper_sqlite-0.2.23}/database_wrapper_sqlite.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@ README.md
 pyproject.toml
 database_wrapper_sqlite/__init__.py
 database_wrapper_sqlite/connector.py
+database_wrapper_sqlite/db_wrapper_sqlite.py
 database_wrapper_sqlite/py.typed
 database_wrapper_sqlite.egg-info/PKG-INFO
 database_wrapper_sqlite.egg-info/SOURCES.txt

database_wrapper_sqlite-0.2.23/database_wrapper_sqlite.egg-info/requires.txt

@@ -0,0 +1 @@
+database_wrapper==0.2.23

{database_wrapper_sqlite-0.2.17 → database_wrapper_sqlite-0.2.23}/pyproject.toml

@@ -4,14 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "database_wrapper_sqlite"
-version = "0.2.17"
+version = "0.2.23"
 description = "database_wrapper for PostgreSQL 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"}
-]
+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",
@@ -31,12 +29,10 @@ classifiers = [
     "Topic :: Database",
     "Topic :: Database :: Front-Ends",
     "Topic :: Software Development",
-    "Topic :: Software Development :: Libraries :: Python Modules"
+    "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 keywords = ["database", "wrapper", "python", "sqlite"]
-dependencies = [
-    "database_wrapper == 0.2.17",
-]
+dependencies = ["database_wrapper == 0.2.23"]
 
 [project.urls]
 Homepage = "https://github.com/gintsmurans/py_database_wrapper"

database_wrapper_sqlite-0.2.17/database_wrapper_sqlite/connector.py

@@ -1,63 +0,0 @@
-from typing import Any, NotRequired, TypedDict
-
-from database_wrapper import DatabaseBackend
-
-
-class SqliteConfig(TypedDict):
-    database: str
-    kwargs: NotRequired[dict[str, Any]]
-
-
-# TODO: Needs to finish the implementation
-class Sqlite(DatabaseBackend):
-    """
-    Sqlite database backend
-
-    :param config: Configuration for Sqlite
-    :type config: MyConfig
-
-    Defaults:
-        _no defaults_
-    """
-
-    config: SqliteConfig
-
-    connection: Any
-    cursor: Any
-
-    def open(self) -> None:
-        # Free resources
-        if hasattr(self, "connection") and self.connection:
-            self.close()
-
-        # Set defaults
-        if "kwargs" not in self.config or not self.config["kwargs"]:
-            self.config["kwargs"] = {}
-
-        self.logger.debug("Connecting to DB")
-
-        raise NotImplementedError(
-            "Sqlite is not yet implemented. See here: https://github.com/gintsmurans/py_database_wrapper/"
-        )
-
-    def last_insert_id(self) -> int:
-        assert self.cursor, "Cursor is not initialized"
-        return self.cursor.lastrowid
-
-    def affected_rows(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_sqlite-0.2.17/database_wrapper_sqlite.egg-info/requires.txt

@@ -1 +0,0 @@
-database_wrapper==0.2.17