mininterface 0.7.4__tar.gz → 0.7.5__tar.gz

{mininterface-0.7.4 → mininterface-0.7.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mininterface
-Version: 0.7.4
+Version: 0.7.5
 Summary: A minimal access to GUI, TUI, CLI and config
 License: GPL-3.0-or-later
 Author: Edvard Rejthar
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: autocombobox (==1.4.2)
 Requires-Dist: humanize
 Requires-Dist: pyyaml
-Requires-Dist: textual (>=0.84,<0.85)
+Requires-Dist: textual (<2.0.0)
 Requires-Dist: tkinter-tooltip
 Requires-Dist: tkinter_form (==0.2.1)
 Requires-Dist: tkscrollableframe
@@ -65,6 +65,7 @@ if __name__ == "__main__":
 - [Background](#background)
 - [Installation](#installation)
 - [Docs](#docs)
+- [Gallery](#gallery)
 - [Examples](#examples)
 
 ## You got CLI
@@ -147,6 +148,13 @@ If the GUI does not work on MacOS, you might need to launch: `brew install pytho
 # Docs
 See the docs overview at [https://cz-nic.github.io/mininterface/](https://cz-nic.github.io/mininterface/Overview/).
 
+# Gallery
+
+These projects have the code base reduced thanks to the mininterface:
+
+* **[deduplidog](https://github.com/CZ-NIC/deduplidog/)** – Find duplicates in a scattered directory structure
+* **[touch-timestamp](https://github.com/CZ-NIC/touch-timestamp/)** – A powerful dialog to change the files' timestamp
+
 # Examples
 
 A powerful [`m.form`](https://cz-nic.github.io/mininterface/Mininterface/#mininterface.Mininterface.form) dialog method accepts either a dataclass or a dict. Take a look on both.

{mininterface-0.7.4 → mininterface-0.7.5}/README.md

@@ -39,6 +39,7 @@ if __name__ == "__main__":
 - [Background](#background)
 - [Installation](#installation)
 - [Docs](#docs)
+- [Gallery](#gallery)
 - [Examples](#examples)
 
 ## You got CLI
@@ -121,6 +122,13 @@ If the GUI does not work on MacOS, you might need to launch: `brew install pytho
 # Docs
 See the docs overview at [https://cz-nic.github.io/mininterface/](https://cz-nic.github.io/mininterface/Overview/).
 
+# Gallery
+
+These projects have the code base reduced thanks to the mininterface:
+
+* **[deduplidog](https://github.com/CZ-NIC/deduplidog/)** – Find duplicates in a scattered directory structure
+* **[touch-timestamp](https://github.com/CZ-NIC/touch-timestamp/)** – A powerful dialog to change the files' timestamp
+
 # Examples
 
 A powerful [`m.form`](https://cz-nic.github.io/mininterface/Mininterface/#mininterface.Mininterface.form) dialog method accepts either a dataclass or a dict. Take a look on both.

{mininterface-0.7.4 → mininterface-0.7.5}/mininterface/__init__.py

@@ -188,17 +188,17 @@ def run(env_or_list: Type[EnvClass] | list[Type[Command]] | None = None,
         parse_cli(_Empty, None, add_verbosity, ask_for_missing, args)
 
     # Build the interface
-    interface = get_interface(title, interface, env)
+    m = get_interface(title, interface, env)
 
     # Empty CLI → GUI edit
     if ask_for_missing and wrong_fields:
         # Some fields must be set.
-        interface.form(wrong_fields)
-        {setattr(interface.env, k, v.val) for k, v in wrong_fields.items()}
+        m.form(wrong_fields)
+        {setattr(m.env, k, v.val) for k, v in wrong_fields.items()}
     elif ask_on_empty_cli and len(sys.argv) <= 1:
-        interface.form()
+        m.form()
 
-    return interface
+    return m
 
 
 __all__ = ["run", "Tag", "validators", "InterfaceNotAvailable", "Cancelled",

{mininterface-0.7.4 → mininterface-0.7.5}/mininterface/auxiliary.py

@@ -25,6 +25,7 @@ def flatten(d: dict[str, T | dict], include_keys: Optional[Callable[[str], list]
             yield v
 
 
+# NOTE: Not used.
 def flatten_keys(d: dict[KT, T | dict]) -> Iterable[tuple[KT, T]]:
     """ Recursively traverse whole dict """
     for k, v in d.items():
@@ -129,7 +130,10 @@ def subclass_matches_annotation(cls, annotation) -> bool:
             return True
 
     # simple types like scalars
-    return issubclass(cls, annotation)
+    try:
+        return issubclass(cls, annotation)  # cls=tuple[int, str] raises an error since Python 3.13
+    except TypeError:
+        return False
 
 
 def serialize_structure(obj):

{mininterface-0.7.4 → mininterface-0.7.5}/mininterface/cli_parser.py

@@ -18,7 +18,9 @@ from tyro._argparse_formatter import TyroArgumentParser
 from tyro._singleton import MISSING_NONPROP
 from tyro.extras import get_parser
 
+
 from .auxiliary import yield_annotations
+from .config import MininterfaceConfig, Config
 from .form_dict import EnvClass, MissingTagValue
 from .tag import Tag
 from .tag_factory import tag_factory
@@ -251,6 +253,10 @@ def parse_cli(env_or_list: Type[EnvClass] | list[Type[EnvClass]],
         # Undocumented feature. User put a namespace into kwargs["default"]
         # that already serves for defaults. We do not fetch defaults yet from a config file.
         disk = yaml.safe_load(config_file.read_text()) or {}  # empty file is ok
+        if mininterface := disk.pop("mininterface", None):
+            # Section 'mininterface' in the config file changes the global configuration.
+            for key, value in vars(_create_with_missing(MininterfaceConfig, mininterface)).items():
+                setattr(Config, key, value)
         kwargs["default"] = _create_with_missing(env, disk)
 
     # Load configuration from CLI

mininterface-0.7.5/mininterface/config.py

@@ -0,0 +1,28 @@
+# Configuration used by all minterfaces in the program.
+# Might be changed by a 'mininterface' section in a config file.
+from dataclasses import dataclass
+from typing import Literal
+
+
+@dataclass
+class Gui:
+    combobox_since: int = 5
+    """ The threshold to switch from radio buttons to a combobox. """
+    test: bool = False
+
+
+@dataclass
+class Tui:
+    ...
+
+
+@dataclass  # (slots=True)
+class MininterfaceConfig:
+    gui: Gui
+    tui: Tui
+    interface: Literal["gui"] | Literal["tui"] | None = None
+    """ Enforce an interface. By default, we choose automatically. """
+
+
+Config = MininterfaceConfig(Gui(), Tui())
+""" Global configuration singleton to be accessed by all minterfaces. """

{mininterface-0.7.4 → mininterface-0.7.5}/mininterface/experimental.py

@@ -53,7 +53,3 @@ class FacetCallback():
     """
     pass
     # NOTE, just a stub. Deprecated, use CallbackTag instead.
-
-
-# NOTE should we use the dataclasses, isn't that slow?
-MININTERFACE_CONFIG = {"gui": {"combobox_since": 5}}

{mininterface-0.7.4 → mininterface-0.7.5}/mininterface/facet.py

@@ -19,11 +19,14 @@ if TYPE_CHECKING:
 
 @dataclass
 class Image:
-    """ NOTE. Experimental. Undocumented. """
+    """ NOTE. Experimental. """
+
     src: str | Path
+    """ Src to the image. """
 
 
 LayoutElement = TypeVar("LayoutElement", str, Image, Path, "Self")
+""" Either a string, Path or facet.Image. """
 
 
 class BackendAdaptor(ABC):
@@ -102,7 +105,7 @@ class Facet(Generic[EnvClass]):
         print("Title", text)
 
     def _layout(self, elements: list[LayoutElement]):
-        """ Experimental. """
+        """ Experimental. Input is a list of `LayoutElements`."""
         # NOTE remove warn when working in textual
         warn("Facet layout not implemented for this interface.")
 
@@ -120,6 +123,7 @@ class Facet(Generic[EnvClass]):
             "My choice": Tag(choices=["one", "two"], on_change=callback)
         })
         # continue here immediately after clicking on a radio button
+        ```
 
         """
         self.adaptor.post_submit_action = _post_submit

{mininterface-0.7.4 → mininterface-0.7.5}/mininterface/interfaces.py

@@ -3,6 +3,8 @@ from importlib import import_module
 import sys
 from typing import Literal, Type
 
+
+from .config import Config
 from .mininterface import Mininterface
 from .exceptions import InterfaceNotAvailable
 from .text_interface import TextInterface
@@ -38,6 +40,7 @@ def __getattr__(name):
 
 def get_interface(title="", interface: InterfaceType = None, env=None):
     args = title, env
+    interface = interface or Config.interface
     if isinstance(interface, type) and issubclass(interface, Mininterface):
         # the user gave a specific interface, let them catch InterfaceNotAvailable then
         return interface(*args)

{mininterface-0.7.4 → mininterface-0.7.5}/mininterface/mininterface.py

@@ -115,7 +115,7 @@ class Mininterface(Generic[EnvClass]):
 
         ![Asking number](asset/ask-number.avif)
 
-        However, when run in a non-interactive session with TUI (ex. no display), [TextInterface](Interfaces.md#TextInterface)
+        However, when run in a non-interactive session with TUI (ex. no display), [TextInterface](Interfaces.md#textinterface)
         is used which is able to turn it into an interactive one.
 
         ```python3

{mininterface-0.7.4 → mininterface-0.7.5}/mininterface/showcase.py

@@ -26,15 +26,18 @@ class Subcommand1(SharedArgs):
     my_local: int = 1
 
     def run(self):
+        print("Subcommand 1 clicked")
         print("Common:", self.common)  # user input
         print("Number:", self.my_local)  # 1 or user input
         print("Internal:", self.internal)
+        print("The submit button blocked!")
         raise ValidationFail("The submit button blocked!")
 
 
 @dataclass
 class Subcommand2(SharedArgs):
     def run(self):
+        print("Subcommand 2 clicked")
         self._facet.set_title("Button clicked")  # you can access internal self._facet: Facet
         print("Common files", self.files)
 

{mininterface-0.7.4 → mininterface-0.7.5}/mininterface/textual_interface/textual_adaptor.py

@@ -82,18 +82,11 @@ class TextualAdaptor(BackendAdaptor):
         if title:
             app.title = title
 
-        widgets: WidgetList = [f for f in flatten(formdict_to_widgetdict(
-            form, self.widgetize), include_keys=self.header)]
-        if len(widgets) and isinstance(widgets[0], Rule):
-            # there are multiple sections in the list, <hr>ed by Rule elements. However, the first takes much space.
-            widgets.pop(0)
-        app.widgets = widgets
-
         if not app.run():
             raise Cancelled
 
         # validate and store the UI value → Tag value → original value
-        vals = ((field._link, field.get_ui_value()) for field in widgets if hasattr(field, "_link"))
+        vals = ((field._link, field.get_ui_value()) for field in app.widgets if hasattr(field, "_link"))
         if not Tag._submit_values(vals) or not self.submit_done():
             return self.run_dialog(form, title, submit)
 

{mininterface-0.7.4 → mininterface-0.7.5}/mininterface/textual_interface/textual_app.py

@@ -5,12 +5,15 @@ from textual.binding import Binding
 from textual.containers import VerticalScroll
 from textual.widget import Widget
 from textual.widgets import (Checkbox, Footer, Header, Input, Label,
-                             RadioButton, Static)
+                             RadioButton, Static, Rule)
 
 
 from .widgets import (Changeable, MyButton, MyCheckbox, MyInput, MyRadioSet,
                       MySubmitButton)
 
+from ..form_dict import formdict_to_widgetdict
+
+from ..auxiliary import flatten
 from ..facet import BackendAdaptor
 
 if TYPE_CHECKING:
@@ -52,6 +55,16 @@ class TextualApp(App[bool | None]):
         self.bind("escape", "exit", description="Cancel")
 
     def compose(self) -> ComposeResult:
+        # prepare widgets
+        # since textual 1.0.0 we have to build widgets not earlier than the context app is ready
+        self.widgets = list(flatten(formdict_to_widgetdict(
+            self.adaptor.facet._form, self.adaptor.widgetize), include_keys=self.adaptor.header))
+
+        # there are multiple sections in the list, <hr>ed by Rule elements. However, the first takes much space.
+        if len(self.widgets) and isinstance(self.widgets[0], Rule):
+            self.widgets.pop(0)
+
+        # start yielding widgets
         if self.title:
             yield Header()
         yield self.output  # NOTE not used

{mininterface-0.7.4 → mininterface-0.7.5}/mininterface/tk_interface/utils.py

@@ -1,5 +1,4 @@
-from pathlib import Path, PosixPath
-from tkinter import Button, Entry, Label, TclError, Variable, Widget, Spinbox
+from tkinter import Button, Entry, TclError, Variable, Widget, Spinbox
 from tkinter.filedialog import askopenfilename, askopenfilenames
 from tkinter.ttk import Checkbutton, Combobox, Frame, Radiobutton, Widget
 from typing import TYPE_CHECKING
@@ -8,8 +7,9 @@ from autocombobox import AutoCombobox
 
 from tkinter_form.tkinter_form import Form, FieldForm
 
-from ..auxiliary import flatten, flatten_keys
-from ..experimental import MININTERFACE_CONFIG, FacetCallback, SubmitButton
+from ..auxiliary import flatten
+from ..config import Config
+from ..experimental import FacetCallback, SubmitButton
 from ..form_dict import TagDict
 from ..tag import Tag
 from ..types import DatetimeTag, PathTag
@@ -113,7 +113,7 @@ def replace_widgets(tk_app: "TkWindow", nested_widgets, form: TagDict):
             nested_frame = Frame(master)
             nested_frame.grid(row=grid_info['row'], column=grid_info['column'])
 
-            if len(tag._get_choices()) > MININTERFACE_CONFIG["gui"]["combobox_since"]:
+            if len(tag._get_choices()) >= Config.gui.combobox_since:
                 widget = AutoCombobox(nested_frame, textvariable=variable)
                 widget['values'] = list(tag._get_choices())
                 widget.pack()

{mininterface-0.7.4 → mininterface-0.7.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "mininterface"
-version = "0.7.4"
+version = "0.7.5"
 description = "A minimal access to GUI, TUI, CLI and config"
 authors = ["Edvard Rejthar <edvard.rejthar@nic.cz>"]
 license = "GPL-3.0-or-later"
@@ -20,7 +20,7 @@ pyyaml = "*"
 # Standard requirements
 autocombobox = "1.4.2"
 humanize = "*"          # used only in the TkInterface, hence it is not a minimal requirement
-textual = "~0.84"
+textual = "<2.0.0"
 tkinter-tooltip = "*"
 tkinter_form = "0.2.1"
 tkscrollableframe = "*"