fificore 0.0.2__tar.gz

fificore-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 FiFi Sayad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fificore-0.0.2/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: fificore
+Version: 0.0.2
+Summary: FiFi Core is full of tools
+Author-email: FiFi <sayad.mehrdad@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 FiFi Sayad
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/fifisayad/FiFiCore.git
+Keywords: core,db,utility
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: SQLAlchemy
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: bumpver; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: pip-tools; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# FiFiCore
+Repo consists of repeatative functionality across different projects which can use
+this core library.

fificore-0.0.2/README.md

@@ -0,0 +1,3 @@
+# FiFiCore
+Repo consists of repeatative functionality across different projects which can use
+this core library.

fificore-0.0.2/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fificore"
+version = "0.0.2"
+description = "FiFi Core is full of tools"
+readme = "README.md"
+authors = [
+  { name = "FiFi", email = "sayad.mehrdad@gmail.com" },
+]
+license = { file = "LICENSE" }
+classifiers = [
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+keywords = ["core", "db", "utility"]
+dependencies = [
+  "SQLAlchemy",
+]
+requires-python = ">=3.12.0"
+
+[project.optional-dependencies]
+dev = ["black", "bumpver", "isort", "pip-tools", "pytest"]
+
+[project.urls]
+Homepage = "https://github.com/fifisayad/FiFiCore.git"
+
+[project.scripts]
+# realpython = "reader.__main__:main"

fificore-0.0.2/setup.cfg

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

fificore-0.0.2/src/fifi/__init__.py

@@ -0,0 +1,13 @@
+__all__ = [
+    "SQLAlchemyEngineBase",
+    "db_async_session",
+    "singleton",
+    "timeit_log",
+    "DecoratedBase",
+]
+
+from .database.sqlalchemy_engine_base import SQLAlchemyEngineBase
+from .decorator.db_async_session import db_async_session
+from .decorator.singleton import singleton
+from .decorator.time_log import timeit_log
+from .models.decorated_base import DecoratedBase

fificore-0.0.2/src/fifi/database/sqlalchemy_engine_base.py

@@ -0,0 +1,59 @@
+import asyncio
+from abc import ABC
+
+from sqlalchemy.ext.asyncio import AsyncEngine
+from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker
+
+from ..models.decorated_base import DecoratedBase
+
+
+class SQLAlchemyEngineBase(ABC):
+    """
+    This is a abstract class for providing enginge to database we consider it.
+    """
+
+    engine: AsyncEngine
+    session_maker: async_sessionmaker
+
+    def __init__(
+        self,
+        user: str,
+        password: str,
+        host: str,
+        port: int,
+        db_name: str,
+        db_tech: str = "sqllite",
+        db_lib: str = "aiosqlite",
+    ):
+        """__init__.
+
+        Args:
+            user (str): user
+            password (str): password
+            host (str): host
+            port (int): port
+            db_name (str): db_name
+            db_tech (str): db_tech
+            db_lib (str): db_lib
+        """
+
+        self.engine = create_async_engine(
+            url="{}+{}://{}:{}@{}:{}/{}".format(
+                db_tech,
+                db_lib,
+                user,
+                password,
+                host,
+                port,
+                db_name,
+            ),
+            echo=False,
+            pool_pre_ping=True,
+        )
+        self.session_maker = async_sessionmaker(self.engine, expire_on_commit=False)
+
+        asyncio.run(self.init_models())
+
+    async def init_models(self):
+        async with self.engine.begin() as conn:
+            await conn.run_sync(DecoratedBase.metadata.create_all)

fificore-0.0.2/src/fifi/decorator/db_async_session.py

@@ -0,0 +1,20 @@
+import functools
+from sqlalchemy.orm import sessionmaker
+
+
+def db_async_session(session_maker: sessionmaker):
+    def decorator(func):
+        @functools.wraps(func)
+        async def wrapper(*args, **kwargs):
+            async with session_maker() as session:
+                try:
+                    result = await func(*args, session=session, **kwargs)
+                    await session.commit()
+                    return result
+                except Exception:
+                    await session.rollback()
+                    raise
+
+        return wrapper
+
+    return decorator

fificore-0.0.2/src/fifi/decorator/singleton.py

@@ -0,0 +1,15 @@
+import functools
+
+
+def singleton(cls):
+    """Turns class into singleton"""
+
+    @functools.wraps(cls)
+    def wrapper(*args, **kwargs):
+        if wrapper.instance:  # type: ignore
+            return wrapper.instance  # type: ignore
+        wrapper.instance = cls(*args, **kwargs)  # type: ignore
+        return wrapper.instance  # type: ignore
+
+    wrapper.instance = None  # type: ignore
+    return wrapper

fificore-0.0.2/src/fifi/decorator/time_log.py

@@ -0,0 +1,20 @@
+import time
+import logging
+from functools import wraps
+
+
+# Setup logger
+logger = logging.getLogger(__name__)
+logging.basicConfig(level=logging.INFO)
+
+
+def timeit_log(func):
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        start = time.perf_counter()
+        result = func(*args, **kwargs)
+        duration = time.perf_counter() - start
+        logger.info(f"[{func.__name__}] executed in {duration:.4f} seconds")
+        return result
+
+    return wrapper

fificore-0.0.2/src/fifi/models/decorated_base.py

@@ -0,0 +1,12 @@
+from typing import Set
+from sqlalchemy.ext.asyncio import AsyncAttrs
+from sqlalchemy.orm import DeclarativeBase
+
+
+class DecoratedBase(AsyncAttrs, DeclarativeBase):
+    def to_dict(self, exclude: Set = set()):
+        return {
+            column.name: getattr(self, column.name)
+            for column in self.__table__.columns
+            if column not in exclude
+        }

fificore-0.0.2/src/fificore.egg-info/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: fificore
+Version: 0.0.2
+Summary: FiFi Core is full of tools
+Author-email: FiFi <sayad.mehrdad@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 FiFi Sayad
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/fifisayad/FiFiCore.git
+Keywords: core,db,utility
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: SQLAlchemy
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: bumpver; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: pip-tools; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# FiFiCore
+Repo consists of repeatative functionality across different projects which can use
+this core library.

fificore-0.0.2/src/fificore.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+src/fifi/__init__.py
+src/fifi/database/sqlalchemy_engine_base.py
+src/fifi/decorator/db_async_session.py
+src/fifi/decorator/singleton.py
+src/fifi/decorator/time_log.py
+src/fifi/models/decorated_base.py
+src/fificore.egg-info/PKG-INFO
+src/fificore.egg-info/SOURCES.txt
+src/fificore.egg-info/dependency_links.txt
+src/fificore.egg-info/requires.txt
+src/fificore.egg-info/top_level.txt
+tests/test_sqlalchemy_engine_base.py

fificore-0.0.2/src/fificore.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fificore-0.0.2/src/fificore.egg-info/requires.txt

@@ -0,0 +1,8 @@
+SQLAlchemy
+
+[dev]
+black
+bumpver
+isort
+pip-tools
+pytest

fificore-0.0.2/src/fificore.egg-info/top_level.txt

@@ -0,0 +1 @@
+fifi

fificore-0.0.2/tests/test_sqlalchemy_engine_base.py

@@ -0,0 +1,85 @@
+import os
+import sqlite3
+from typing import Optional
+import pytest
+import logging
+from sqlalchemy import Column, Integer, Select, String
+from sqlalchemy.ext.asyncio import async_sessionmaker, AsyncEngine
+from sqlalchemy import text
+from sqlalchemy.ext.asyncio.session import AsyncSession
+
+from src.fifi import SQLAlchemyEngineBase
+from src.fifi import DecoratedBase
+from src.fifi import db_async_session
+
+
+class DummyModel(DecoratedBase):
+    __tablename__ = "dummy"
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+
+
+@pytest.fixture
+def sql_alchemy_engine_base_test():
+    sqlite3.connect("memory")
+    engine_base = SQLAlchemyEngineBase(
+        user="",
+        password="",
+        host="",
+        port=0,
+        db_name="memory",
+        db_tech="sqlite",
+        db_lib="aiosqlite",
+    )
+    yield engine_base
+    os.remove("./memory")
+
+
+@pytest.mark.asyncio
+class TestSQLAlchemyEngineBase:
+
+    async def test_engine_base_initializes_correctly(
+        self, sql_alchemy_engine_base_test
+    ):
+
+        assert isinstance(sql_alchemy_engine_base_test.engine, AsyncEngine)
+        assert isinstance(
+            sql_alchemy_engine_base_test.session_maker, async_sessionmaker
+        )
+
+        async with sql_alchemy_engine_base_test.engine.begin() as conn:
+
+            result = await conn.execute(
+                text(
+                    "SELECT name FROM sqlite_master WHERE type='table' AND name='dummy';"
+                )
+            )
+            table = result.scalar()
+            logging.info(f"tables = {table}")
+            assert table == "dummy"
+
+    async def test_dict_decorated_base(self, sql_alchemy_engine_base_test):
+
+        @db_async_session(sql_alchemy_engine_base_test.session_maker)
+        async def data_seeder(session: Optional[AsyncSession] = None):
+            if not session:
+                raise Exception()
+            fifi = DummyModel(name="FiFi")
+            mehrdad = DummyModel(name="Mehrdad")
+            session.add(fifi)
+            session.add(mehrdad)
+
+        @db_async_session(sql_alchemy_engine_base_test.session_maker)
+        async def data_reader(session: Optional[AsyncSession] = None) -> DummyModel:
+            if not session:
+                raise Exception()
+            stmt = Select(DummyModel).where(DummyModel.name == "FiFi")
+            result = await session.execute(stmt)
+            return result.scalar_one()
+
+        await data_seeder()
+        fifi = await data_reader()
+        logging.info(f"fifi object: {fifi.to_dict()}")
+        assert isinstance(fifi.to_dict(), dict)
+        assert isinstance(fifi, DummyModel)
+        assert str(fifi.name) == "FiFi"