mininterface 0.7.2__tar.gz → 0.7.3__tar.gz

{mininterface-0.7.2 → mininterface-0.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: mininterface
-Version: 0.7.2
+Version: 0.7.3
 Summary: A minimal access to GUI, TUI, CLI and config
 Home-page: https://github.com/CZ-NIC/mininterface
 License: GPL-3.0-or-later
@@ -15,6 +15,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: all
 Provides-Extra: gui
+Provides-Extra: img
+Provides-Extra: tui
 Provides-Extra: web
 Requires-Dist: autocombobox (==1.4.2)
 Requires-Dist: humanize
@@ -143,6 +145,10 @@ pip install --no-dependencies mininterface
 pip install tyro typing_extensions pyyaml
 ```
 
+## MacOS GUI
+
+If the GUI does not work on MacOS, you might need to launch: `brew install python-tk`
+
 # Docs
 See the docs overview at [https://cz-nic.github.io/mininterface/](https://cz-nic.github.io/mininterface/Overview/).
 

{mininterface-0.7.2 → mininterface-0.7.3}/README.md

@@ -114,6 +114,10 @@ pip install --no-dependencies mininterface
 pip install tyro typing_extensions pyyaml
 ```
 
+## MacOS GUI
+
+If the GUI does not work on MacOS, you might need to launch: `brew install python-tk`
+
 # Docs
 See the docs overview at [https://cz-nic.github.io/mininterface/](https://cz-nic.github.io/mininterface/Overview/).
 

{mininterface-0.7.2 → mininterface-0.7.3}/mininterface/cli_parser.py

@@ -150,7 +150,7 @@ def run_tyro_parser(env_or_list: Type[EnvClass] | list[Type[EnvClass]],
         if ask_for_missing and getattr(e, "code", None) == 2 and eavesdrop:
             # Some required arguments are missing. Determine which.
             wf = {}
-            for arg in eavesdrop.partition(":")[2].strip().split(", "):
+            for arg in _fetch_eavesdrop_args():
                 treat_missing(type_form, kwargs, parser, wf, arg)
 
             # Second attempt to parse CLI
@@ -195,7 +195,6 @@ def treat_missing(env_class, kwargs: dict, parser: ArgumentParser, wf: dict, arg
         # However, the UI then is not able to use ex. the number filtering capabilities.
         # Putting there None is not a good idea as dataclass_to_tagdict fails if None is not allowed by the annotation.
         tag = wf[field_name] = tag_factory(MissingTagValue(),
-                                           # tag = wf[field_name] = tag_factory(MISSING,
                                            argument.help.replace("(required)", ""),
                                            validation=not_empty,
                                            _src_class=env_class,
@@ -205,9 +204,17 @@ def treat_missing(env_class, kwargs: dict, parser: ArgumentParser, wf: dict, arg
         # A None would be enough because Mininterface will ask for the missing values
         # promply, however, Pydantic model would fail.
         # As it serves only for tyro parsing and the field is marked wrong, the made up value is never used or seen.
-        if "default" not in kwargs:
-            kwargs["default"] = SimpleNamespace()
-        setattr(kwargs["default"], field_name, tag._make_default_value())
+        set_default(kwargs, field_name, tag._make_default_value())
+
+
+def _fetch_eavesdrop_args():
+    return eavesdrop.partition(":")[2].strip().split(", ")
+
+
+def set_default(kwargs, field_name, val):
+    if "default" not in kwargs:
+        kwargs["default"] = SimpleNamespace()
+    setattr(kwargs["default"], field_name, val)
 
 
 def _parse_cli(env_or_list: Type[EnvClass] | list[Type[EnvClass]],
@@ -228,15 +235,20 @@ def _parse_cli(env_or_list: Type[EnvClass] | list[Type[EnvClass]],
     Returns:
         Configuration namespace.
     """
+    if isinstance(env_or_list, list):
+        subcommands, env = env_or_list, None
+    else:
+        subcommands, env = None, env_or_list
+
     # Load config file
-    if config_file and isinstance(env_or_list, list):
-        # NOTE. Reading config files when using subcommands is not implemented.
+    if config_file and subcommands:
+        # Reading config files when using subcommands is not implemented.
         static = {}
         kwargs["default"] = None
         warnings.warn(f"Config file {config_file} is ignored because subcommands are used."
-                      "It is not easy to set who this should work. "
-                      "Describe the developer your usecase so that they might implement this.")
-    if "default" not in kwargs and not isinstance(env_or_list, list):
+                      " It is not easy to set how this should work."
+                      " Describe the developer your usecase so that they might implement this.")
+    if "default" not in kwargs and not subcommands:
         # 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 = {}
@@ -244,29 +256,28 @@ def _parse_cli(env_or_list: Type[EnvClass] | list[Type[EnvClass]],
             disk = yaml.safe_load(config_file.read_text()) or {}  # empty file is ok
             # Nested dataclasses have to be properly initialized. YAML gave them as dicts only.
             for key in (key for key, val in disk.items() if isinstance(val, dict)):
-                disk[key] = env_or_list.__annotations__[key](**disk[key])
+                disk[key] = env.__annotations__[key](**disk[key])
 
         # Fill default fields
-        if pydantic and issubclass(env_or_list, BaseModel):
+        if pydantic and issubclass(env, BaseModel):
             # Unfortunately, pydantic needs to fill the default with the actual values,
             # the default value takes the precedence over the hard coded one, even if missing.
-            static = {key: env_or_list.model_fields.get(key).default
-                      for ann in yield_annotations(env_or_list) for key in ann if not key.startswith("__") and not key in disk}
-            # static = {key: env_or_list.model_fields.get(key).default
-            #           for key, _ in iterate_attributes(env_or_list) if not key in disk}
-        elif attr and attr.has(env_or_list):
+            static = {key: env.model_fields.get(key).default
+                      for ann in yield_annotations(env) for key in ann if not key.startswith("__") and not key in disk}
+            # static = {key: env_.model_fields.get(key).default
+            #           for key, _ in iterate_attributes(env_) if not key in disk}
+        elif attr and attr.has(env):
             # Unfortunately, attrs needs to fill the default with the actual values,
             # the default value takes the precedence over the hard coded one, even if missing.
             # NOTE Might not work for inherited models.
             static = {key: field.default
-                      for key, field in attr.fields_dict(env_or_list).items() if not key.startswith("__") and not key in disk}
+                      for key, field in attr.fields_dict(env).items() if not key.startswith("__") and not key in disk}
         else:
             # To ensure the configuration file does not need to contain all keys, we have to fill in the missing ones.
             # Otherwise, tyro will spawn warnings about missing fields.
             static = {key: val
-                      for key, val in yield_defaults(env_or_list) if not key.startswith("__") and not key in disk}
-        kwargs["default"] = SimpleNamespace(**(disk | static))
+                      for key, val in yield_defaults(env) if not key.startswith("__") and not key in disk}
+        kwargs["default"] = SimpleNamespace(**(static | disk))
 
     # Load configuration from CLI
-    env, wrong_fields = run_tyro_parser(env_or_list, kwargs, add_verbosity, ask_for_missing, args)
-    return env, wrong_fields
+    return run_tyro_parser(subcommands or env, kwargs, add_verbosity, ask_for_missing, args)

{mininterface-0.7.2 → mininterface-0.7.3}/mininterface/textual_interface/textual_adaptor.py

@@ -28,6 +28,8 @@ class TextualAdaptor(BackendAdaptor):
     def __init__(self, interface: "TextualInterface"):
         self.interface = interface
         self.facet = interface.facet = TextualFacet(self, interface.env)
+        self.app: TextualApp | None = None
+        self.layout_elements = []
 
     @staticmethod
     def widgetize(tag: Tag) -> Widget | Changeable:
@@ -73,6 +75,9 @@ class TextualAdaptor(BackendAdaptor):
 
     def run_dialog(self, form: TagDict, title: str = "", submit: bool | str = True) -> TagDict:
         super().run_dialog(form, title, submit)
+        # Unfortunately, there seems to be no way to reuse the app.
+        # Which blocks using multiple form external .form() calls from the web interface.
+        # Textual cannot run in a thread, it seems it cannot run in another process, self.suspend() is of no use.
         self.app = app = TextualApp(self, submit)
         if title:
             app.title = title

{mininterface-0.7.2 → mininterface-0.7.3}/mininterface/textual_interface/textual_app.py

@@ -26,6 +26,14 @@ class TextualApp(App[bool | None]):
     #     ("down", "go_up", "Go down"),
     # ]
 
+    DEFAULT_CSS = """
+    ImageViewer{
+
+        height: 20;
+    }
+    """
+    """ Limit layout image size """
+
     def __init__(self, adaptor: "TextualAdaptor", submit: str | bool = True):
         super().__init__()
         self.title = adaptor.facet._title
@@ -52,6 +60,7 @@ class TextualApp(App[bool | None]):
             yield Label(text, id="buffered_text")
         focus_set = False
         with VerticalScroll():
+            yield from self.adaptor.layout_elements
             for i, fieldt in enumerate(self.widgets):
                 if isinstance(fieldt, Input):
                     yield Label(fieldt.placeholder)

{mininterface-0.7.2 → mininterface-0.7.3}/mininterface/textual_interface/textual_button_app.py

@@ -2,6 +2,7 @@ from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any
 
 from textual.app import App, ComposeResult
+from textual.containers import VerticalScroll
 from textual.widgets import Button, Footer, Label
 
 from ..exceptions import Cancelled
@@ -60,6 +61,7 @@ class TextualButtonApp(App):
         self.focused_i: int = 0
         self.values = {}
         self.interface = interface
+        self.adaptor = self.interface.adaptor
 
     def yes_no(self, text: str, focus_no=True) -> DummyWrapper:
         return self.buttons(text, [("Yes", True), ("No", False)], int(focus_no))
@@ -78,6 +80,7 @@ class TextualButtonApp(App):
         yield Footer()
         if text := self.interface._redirected.join():
             yield Label(text, id="buffered_text")
+        yield from self.adaptor.layout_elements
         yield Label(self.text, id="question")
 
         self.values.clear()

mininterface-0.7.3/mininterface/textual_interface/textual_facet.py

@@ -0,0 +1,64 @@
+from datetime import datetime
+from typing import TYPE_CHECKING
+from warnings import warn
+from pathlib import Path
+
+from textual.widgets import (Checkbox, Footer, Header, Input, Label,
+                             RadioButton, Static)
+
+from humanize import naturalsize
+
+from ..exceptions import DependencyRequired
+from ..facet import Facet, Image, LayoutElement
+if TYPE_CHECKING:
+    from .textual_adaptor import TextualAdaptor
+
+
+class TextualFacet(Facet):
+    adaptor: "TextualAdaptor"
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        # Since TextualApp turns off, we need to have its values stored somewhere
+        self._title = ""
+
+    # NOTE: multiline title will not show up
+    def set_title(self, title: str):
+        self._title = title
+        try:
+            self.adaptor.app.title = title
+        except:
+            # NOTE: When you receive Facet in Command.init, the app does not exist yet
+            warn("Setting textual title not implemented well.")
+
+    def _layout(self, elements: list[LayoutElement]):
+        append = self.adaptor.layout_elements.append
+        try:
+            from PIL import Image as ImagePIL
+            from textual_imageview.viewer import ImageViewer
+            PIL = True
+        except:
+            PIL = False
+
+        for el in elements:
+            match el:
+                case Image():
+                    if not PIL:
+                        raise DependencyRequired("img")
+                    append(ImageViewer(ImagePIL.open(el.src)))
+                case Path():
+                    size = naturalsize(el.stat().st_size)
+                    mtime = datetime.fromtimestamp(el.stat().st_mtime).strftime("%Y-%m-%d %H:%M:%S")
+                    append(Label(f"{el} / {size} / {mtime}"))
+                case str():
+                    append(Label(el))
+                case _:
+                    append(Label("Error in the layout: Unknown {el}"))
+
+    def submit(self, *args, **kwargs):
+        super().submit(*args, **kwargs)
+        try:
+            self.adaptor.app.action_confirm()
+        except:
+            # NOTE: When you receive Facet in Command.init, the app does not exist yet
+            warn("Setting textual title not implemented well.")

mininterface-0.7.3/mininterface/tk_interface/external_fix.py

@@ -0,0 +1,74 @@
+# The purpose of the file is to put the descriptions to the bottom of the widgets
+# as it was in the former version of the tkinter_form and to limit their width.
+from tkinter import ttk
+
+from tkinter_form import Form, Value, FieldForm
+
+orig = Form._Form__create_widgets
+
+
+def __create_widgets_monkeypatched(
+    self, form_dict: dict, name_config: str, button_command: callable
+) -> None:
+    """
+    Create form widgets
+
+    Args:
+        form_dict (dict): form dict base
+        name_config (str): name_config
+        button (bool): button_config
+    """
+
+    index = 0
+    for _, (name_key, value) in enumerate(form_dict.items()):
+        index += 1
+        description = None
+        if isinstance(value, Value):
+            value, description = value.val, value.description
+
+        self.rowconfigure(index, weight=1)
+
+        if isinstance(value, dict):
+            widget = Form(self, name_key, value)
+            widget.grid(row=index, column=0, columnspan=3, sticky="nesw")
+
+            self.fields[name_key] = widget
+            last_index = index
+            continue
+
+        variable = self._Form__type_vars[type(value)]()
+        widget = self._Form__type_widgets[type(value)](self)
+
+        self.columnconfigure(1, weight=1)
+        widget.grid(row=index, column=1, sticky="nesw", padx=2, pady=2)
+        label = ttk.Label(self, text=name_key)
+        self.columnconfigure(0, weight=1)
+        label.grid(row=index, column=0, sticky="nes", padx=2, pady=2)
+
+        # Add a further description to the row below the widget
+        description_label = None
+        if not description is None:
+            index += 1
+            description_label = ttk.Label(self, text=description, wraplength=1000)
+            description_label.grid(row=index, column=1, columnspan=2, sticky="nesw", padx=2, pady=2)
+
+        self.fields[name_key] = FieldForm(
+            master=self,
+            label=label,
+            widget=widget,
+            variable=variable,
+            value=value,
+            description=description_label,
+        )
+
+        last_index = index
+
+    if button_command:
+        self._Form__command = button_command
+        self.button = ttk.Button(
+            self, text=name_config, command=self._Form__command_button
+        )
+        self.button.grid(row=last_index + 1, column=0, columnspan=3, sticky="nesw")
+
+
+Form._Form__create_widgets = __create_widgets_monkeypatched

{mininterface-0.7.2 → mininterface-0.7.3}/mininterface/tk_interface/tk_facet.py

@@ -36,10 +36,13 @@ class TkFacet(Facet):
                         raise DependencyRequired("img")
                     filename = el.src
                     img = ImagePIL.open(filename)
-                    img = img.resize((250, 250))
-                    img = ImageTk.PhotoImage(img)
-                    panel = Label(self.adaptor.frame, image=img)
-                    panel.image = img
+                    max_width, max_height = 250, 250
+                    w_o, h_o = img.size
+                    scale = min(max_width / w_o, max_height / h_o)
+                    img = img.resize((int(w_o * scale), int(h_o * scale)), ImagePIL.LANCZOS)
+                    img_p = ImageTk.PhotoImage(img)
+                    panel = Label(self.adaptor.frame, image=img_p)
+                    panel.image = img_p
                     panel.pack()
                 case Path():
                     size = naturalsize(el.stat().st_size)

{mininterface-0.7.2 → mininterface-0.7.3}/mininterface/tk_interface/utils.py

@@ -14,6 +14,7 @@ from ..form_dict import TagDict
 from ..tag import Tag
 from ..types import DatetimeTag, PathTag
 from .date_entry import DateEntryFrame
+from .external_fix import __create_widgets_monkeypatched
 
 if TYPE_CHECKING:
     from tk_window import TkWindow

{mininterface-0.7.2 → mininterface-0.7.3}/mininterface/types.py

@@ -159,10 +159,7 @@ class PathTag(Tag):
 @dataclass(repr=False)
 class DatetimeTag(Tag):
     """
-    !!! warning
-        Experimental. Still in development.
-
-    Datetime is supported.
+    Datetime, date and time types are supported.
 
     ```python3
     from datetime import datetime
@@ -214,13 +211,12 @@ class DatetimeTag(Tag):
     # ![Time only](asset/datetime_time.avif)
 
     # NOTE: It would be nice we might put any date format to be parsed.
-    # NOTE: The parameters are still ignored.
 
     date: bool = False
-    """ The date part is active """
+    """ The date part is active. True for datetime and date. """
 
     time: bool = False
-    """ The time part is active """
+    """ The time part is active. True for datetime and time.  """
 
     full_precision: bool = False
     """ Include full time precison, seconds, microseconds. """
@@ -230,9 +226,6 @@ class DatetimeTag(Tag):
         if self.annotation:
             self.date = issubclass(self.annotation, date)
             self.time = issubclass(self.annotation, time) or issubclass(self.annotation, datetime)
-        # NOTE: remove
-        # if not self.time and self.full_precision:
-        #     self.full_precision = False
 
     def _make_default_value(self):
         return datetime.now()

{mininterface-0.7.2 → mininterface-0.7.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "mininterface"
-version = "0.7.2"
+version = "0.7.3"
 description = "A minimal access to GUI, TUI, CLI and config"
 authors = ["Edvard Rejthar <edvard.rejthar@nic.cz>"]
 license = "GPL-3.0-or-later"
@@ -27,8 +27,10 @@ tkscrollableframe = "*"
 
 [tool.poetry.extras]
 web = ["textual-serve"]
+img = ["pillow", "textual_imageview"]
+tui = ["textual_imageview"]
 gui = ["pillow", "tkcalendar"]
-all = ["textual-serve", "pillow", "tkcalendar"]
+all = ["textual-serve", "pillow", "tkcalendar", "textual_imageview"]
 
 [tool.poetry.scripts]
 mininterface = "mininterface.__main__:main"

mininterface-0.7.2/mininterface/textual_interface/textual_facet.py

@@ -1,31 +0,0 @@
-from typing import TYPE_CHECKING
-from warnings import warn
-from ..facet import Facet
-if TYPE_CHECKING:
-    from .textual_adaptor import TextualAdaptor
-
-
-class TextualFacet(Facet):
-    adaptor: "TextualAdaptor"
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        # Since TextualApp turns off, we need to have its values stored somewhere
-        self._title = ""
-
-    # NOTE: multiline title will not show up
-    def set_title(self, title: str):
-        self._title = title
-        try:
-            self.adaptor.app.title = title
-        except:
-            # NOTE: When you receive Facet in Command.init, the app does not exist yet
-            warn("Setting textual title not implemented well.")
-
-    def submit(self, *args, **kwargs):
-        super().submit(*args, **kwargs)
-        try:
-            self.adaptor.app.action_confirm()
-        except:
-            # NOTE: When you receive Facet in Command.init, the app does not exist yet
-            warn("Setting textual title not implemented well.")