mininterface 0.7.3__tar.gz → 0.7.4__tar.gz

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

@@ -1,8 +1,7 @@
 Metadata-Version: 2.3
 Name: mininterface
-Version: 0.7.3
+Version: 0.7.4
 Summary: A minimal access to GUI, TUI, CLI and config
-Home-page: https://github.com/CZ-NIC/mininterface
 License: GPL-3.0-or-later
 Author: Edvard Rejthar
 Author-email: edvard.rejthar@nic.cz
@@ -13,11 +12,6 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 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
 Requires-Dist: pyyaml
@@ -26,7 +20,8 @@ Requires-Dist: tkinter-tooltip
 Requires-Dist: tkinter_form (==0.2.1)
 Requires-Dist: tkscrollableframe
 Requires-Dist: typing_extensions
-Requires-Dist: tyro (==0.8.14)
+Requires-Dist: tyro (>=0.9,<0.10)
+Project-URL: Homepage, https://github.com/CZ-NIC/mininterface
 Description-Content-Type: text/markdown
 
 # Mininterface – access to GUI, TUI, CLI and config files

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

@@ -8,7 +8,7 @@ from .exceptions import Cancelled, InterfaceNotAvailable
 from .interfaces import get_interface
 
 from . import validators
-from .cli_parser import _parse_cli, assure_args
+from .cli_parser import parse_cli, assure_args
 from .subcommands import Command, SubcommandPlaceholder
 from .form_dict import DataClass, EnvClass
 from .mininterface import EnvClass, Mininterface
@@ -183,9 +183,9 @@ def run(env_or_list: Type[EnvClass] | list[Type[Command]] | None = None,
         start.choose_subcommand(env_or_list)
     elif env_or_list:
         # Load configuration from CLI and a config file
-        env, wrong_fields = _parse_cli(env_or_list, config_file, add_verbosity, ask_for_missing, args, **kwargs)
+        env, wrong_fields = parse_cli(env_or_list, config_file, add_verbosity, ask_for_missing, args, **kwargs)
     else:  # even though there is no configuration, yet we need to parse CLI for meta-commands like --help or --verbose
-        _parse_cli(_Empty, None, add_verbosity, ask_for_missing, args)
+        parse_cli(_Empty, None, add_verbosity, ask_for_missing, args)
 
     # Build the interface
     interface = get_interface(title, interface, env)

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

@@ -70,15 +70,6 @@ def yield_annotations(dataclass):
     yield from (cl.__annotations__ for cl in dataclass.__mro__ if is_dataclass(cl))
 
 
-def yield_defaults(dataclass):
-    """ Return tuple(name, type, default value or MISSING).
-    (Default factory is automatically resolved.)
-    """
-    return ((f.name,
-             f.default_factory() if f.default_factory is not MISSING else f.default)
-            for f in fields(dataclass))
-
-
 def matches_annotation(value, annotation) -> bool:
     """ Check whether the value type corresponds to the annotation.
     Because built-in isinstance is not enough, it cannot determine parametrized generics.

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

@@ -6,7 +6,7 @@ import sys
 import warnings
 from argparse import Action, ArgumentParser
 from contextlib import ExitStack
-from dataclasses import MISSING
+from dataclasses import MISSING, fields, is_dataclass
 from pathlib import Path
 from types import SimpleNamespace
 from typing import Optional, Sequence, Type, Union
@@ -15,12 +15,10 @@ from unittest.mock import patch
 import yaml
 from tyro import cli
 from tyro._argparse_formatter import TyroArgumentParser
-from tyro._fields import NonpropagatingMissingType
-# NOTE in the future versions of tyro, include that way:
-# from tyro._singleton import NonpropagatingMissingType
+from tyro._singleton import MISSING_NONPROP
 from tyro.extras import get_parser
 
-from .auxiliary import yield_annotations, yield_defaults
+from .auxiliary import yield_annotations
 from .form_dict import EnvClass, MissingTagValue
 from .tag import Tag
 from .tag_factory import tag_factory
@@ -137,8 +135,9 @@ def run_tyro_parser(env_or_list: Type[EnvClass] | list[Type[EnvClass]],
         with ExitStack() as stack:
             [stack.enter_context(p) for p in patches]  # apply just the chosen mocks
             res = cli(type_form, args=args, **kwargs)
-            if isinstance(res, NonpropagatingMissingType):
-                # NOTE tyro does not work if a required positional is missing tyro.cli() returns just NonpropagatingMissingType.
+            if res is MISSING_NONPROP:
+                # NOTE tyro does not work if a required positional is missing tyro.cli()
+                # returns just NonpropagatingMissingType (MISSING_NONPROP).
                 # If this is supported, I might set other attributes like required (date, time).
                 # Fail if missing:
                 #   files: Positional[list[Path]]
@@ -217,12 +216,12 @@ def set_default(kwargs, field_name, val):
     setattr(kwargs["default"], field_name, val)
 
 
-def _parse_cli(env_or_list: Type[EnvClass] | list[Type[EnvClass]],
-               config_file: Path | None = None,
-               add_verbosity=True,
-               ask_for_missing=True,
-               args=None,
-               **kwargs) -> tuple[EnvClass | None, dict, WrongFields]:
+def parse_cli(env_or_list: Type[EnvClass] | list[Type[EnvClass]],
+              config_file: Path | None = None,
+              add_verbosity=True,
+              ask_for_missing=True,
+              args=None,
+              **kwargs) -> tuple[EnvClass | None, dict, WrongFields]:
     """ Parse CLI arguments, possibly merged from a config file.
 
     Args:
@@ -243,41 +242,90 @@ def _parse_cli(env_or_list: Type[EnvClass] | list[Type[EnvClass]],
     # Load config file
     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 how this should work."
                       " Describe the developer your usecase so that they might implement this.")
-    if "default" not in kwargs and not subcommands:
+
+    if "default" not in kwargs and not subcommands and config_file:
         # 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 = {}
-        if config_file:
-            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.__annotations__[key](**disk[key])
-
-        # Fill default fields
-        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.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).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) if not key.startswith("__") and not key in disk}
-        kwargs["default"] = SimpleNamespace(**(static | disk))
+        disk = yaml.safe_load(config_file.read_text()) or {}  # empty file is ok
+        kwargs["default"] = _create_with_missing(env, disk)
 
     # Load configuration from CLI
     return run_tyro_parser(subcommands or env, kwargs, add_verbosity, ask_for_missing, args)
+
+
+def _create_with_missing(env, disk: dict):
+    """
+    Create a default instance of an Env object. This is due to provent tyro to spawn warnings about missing fields.
+    Nested dataclasses have to be properly initialized. YAML gave them as dicts only.
+    """
+
+    # Determine model
+    if pydantic and issubclass(env, BaseModel):
+        m = _process_pydantic
+    elif attr and attr.has(env):
+        m = _process_attr
+    else:  # dataclass
+        m = _process_dataclass
+
+    # Fill default fields with the config file values or leave the defaults.
+    # Unfortunately, we have to fill the defaults, we cannot leave them empty
+    # as the default value takes the precedence over the hard coded one, even if missing.
+    out = {}
+    for name, v in m(env, disk):
+        out[name] = v
+        disk.pop(name, None)
+
+    # Check for unknown fields
+    if disk:
+        warnings.warn(f"Unknown fields in the configuration file: {', '.join(disk)}")
+
+    # Safely initialize the model
+    return env(**out)
+
+
+def _process_pydantic(env, disk):
+    for name, f in env.model_fields.items():
+        if name in disk:
+            if isinstance(f.default, BaseModel):
+                v = _create_with_missing(f.default.__class__, disk[name])
+            else:
+                v = disk[name]
+        elif f.default is not None:
+            v = f.default
+        yield name, v
+
+
+def _process_attr(env, disk):
+    for f in attr.fields(env):
+        if f.name in disk:
+            if attr.has(f.default):
+                v = _create_with_missing(f.default.__class__, disk[f.name])
+            else:
+                v = disk[f.name]
+        elif f.default is not attr.NOTHING:
+            v = f.default
+        else:
+            v = MISSING_NONPROP
+        yield f.name, v
+
+
+def _process_dataclass(env, disk):
+    for f in fields(env):
+        if f.name.startswith("__"):
+            continue
+        elif f.name in disk:
+            if is_dataclass(f.type):
+                v = _create_with_missing(f.type, disk[f.name])
+            else:
+                v = disk[f.name]
+        elif f.default_factory is not MISSING:
+            v = f.default_factory()
+        elif f.default is not MISSING:
+            v = f.default
+        else:
+            v = MISSING_NONPROP
+        yield f.name, v

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

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "mininterface"
-version = "0.7.3"
+version = "0.7.4"
 description = "A minimal access to GUI, TUI, CLI and config"
 authors = ["Edvard Rejthar <edvard.rejthar@nic.cz>"]
 license = "GPL-3.0-or-later"
@@ -14,7 +14,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 # Minimal requirements
 python = "^3.10"
-tyro = "0.8.14"         # NOTE: 0.9 brings some test breaking changes
+tyro = "^0.9"
 typing_extensions = "*"
 pyyaml = "*"
 # Standard requirements
@@ -25,7 +25,7 @@ tkinter-tooltip = "*"
 tkinter_form = "0.2.1"
 tkscrollableframe = "*"
 
-[tool.poetry.extras]
+[tool.poetry.project.optional-dependencies]
 web = ["textual-serve"]
 img = ["pillow", "textual_imageview"]
 tui = ["textual_imageview"]