init

pydantic_typer/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2023-present Waylon S. Walker <waylon@waylonwalker.com>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "0.0.0.dev1"

pydantic_typer/__init__.py

@@ -0,0 +1,101 @@
+# SPDX-FileCopyrightText: 2023-present Waylon S. Walker <waylon@waylonwalker.com>
+##
+# SPDX-License-Identifier: MIT
+
+from functools import wraps
+import inspect
+from typing import Callable, Optional
+
+from pydantic import BaseModel
+
+
+class Person(BaseModel):
+    name: str
+    age: int
+    email: Optional[str]
+    pet: str = "dog"
+
+
+def make_person(name: str, age: int) -> Person:
+    return Person(name=name, age=age)
+
+
+def expand_pydantic_args(func: Callable) -> Callable:
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        import inspect
+
+        sig = inspect.signature(func)
+
+        instances = {}
+        for name, value in kwargs.items():
+            if name in sig.parameters:
+                instances[name] = value
+
+        for name, param in sig.parameters.items():
+            # func wants this directly
+            # this should check isinstance, but it's not working
+            if name in kwargs and repr(param.annotation) == repr(kwargs[name]):
+                instances[name] = kwargs[name]
+
+            # an instance was not passed in, create one with kwargs passed in
+            elif hasattr(param.annotation, "__fields__"):
+                instances[name] = param.annotation(**kwargs)
+
+        return func(**instances)
+
+    sig = inspect.signature(func)
+    more_args = []
+    for name, param in sig.parameters.items():
+        if hasattr(param.annotation, "__fields__"):
+            more_args.extend(param.annotation.__fields__)
+
+    wrapper.__doc__ = (
+        func.__doc__ + f"\nalso accepts {more_args} in place of person model"
+    )
+    fields = Person.__fields__
+    args = ",".join(
+        [
+            f"{name}: {field.annotation.__name__ if str(field.annotation).startswith('<') else str(field.annotation)}=            '{field.default}'"
+            for name, field in fields.items()
+        ]
+    )
+    call_args = ",".join([f"{name}={name}" for name, field in fields.items()])
+
+    new_func = f"""
+import typing
+def {func.__name__}({args}):
+    '''{func.__doc__}'''
+    return wrapper({call_args})
+    """
+    exec(new_func, locals(), globals())
+    # return outter
+
+    return globals()[func.__name__]
+
+
+# @expand_pydantic_args
+# def get_person(person: Person) -> Person:
+#    """mydocstring"""
+#    from rich import print
+
+#    print(person)
+
+
+def get_person_vanilla(person: Person) -> Person:
+    from rich import print
+
+    print(person)
+    return person
+
+
+@expand_pydantic_args
+def get_person(person: Person, thing: str = None) -> Person:
+    """mydocstring"""
+    from rich import print
+
+    print(person)
+    # return person
+
+
+# get_person(name="me", age=1)

pydantic_typer/__main__.py

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2023-present Waylon S. Walker <waylon@waylonwalker.com>
+#
+# SPDX-License-Identifier: MIT
+import sys
+
+if __name__ == '__main__':
+    from .cli import {{python_package}}
+
+    sys.exit({{python_package}}())

pydantic_typer/cli/app.py

@@ -0,0 +1,62 @@
+import typer
+
+from pydantic_typer import Person, expand_pydantic_args
+from pydantic_typer.cli.common import verbose_callback
+from pydantic_typer.cli.config import config_app
+from pydantic_typer.cli.tui import tui_app
+
+app = typer.Typer(
+    name="pydantic_typer",
+    help="A rich terminal report for coveragepy.",
+)
+app.add_typer(config_app)
+app.add_typer(tui_app)
+
+
+def version_callback(value: bool) -> None:
+    """Callback function to print the version of the pydantic-typer package.
+
+    Args:
+        value (bool): Boolean value to determine if the version should be printed.
+
+    Raises:
+        typer.Exit: If the value is True, the version will be printed and the program will exit.
+
+    Example:
+        version_callback(True)
+    """
+    if value:
+        from pydantic_typer.__about__ import __version__
+
+        typer.echo(f"{__version__}")
+        raise typer.Exit()
+
+
+@app.callback()
+def main(
+    version: bool = typer.Option(
+        None,
+        "--version",
+        callback=version_callback,
+        is_eager=True,
+    ),
+    verbose: bool = typer.Option(
+        False,
+        callback=verbose_callback,
+        help="show the log messages",
+    ),
+) -> None:
+    return
+
+
+@app.command()
+@expand_pydantic_args
+def get_person(person: Person) -> Person:
+    """mydocstring"""
+    from rich import print
+
+    print(person)
+
+
+if __name__ == "__main__":
+    typer.run(main)

pydantic_typer/cli/common.py

@@ -0,0 +1,6 @@
+from pydantic_typer.console import console
+
+
+def verbose_callback(value: bool) -> None:
+    if value:
+        console.quiet = False

pydantic_typer/cli/config.py

@@ -0,0 +1,29 @@
+from rich.console import Console
+import typer
+
+from pydantic_typer.cli.common import verbose_callback
+from pydantic_typer.config import config as configuration
+
+config_app = typer.Typer()
+
+
+@config_app.callback()
+def config(
+    verbose: bool = typer.Option(
+        False,
+        callback=verbose_callback,
+        help="show the log messages",
+    ),
+):
+    "configuration cli"
+
+
+@config_app.command()
+def show(
+    verbose: bool = typer.Option(
+        False,
+        callback=verbose_callback,
+        help="show the log messages",
+    ),
+):
+    Console().print(configuration)

pydantic_typer/cli/tui.py

@@ -0,0 +1,18 @@
+import typer
+
+from pydantic_typer.cli.common import verbose_callback
+from pydantic_typer.tui.app import run_app
+
+tui_app = typer.Typer()
+
+
+@tui_app.callback(invoke_without_command=True)
+def i(
+    verbose: bool = typer.Option(
+        False,
+        callback=verbose_callback,
+        help="show the log messages",
+    ),
+):
+    "interactive tui"
+    run_app()

pydantic_typer/config.py

@@ -0,0 +1,3 @@
+from pydantic_typer.standard_config import load
+
+config = load("pydantic_typer")

pydantic_typer/console.py

@@ -0,0 +1,4 @@
+from rich.console import Console
+
+console = Console()
+console.quiet = True

pydantic_typer/standard_config.py

@@ -0,0 +1,239 @@
+"""Standard Config.
+A module to load tooling config from a users project space.
+
+Inspired from frustrations that some tools have a tool.ini, .tool.ini,
+setup.cfg, or pyproject.toml.  Some allow for global configs, some don't.  Some
+properly follow the users home directory, others end up in a weird temp
+directory.  Windows home directory is only more confusing.  Some will even
+respect the users `$XDG_HOME` directory.
+
+
+This file is for any project that can be configured in plain text such as `ini`
+or `toml` and not requiring a .py file.  Just name your tool and let users put
+config where it makes sense to them, no need to figure out resolution order.
+
+## Usage:
+
+``` python
+from standard_config import load
+
+# Retrieve any overrides from the user
+overrides = {'setting': True}
+config = load('my_tool', overrides)
+```
+
+## Resolution Order
+
+* First global file with a tool key
+* First local file with a tool key
+* Environment variables prefixed with `TOOL`
+* Overrides
+
+### Tool Specific Ini files
+
+Ini file formats must include a `<tool>` key.
+
+``` ini
+[my_tool]
+setting = True
+```
+
+### pyproject.toml
+
+Toml files must include a `tool.<tool>` key
+
+``` toml
+[tool.my_tool]
+setting = True
+```
+
+### setup.cfg
+
+setup.cfg files must include a `tool:<tool>` key
+
+``` ini
+[tool:my_tool]
+setting = True
+```
+
+
+### global files to consider
+
+* <home>/tool.ini
+* <home>/.tool
+* <home>/.tool.ini
+* <home>/.config/tool.ini
+* <home>/.config/.tool
+* <home>/.config/.tool.ini
+
+### local files to consider
+
+* <project_home>/tool.ini
+* <project_home>/.tool
+* <project_home>/.tool.ini
+* <project_home>/pyproject.toml
+* <project_home>/setup.cfg
+
+"""
+
+import os
+from pathlib import Path
+from typing import Dict, List, Union
+
+import anyconfig
+
+# path_spec_type = List[Dict[str, Union[Path, str, List[str\}\}\}\}
+path_spec_type = List
+
+
+def _get_global_path_specs(tool: str) -> path_spec_type:
+    """
+    Generate a list of standard pathspecs for global config files.
+
+    Args:
+        tool (str): name of the tool to configure
+    """
+    try:
+        home = Path(os.environ["XDG_HOME"])
+    except KeyError:
+        home = Path.home()
+
+    return [
+        {"path_specs": home / f"{tool}.ini", "ac_parser": "ini", "keys": [tool]},
+        {"path_specs": home / f".{tool}", "ac_parser": "ini", "keys": [tool]},
+        {"path_specs": home / f".{tool}.ini", "ac_parser": "ini", "keys": [tool]},
+        {
+            "path_specs": home / ".config" / f"{tool}.ini",
+            "ac_parser": "ini",
+            "keys": [tool],
+        },
+        {
+            "path_specs": home / ".config" / f".{tool}",
+            "ac_parser": "ini",
+            "keys": [tool],
+        },
+        {
+            "path_specs": home / ".config" / f".{tool}.ini",
+            "ac_parser": "ini",
+            "keys": [tool],
+        },
+    ]
+
+
+def _get_local_path_specs(tool: str, project_home: Union[str, Path]) -> path_spec_type:
+    """
+    Generate a list of standard pathspecs for local, project directory config files.
+
+    Args:
+        tool (str): name of the tool to configure
+    """
+    return [
+        {
+            "path_specs": Path(project_home) / f"{tool}.ini",
+            "ac_parser": "ini",
+            "keys": [tool],
+        },
+        {
+            "path_specs": Path(project_home) / f".{tool}",
+            "ac_parser": "ini",
+            "keys": [tool],
+        },
+        {
+            "path_specs": Path(project_home) / f".{tool}.ini",
+            "ac_parser": "ini",
+            "keys": [tool],
+        },
+        {
+            "path_specs": Path(project_home) / f"{tool}.yml",
+            "ac_parser": "yaml",
+            "keys": [tool],
+        },
+        {
+            "path_specs": Path(project_home) / f".{tool}.yml",
+            "ac_parser": "yaml",
+            "keys": [tool],
+        },
+        {
+            "path_specs": Path(project_home) / f"{tool}.toml",
+            "ac_parser": "toml",
+            "keys": [tool],
+        },
+        {
+            "path_specs": Path(project_home) / f".{tool}.toml",
+            "ac_parser": "toml",
+            "keys": [tool],
+        },
+        {
+            "path_specs": Path(project_home) / "pyproject.toml",
+            "ac_parser": "toml",
+            "keys": ["tool", tool],
+        },
+        {
+            "path_specs": Path(project_home) / "setup.cfg",
+            "ac_parser": "ini",
+            "keys": [f"tool.{tool}"],
+        },
+    ]
+
+
+def _get_attrs(attrs: list, config: Dict) -> Dict:
+    """Get nested config data from a list of keys.
+
+    specifically written for pyproject.toml which needs to get `tool` then `<tool>`
+    """
+    for attr in attrs:
+        config = config[attr]
+    return config
+
+
+def _load_files(config_path_specs: path_spec_type) -> Dict:
+    """Use anyconfig to load config files stopping at the first one that exists.
+
+    config_path_specs (list): a list of pathspecs and keys to load
+    """
+    for file in config_path_specs:
+        if file["path_specs"].exists():
+            config = anyconfig.load(**file)
+        else:
+            # ignore missing files
+            continue
+
+        try:
+            return _get_attrs(file["keys"], config)
+        except KeyError:
+            # ignore incorrect keys
+            continue
+
+    return {}
+
+
+def _load_env(tool: str) -> Dict:
+    """Load config from environment variables.
+
+    Args:
+        tool (str): name of the tool to configure
+    """
+    vars = [var for var in os.environ.keys() if var.startswith(tool.upper())]
+    return {
+        var.lower().strip(tool.lower()).strip("_").strip("-"): os.environ[var]
+        for var in vars
+    }
+
+
+def load(tool: str, project_home: Union[Path, str] = ".", overrides: Dict = {}) -> Dict:
+    """Load tool config from standard config files.
+
+    Resolution Order
+
+    * First global file with a tool key
+    * First local file with a tool key
+    * Environment variables prefixed with `TOOL`
+    * Overrides
+
+    Args:
+        tool (str): name of the tool to configure
+    """
+    global_config = _load_files(_get_global_path_specs(tool))
+    local_config = _load_files(_get_local_path_specs(tool, project_home))
+    env_config = _load_env(tool)
+    return {**global_config, **local_config, **env_config, **overrides}

pydantic_typer/tui/app.css

@@ -0,0 +1,18 @@
+Screen {
+  align: center middle;
+  layers: main footer;
+}
+
+Sidebar {
+  height: 100vh;
+  width: auto;
+  min-width: 20;
+  background: $secondary-background-darken-2;
+  dock: left;
+  margin-right: 1;
+  layer: main;
+}
+
+Footer {
+  layer: footer;
+}

pydantic_typer/tui/app.py

@@ -0,0 +1,62 @@
+from pathlib import Path
+
+from textual.app import App, ComposeResult
+from textual.containers import Container
+from textual.css.query import NoMatches
+from textual.widgets import Footer, Static
+
+from pydantic_typer.config import config
+
+config["tui"] = {}
+config["tui"]["bindings"] = {}
+
+
+class Sidebar(Static):
+    def compose(self) -> ComposeResult:
+        yield Container(
+            Static("sidebar"),
+            id="sidebar",
+        )
+
+
+class Tui(App):
+    """A Textual app to manage requests."""
+
+    CSS_PATH = Path("__file__").parent / "app.css"
+    BINDINGS = [tuple(b.values()) for b in config["tui"]["bindings"]]
+
+    def compose(self) -> ComposeResult:
+        """Create child widgets for the app."""
+        yield Container(Static("hello world"))
+        yield Footer()
+
+    def action_toggle_dark(self) -> None:
+        """An action to toggle dark mode."""
+        self.dark = not self.dark
+
+    def action_toggle_sidebar(self):
+        try:
+            self.query_one("PromptSidebar").remove()
+        except NoMatches:
+            self.mount(Sidebar())
+
+
+def run_app():
+    import os
+    import sys
+
+    from textual.features import parse_features
+
+    dev = "--dev" in sys.argv
+    features = set(parse_features(os.environ.get("TEXTUAL", "")))
+    if dev:
+        features.add("debug")
+        features.add("devtools")
+
+    os.environ["TEXTUAL"] = ",".join(sorted(features))
+    app = Tui()
+    app.run()
+
+
+if __name__ == "__main__":
+    run_app()