klab-pytest-toolkit-prompt 0.0.0__tar.gz

klab_pytest_toolkit_prompt-0.0.0/.gitignore

@@ -0,0 +1,177 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Custom ###
+pytest.xml
+pytest-coverage.txt
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

klab_pytest_toolkit_prompt-0.0.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: klab-pytest-toolkit-prompt
+Version: 0.0.0
+Summary: Pytest prompt fixtures for the Klab Pytest Toolkit
+Author-email: Burak Kizilkaya <burak.kizilkaya@outlook.com>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: <4,>=3.11
+Requires-Dist: pytest>=8.3.5
+Description-Content-Type: text/markdown
+
+# Klab Pytest Toolkit - Prompt
+
+Custom pytest fixtures for interactive user prompts during test execution using tkinter UI dialogs.
+The goal is to allow testers to interact with the test process, providing confirmations or displaying important information.
+
+At the moment the package provides the following fixtures:
+
+- `ui_prompt_factory`: Factory for creating multiple prompt instance. With the factory you can create the prompt fixture.
+
+## Installation
+
+```bash
+pip install klab-pytest-toolkit-prompt
+```
+
+## Usage
+
+### UI Prompt
+
+**Create the fixture**
+
+The factory class `PromptFactory` can be used to create multiple prompt instances.
+This is already provided as a pytest fixture `prompt_factory`.
+
+```python
+
+@pytest.fixture
+def ui_prompt(prompt_factory) -> PromptInterface:
+    """Fixture to provide a UI prompt interface for user interaction during tests."""
+    return prompt_factory.create_prompt(prompt_type=PromptFactory.PromptType.UI_PROMPT)
+```
+
+**Functions**
+
+The following functions are available on the `PromptInterface` instance:
+
+**Show Information Dialog**
+
+```python
+def test_with_info(ui_prompt):
+    """Display information to the user."""
+    ui_prompt.show_info("Test is about to perform a critical operation")
+    
+    # Continue with test
+    perform_operation()
+```
+
+**Get User Confirmation**
+
+```python
+def test_with_confirmation(ui_prompt):
+    """Get user confirmation before proceeding."""
+    if ui_prompt.confirm_action("Continue with destructive test?"):
+        # User clicked Yes
+        perform_destructive_operation()
+    else:
+        # User clicked No
+        pytest.skip("User cancelled the test")
+```
+
+**With Timeout (Auto-close)**
+
+```python
+def test_with_timeout(ui_prompt):
+    """Show dialog that auto-closes after timeout."""
+    # Dialog closes automatically after 5 seconds
+    ui_prompt.show_info("This will auto-close in 5 seconds", timeout=5)
+    
+    # Confirmation dialog with timeout (returns False if timeout expires)
+    result = ui_prompt.confirm_action(
+        "Click within 10 seconds",
+        timeout=10
+    )
+```
+
+## Examples
+
+See the `tests` directory for example test cases demonstrating the usage of the prompt fixtures.
+
+## License
+
+MIT

klab_pytest_toolkit_prompt-0.0.0/README.md

@@ -0,0 +1,82 @@
+# Klab Pytest Toolkit - Prompt
+
+Custom pytest fixtures for interactive user prompts during test execution using tkinter UI dialogs.
+The goal is to allow testers to interact with the test process, providing confirmations or displaying important information.
+
+At the moment the package provides the following fixtures:
+
+- `ui_prompt_factory`: Factory for creating multiple prompt instance. With the factory you can create the prompt fixture.
+
+## Installation
+
+```bash
+pip install klab-pytest-toolkit-prompt
+```
+
+## Usage
+
+### UI Prompt
+
+**Create the fixture**
+
+The factory class `PromptFactory` can be used to create multiple prompt instances.
+This is already provided as a pytest fixture `prompt_factory`.
+
+```python
+
+@pytest.fixture
+def ui_prompt(prompt_factory) -> PromptInterface:
+    """Fixture to provide a UI prompt interface for user interaction during tests."""
+    return prompt_factory.create_prompt(prompt_type=PromptFactory.PromptType.UI_PROMPT)
+```
+
+**Functions**
+
+The following functions are available on the `PromptInterface` instance:
+
+**Show Information Dialog**
+
+```python
+def test_with_info(ui_prompt):
+    """Display information to the user."""
+    ui_prompt.show_info("Test is about to perform a critical operation")
+    
+    # Continue with test
+    perform_operation()
+```
+
+**Get User Confirmation**
+
+```python
+def test_with_confirmation(ui_prompt):
+    """Get user confirmation before proceeding."""
+    if ui_prompt.confirm_action("Continue with destructive test?"):
+        # User clicked Yes
+        perform_destructive_operation()
+    else:
+        # User clicked No
+        pytest.skip("User cancelled the test")
+```
+
+**With Timeout (Auto-close)**
+
+```python
+def test_with_timeout(ui_prompt):
+    """Show dialog that auto-closes after timeout."""
+    # Dialog closes automatically after 5 seconds
+    ui_prompt.show_info("This will auto-close in 5 seconds", timeout=5)
+    
+    # Confirmation dialog with timeout (returns False if timeout expires)
+    result = ui_prompt.confirm_action(
+        "Click within 10 seconds",
+        timeout=10
+    )
+```
+
+## Examples
+
+See the `tests` directory for example test cases demonstrating the usage of the prompt fixtures.
+
+## License
+
+MIT

klab_pytest_toolkit_prompt-0.0.0/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "klab-pytest-toolkit-prompt"
+dynamic = ["version"]
+description = "Pytest prompt fixtures for the Klab Pytest Toolkit"
+authors = [{ name = "Burak Kizilkaya", email = "burak.kizilkaya@outlook.com" }]
+requires-python = ">=3.11,<4"
+readme = "README.md"
+license = "MIT"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "pytest>=8.3.5",
+]
+
+[project.entry-points.pytest11]
+klab_pytest_toolkit_prompt = "klab_pytest_toolkit_prompt.plugin"
+
+[tool.hatch.version]
+path = "src/klab_pytest_toolkit_prompt/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "tests",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+pythonpath = [
+  "."
+]

klab_pytest_toolkit_prompt-0.0.0/src/klab_pytest_toolkit_prompt/__init__.py

@@ -0,0 +1,10 @@
+"""Klab Pytest Toolkit - Prompt"""
+
+from klab_pytest_toolkit_prompt.core import PromptInterface, PromptFactory
+
+__version__ = "0.0.0"
+
+__all__ = [
+    "PromptInterface",
+    "PromptFactory",
+]

klab_pytest_toolkit_prompt-0.0.0/src/klab_pytest_toolkit_prompt/core.py

@@ -0,0 +1,45 @@
+import abc
+from typing import Optional
+
+
+class PromptInterface(abc.ABC):
+    """Abstract base class for prompt interfaces."""
+
+    @abc.abstractmethod
+    def show_info(self, message: str, timeout: Optional[int] = None) -> None:
+        """Display an informational message to the user."""
+        raise NotImplementedError
+
+    def confirm_action(self, message: str, timeout: Optional[int] = None) -> Optional[bool]:
+        """Prompt the user to confirm an action."""
+        raise NotImplementedError
+
+    def get_user_input(self, prompt: str, timeout: Optional[int] = None) -> Optional[str]:
+        """Prompt the user for input."""
+        raise NotImplementedError
+
+    def __enter__(self):
+        """Enter the runtime context related to this object."""
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        """Exit the runtime context related to this object."""
+        pass
+
+
+class PromptFactory:
+    """Factory for creating prompt interface instances."""
+
+    class PromptType:
+        UI_PROMPT = "ui_prompt"
+        # Future prompt types can be added here
+
+    @staticmethod
+    def create_prompt(prompt_type: str = PromptType.UI_PROMPT) -> PromptInterface:
+        """Create a prompt interface instance based on the specified type."""
+        if prompt_type == PromptFactory.PromptType.UI_PROMPT:
+            from klab_pytest_toolkit_prompt.ui import UiPrompt
+
+            return UiPrompt()
+        else:
+            raise ValueError(f"Unsupported prompt type: {prompt_type}")

klab_pytest_toolkit_prompt-0.0.0/src/klab_pytest_toolkit_prompt/plugin.py

@@ -0,0 +1,24 @@
+"""Pytest plugin to register prompt fixtures."""
+
+from klab_pytest_toolkit_prompt.core import PromptFactory
+import pytest
+
+
+def pytest_configure(config):
+    """Register custom markers and configure prompt fixtures."""
+    pass
+
+
+def pytest_addoption(parser):
+    """Add command line and ini file options."""
+    pass
+
+
+@pytest.fixture
+def prompt_factory() -> PromptFactory:
+    """Factory fixture to create prompt interface instances.
+
+    Returns:
+        PromptFactory: An instance of the PromptFactory
+    """
+    return PromptFactory()

klab_pytest_toolkit_prompt-0.0.0/src/klab_pytest_toolkit_prompt/ui.py

@@ -0,0 +1,116 @@
+import tkinter as tk
+from tkinter import messagebox, simpledialog
+from typing import Any, Callable, Optional, TypeVar
+
+from klab_pytest_toolkit_prompt.core import PromptInterface
+
+T = TypeVar("T")
+
+
+class UiPrompt(PromptInterface):
+    """Concrete implementation of PromptInterface for UI prompts.
+
+    The implementation will be done with tkinter, because it is included in the standard library.
+    """
+
+    def _run_dialog(
+        self,
+        dialog_fn: Callable[[tk.Tk], T],
+        timeout: Optional[int] = None,
+        default: Optional[T] = None,
+    ) -> Optional[T]:
+        """Run a dialog with optional timeout handling.
+
+        Args:
+            dialog_fn: Function that takes root window and returns dialog result
+            timeout: Optional timeout in seconds
+            default: Default value to return on timeout or error
+
+        Returns:
+            The dialog result or default value
+        """
+        result: Any = default
+        timeout_expired = False
+
+        def show():
+            nonlocal result, timeout_expired
+            root = tk.Tk()
+            root.withdraw()
+            root.update_idletasks()
+
+            if timeout:
+
+                def auto_close():
+                    nonlocal timeout_expired
+                    timeout_expired = True
+                    self._safe_destroy(root)
+
+                root.after(timeout * 1000, auto_close)
+
+            try:
+                dialog_result = dialog_fn(root)
+                if not timeout_expired:
+                    result = dialog_result
+            except tk.TclError:
+                pass
+
+            self._safe_destroy(root)
+
+        show()
+        return result
+
+    @staticmethod
+    def _safe_destroy(root: tk.Tk) -> None:
+        """Safely quit and destroy a tkinter root window."""
+        try:
+            root.quit()
+            root.destroy()
+        except tk.TclError:
+            pass
+
+    def show_info(self, message: str, timeout: Optional[int] = None) -> None:
+        """Display an informational message to the user.
+
+        Args:
+            message: The message to display
+            timeout: Optional timeout in seconds. If provided, the dialog will
+                    automatically close after this time.
+        """
+        self._run_dialog(
+            lambda root: messagebox.showinfo("Information", message, parent=root),
+            timeout=timeout,
+        )
+
+    def confirm_action(self, message: str, timeout: Optional[int] = None) -> Optional[bool]:
+        """Prompt the user to confirm an action.
+
+        Args:
+            message: The confirmation message to display
+            timeout: Optional timeout in seconds. If provided and expires,
+                    returns False (no confirmation).
+
+        Returns:
+            bool: True if user confirmed (clicked Yes/OK), False otherwise
+        """
+        return self._run_dialog(
+            lambda root: messagebox.askyesno("Confirm Action", message, parent=root),
+            timeout=timeout,
+            default=False,
+        )
+
+    def get_user_input(self, prompt: str, timeout: Optional[int] = None) -> Optional[str]:
+        """Prompt the user for input.
+
+        Args:
+            prompt: The prompt message to display
+            timeout: Optional timeout in seconds. If provided and expires,
+                    returns None.
+
+        Returns:
+            Optional[str]: The user input, or None if cancelled or timed out
+        """
+        return self._run_dialog(
+            lambda root: simpledialog.askstring("Input Required", prompt, parent=root),
+            timeout=timeout,
+            default=None,
+        )