devsetgo-lib 0.12.0__tar.gz → 0.12.2__tar.gz

{devsetgo_lib-0.12.0 → devsetgo_lib-0.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: devsetgo_lib
-Version: 0.12.0
+Version: 0.12.2
 Summary: DevSetGo Common Library provides reusable Python functions for enhanced code efficiency. It includes utilities for file operations, calendar, pattern matching, logging, FastAPI endpoints, and async database handling with CRUD operations.
 Project-URL: Homepage, https://github.com/devsetgo/devsetgo_lib
 Project-URL: Documentation, https://devsetgo.github.io/devsetgo_lib/
@@ -168,4 +168,3 @@ Contributions and feedback are highly appreciated. Please refer to our [Contribu
 
 ## Further Documentation
 For more detailed information, visit [LINK_TO_DETAILED_DOCUMENTATION](https://devsetgo.github.io/devsetgo_lib/).
-

{devsetgo_lib-0.12.0 → devsetgo_lib-0.12.2}/README.md

@@ -98,4 +98,3 @@ Contributions and feedback are highly appreciated. Please refer to our [Contribu
 
 ## Further Documentation
 For more detailed information, visit [LINK_TO_DETAILED_DOCUMENTATION](https://devsetgo.github.io/devsetgo_lib/).
-

devsetgo_lib-0.12.2/dsg_lib/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+__version__ = '0.12.2'

devsetgo_lib-0.12.2/dsg_lib/async_database_functions/__import_sqlalchemy.py

@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+from typing import Tuple
+
+from loguru import logger
+from packaging import version as packaging_version
+
+# Importing AsyncDatabase class from local module async_database
+
+
+def import_sqlalchemy() -> Tuple:
+    """
+    Imports and returns SQLAlchemy components.
+
+    This function attempts to import SQLAlchemy and its components. It checks the version of SQLAlchemy
+    and raises an ImportError if the version is less than the minimum required version.
+
+    Returns:
+        tuple: A tuple containing the following SQLAlchemy components:
+            - sqlalchemy: The SQLAlchemy module.
+            - MetaData: The MetaData class from SQLAlchemy.
+            - create_engine: The create_engine function from SQLAlchemy.
+            - text: The text function from SQLAlchemy.
+            - Column: The Column class from SQLAlchemy.
+            - DateTime: The DateTime class from SQLAlchemy.
+            - String: The String class from SQLAlchemy.
+            - IntegrityError: The IntegrityError exception from SQLAlchemy.
+            - SQLAlchemyError: The SQLAlchemyError exception from SQLAlchemy.
+            - AsyncSession: The AsyncSession class from SQLAlchemy.
+            - create_async_engine: The create_async_engine function from SQLAlchemy.
+            - select: The select function from SQLAlchemy.
+            - declarative_base: The declarative_base function from SQLAlchemy.
+            - sessionmaker: The sessionmaker function from SQLAlchemy.
+            - func: The func object from SQLAlchemy.
+            - NoResultFound: The NoResultFound exception from SQLAlchemy.
+
+    Raises:
+        ImportError: If the SQLAlchemy version is less than the minimum required version.
+
+    """
+    min_version = '2.0.0'  # Minimum required version of SQLAlchemy
+
+    logger.info('Attempting to import SQLAlchemy...')
+
+    try:
+        # Import SQLAlchemy and its components
+        import sqlalchemy
+        from sqlalchemy import Column, DateTime, MetaData, String, create_engine, text
+        from sqlalchemy.exc import IntegrityError, SQLAlchemyError
+        from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
+        from sqlalchemy.future import select
+        from sqlalchemy.orm import declarative_base, sessionmaker
+        from sqlalchemy.orm.exc import NoResultFound
+        from sqlalchemy.sql import func
+
+        logger.info('Successfully imported SQLAlchemy.')
+
+    except ImportError:  # pragma: no cover
+        # Handle the case where SQLAlchemy is not installed
+        logger.error('Failed to import SQLAlchemy.')
+        create_engine = text = sqlalchemy = None  # pragma: no cover
+
+    # Check SQLAlchemy version
+    if sqlalchemy is not None and packaging_version.parse(
+        sqlalchemy.__version__
+    ) < packaging_version.parse(min_version):
+        # If the installed version is less than the minimum required version, raise an error
+        logger.error(
+            f'SQLAlchemy version >= {min_version} required, run `pip install --upgrade sqlalchemy`'
+        )
+        raise ImportError(
+            f'SQLAlchemy version >= {min_version} required, run `pip install --upgrade sqlalchemy`'
+        )  # pragma: no cover
+
+    logger.info('Returning SQLAlchemy components.')
+
+    # Return the imported SQLAlchemy components
+    return (
+        sqlalchemy,
+        MetaData,
+        create_engine,
+        text,
+        IntegrityError,
+        SQLAlchemyError,
+        AsyncSession,
+        create_async_engine,
+        select,
+        declarative_base,
+        sessionmaker,
+        Column,
+        DateTime,
+        String,
+        func,
+        NoResultFound,
+    )
+
+
+# Call the import_sqlalchemy function and unpack its return value
+# into several variables. Each variable corresponds to a component
+# of SQLAlchemy that we want to use in our code.
+
+(
+    sqlalchemy,  # The SQLAlchemy module
+    MetaData,  # The MetaData class from SQLAlchemy
+    create_engine,  # The create_engine function from SQLAlchemy
+    text,  # The text function from SQLAlchemy
+    IntegrityError,  # The IntegrityError exception from SQLAlchemy
+    SQLAlchemyError,  # The SQLAlchemyError exception from SQLAlchemy
+    AsyncSession,  # The AsyncSession class from SQLAlchemy
+    create_async_engine,  # The create_async_engine function from SQLAlchemy
+    select,  # The select function from SQLAlchemy
+    declarative_base,  # The declarative_base function from SQLAlchemy
+    sessionmaker,  # The sessionmaker function from SQLAlchemy
+    Column,  # The Column class from SQLAlchemy
+    DateTime,  # The DateTime class from SQLAlchemy
+    String,  # The String class from SQLAlchemy
+    func,  # The func object from SQLAlchemy
+    NoResultFound,  # The NoResultFound exception from SQLAlchemy
+) = import_sqlalchemy()  # Call the function that imports SQLAlchemy and checks its version

{devsetgo_lib-0.12.0 → devsetgo_lib-0.12.2}/dsg_lib/async_database_functions/async_database.py

@@ -16,6 +16,33 @@ database operations. It provides methods to get a database session and to create
 tables in the database.
 
 This module uses the logger from the dsg_lib.common_functions for logging.
+
+Example:
+```python
+from dsg_lib.async_database_functions import (
+    async_database,
+    base_schema,
+    database_config,
+    database_operations,
+)
+
+# Create a DBConfig instance
+config = {
+    "database_uri": "sqlite+aiosqlite:///:memory:?cache=shared",
+    "echo": False,
+    "future": True,
+    "pool_recycle": 3600,
+}
+
+# create database configuration
+db_config = database_config.DBConfig(config)
+
+# Create an AsyncDatabase instance
+async_db = async_database.AsyncDatabase(db_config)
+
+# Create a DatabaseOperations instance
+db_ops = database_operations.DatabaseOperations(async_db)
+```
 """
 
 
@@ -54,7 +81,7 @@ class AsyncDatabase:
         """
         self.db_config = db_config
         self.Base = BASE
-        logger.debug("AsyncDatabase initialized")
+        logger.debug('AsyncDatabase initialized')
 
     def get_db_session(self):
         """This method returns a context manager that provides a new database
@@ -65,7 +92,7 @@ class AsyncDatabase:
         Returns: contextlib._GeneratorContextManager: A context manager that
         provides a new database session.
         """
-        logger.debug("Getting database session")
+        logger.debug('Getting database session')
         return self.db_config.get_db_session()
 
     async def create_tables(self):
@@ -75,7 +102,7 @@ class AsyncDatabase:
 
         Returns: None
         """
-        logger.debug("Creating tables")
+        logger.debug('Creating tables')
         try:
             # Bind the engine to the metadata of the base class
             self.Base.metadata.bind = self.db_config.engine
@@ -84,8 +111,8 @@ class AsyncDatabase:
             async with self.db_config.engine.begin() as conn:
                 # Run a function in a synchronous manner
                 await conn.run_sync(self.Base.metadata.create_all)
-            logger.info("Tables created successfully")
+            logger.info('Tables created successfully')
         except Exception as ex:  # pragma: no cover
             # Log the error and raise it
-            logger.error(f"Error creating tables: {ex}")  # pragma: no cover
+            logger.error(f'Error creating tables: {ex}')  # pragma: no cover
             raise  # pragma: no cover

{devsetgo_lib-0.12.0 → devsetgo_lib-0.12.2}/dsg_lib/async_database_functions/base_schema.py

@@ -17,7 +17,9 @@ that are needed for most models like `pkid`, `date_created`, and `date_updated`.
 To create a new database model, import this module and extend the `SchemaBase`
 class.
 
-Example: ```python from dsg_lib.async_database_functions import base_schema
+Example:
+```python
+from dsg_lib.async_database_functions import base_schema
 
 class MyModel(base_schema.SchemaBaseSQLite):
         # Define your model-specific columns here my_column =
@@ -29,72 +31,35 @@ class MyModel(base_schema.SchemaBaseSQLite):
 
 # Importing required modules from Python's standard library
 import datetime
-from typing import Tuple
 from uuid import uuid4
 
-from packaging import version as packaging_version
+from .__import_sqlalchemy import import_sqlalchemy
 
-
-def import_sqlalchemy() -> Tuple:
-    """
-    This function tries to import SQLAlchemy and its components, and raises an
-    ImportError if SQLAlchemy is not installed or if the installed version is
-    not compatible with the minimum required version.
-
-    Returns:
-        Tuple: A tuple containing the imported SQLAlchemy module and its
-        components (Column, DateTime, String, text).
-
-    Raises:
-        ImportError: If SQLAlchemy is not installed or if the installed version
-        is not compatible with the minimum required version.
-
-    Example: ```python from dsg_lib import base_schema sqlalchemy, Column,
-    DateTime, String, text = base_schema.import_sqlalchemy() ```
-    """
-    try:
-        import sqlalchemy
-        from sqlalchemy import Column, DateTime, String
-        from sqlalchemy.sql import text
-
-    except ImportError:
-        Column = DateTime = String = text = sqlalchemy = None
-
-    # Check SQLAlchemy version
-    min_version = "1.4.0"  # replace with your minimum required version
-    if sqlalchemy is not None and packaging_version.parse(
-        sqlalchemy.__version__
-    ) < packaging_version.parse(min_version):
-        raise ImportError(
-            f"SQLAlchemy version >= {min_version} required, run `pip install --upgrade sqlalchemy`"
-        )
-
-    return (
-        sqlalchemy,
-        Column,
-        DateTime,
-        String,
-        text,
-    )
-
-
-# Call the function at the module level to import SQLAlchemy and its components
 (
-    sqlalchemy,
-    Column,
-    DateTime,
-    String,
-    text,
-) = import_sqlalchemy()
+    sqlalchemy,  # The SQLAlchemy module
+    MetaData,  # The MetaData class from SQLAlchemy
+    create_engine,  # The create_engine function from SQLAlchemy
+    text,  # The text function from SQLAlchemy
+    IntegrityError,  # The IntegrityError exception from SQLAlchemy
+    SQLAlchemyError,  # The SQLAlchemyError exception from SQLAlchemy
+    AsyncSession,  # The AsyncSession class from SQLAlchemy
+    create_async_engine,  # The create_async_engine function from SQLAlchemy
+    select,  # The select function from SQLAlchemy
+    declarative_base,  # The declarative_base function from SQLAlchemy
+    sessionmaker,  # The sessionmaker function from SQLAlchemy
+    Column,  # The Column class from SQLAlchemy
+    DateTime,  # The DateTime class from SQLAlchemy
+    String,  # The String class from SQLAlchemy
+    func,  # The func object from SQLAlchemy
+    NoResultFound,  # The NoResultFound exception from SQLAlchemy
+) = import_sqlalchemy()  # Call the function that imports SQLAlchemy and checks its version
 
 
 # comments
-uuid_comment = "Unique identifier for each record, a string representation of a UUID"
-date_created_comment = (
-    "Date and time when a row was inserted, defaults to current UTC time"
-)
+uuid_comment = 'Unique identifier for each record, a string representation of a UUID'
+date_created_comment = 'Date and time when a row was inserted, defaults to current UTC time'
 date_updated_comment = (
-    "Date and time when a row was last updated, defaults to current UTC time on update"
+    'Date and time when a row was last updated, defaults to current UTC time on update'
 )
 
 
@@ -115,7 +80,7 @@ class SchemaBaseSQLite:
 
     Example:
     ```python
-    from dsg_lib import base_schema
+    from dsg_lib.async_database_functions import base_schema
     from sqlalchemy.orm import declarative_base
 
     BASE = declarative_base()
@@ -174,7 +139,7 @@ class SchemaBasePostgres:
 
     Example:
     ```python
-    from dsg_lib import base_schema
+    from dsg_lib.async_database_functions import base_schema
     from sqlalchemy.orm import declarative_base
 
     BASE = declarative_base()
@@ -233,7 +198,7 @@ class SchemaBaseMySQL:
 
     Example:
     ```python
-    from dsg_lib import base_schema
+    from dsg_lib.async_database_functions import base_schema
     from sqlalchemy.orm import declarative_base
 
     BASE = declarative_base()
@@ -259,7 +224,7 @@ class SchemaBaseMySQL:
     date_created = Column(
         DateTime,
         index=True,
-        server_default=text("UTC_TIMESTAMP()"),
+        server_default=text('UTC_TIMESTAMP()'),
         comment=date_created_comment,
     )
 
@@ -268,8 +233,8 @@ class SchemaBaseMySQL:
     date_updated = Column(
         DateTime,
         index=True,
-        server_default=text("UTC_TIMESTAMP()"),
-        onupdate=text("UTC_TIMESTAMP()"),
+        server_default=text('UTC_TIMESTAMP()'),
+        onupdate=text('UTC_TIMESTAMP()'),
         comment=date_updated_comment,
     )
 
@@ -292,7 +257,7 @@ class SchemaBaseOracle:
 
     Example:
     ```python
-    from dsg_lib import base_schema
+    from dsg_lib.async_database_functions import base_schema
     from sqlalchemy.orm import declarative_base
 
     BASE = declarative_base()
@@ -318,7 +283,7 @@ class SchemaBaseOracle:
     date_created = Column(
         DateTime,
         index=True,
-        server_default=text("SYS_EXTRACT_UTC(SYSTIMESTAMP)"),
+        server_default=text('SYS_EXTRACT_UTC(SYSTIMESTAMP)'),
         comment=date_created_comment,
     )
 
@@ -327,8 +292,8 @@ class SchemaBaseOracle:
     date_updated = Column(
         DateTime,
         index=True,
-        server_default=text("SYS_EXTRACT_UTC(SYSTIMESTAMP)"),
-        onupdate=text("SYS_EXTRACT_UTC(SYSTIMESTAMP)"),
+        server_default=text('SYS_EXTRACT_UTC(SYSTIMESTAMP)'),
+        onupdate=text('SYS_EXTRACT_UTC(SYSTIMESTAMP)'),
         comment=date_updated_comment,
     )
 
@@ -351,7 +316,7 @@ class SchemaBaseMSSQL:
 
     Example:
     ```python
-    from dsg_lib import base_schema
+    from dsg_lib.async_database_functions import base_schema
     from sqlalchemy.orm import declarative_base
 
     BASE = declarative_base()
@@ -377,7 +342,7 @@ class SchemaBaseMSSQL:
     date_created = Column(
         DateTime,
         index=True,
-        server_default=text("GETUTCDATE()"),
+        server_default=text('GETUTCDATE()'),
         comment=date_created_comment,
     )
 
@@ -386,8 +351,8 @@ class SchemaBaseMSSQL:
     date_updated = Column(
         DateTime,
         index=True,
-        server_default=text("GETUTCDATE()"),
-        onupdate=text("GETUTCDATE()"),
+        server_default=text('GETUTCDATE()'),
+        onupdate=text('GETUTCDATE()'),
         comment=date_updated_comment,
     )
 
@@ -410,7 +375,7 @@ class SchemaBaseFirebird:
 
     Example:
     ```python
-    from dsg_lib import base_schema
+    from dsg_lib.async_database_functions import base_schema
     from sqlalchemy.orm import declarative_base
 
     BASE = declarative_base()
@@ -436,8 +401,8 @@ class SchemaBaseFirebird:
     date_created = Column(
         DateTime,
         index=True,
-        server_default=text("CURRENT_TIMESTAMP"),
-        comment="Date and time when a row was inserted, defaults to current time",
+        server_default=text('CURRENT_TIMESTAMP'),
+        comment='Date and time when a row was inserted, defaults to current time',
     )
 
     # The date and time when a particular row was last updated. It defaults to
@@ -445,9 +410,9 @@ class SchemaBaseFirebird:
     date_updated = Column(
         DateTime,
         index=True,
-        server_default=text("CURRENT_TIMESTAMP"),
-        onupdate=text("CURRENT_TIMESTAMP"),
-        comment="Date and time when a row was last updated, defaults to current time on update",
+        server_default=text('CURRENT_TIMESTAMP'),
+        onupdate=text('CURRENT_TIMESTAMP'),
+        comment='Date and time when a row was last updated, defaults to current time on update',
     )
 
 
@@ -469,7 +434,7 @@ class SchemaBaseSybase:
 
     Example:
     ```python
-    from dsg_lib import base_schema
+    from dsg_lib.async_database_functions import base_schema
     from sqlalchemy.orm import declarative_base
 
     BASE = declarative_base()
@@ -495,7 +460,7 @@ class SchemaBaseSybase:
     date_created = Column(
         DateTime,
         index=True,
-        server_default=text("GETUTCDATE()"),
+        server_default=text('GETUTCDATE()'),
         comment=date_created_comment,
     )
 
@@ -504,8 +469,8 @@ class SchemaBaseSybase:
     date_updated = Column(
         DateTime,
         index=True,
-        server_default=text("GETUTCDATE()"),
-        onupdate=text("GETUTCDATE()"),
+        server_default=text('GETUTCDATE()'),
+        onupdate=text('GETUTCDATE()'),
         comment=date_updated_comment,
     )
 
@@ -528,7 +493,7 @@ class SchemaBaseCockroachDB:
 
     Example:
     ```python
-    from dsg_lib import base_schema
+    from dsg_lib.async_database_functions import base_schema
     from sqlalchemy.orm import declarative_base
 
     BASE = declarative_base()