wiederverwendbar 0.8.3__tar.gz → 0.8.4__tar.gz

{wiederverwendbar-0.8.3 → wiederverwendbar-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wiederverwendbar
-Version: 0.8.3
+Version: 0.8.4
 Summary: A collection of scripts, classes and tools they are \"wiederverwendbar\".
 Author-Email: Julius Koenig <info@bastelquartier.de>
 License: GPL-3.0

{wiederverwendbar-0.8.3 → wiederverwendbar-0.8.4}/pyproject.toml

@@ -12,7 +12,7 @@ dependencies = [
 ]
 requires-python = ">=3.9"
 readme = "README.md"
-version = "0.8.3"
+version = "0.8.4"
 
 [project.license]
 text = "GPL-3.0"

{wiederverwendbar-0.8.3 → wiederverwendbar-0.8.4}/src/wiederverwendbar/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.8.3"
+__version__ = "0.8.4"
 TITLE = "wiederverwendbar"
 VERSION = __version__
 AUTHOR = "Julius Koenig"

wiederverwendbar-0.8.4/src/wiederverwendbar/examples/sqlalchemy/db.py

@@ -0,0 +1,89 @@
+from pathlib import Path
+from typing import Optional
+
+from sqlalchemy import Column, ForeignKey, Integer, Text
+
+from sqlalchemy.orm import relationship
+
+from wiederverwendbar.logger import LoggerSingleton, LoggerSettings, LogLevels
+from wiederverwendbar.sqlalchemy import Base, SqlalchemySettings, SqlalchemyDbSingleton
+
+LoggerSingleton(name="test", settings=LoggerSettings(log_level=LogLevels.DEBUG), init=True)
+SqlalchemyDbSingleton(settings=SqlalchemySettings(db_file=Path("test.db")), init=True)
+
+
+class MyBase(Base, SqlalchemyDbSingleton().Base):
+    __abstract__ = True
+
+
+class Parent(MyBase):
+    __tablename__ = "parent"
+    __str_columns__: list[str] = ["id", "name"]
+
+    id: int = Column(Integer(), primary_key=True, autoincrement=True, name="parent_id")
+    name: str = Column(Text(50), nullable=False, unique=True)
+    children: list["Child"] = relationship("Child",
+                                           foreign_keys="Child.parent_id",
+                                           primaryjoin="Parent.id == Child.parent_id",
+                                           viewonly=True)
+
+
+class Child(MyBase):
+    __tablename__ = "child"
+    __str_columns__: list[str] = ["id", "name"]
+
+    id: int = Column(Integer(), primary_key=True, autoincrement=True, name="parent_id")
+    name: str = Column(Text(50), nullable=False, unique=True)
+    parent_id: int = Column(Integer(), ForeignKey("parent.parent_id"), nullable=False, name="child_parent_id")
+    parent: Optional[Parent] = relationship("Parent",
+                                            foreign_keys="Parent.id",
+                                            primaryjoin="Child.parent_id == Parent.id")
+
+
+if __name__ == '__main__':
+    SqlalchemyDbSingleton().create_all()
+
+    parent1 = Parent.get(name="parent1")
+    if parent1 is None:
+        parent1 = Parent(name="parent1")
+        parent1.save()
+
+    child1 = Child.get(name="child1")
+    if child1 is None:
+        child1 = Child(name="child1", parent_id=parent1.id)
+        child1.save()
+
+    child2 = Child.get(name="child2")
+    if child2 is None:
+        child2 = Child(name="child2", parent_id=parent1.id)
+        child2.save()
+
+    child3 = Child.get(name="child3")
+    if child3 is None:
+        child3 = Child(name="child3", parent_id=parent1.id)
+        child3.save()
+
+    parent2 = Parent.get(name="parent2")
+    if parent2 is None:
+        parent2 = Parent(name="parent2")
+        parent2.save()
+
+    child4 = Child.get(name="child4")
+    if child4 is None:
+        child4 = Child(name="child4", parent_id=parent2.id)
+        child4.save()
+
+    child5 = Child.get(name="child5")
+    if child5 is None:
+        child5 = Child(name="child5", parent_id=parent2.id)
+        child5.save()
+
+    child6 = Child.get(name="child6")
+    if child6 is None:
+        child6 = Child(name="child6", parent_id=parent2.id)
+        child6.save()
+
+    Parent.delete_all()  # Should raise an IntegrityError --> FOREIGN KEY constraint failed
+    parent2.delete() # Should raise an IntegrityError --> FOREIGN KEY constraint failed
+
+    print()

{wiederverwendbar-0.8.3 → wiederverwendbar-0.8.4}/src/wiederverwendbar/sqlalchemy/base.py

@@ -2,7 +2,7 @@ from typing import Any, Optional, Callable, Union, TYPE_CHECKING
 
 from sqlalchemy import inspect
 from sqlalchemy.sql import ColumnExpressionArgument
-from sqlalchemy.orm import Session, QueryableAttribute, InstrumentedAttribute
+from sqlalchemy.orm import Session, QueryableAttribute
 from sqlalchemy.orm.exc import DetachedInstanceError
 
 from wiederverwendbar.default import Default
@@ -399,3 +399,19 @@ class Base:
         session.commit()
 
         self.session_close(session_created=session_created, session=session)
+
+    @classmethod
+    def delete_all(cls,
+                   *criterion: Union[ColumnExpressionArgument[bool], bool],
+                   session: Optional[Session] = None,
+                   **kwargs: Any) -> None:
+        session_created, session = cls.session(session=session)
+
+        # delete rows
+        if criterion:
+            session.query(cls).filter(*criterion, **kwargs).delete()
+        else:
+            session.query(cls).filter_by(**kwargs).delete()
+        session.commit()
+
+        cls.session_close(session_created=session_created, session=session)

{wiederverwendbar-0.8.3 → wiederverwendbar-0.8.4}/src/wiederverwendbar/sqlalchemy/db.py

@@ -1,10 +1,11 @@
 import inspect
 import logging
+import sqlite3
 from ipaddress import IPv4Address
 from pathlib import Path
-from typing import Any, Optional, Union, Sequence
+from typing import Any, Optional, Union, Sequence, Callable
 
-from sqlalchemy import create_engine, Table
+from sqlalchemy import create_engine, Table, event
 from sqlalchemy.orm import sessionmaker, declarative_base, DeclarativeMeta as _DeclarativeMeta, Session
 from sqlalchemy.ext.declarative import declarative_base
 
@@ -41,6 +42,7 @@ class SqlalchemyDb:
                  username: Optional[str] = None,
                  password: Optional[str] = None,
                  echo: Optional[bool] = None,
+                 sqlite_handle_foreign_keys: bool = True,
                  settings: Optional[SqlalchemySettings] = None):
         """
         Create a new Sqlalchemy Database
@@ -52,22 +54,26 @@ class SqlalchemyDb:
         :param username: User to connect to database
         :param password: Password to connect to database
         :param echo: Echo SQL queries to console
+        :param sqlite_handle_foreign_keys: Enable SQLite Foreign Keys
         :param settings: Sqlalchemy Settings
         """
 
-        self.settings: SqlalchemySettings = settings or SqlalchemySettings()
-        self.file: Optional[Path] = file or self.settings.db_file
-        self.host: Union[IPv4Address, str, None] = host or self.settings.db_host
-        self.port: Optional[int] = port or self.settings.db_port
-        self.protocol: Optional[str] = protocol or self.settings.db_protocol
-        self.name: Optional[str] = name or self.settings.db_name
-        self.username: Optional[str] = username or self.settings.db_username
-        self.password: Optional[str] = password or self.settings.db_password
-        self.echo: bool = echo or self.settings.db_echo
+        self._settings: SqlalchemySettings = settings or SqlalchemySettings()
+        self._file: Optional[Path] = file or self.settings.db_file
+        self._host: Union[IPv4Address, str, None] = host or self.settings.db_host
+        self._port: Optional[int] = port or self.settings.db_port
+        self._protocol: Optional[str] = protocol or self.settings.db_protocol
+        self._name: Optional[str] = name or self.settings.db_name
+        self._username: Optional[str] = username or self.settings.db_username
+        self._password: Optional[str] = password or self.settings.db_password
+        self._echo: bool = echo or self.settings.db_echo
+        self._sqlite_handle_foreign_keys: bool = sqlite_handle_foreign_keys or self.settings.db_sqlite_handle_foreign_keys
 
         logger.debug(f"Create {self}")
 
         self.engine = create_engine(self.connection_string, echo=self.echo)
+        if self.protocol == "sqlite" and self.sqlite_handle_foreign_keys:
+            self.listen("connect", self._sqlite_set_handle_foreign_keys)
         self.session_maker = sessionmaker(bind=self.engine)
         self.Base: DeclarativeMeta = declarative_base(metaclass=DeclarativeMeta)
         self.session_maker.configure(binds={self.Base: self.engine})
@@ -75,6 +81,46 @@ class SqlalchemyDb:
     def __str__(self):
         return f"{self.__class__.__name__}({self.connection_string_printable})"
 
+    @property
+    def settings(self) -> SqlalchemySettings:
+        return self._settings
+
+    @property
+    def file(self) -> Optional[Path]:
+        return self._file
+
+    @property
+    def host(self) -> Union[IPv4Address, str, None]:
+        return self._host
+
+    @property
+    def port(self) -> Optional[int]:
+        return self._port
+
+    @property
+    def protocol(self) -> Optional[str]:
+        return self._protocol
+
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
+    @property
+    def username(self) -> Optional[str]:
+        return self._username
+
+    @property
+    def password(self) -> Optional[str]:
+        return self._password
+
+    @property
+    def echo(self) -> bool:
+        return self._echo
+
+    @property
+    def sqlite_handle_foreign_keys(self) -> bool:
+        return self._sqlite_handle_foreign_keys
+
     def get_connection_string(self, printable: bool = False) -> str:
         """
         Get the Connection String
@@ -150,3 +196,45 @@ class SqlalchemyDb:
 
         logger.debug(f"Create Session for {self}")
         return self.session_maker()
+
+    def listen(self,
+               identifier: str,
+               func: Callable[..., Any],
+               *args: Any,
+               **kwargs: Any) -> None:
+        """
+        Register a listener function for the engine.
+
+        :param identifier: String name of the event.
+        :param func: Callable function.
+        :return: None
+
+        .. Seealso::
+            sqlalchemy.event.api.listen for more.
+        """
+
+        event.listen(self.engine, identifier, func, *args, **kwargs)
+
+    def listens_for(self,
+                    identifier: str,
+                    *args: Any,
+                    **kw: Any) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
+        """
+        Decorate a function as a listener for the engine.
+
+        :param identifier: String name of the event.
+        :return: Callable[[Callable[..., Any]], Callable[..., Any]]
+
+        .. Seealso::
+            sqlalchemy.event.api.listens_for for more.
+        """
+
+        return event.listens_for(self.engine, identifier, *args, **kw)
+
+    @classmethod
+    def _sqlite_set_handle_foreign_keys(cls, connection, _connection_record):
+        if not isinstance(connection, sqlite3.Connection):
+            raise RuntimeError(f"Connection is not a sqlite3.Connection: {connection}")
+        cursor = connection.cursor()
+        cursor.execute("PRAGMA foreign_keys=ON")
+        cursor.close()

{wiederverwendbar-0.8.3 → wiederverwendbar-0.8.4}/src/wiederverwendbar/sqlalchemy/settings.py

@@ -34,3 +34,6 @@ class SqlalchemySettings(PrintableSettings):
     db_echo: bool = Field(default=False,
                           title="Database echo.",
                           description="Echo SQL queries to console")
+    db_sqlite_handle_foreign_keys: bool = Field(default=True,
+                                                title="Database SQLite Handle Foreign Keys",
+                                                description="Handle foreign keys in SQLite")

wiederverwendbar-0.8.3/src/wiederverwendbar/examples/sqlalchemy/db.py

@@ -1,31 +0,0 @@
-from pathlib import Path
-
-from sqlalchemy import Column, Text, Integer
-
-from wiederverwendbar.logger import LoggerSingleton, LoggerSettings
-from wiederverwendbar.sqlalchemy import Base, SqlalchemySettings, SqlalchemyDbSingleton
-
-LoggerSingleton(name="test", settings=LoggerSettings(log_level=LoggerSettings.LogLevels.DEBUG), init=True)
-
-
-class MyBase(Base, SqlalchemyDbSingleton(settings=SqlalchemySettings(db_file=Path("test.db")), init=True).Base):
-    __abstract__ = True
-
-
-class MyTable(MyBase):
-    __tablename__ = "my_table"
-    __str_columns__: list[str] = ["name"]
-
-    name = Column(Text(50), primary_key=True)
-    value = Column(Integer)
-
-
-if __name__ == '__main__':
-    SqlalchemyDbSingleton().create_all()
-
-    my_table = MyTable(name="test", value=1)
-
-    d = my_table.as_dict()
-    my_table.save()
-
-    print()