clean up and refactor
This commit is contained in:
parent
cb95da6407
commit
22b7eaf593
16 changed files with 136 additions and 500 deletions
28
examples/models.py
Normal file
28
examples/models.py
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
from pydantic import BaseModel, Field
|
||||
from typing import Optional
|
||||
|
||||
|
||||
class Alpha(BaseModel):
|
||||
a: int
|
||||
|
||||
|
||||
class Color(BaseModel):
|
||||
r: int
|
||||
g: int
|
||||
b: int
|
||||
alpha: Alpha
|
||||
|
||||
|
||||
class Hair(BaseModel):
|
||||
color: Color
|
||||
length: int
|
||||
|
||||
|
||||
class Person(BaseModel):
|
||||
name: str
|
||||
other_name: Optional[str] = None
|
||||
age: int
|
||||
email: Optional[str]
|
||||
pet: str = "dog"
|
||||
address: str = Field("123 Main St", description="Where the person calls home.")
|
||||
hair: Hair
|
||||
13
examples/person.py
Normal file
13
examples/person.py
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
|
||||
from examples.models import Person
|
||||
from pydantic_typer import expand_pydantic_args
|
||||
|
||||
|
||||
@expand_pydantic_args()
|
||||
def get_person(person: Person, thing: str = None) -> Person:
|
||||
"""mydocstring"""
|
||||
from rich import print
|
||||
|
||||
print(str(thing))
|
||||
|
||||
print(person)
|
||||
30
examples/person_cli.py
Normal file
30
examples/person_cli.py
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
import typer
|
||||
|
||||
from examples.models import Person
|
||||
from pydantic_typer import expand_pydantic_args
|
||||
|
||||
app = typer.Typer(
|
||||
name="pydantic_typer",
|
||||
help="a demo app",
|
||||
)
|
||||
|
||||
|
||||
@app.callback()
|
||||
def main() -> None:
|
||||
return
|
||||
|
||||
|
||||
@app.command()
|
||||
@expand_pydantic_args(typer=True)
|
||||
def get_person(person: Person, thing: str, another: str = "this") -> Person:
|
||||
"""Get a person's information."""
|
||||
from rich import print
|
||||
|
||||
print(thing)
|
||||
print(another)
|
||||
|
||||
print(person)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
typer.run(get_person)
|
||||
|
|
@ -1,44 +1,13 @@
|
|||
# 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 typing import Callable
|
||||
|
||||
from pydantic import BaseModel, Field
|
||||
import typer
|
||||
|
||||
__all__ = ["typer"]
|
||||
|
||||
|
||||
class Alpha(BaseModel):
|
||||
a: int
|
||||
|
||||
|
||||
class Color(BaseModel):
|
||||
r: int
|
||||
g: int
|
||||
b: int
|
||||
alpha: Alpha
|
||||
|
||||
|
||||
class Hair(BaseModel):
|
||||
color: Color
|
||||
length: int
|
||||
|
||||
|
||||
class Person(BaseModel):
|
||||
name: str
|
||||
other_name: Optional[str] = None
|
||||
age: int
|
||||
email: Optional[str]
|
||||
pet: str = "dog"
|
||||
address: str = Field("123 Main St", description="Where the person calls home.")
|
||||
hair: Hair
|
||||
|
||||
|
||||
def make_annotation(name, field, names, typer=False):
|
||||
def _make_annotation(name, field, names, typer=False):
|
||||
panel_name = names.get(name)
|
||||
next_name = panel_name
|
||||
while next_name is not None:
|
||||
|
|
@ -76,7 +45,7 @@ def make_annotation(name, field, names, typer=False):
|
|||
return f"{name}: {annotation}{default}"
|
||||
|
||||
|
||||
def make_signature(func, wrapper, typer=False, more_args={}):
|
||||
def _make_signature(func, wrapper, typer=False, more_args={}):
|
||||
sig = inspect.signature(func)
|
||||
names = {}
|
||||
for name, param in sig.parameters.items():
|
||||
|
|
@ -111,7 +80,7 @@ def make_signature(func, wrapper, typer=False, more_args={}):
|
|||
) + f"\nalso accepts {more_args.keys()} in place of person model"
|
||||
# fields = Person.__fields__
|
||||
raw_args = [
|
||||
make_annotation(
|
||||
_make_annotation(
|
||||
name,
|
||||
field,
|
||||
names=names,
|
||||
|
|
@ -153,7 +122,7 @@ def {func.__name__}({aargs}{', ' if aargs else ''}{kwargs}):
|
|||
sig = inspect.signature(new_func)
|
||||
for name, param in sig.parameters.items():
|
||||
if hasattr(param.annotation, "__fields__"):
|
||||
return make_signature(new_func, wrapper, typer=typer, more_args=more_args)
|
||||
return _make_signature(new_func, wrapper, typer=typer, more_args=more_args)
|
||||
return new_func
|
||||
|
||||
|
||||
|
|
@ -193,23 +162,6 @@ def expand_pydantic_args(typer: bool = False) -> Callable:
|
|||
def wrapper(*args, **kwargs):
|
||||
return func(**_expand_kwargs(func, kwargs))
|
||||
|
||||
return make_signature(func, wrapper, typer=typer)
|
||||
return _make_signature(func, wrapper, typer=typer)
|
||||
|
||||
return decorator
|
||||
|
||||
|
||||
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(str(thing))
|
||||
|
||||
print(person)
|
||||
|
|
|
|||
|
|
@ -1,9 +0,0 @@
|
|||
# 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}}())
|
||||
|
|
@ -1,62 +0,0 @@
|
|||
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)
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
from pydantic_typer.console import console
|
||||
|
||||
|
||||
def verbose_callback(value: bool) -> None:
|
||||
if value:
|
||||
console.quiet = False
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
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)
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
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()
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
from pydantic_typer.standard_config import load
|
||||
|
||||
config = load("pydantic_typer")
|
||||
|
|
@ -1,239 +0,0 @@
|
|||
"""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}
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
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;
|
||||
}
|
||||
|
|
@ -1,62 +0,0 @@
|
|||
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()
|
||||
|
|
@ -95,3 +95,62 @@ testpaths = ["tests"]
|
|||
|
||||
[tool.coverage_rich]
|
||||
fail-under=80
|
||||
|
||||
[tool.ruff]
|
||||
ignore = ["E501"]
|
||||
target-version = "py37"
|
||||
|
||||
|
||||
select = [
|
||||
"F", # Pyflakes
|
||||
"E", # Error
|
||||
"W", # Warning
|
||||
"C90", # mccabe
|
||||
"I", # isort
|
||||
"N", # pep8-naming
|
||||
"D", # pydocstyle
|
||||
"UP", # pyupgrade
|
||||
"YTT", # flake8-2020
|
||||
"ANN", # flake8-annotations
|
||||
"S", # flake8-bandit
|
||||
"BLE", # flake8-blind-except
|
||||
"FBT", # flake8-boolean-trap
|
||||
"B", # flake8-bugbear
|
||||
"A", # flake8-builtins
|
||||
"COM", # flake8-commas
|
||||
"C4", # flake8-comprehensions
|
||||
"DTZ", # flake8-datetimez
|
||||
"T10", # flake8-debugger
|
||||
"DJ", # flake8-django
|
||||
"EM", # flake8-errmsg
|
||||
"EXE", # flake8-executable
|
||||
"ISC", # flake8-implicit-str-concat
|
||||
"ICN", # flake8-import-conventions
|
||||
"G", # flake8-logging-format
|
||||
"INP", # flake8-no-pep420
|
||||
"PIE", # flake8-pie
|
||||
"T20", # flake8-print
|
||||
"PYI", # flake8-pyi
|
||||
"PT", # flake8-pytest-style
|
||||
"Q", # flake8-quotes
|
||||
"RSE", # flake8-raise
|
||||
"RET", # flake8-return
|
||||
"SLF", # flake8-self
|
||||
"SIM", # flake8-simplify
|
||||
"TID", # flake8-tidy-imports
|
||||
"TCH", # flake8-type-checking
|
||||
"INT", # flake8-gettext
|
||||
"ARG", # flake8-unused-arguments
|
||||
"PTH", # flake8-use-pathlib
|
||||
"ERA", # eradicate
|
||||
"PD", # pandas-vet
|
||||
"PGH", # pygrep-hooks
|
||||
"PL", # Pylint
|
||||
"PLC", # Convention
|
||||
"PLE", # Error
|
||||
"PLR", # Refactor
|
||||
"PLW", # Warning
|
||||
"TRY", # tryceratops
|
||||
"NPY", # NumPy-specific rules
|
||||
"RUF", # Ruff-specific rules
|
||||
]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue