database-wrapper 0.1.85__tar.gz → 0.2.2__tar.gz

{database_wrapper-0.1.85 → database_wrapper-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: database_wrapper
-Version: 0.1.85
+Version: 0.2.2
 Summary: A Different Approach to Database Wrappers in Python
 Author-email: Gints Murans <gm@gm.lv>
 License: GNU General Public License v3.0 (GPL-3.0)
@@ -33,13 +33,13 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Provides-Extra: pgsql
-Requires-Dist: database_wrapper_pgsql==0.1.85; extra == "pgsql"
+Requires-Dist: database_wrapper_pgsql==0.2.2; extra == "pgsql"
 Provides-Extra: mysql
-Requires-Dist: database_wrapper_mysql==0.1.85; extra == "mysql"
+Requires-Dist: database_wrapper_mysql==0.2.2; extra == "mysql"
 Provides-Extra: mssql
-Requires-Dist: database_wrapper_mssql==0.1.85; extra == "mssql"
+Requires-Dist: database_wrapper_mssql==0.2.2; extra == "mssql"
 Provides-Extra: sqlite
-Requires-Dist: database_wrapper_sqlite==0.1.85; extra == "sqlite"
+Requires-Dist: database_wrapper_sqlite==0.2.2; extra == "sqlite"
 Provides-Extra: all
 Requires-Dist: database_wrapper[mssql,mysql,pgsql,sqlite]; extra == "all"
 Provides-Extra: dev

{database_wrapper-0.1.85 → database_wrapper-0.2.2}/database_wrapper/config.py

@@ -3,7 +3,7 @@ from typing import Any
 CONFIG: dict[str, Any] = {
     # These are supposed to be set automatically by a git pre-compile script
     # They are one git commit hash behind, if used automatically
-    "git_commit_hash": "1453524e4fadcf1255349a31745df6ca666c2359",
-    "git_commit_date": "25.04.2025 19:10",
-    "app_version": "0.1.85",
+    "git_commit_hash": "c2bc2271cb75bcb46a0114013afa9b34dcb71aa6",
+    "git_commit_date": "16.05.2025 21:56",
+    "app_version": "0.2.2",
 }

{database_wrapper-0.1.85 → database_wrapper-0.2.2}/database_wrapper/db_backend.py

@@ -10,20 +10,20 @@ class DatabaseBackend:
     config: Any
     """ Database configuration """
 
-    connectionTimeout: int
+    connection_timeout: int
     """ Connection timeout """
 
     name: str
     """ Instance name """
 
     # TODO: This should be made to increase exponentially
-    slowDownTimeout: int
+    slow_down_timeout: int
     """ How long to wait before trying to reconnect """
 
     pool: Any
     """ Connection pool """
 
-    poolAsync: Any
+    pool_async: Any
     """ Async connection pool """
 
     connection: Any
@@ -32,19 +32,19 @@ class DatabaseBackend:
     cursor: Any
     """ Cursor to database """
 
-    contextConnection: ContextVar[Any | None]
+    context_connection: ContextVar[Any | None]
     """ Connection used in context manager """
 
-    contextConnectionAsync: ContextVar[Any | None]
+    context_connection_async: ContextVar[Any | None]
     """ Connection used in async context manager """
 
-    loggerName: str
+    logger_name: str
     """ Logger name """
 
     logger: logging.Logger
     """ Logger """
 
-    shutdownRequested: Event
+    shutdown_requested: Event
     """
     Event to signal shutdown
     Used to stop database pool from creating new connections
@@ -56,16 +56,16 @@ class DatabaseBackend:
 
     def __init__(
         self,
-        dbConfig: Any,
-        connectionTimeout: int = 5,
-        instanceName: str = "database_backend",
-        slowDownTimeout: int = 5,
+        db_config: Any,
+        connection_timeout: int = 5,
+        instance_name: str = "database_backend",
+        slow_down_timeout: int = 5,
     ) -> None:
         """
         Main concept here is that in init we do not connect to database,
         so that class instances can be safely made regardless of connection statuss.
 
-        Remember to call open() or openPool() before using this class.
+        Remember to call open() or open_pool() before using this class.
         Close will be called automatically when class is destroyed.
 
         Contexts are not implemented here, but in child classes should be used
@@ -75,23 +75,24 @@ class DatabaseBackend:
         if not upon destroying the class, an error will be raised that method was not awaited.
         """
 
-        self.config = dbConfig
-        self.connectionTimeout = connectionTimeout
-        self.name = instanceName
-        self.slowDownTimeout = slowDownTimeout
+        self.config = db_config
+        self.connection_timeout = connection_timeout
+        self.name = instance_name
+        self.slow_down_timeout = slow_down_timeout
 
-        self.loggerName = f"{__name__}.{self.__class__.__name__}.{self.name}"
-        self.logger = logging.getLogger(self.loggerName)
+        self.logger_name = f"{__name__}.{self.__class__.__name__}.{self.name}"
+        self.logger = logging.getLogger(self.logger_name)
 
         self.pool = None
-        self.poolAsync = None
+        self.pool_async = None
 
         self.connection = None
         self.cursor = None
-        self.shutdownRequested = Event()
-        self.contextConnection = ContextVar(f"db_connection_{self.name}", default=None)
-        self.contextConnectionAsync = ContextVar(
-            f"db_connection_{self.name}_async", default=None
+        self.shutdown_requested = Event()
+        self.context_connection = ContextVar(f"db_connection_{self.name}", default=None)
+        self.context_connection_async = ContextVar(
+            f"db_connection_{self.name}_async",
+            default=None,
         )
 
     def __del__(self) -> None:
@@ -100,14 +101,14 @@ class DatabaseBackend:
 
         # Clean up connections
         self.close()
-        self.closePool()
+        self.close_pool()
 
         # Clean just in case
         del self.connection
         del self.cursor
 
         del self.pool
-        del self.poolAsync
+        del self.pool_async
 
     ###############
     ### Context ###
@@ -133,11 +134,11 @@ class DatabaseBackend:
     ### Connection ###
     ##################
 
-    def openPool(self) -> Any:
+    def open_pool(self) -> Any:
         """Open connection pool"""
         ...
 
-    def closePool(self) -> Any:
+    def close_pool(self) -> Any:
         """Close connection pool"""
         ...
 
@@ -157,7 +158,7 @@ class DatabaseBackend:
             self.connection.close()
             self.connection = None
 
-    def newConnection(self) -> Any:
+    def new_connection(self) -> Any:
         """
         Create new connection
 
@@ -168,7 +169,7 @@ class DatabaseBackend:
         """
         raise Exception("Not implemented")
 
-    def returnConnection(self, connection: Any) -> Any:
+    def return_connection(self, connection: Any) -> Any:
         """
         Return connection to pool
 
@@ -190,18 +191,36 @@ class DatabaseBackend:
         """
         raise Exception("Not implemented")
 
+    def has_connection(self) -> bool:
+        """
+        Check if connection is alive/set.
+
+        Returns:
+            bool: Connection status
+        """
+        return self.connection is not None
+
+    def has_cursor(self) -> bool:
+        """
+        Check if cursor is alive/set.
+
+        Returns:
+            bool: Cursor status
+        """
+        return self.cursor is not None
+
     ###############
     ### Helpers ###
     ###############
 
-    def fixSocketTimeouts(self, fd: Any) -> None:
+    def fix_socket_timeouts(self, fd: Any) -> None:
         # Lets do some socket magic
         s = socket.fromfd(fd, socket.AF_INET, socket.SOCK_STREAM)
         # Enable sending of keep-alive messages
         s.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
         # Time the connection needs to remain idle before start sending
         # keepalive probes
-        s.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, self.connectionTimeout)
+        s.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, self.connection_timeout)
         # Time between individual keepalive probes
         s.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 1)
         # The maximum number of keepalive probes should send before dropping
@@ -210,27 +229,27 @@ class DatabaseBackend:
         # To set timeout for an RTO you must set TCP_USER_TIMEOUT timeout
         # (in milliseconds) for socket.
         s.setsockopt(
-            socket.IPPROTO_TCP, socket.TCP_USER_TIMEOUT, self.connectionTimeout * 1000
+            socket.IPPROTO_TCP, socket.TCP_USER_TIMEOUT, self.connection_timeout * 1000
         )
 
     ####################
     ### Transactions ###
     ####################
 
-    def beginTransaction(self) -> Any:
+    def begin_transaction(self) -> Any:
         """Start transaction"""
         raise Exception("Not implemented")
 
-    def commitTransaction(self) -> Any:
+    def commit_transaction(self) -> Any:
         """Commit transaction"""
         raise Exception("Not implemented")
 
-    def rollbackTransaction(self) -> Any:
+    def rollback_transaction(self) -> Any:
         """Rollback transaction"""
         raise Exception("Not implemented")
 
     # @contextmanager
-    def transaction(self, dbConn: Any = None) -> Any:
+    def transaction(self, db_conn: Any = None) -> Any:
         """
         Transaction context manager
 
@@ -243,11 +262,11 @@ class DatabaseBackend:
     ### Data ###
     ############
 
-    def lastInsertId(self) -> int:
+    def last_insert_id(self) -> int:
         """Get last inserted row id generated by auto increment"""
         raise Exception("Not implemented")
 
-    def affectedRows(self) -> int:
+    def affected_rows(self) -> int:
         """Get affected rows count"""
         raise Exception("Not implemented")