mininterface 1.0.0a1__tar.gz → 1.0.2__tar.gz

{mininterface-1.0.0a1 → mininterface-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mininterface
-Version: 1.0.0a1
+Version: 1.0.2
 Summary: A minimal access to GUI, TUI, CLI and config
 License: LGPL-3.0-or-later
 Author: Edvard Rejthar
@@ -165,7 +165,7 @@ There are various bundles. We mark the least permissive licence in the bundle.
 Apart from the minimal bundle (which lacks CLI and dataclass support), they have the same functionality, differring only in the user experience.
 
 !!! tip
-  For automated testing (e.g., in CI environments), the `mininterface[basic]` bundle is sufficient.
+    For automated testing (e.g., in CI environments), the `mininterface[basic]` bundle is sufficient.
 
 ## MacOS GUI
 
@@ -188,7 +188,7 @@ Take a look at the following example.
 
 1. We define any Env class.
 2. Then, we initialize mininterface with [`run(Env)`][mininterface.run] – the missing fields will be prompter for
-3. Then, we use various dialog methods, like [`confirm`][mininterface.Mininterface.confirm], [`choice`][mininterface.Mininterface.select] or [`form`][mininterface.Mininterface.form].
+3. Then, we use various dialog methods, like [`confirm`][mininterface.Mininterface.confirm], [`select`][mininterface.Mininterface.select] or [`form`][mininterface.Mininterface.form].
 
 Below, you find the screenshots how the program looks in various environments ([graphic](Interfaces.md#guiinterface-or-tkinterface-or-gui) interface, [web](Interfaces.md#webinterface-or-web) interface...).
 
@@ -216,7 +216,7 @@ if __name__ == "__main__":
       # like `confirm` for bool
       if m.confirm("Do you want to continue?"):
 
-        # or `choice` for choosing a value
+        # or `select` for choosing a value
         fruit = m.select(("apple", "banana", "sirup"), "Choose a fruit")
 
         if fruit == "apple":

{mininterface-1.0.0a1 → mininterface-1.0.2}/README.md

@@ -127,7 +127,7 @@ There are various bundles. We mark the least permissive licence in the bundle.
 Apart from the minimal bundle (which lacks CLI and dataclass support), they have the same functionality, differring only in the user experience.
 
 !!! tip
-  For automated testing (e.g., in CI environments), the `mininterface[basic]` bundle is sufficient.
+    For automated testing (e.g., in CI environments), the `mininterface[basic]` bundle is sufficient.
 
 ## MacOS GUI
 
@@ -150,7 +150,7 @@ Take a look at the following example.
 
 1. We define any Env class.
 2. Then, we initialize mininterface with [`run(Env)`][mininterface.run] – the missing fields will be prompter for
-3. Then, we use various dialog methods, like [`confirm`][mininterface.Mininterface.confirm], [`choice`][mininterface.Mininterface.select] or [`form`][mininterface.Mininterface.form].
+3. Then, we use various dialog methods, like [`confirm`][mininterface.Mininterface.confirm], [`select`][mininterface.Mininterface.select] or [`form`][mininterface.Mininterface.form].
 
 Below, you find the screenshots how the program looks in various environments ([graphic](Interfaces.md#guiinterface-or-tkinterface-or-gui) interface, [web](Interfaces.md#webinterface-or-web) interface...).
 
@@ -178,7 +178,7 @@ if __name__ == "__main__":
       # like `confirm` for bool
       if m.confirm("Do you want to continue?"):
 
-        # or `choice` for choosing a value
+        # or `select` for choosing a value
         fruit = m.select(("apple", "banana", "sirup"), "Choose a fruit")
 
         if fruit == "apple":

{mininterface-1.0.0a1 → mininterface-1.0.2}/mininterface/__init__.py

@@ -244,5 +244,5 @@ def run(env_or_list: Type[EnvClass] | list[Type[EnvClass]] | ArgumentParser | No
 
 
 __all__ = ["run", "Mininterface", "Tag",
-           "InterfaceNotAvailable", "Cancelled",
+           "Cancelled",
            "Validation", "Options"]

{mininterface-1.0.0a1 → mininterface-1.0.2}/mininterface/_mininterface/__init__.py

@@ -37,10 +37,10 @@ class Mininterface(Generic[EnvClass]):
         or you can create [one](Interfaces.md) directly (without benefiting from the CLI parsing).
 
     Raise:
-        [Cancelled][mininterface.exceptions.Cancelled]: A SystemExit based exception noting that the program exits without a traceback, ex. if user hits the escape.
+        [Cancelled][mininterface.exceptions.Cancelled]: A `SystemExit` based exception noting that the program exits without a traceback, ex. if user hits the escape.
 
     Raise:
-        [InterfaceNotAvailable][mininterface.exceptions.InterfaceNotAvailable]: Interface failed to init, ex. display not available in GUI.
+        [InterfaceNotAvailable][mininterface.exceptions.InterfaceNotAvailable]: Interface failed to init, ex. display not available in GUI. You don't have to check for it when invoking an interface through safe methods [`run`][mininterface.run] or [`get_interface`][mininterface.interfaces.get_interface].
     """
     # This base interface does not require any user input and hence is suitable for headless testing.
 

{mininterface-1.0.0a1 → mininterface-1.0.2}/mininterface/_text_interface/adaptor.py

@@ -1,18 +1,22 @@
 import warnings
 
-from simple_term_menu import TerminalMenu
-
-from ..tag.select_tag import SelectTag
+try:
+    # NOTE does not work in Win, we should find a replacement
+    # https://github.com/IngoMeyer441/simple-term-menu/issues/5
+    from simple_term_menu import TerminalMenu
+except ImportError:
+    from ..exceptions import InterfaceNotAvailable
+    raise InterfaceNotAvailable
 
 from .._lib.auxiliary import flatten
-from ..exceptions import Cancelled
 from .._lib.form_dict import TagDict
 from .._mininterface import Tag
 from .._mininterface.adaptor import BackendAdaptor
+from ..exceptions import Cancelled
 from ..settings import TextSettings
-from ..tag.internal import (BoolWidget, CallbackButtonWidget,
-                            SubmitButtonWidget)
+from ..tag.internal import BoolWidget, CallbackButtonWidget, SubmitButtonWidget
 from ..tag.secret_tag import SecretTag
+from ..tag.select_tag import SelectTag
 from .facet import TextFacet
 
 

{mininterface-1.0.0a1 → mininterface-1.0.2}/mininterface/_tk_interface/__init__.py

@@ -1,4 +1,4 @@
-from typing import Type
+from typing import Iterable, Type
 
 try:
     # It seems tkinter is installed either by default or not installable at all.
@@ -10,7 +10,7 @@ except ImportError:
 
 from ..exceptions import InterfaceNotAvailable
 
-from .._mininterface import EnvClass, Mininterface, TagValue
+from .._mininterface import EnvClass, Mininterface, TagValue, ValidationCallback
 from .._mininterface.mixin import RichUiMixin
 from ..tag import Tag
 from ..settings import GuiSettings
@@ -33,8 +33,8 @@ class TkInterface(Redirectable, RichUiMixin, Mininterface):
         # The window must disappear completely. Otherwise an empty trailing window would appear in the case another TkInterface would start.
         self._adaptor.destroy()
 
-    def ask(self, text: str, annotation: Type[TagValue] | Tag = str) -> TagValue:
-        if annotation is int:
+    def ask(self, text: str, annotation: Type[TagValue] | Tag = str, validation: Iterable[ValidationCallback] | ValidationCallback | None = None) -> TagValue:
+        if annotation is int and validation is None:
             # without 0, tkinter_form would create a mere text Entry
             return self.form({text: 0})[text]
-        return super().ask(text, annotation)
+        return super().ask(text, annotation, validation)

{mininterface-1.0.0a1 → mininterface-1.0.2}/mininterface/tag/path_tag.py

@@ -82,8 +82,7 @@ class PathTag(Tag[Path | list[Path] | TagValue]):
         value = super()._validate(value)
         # Check for multiple paths before any conversion
         if not self.multiple and isinstance(value, (list, tuple)):
-            self.set_error_text("Multiple paths are not allowed")
-            raise ValueError()
+            raise ValueError("Multiple paths are not allowed")
         # Convert to list for validation
         paths = value if isinstance(value, list) else [value]
 
@@ -93,23 +92,18 @@ class PathTag(Tag[Path | list[Path] | TagValue]):
                 try:
                     path = Path(path)
                 except Exception:
-                    self.set_error_text(f"Invalid path format: {path}")
-                    raise ValueError()
+                    raise ValueError(f"Invalid path format: {path}")
 
             if self.exist and not path.exists():
-                self.set_error_text(f"Path does not exist: {path}")
-                raise ValueError()
+                raise ValueError(f"Path does not exist: {path}")
 
             if self.is_dir and self.is_file:
-                self.set_error_text(f"Path cannot be both a file and a directory: {path}")
-                raise ValueError()
+                raise ValueError(f"Path cannot be both a file and a directory: {path}")
 
             if self.is_dir and not path.is_dir():
-                self.set_error_text(f"Path is not a directory: {path}")
-                raise ValueError()
+                raise ValueError(f"Path is not a directory: {path}")
 
             if self.is_file and not path.is_file():
-                self.set_error_text(f"Path is not a file: {path}")
-                raise ValueError()
+                raise ValueError(f"Path is not a file: {path}")
 
         return value

{mininterface-1.0.0a1 → mininterface-1.0.2}/mininterface/tag/select_tag.py

@@ -312,11 +312,9 @@ class SelectTag(Tag[TagValue]):
             if all(v in vals for v in out_value):
                 return out_value
             else:
-                self.set_error_text(f"A value is not one of the allowed")
-                raise ValueError
+                raise ValueError(f"A value is not one of the options")
         else:
             if out_value in vals:
                 return out_value
             else:
-                self.set_error_text(f"Not one of the allowed values")
-                raise ValueError
+                raise ValueError(f"Not one of the allowed values")

{mininterface-1.0.0a1 → mininterface-1.0.2}/mininterface/tag/tag.py

@@ -749,8 +749,7 @@ class Tag(Generic[TagValue]):
                         # Ex. putting "2.0" into an int.
                         # It would generate type problem later here in the method,
                         # but even now comparison failed Ex. TypeError("2.0" > 0)
-                        self.set_error_text(f"Type must be {self._repr_annotation()}!")
-                        raise ValueError
+                        raise ValueError(f"Type must be {self._repr_annotation()}!")
                 else:
                     res = vald(self)
                     if isinstance(res, tuple):
@@ -760,16 +759,14 @@ class Tag(Generic[TagValue]):
                         passed = res
                         self.val = last
                     if passed is not True:  # we did not pass, there might be an error message in passed
-                        self.set_error_text(passed or f"Validation fail")
-                        raise ValueError
+                        raise ValueError(passed or f"Validation fail")
 
         # pydantic_check
         if self._pydantic_field:
             try:
                 create_model('ValidationModel', check=(self.annotation, self._pydantic_field))(check=out_value)
             except PydanticValidationError as e:
-                self.set_error_text(e.errors()[0]["msg"])
-                raise ValueError
+                raise ValueError(e.errors()[0]["msg"])
         # attrs check
         if self._attrs_field:
             try:
@@ -778,13 +775,11 @@ class Tag(Generic[TagValue]):
                     {"check": attr.ib(validator=self._attrs_field.validator)}
                 )(check=out_value)
             except ValueError as e:
-                self.set_error_text(str(e))
-                raise
+                raise ValueError(str(e))
 
         # Type check
         if not self._is_right_instance(out_value):
-            self.set_error_text(f"Type must be {self._repr_annotation()}!")
-            raise ValueError
+            raise ValueError(f"Type must be {self._repr_annotation()}!")
 
         return out_value
 
@@ -870,7 +865,8 @@ class Tag(Generic[TagValue]):
         # User and type validation check
         try:
             self.val = self._validate(out_value)   # checks succeeded, confirm the value
-        except ValueError:
+        except ValueError as e:
+            self.set_error_text(str(e))
             return False
         self._update_source(out_value)
         return True

{mininterface-1.0.0a1 → mininterface-1.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "mininterface"
-version = "1.0.0-alpha.1"
+version = "1.0.2"
 description = "A minimal access to GUI, TUI, CLI and config"
 authors = ["Edvard Rejthar <edvard.rejthar@nic.cz>"]
 license = "LGPL-3.0-or-later"