wiederverwendbar 0.8.5__py3-none-any.whl → 0.9.0__py3-none-any.whl

wiederverwendbar/examples/sqlalchemy/db.py

@@ -1,89 +0,0 @@
-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/examples/starlette_admin/action_log.py

@@ -1,126 +0,0 @@
-import logging
-import asyncio
-
-import uvicorn
-from starlette.applications import Starlette
-from starlette.responses import HTMLResponse
-from starlette.routing import Route
-from starlette.requests import Request
-from starlette_admin.contrib.mongoengine import Admin, ModelView
-from starlette_admin.actions import action
-from mongoengine import Document, StringField
-from kombu import Connection
-
-from wiederverwendbar.mongoengine import MongoengineDbSingleton
-from wiederverwendbar.starlette_admin import ActionLogAdmin, ActionLogger
-
-logger = logging.getLogger(__name__)
-ch = logging.StreamHandler()
-ch.setLevel(logging.DEBUG)
-logger.addHandler(ch)
-logger.setLevel(logging.DEBUG)
-
-# connect to database
-MongoengineDbSingleton(init=True)
-
-# create kombu connection
-kombu_connection = Connection(MongoengineDbSingleton().connection_string)
-
-
-# Create starlette app
-app = Starlette(
-    routes=[
-        Route(
-            "/",
-            lambda r: HTMLResponse("<a href=/admin/>Click me to get to Admin!</a>"),
-        ),
-    ],
-)
-
-
-class MyAdmin(Admin, ActionLogAdmin):
-    ...
-
-
-# Create admin
-admin = MyAdmin(title="Test Admin", kombu_connection=kombu_connection)
-
-
-class Test(Document):
-    meta = {"collection": "test"}
-
-    test_str = StringField()
-
-
-class TestView(ModelView):
-    def __init__(self):
-        super().__init__(document=Test, icon="fa fa-server", name="Test", label="Test")
-
-    actions = ["delete", "test_action_normal", "test_action_action_log"]
-
-    @action(name="test_action_normal",
-            text="Test Action - Normal")
-    # confirmation="Möchtest du die Test Aktion durchführen?",
-    # icon_class="fa-regular fa-network-wired",
-    # submit_btn_text="Ja, fortsetzen",
-    # submit_btn_class="btn-success")
-    async def test_action_normal(self, request: Request, pk: list[str]) -> str:
-        await asyncio.sleep(2)
-
-        return "Test Aktion erfolgreich."
-
-    @action(name="test_action_action_log",
-            text="Test Action - Action Log")
-    # confirmation="Möchtest du die Test Aktion durchführen?",
-    # icon_class="fa-regular fa-network-wired",
-    # submit_btn_text="Ja, fortsetzen",
-    # submit_btn_class="btn-success")
-    async def test_action_action_log(self, request: Request, pk: list[str]) -> str:
-        with ActionLogger(request, parent=logger) as action_logger:
-            # use context manager to ensure that the logger is finalized
-            with action_logger.sub_logger("sub_action_1", "Sub Action 1", steps=3, ignore_loggers_like=["pymongo"]) as sub_logger:
-                sub_logger.info("Test Aktion startet ...")
-                sub_logger.debug("Debug")
-                sub_logger.info("Test Aktion step 1")
-                await asyncio.sleep(2)
-                sub_logger.next_step()
-                sub_logger.info("Test Aktion step 2")
-                _ = 1 / 0  # raise exception
-                # raise ActionFailed("Test Aktion fehlgeschlagen.")
-                await asyncio.sleep(2)
-                sub_logger.next_step()
-                sub_logger.steps += 100
-                for i in range(1, 100):
-                    sub_logger.info(f"Test Aktion step 2 - {i}")
-                    sub_logger.next_step()
-                    await asyncio.sleep(0.1)
-                sub_logger.info("Test Aktion step 3")
-                await asyncio.sleep(2)
-
-            sub_action_2_logger = action_logger.new_sub_logger("sub_action_2", "Sub Action 2")
-            sub_action_2_logger.start(steps=3)
-            sub_action_3_logger = action_logger.new_sub_logger("sub_action_3", "Sub Action 3")
-            sub_action_3_logger.start()
-            sub_action_3_logger.steps = 3
-            sub_action_2_logger.info("Test Aktion startet ...")
-            sub_action_3_logger.info("Test Aktion startet ...")
-            await asyncio.sleep(2)
-            sub_action_2_logger.next_step()
-            sub_action_3_logger.next_step()
-            await asyncio.sleep(2)
-            sub_action_2_logger.next_step()
-            sub_action_3_logger.next_step()
-            sub_action_2_logger.finalize(success=False, on_error_msg="Test Aktion fehlgeschlagen.")
-            sub_action_3_logger.finalize(success=True, on_success_msg="Test Aktion erfolgreich.")
-
-        return "Test Aktion erfolgreich."
-
-
-# Add views to admin#
-admin.add_view(TestView())
-
-# Mount admin to app
-admin.mount_to(app)
-
-if __name__ == "__main__":
-    uvicorn.run(app, host="0.0.0.0", port=8000)

wiederverwendbar/examples/starlette_admin/action_log_file_download.py

@@ -1,99 +0,0 @@
-import logging
-import asyncio
-
-import uvicorn
-from starlette.applications import Starlette
-from starlette.responses import HTMLResponse
-from starlette.routing import Route
-from starlette.requests import Request
-from starlette_admin.contrib.mongoengine import Admin, ModelView
-from starlette_admin.actions import action
-from mongoengine import Document, StringField
-from kombu import Connection
-
-from wiederverwendbar.functions.test_file import test_file
-from wiederverwendbar.mongoengine import MongoengineDbSingleton
-from wiederverwendbar.starlette_admin import ActionLogAdmin, ActionLogger, FormCommand, MultiPathAdmin, DownloadCommand
-
-logger = logging.getLogger(__name__)
-ch = logging.StreamHandler()
-ch.setLevel(logging.DEBUG)
-logger.addHandler(ch)
-logger.setLevel(logging.DEBUG)
-
-# connect to database
-MongoengineDbSingleton(init=True)
-
-# create kombu connection
-kombu_connection = Connection(MongoengineDbSingleton().connection_string)
-
-
-# Create starlette app
-app = Starlette(
-    routes=[
-        Route(
-            "/",
-            lambda r: HTMLResponse("<a href=/admin/>Click me to get to Admin!</a>"),
-        ),
-    ],
-)
-
-
-class MyAdmin(Admin, ActionLogAdmin, MultiPathAdmin):
-    ...
-
-
-# Create admin
-admin = MyAdmin(title="Test Admin", kombu_connection=kombu_connection)
-
-
-class Test(Document):
-    meta = {"collection": "test"}
-
-    test_str = StringField()
-
-
-class TestView(ModelView):
-    def __init__(self):
-        super().__init__(document=Test, icon="fa fa-server", name="Test", label="Test")
-
-    actions = ["delete", "test_action_normal", "test_action_action_log"]
-
-    @action(name="test_action_normal",
-            text="Test Action - Normal")
-    # confirmation="Möchtest du die Test Aktion durchführen?",
-    # icon_class="fa-regular fa-network-wired",
-    # submit_btn_text="Ja, fortsetzen",
-    # submit_btn_class="btn-success")
-    async def test_action_normal(self, request: Request, pk: list[str]) -> str:
-        await asyncio.sleep(2)
-
-        return "Test Aktion erfolgreich."
-
-    @action(name="test_action_action_log",
-            text="Test Action - Action Log")
-    # confirmation="Möchtest du die Test Aktion durchführen?",
-    # icon_class="fa-regular fa-network-wired",
-    # submit_btn_text="Ja, fortsetzen",
-    # submit_btn_class="btn-success")
-    async def test_action_action_log(self, request: Request, pk: list[str]) -> str:
-        with await ActionLogger(request, parent=logger) as action_logger:
-            # use context manager to ensure that the logger is finalized
-            with action_logger.sub_logger("sub_action_1", "Sub Action 1", steps=3, ignore_loggers_like=["pymongo"]) as sub_logger:
-                sub_logger_yes_no = sub_logger.yes_no("Möchtest du eine Testdatei generieren?")()
-                if not sub_logger_yes_no:
-                    sub_logger.finalize(success=False, on_error_msg="Test Aktion abgebrochen.")
-                generated_file = test_file(1, 'MB')
-                DownloadCommand(sub_logger, text="Testdatei", file_path=generated_file)()
-
-        return "Test Aktion erfolgreich."
-
-
-# Add views to admin#
-admin.add_view(TestView())
-
-# Mount admin to app
-admin.mount_to(app)
-
-if __name__ == "__main__":
-    uvicorn.run(app, host="0.0.0.0", port=8000)

wiederverwendbar/examples/starlette_admin/action_log_form.py

@@ -1,149 +0,0 @@
-import logging
-import asyncio
-
-import uvicorn
-from starlette.applications import Starlette
-from starlette.responses import HTMLResponse
-from starlette.routing import Route
-from starlette.requests import Request
-from starlette_admin.contrib.mongoengine import Admin, ModelView
-from starlette_admin.actions import action
-from starlette_admin.exceptions import ActionFailed
-from mongoengine import Document, StringField
-from kombu import Connection
-
-from wiederverwendbar.mongoengine import MongoengineDbSingleton
-from wiederverwendbar.starlette_admin import ActionLogAdmin, ActionLogger, FormCommand
-
-logger = logging.getLogger(__name__)
-ch = logging.StreamHandler()
-ch.setLevel(logging.DEBUG)
-logger.addHandler(ch)
-logger.setLevel(logging.DEBUG)
-
-# connect to database
-MongoengineDbSingleton(init=True)
-
-# create kombu connection
-kombu_connection = Connection(MongoengineDbSingleton().connection_string)
-
-
-# Create starlette app
-app = Starlette(
-    routes=[
-        Route(
-            "/",
-            lambda r: HTMLResponse("<a href=/admin/>Click me to get to Admin!</a>"),
-        ),
-    ],
-)
-
-
-class MyAdmin(Admin, ActionLogAdmin):
-    ...
-
-
-# Create admin
-admin = MyAdmin(title="Test Admin", kombu_connection=kombu_connection)
-
-
-class Test(Document):
-    meta = {"collection": "test"}
-
-    test_str = StringField()
-
-
-class TestView(ModelView):
-    def __init__(self):
-        super().__init__(document=Test, icon="fa fa-server", name="Test", label="Test")
-
-    actions = ["delete", "test_action_normal", "test_action_action_log"]
-
-    @action(name="test_action_normal",
-            text="Test Action - Normal")
-    # confirmation="Möchtest du die Test Aktion durchführen?",
-    # icon_class="fa-regular fa-network-wired",
-    # submit_btn_text="Ja, fortsetzen",
-    # submit_btn_class="btn-success")
-    async def test_action_normal(self, request: Request, pk: list[str]) -> str:
-        await asyncio.sleep(2)
-
-        return "Test Aktion erfolgreich."
-
-    @action(name="test_action_action_log",
-            text="Test Action - Action Log")
-    # confirmation="Möchtest du die Test Aktion durchführen?",
-    # icon_class="fa-regular fa-network-wired",
-    # submit_btn_text="Ja, fortsetzen",
-    # submit_btn_class="btn-success")
-    async def test_action_action_log(self, request: Request, pk: list[str]) -> str:
-        with await ActionLogger(request, parent=logger) as action_logger:
-            # send form
-            action_logger_form_data = FormCommand(action_logger,
-                                                  """<form>
-                      <div class="mt-3">
-                          <input type="hidden" name="hidden">
-                          <div>
-                              <label class="form-check">
-                                  <input type="radio" class="form-check-input" name="action" value="choice1" checked>
-                                  <span class="form-check-label">Choice 1</span>
-                              </label>
-                              <label class="form-check">
-                                  <input type="radio" class="form-check-input" name="action" value="choice2">
-                                  <span class="form-check-label">Choice 2</span>
-                              </label>
-                              <label class="form-check">
-                                  <input type="radio" class="form-check-input" name="action" value="choice3">
-                                  <span class="form-check-label">Choice 3</span>
-                              </label>
-                          </div>
-                      </div>
-                  </form>""",
-                                                  "Weiter",
-                                                  "Abbrechen")()
-            if not action_logger_form_data:
-                raise ActionFailed("Test Aktion abgebrochen.")
-
-            action_logger_yes_no = action_logger.yes_no("Möchtest du fortfahren?")()
-            if not action_logger_yes_no:
-                raise ActionFailed("Test Aktion abgebrochen.")
-
-            # use context manager to ensure that the logger is finalized
-            with action_logger.sub_logger("sub_action_1", "Sub Action 1", steps=3, ignore_loggers_like=["pymongo"]) as sub_logger:
-                sub_logger.info("Test Aktion startet ...")
-                sub_logger.debug("Debug")
-                sub_logger.info("Test Aktion step 1")
-                await asyncio.sleep(2)
-                sub_logger.next_step()
-                sub_logger.info("Test Aktion step 2")
-
-                # send form with positive/negative buttons
-                sub_logger_confirm = sub_logger.confirm("Information")()
-                sub_logger.info(f"Confirm: {sub_logger_confirm}")
-
-
-                sub_logger_yes_no = sub_logger.yes_no("Möchtest du fortfahren?")()
-                if not sub_logger_yes_no:
-                    sub_logger.finalize(success=False, on_error_msg="Test Aktion abgebrochen.")
-
-                await asyncio.sleep(2)
-                sub_logger.next_step()
-                sub_logger.steps += 100
-                for i in range(1, 100):
-                    sub_logger.info(f"Test Aktion step 2 - {i}")
-                    sub_logger.next_step()
-                    await asyncio.sleep(0.01)
-                sub_logger.info("Test Aktion step 3")
-                await asyncio.sleep(2)
-
-        return "Test Aktion erfolgreich."
-
-
-# Add views to admin#
-admin.add_view(TestView())
-
-# Mount admin to app
-admin.mount_to(app)
-
-if __name__ == "__main__":
-    uvicorn.run(app, host="0.0.0.0", port=8000)

wiederverwendbar/examples/starlette_admin/action_log_thread.py

@@ -1,192 +0,0 @@
-import logging
-import asyncio
-import threading
-import time
-from typing import Optional
-
-import uvicorn
-from starlette.applications import Starlette
-from starlette.responses import HTMLResponse
-from starlette.routing import Route
-from starlette.requests import Request
-from starlette_admin.contrib.mongoengine import Admin, ModelView
-from starlette_admin.actions import action
-from mongoengine import Document, StringField
-from kombu import Connection
-
-from wiederverwendbar.mongoengine import MongoengineDbSingleton
-from wiederverwendbar.starlette_admin import ActionLogAdmin, ActionLogger
-
-logger = logging.getLogger(__name__)
-ch = logging.StreamHandler()
-ch.setLevel(logging.DEBUG)
-logger.addHandler(ch)
-logger.setLevel(logging.DEBUG)
-
-# connect to database
-MongoengineDbSingleton(init=True)
-
-# create kombu connection
-kombu_connection = Connection(MongoengineDbSingleton().connection_string)
-
-# Create starlette app
-app = Starlette(
-    routes=[
-        Route(
-            "/",
-            lambda r: HTMLResponse("<a href=/admin/>Click me to get to Admin!</a>"),
-        ),
-    ],
-)
-
-
-class MyAdmin(Admin, ActionLogAdmin):
-    ...
-
-
-# Create admin
-admin = MyAdmin(title="Test Admin", kombu_connection=kombu_connection)
-
-
-class Test(Document):
-    meta = {"collection": "test"}
-
-    test_str = StringField()
-
-
-class TestView(ModelView):
-    def __init__(self):
-        super().__init__(document=Test, icon="fa fa-server", name="Test", label="Test")
-
-    actions = ["delete", "test_action_normal", "test_action_action_log"]
-
-    @action(name="test_action_normal",
-            text="Test Action - Normal")
-    # confirmation="Möchtest du die Test Aktion durchführen?",
-    # icon_class="fa-regular fa-network-wired",
-    # submit_btn_text="Ja, fortsetzen",
-    # submit_btn_class="btn-success")
-    async def test_action_normal(self, request: Request, pk: list[str]) -> str:
-        await asyncio.sleep(2)
-
-        return "Test Aktion erfolgreich."
-
-    @action(name="test_action_action_log",
-            text="Test Action - Action Log")
-    # confirmation="Möchtest du die Test Aktion durchführen?",
-    # icon_class="fa-regular fa-network-wired",
-    # submit_btn_text="Ja, fortsetzen",
-    # submit_btn_class="btn-success")
-    async def test_action_action_log(self, request: Request, pk: list[str]) -> str:
-        with ActionLogger(request, parent=logger) as action_logger:
-            action_thread = ActionThread(action_logger=action_logger, payload=payload, name="action_thrad_1", title="Action Thread 1")
-            action_thread.start()
-            await action_thread.wait(timeout=5)
-
-        return "Test Aktion erfolgreich."
-
-
-class ActionThread(threading.Thread):
-    def __init__(self,
-                 action_logger: ActionLogger,
-                 name: str,
-                 payload: Optional[callable] = None,
-                 payload_args: Optional[list] = None,
-                 payload_kwargs: Optional[dict] = None,
-                 title: Optional[str] = None,
-                 log_level: int = logging.NOTSET,
-                 parent: Optional[logging.Logger] = None,
-                 formatter: Optional[logging.Formatter] = None,
-                 steps: Optional[int] = None,
-                 on_success_msg: Optional[str] = None,
-                 on_error_msg: Optional[str] = "Something went wrong.",
-                 show_errors: Optional[bool] = None,
-                 halt_on_error: Optional[bool] = None,
-                 use_context_logger_level: bool = True,
-                 use_context_logger_level_on_not_set: Optional[bool] = None,
-                 ignore_loggers_equal: Optional[list[str]] = None,
-                 ignore_loggers_like: Optional[list[str]] = None,
-                 handle_origin_logger: bool = True,
-                 *args,
-                 **kwargs):
-        super().__init__(*args, **kwargs)
-
-        self.lock = threading.Lock()
-        self._payload = payload
-        self._payload_args = payload_args if payload_args is not None else []
-        self._payload_kwargs = payload_kwargs if payload_kwargs is not None else {}
-
-        self._action_logger = action_logger
-        self._sub_logger = None
-
-        self._name = name
-        self._title = title
-        self._log_level = log_level
-        self._parent = parent
-        self._formatter = formatter
-        self._steps = steps
-        self._on_success_msg = on_success_msg
-        self._on_error_msg = on_error_msg
-        self._show_errors = show_errors
-        self._halt_on_error = halt_on_error
-        self._use_context_logger_level = use_context_logger_level
-        self._use_context_logger_level_on_not_set = use_context_logger_level_on_not_set
-        self._ignore_loggers_equal = ignore_loggers_equal
-        self._ignore_loggers_like = ignore_loggers_like
-        self._handle_origin_logger = handle_origin_logger
-
-    def run(self):
-        with self._action_logger.sub_logger(name=self._name,
-                                            title=self._title,
-                                            log_level=self._log_level,
-                                            parent=self._parent,
-                                            formatter=self._formatter,
-                                            steps=self._steps,
-                                            on_success_msg=self._on_success_msg,
-                                            on_error_msg=self._on_error_msg,
-                                            show_errors=self._show_errors,
-                                            halt_on_error=self._halt_on_error,
-                                            use_context_logger_level=self._use_context_logger_level,
-                                            use_context_logger_level_on_not_set=self._use_context_logger_level_on_not_set,
-                                            ignore_loggers_equal=self._ignore_loggers_equal,
-                                            ignore_loggers_like=self._ignore_loggers_like,
-                                            handle_origin_logger=self._handle_origin_logger) as sub_logger:
-            self._sub_logger = sub_logger
-            try:
-                self.payload()
-            except Exception as e:
-                with self.lock:
-                    self._sub_logger.finalize(success=False, on_error_msg=str(e))
-            self._sub_logger.finalize(success=True)
-
-    async def wait(self, timeout: int = -1):
-        start_wait = time.perf_counter()
-        while self.is_alive():
-            if timeout != -1:
-                if time.perf_counter() - start_wait > timeout:
-                    with self.lock:
-                        self._sub_logger.finalize(success=False, on_error_msg="Thread timed out.")
-            await asyncio.sleep(0.1)
-
-    def payload(self):
-        if self._payload is None:
-            raise NotImplementedError("Payload not implemented.")
-        self._payload(*self._payload_args, **self._payload_kwargs)
-
-
-def payload():
-    while True:
-        t_logger = logging.getLogger("test_foo")
-        t_logger.debug("foo")
-        print("foo")
-        time.sleep(1)
-
-
-# Add views to admin#
-admin.add_view(TestView())
-
-# Mount admin to app
-admin.mount_to(app)
-
-if __name__ == "__main__":
-    uvicorn.run(app, host="0.0.0.0", port=8000)