python-tty 0.1.0__tar.gz

python_tty-0.1.0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: python-tty
+Version: 0.1.0
+Summary: A multi-console TTY framework for complex CLI/TTY apps
+Home-page: https://github.com/ROOKIEMIE/python-tty
+Author: ROOKIEMIE
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: prompt_toolkit>=3.0.32
+Requires-Dist: tqdm
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Command Line Framework (V2: Web/RPC-ready)
+
+[中文](README_zh.md)
+
+V2 extends the TTY core toward Web + RPC, while keeping the current codebase focused on the TTY runtime. At the moment, Web/RPC is planned but not yet implemented.
+
+## Quick Start (TTY Core)
+
+1) Define your consoles and commands (see examples in `src/consoles/examples` and `src/commands/examples`).
+2) Ensure console modules are imported so decorators can register them:
+   - Update `DEFAULT_CONSOLE_MODULES` in `src/consoles/loader.py`, or
+   - Call `load_consoles([...])` manually.
+3) Start the factory:
+
+```python
+from src.console_factory import ConsoleFactory
+
+factory = ConsoleFactory(service=my_business_core)
+factory.start()
+```
+
+The `service` instance is available in all consoles via `console.service`, and in commands via `self.console.service`. If `service` does not inherit `UIEventSpeaker`, a warning is emitted at startup.
+
+## Current Capabilities (TTY Core)
+
+Console layer:
+- `src/consoles/core.py`: `BaseConsole`, `MainConsole`, `SubConsole`
+- `src/consoles/manager.py` and `src/consoles/registry.py` for lifecycle and registration
+
+Commands layer:
+- `src/commands/core.py`: `BaseCommands`, `CommandValidator`
+- `src/commands/registry.py`: `CommandRegistry`, `ArgSpec`
+- `src/commands/general.py`: `GeneralValidator`, `GeneralCompleter`
+- `src/commands/mixins.py`: `CommandMixin` and built-in mixins
+
+UI and utilities:
+- `src/core/events.py`: `UIEvent`, `UIEventLevel`, `UIEventSpeaker`
+- `src/ui/output.py`: `proxy_print`
+- `src/utils/`: `tokenize.py`, `table.py`, `ui_logger.py`
+
+## Roadmap (V2)
+
+Planned milestones for Web + RPC:
+- M1: Meta Descriptor v1 + Exporter
+- M2: RPC proto v1 + local (de)serialization
+- M3: Meta Web Server (HTTP + WS)
+- M4: RPC Server (mTLS + allowlist + audit)
+- M5: Unified execution system (CommandExecutor)

python_tty-0.1.0/README.md

@@ -0,0 +1,48 @@
+# Command Line Framework (V2: Web/RPC-ready)
+
+[中文](README_zh.md)
+
+V2 extends the TTY core toward Web + RPC, while keeping the current codebase focused on the TTY runtime. At the moment, Web/RPC is planned but not yet implemented.
+
+## Quick Start (TTY Core)
+
+1) Define your consoles and commands (see examples in `src/consoles/examples` and `src/commands/examples`).
+2) Ensure console modules are imported so decorators can register them:
+   - Update `DEFAULT_CONSOLE_MODULES` in `src/consoles/loader.py`, or
+   - Call `load_consoles([...])` manually.
+3) Start the factory:
+
+```python
+from src.console_factory import ConsoleFactory
+
+factory = ConsoleFactory(service=my_business_core)
+factory.start()
+```
+
+The `service` instance is available in all consoles via `console.service`, and in commands via `self.console.service`. If `service` does not inherit `UIEventSpeaker`, a warning is emitted at startup.
+
+## Current Capabilities (TTY Core)
+
+Console layer:
+- `src/consoles/core.py`: `BaseConsole`, `MainConsole`, `SubConsole`
+- `src/consoles/manager.py` and `src/consoles/registry.py` for lifecycle and registration
+
+Commands layer:
+- `src/commands/core.py`: `BaseCommands`, `CommandValidator`
+- `src/commands/registry.py`: `CommandRegistry`, `ArgSpec`
+- `src/commands/general.py`: `GeneralValidator`, `GeneralCompleter`
+- `src/commands/mixins.py`: `CommandMixin` and built-in mixins
+
+UI and utilities:
+- `src/core/events.py`: `UIEvent`, `UIEventLevel`, `UIEventSpeaker`
+- `src/ui/output.py`: `proxy_print`
+- `src/utils/`: `tokenize.py`, `table.py`, `ui_logger.py`
+
+## Roadmap (V2)
+
+Planned milestones for Web + RPC:
+- M1: Meta Descriptor v1 + Exporter
+- M2: RPC proto v1 + local (de)serialization
+- M3: Meta Web Server (HTTP + WS)
+- M4: RPC Server (mTLS + allowlist + audit)
+- M5: Unified execution system (CommandExecutor)

python_tty-0.1.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"

python_tty-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

python_tty-0.1.0/setup.py

@@ -0,0 +1,23 @@
+from setuptools import setup, find_packages
+from pathlib import Path
+
+ROOT = Path(__file__).parent
+long_description = (ROOT / "README.md").read_text(encoding="utf-8")
+
+setup(
+    name="python-tty",                 # PyPI 分发名（可以有连字符）
+    version="0.1.0",                   # 先用手动版本；后续可切 tag 自动版本
+    description="A multi-console TTY framework for complex CLI/TTY apps",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="ROOKIEMIE",
+    url="https://github.com/ROOKIEMIE/python-tty",
+    package_dir={"": "src"},
+    packages=find_packages(where="src", exclude=("tests*", "demos*", "docs*")),
+    include_package_data=True,
+    python_requires=">=3.10",
+    install_requires=[
+        "prompt_toolkit>=3.0.32",
+        "tqdm",
+    ],
+)

python_tty-0.1.0/src/python_tty/__init__.py

@@ -0,0 +1,15 @@
+from python_tty.config import Config
+from python_tty.console_factory import ConsoleFactory
+from python_tty.ui.events import UIEvent, UIEventLevel, UIEventListener, UIEventSpeaker
+from python_tty.ui.output import proxy_print
+
+__all__ = [
+    "UIEvent",
+    "UIEventLevel",
+    "UIEventListener",
+    "UIEventSpeaker",
+    "ConsoleFactory",
+    "Config",
+    "proxy_print",
+]
+

python_tty-0.1.0/src/python_tty/commands/__init__.py

@@ -0,0 +1,24 @@
+from python_tty.commands.core import BaseCommands, CommandValidator
+from python_tty.commands.registry import (
+    ArgSpec,
+    CommandDef,
+    CommandInfo,
+    CommandRegistry,
+    CommandStyle,
+    COMMAND_REGISTRY,
+    define_command_style,
+)
+
+__all__ = [
+    "ArgSpec",
+    "BaseCommands",
+    "CommandDef",
+    "CommandInfo",
+    "CommandRegistry",
+    "CommandStyle",
+    "COMMAND_REGISTRY",
+    "CommandValidator",
+    "define_command_style",
+]
+
+

python_tty-0.1.0/src/python_tty/commands/core.py

@@ -0,0 +1,119 @@
+from prompt_toolkit.completion import NestedCompleter
+from prompt_toolkit.document import Document
+from prompt_toolkit.validation import DummyValidator, Validator, ValidationError
+
+from python_tty.commands.registry import COMMAND_REGISTRY, ArgSpec
+from python_tty.exceptions.console_exception import ConsoleInitException
+from python_tty.utils import split_cmd
+
+
+class CommandValidator(Validator):
+    def __init__(self, command_validators: dict, enable_undefined_command=False):
+        self.command_validators = command_validators
+        self.enable_undefined_command = enable_undefined_command
+        super().__init__()
+
+    def validate(self, document: Document) -> None:
+        try:
+            token, arg_text, _ = split_cmd(document.text)
+            if token in self.command_validators.keys():
+                cmd_validator = self.command_validators[token]
+                cmd_validator.validate(Document(text=arg_text))
+            else:
+                if not self.enable_undefined_command:
+                    raise ValidationError(message="Bad command")
+        except ValueError:
+            return
+
+
+class BaseCommands:
+    def __init__(self, console, registry=None):
+        self.console = console
+        self.registry = registry if registry is not None else COMMAND_REGISTRY
+        self.command_defs = []
+        self.command_defs_by_name = {}
+        self.command_defs_by_id = {}
+        self.command_completers = {}
+        self.command_validators = {}
+        self.command_funcs = {}
+        self._init_funcs()
+        self.completer = NestedCompleter.from_nested_dict(self.command_completers)
+        self.validator = CommandValidator(self.command_validators, self.enable_undefined_command)
+
+    @property
+    def enable_undefined_command(self):
+        return False
+
+    def _init_funcs(self):
+        if self.console is None:
+            raise ConsoleInitException("Console is None")
+        defs = self.registry.get_command_defs_for_console(self.console.__class__)
+        if len(defs) == 0:
+            defs = self.registry.collect_from_commands_cls(self.__class__)
+        self.command_defs = defs
+        self._collect_completer_and_validator(defs)
+
+    def _collect_completer_and_validator(self, defs):
+        for command_def in defs:
+            self._map_components(command_def)
+
+    def _map_components(self, command_def):
+        command_id = self._build_command_id(command_def)
+        if command_id is not None:
+            self.command_defs_by_id[command_id] = command_def
+        for command_name in command_def.all_names():
+            self.command_funcs[command_name] = command_def.func
+            self.command_defs_by_name[command_name] = command_def
+            if command_def.completer is None:
+                self.command_completers[command_name] = None
+            else:
+                self.command_completers[command_name] = self._build_completer(command_def)
+            self.command_validators[command_name] = self._build_validator(command_def)
+
+    def _build_completer(self, command_def):
+        try:
+            return command_def.completer(self.console, command_def.arg_spec)
+        except TypeError:
+            try:
+                return command_def.completer(self.console)
+            except TypeError as exc:
+                raise ConsoleInitException(
+                    "Completer init failed. Use completer_from(...) to adapt "
+                    "prompt_toolkit completers."
+                ) from exc
+
+    def _build_validator(self, command_def):
+        if command_def.validator is None:
+            return DummyValidator()
+        try:
+            return command_def.validator(self.console, command_def.func, command_def.arg_spec)
+        except TypeError:
+            return command_def.validator(self.console, command_def.func)
+
+    def get_command_def(self, command_name):
+        command_def = self.command_defs_by_id.get(command_name)
+        if command_def is not None:
+            return command_def
+        return self.command_defs_by_name.get(command_name)
+
+    def get_command_def_by_id(self, command_id):
+        return self.command_defs_by_id.get(command_id)
+
+    def get_command_id(self, command_name):
+        command_def = self.command_defs_by_name.get(command_name)
+        if command_def is None:
+            return None
+        return self._build_command_id(command_def)
+
+    def _build_command_id(self, command_def):
+        console_name = getattr(self.console, "console_name", None)
+        if not console_name:
+            console_name = self.console.__class__.__name__.lower()
+        return f"cmd:{console_name}:{command_def.func_name}"
+
+    def deserialize_args(self, command_def, raw_text):
+        if command_def.arg_spec is None:
+            arg_spec = ArgSpec.from_signature(command_def.func)
+            return arg_spec.parse(raw_text)
+        return command_def.arg_spec.parse(raw_text)
+

python_tty-0.1.0/src/python_tty/commands/decorators.py

@@ -0,0 +1,58 @@
+from functools import wraps
+
+from prompt_toolkit.completion import Completer
+from prompt_toolkit.validation import Validator
+
+from python_tty.commands import BaseCommands
+from python_tty.commands.registry import COMMAND_REGISTRY, CommandInfo, CommandStyle, define_command_style
+from python_tty.exceptions.console_exception import ConsoleInitException
+
+
+def commands(commands_cls):
+    """Bind a BaseCommands subclass to a Console class for auto command wiring."""
+    if not issubclass(commands_cls, BaseCommands):
+        raise ConsoleInitException("Commands must inherit BaseCommands")
+
+    def decorator(console_cls):
+        from python_tty.consoles import MainConsole, SubConsole
+        if not issubclass(console_cls, (MainConsole, SubConsole)):
+            raise ConsoleInitException("commands decorator must target a Console class")
+        existing = getattr(console_cls, "__commands_cls__", None)
+        if existing is not None and existing is not commands_cls:
+            raise ConsoleInitException(
+                f"{console_cls.__name__} already binds to {existing.__name__}; "
+                f"cannot bind to {commands_cls.__name__} again"
+            )
+        setattr(console_cls, "__commands_cls__", commands_cls)
+        COMMAND_REGISTRY.register_console_commands(console_cls, commands_cls)
+        return console_cls
+
+    return decorator
+
+
+def register_command(command_name: str, command_description: str, command_alias=None,
+                     command_style=CommandStyle.LOWERCASE,
+                     completer=None, validator=None, arg_spec=None):
+    """Declare command metadata for a command method on a BaseCommands subclass."""
+    if completer is not None and not isinstance(completer, type):
+        raise ConsoleInitException("Command completer must be a class")
+    if validator is not None and not isinstance(validator, type):
+        raise ConsoleInitException("Command validator must be a class")
+    if completer is not None and not issubclass(completer, Completer):
+        raise ConsoleInitException("Command completer must inherit Completer")
+    if validator is not None and not issubclass(validator, Validator):
+        raise ConsoleInitException("Command validator must inherit Validator")
+    def inner_wrapper(func):
+        func.info = CommandInfo(define_command_style(command_name, command_style), command_description,
+                                completer, validator, command_alias, arg_spec)
+        func.type = None
+
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            result = func(*args, **kwargs)
+            return result
+
+        return wrapper
+
+    return inner_wrapper
+

python_tty-0.1.0/src/python_tty/commands/examples/__init__.py

@@ -0,0 +1,8 @@
+from python_tty.commands.examples.root_commands import RootCommands
+from python_tty.commands.examples.sub_commands import SubCommands
+
+__all__ = [
+    "RootCommands",
+    "SubCommands",
+]
+

python_tty-0.1.0/src/python_tty/commands/examples/root_commands.py

@@ -0,0 +1,33 @@
+from python_tty.commands import BaseCommands
+from python_tty.commands.decorators import register_command
+from python_tty.commands.general import GeneralValidator
+from python_tty.commands.mixins import HelpMixin, QuitMixin
+from python_tty.ui.events import UIEventLevel
+from python_tty.ui.output import proxy_print
+
+
+class RootCommands(BaseCommands, HelpMixin, QuitMixin):
+    @property
+    def enable_undefined_command(self):
+        return True
+    
+    @register_command("use", "Enter sub console", validator=GeneralValidator)
+    def run_use(self, console_name):
+        manager = getattr(self.console, "manager", None)
+        if manager is None:
+            proxy_print("Console manager not configured", UIEventLevel.WARNING)
+            return
+        if not manager.is_registered(console_name):
+            proxy_print(f"Console [{console_name}] not registered", UIEventLevel.ERROR)
+            return
+        manager.push(console_name)
+
+    @register_command("debug", "Debug root console, display some information", validator=GeneralValidator)
+    def run_debug(self, *args):
+        framework = self.console.service
+        proxy_print(str(framework))
+
+
+if __name__ == '__main__':
+    pass
+

python_tty-0.1.0/src/python_tty/commands/examples/sub_commands.py

@@ -0,0 +1,11 @@
+from python_tty.commands import BaseCommands
+from python_tty.commands.decorators import register_command
+from python_tty.commands.general import GeneralValidator
+from python_tty.commands.mixins import BackMixin, HelpMixin, QuitMixin
+
+
+class SubCommands(BaseCommands, HelpMixin, QuitMixin, BackMixin):
+    @register_command("debug", "Debug command, display some information", [], validator=GeneralValidator)
+    def run_debug(self):
+        pass
+

python_tty-0.1.0/src/python_tty/commands/general.py

@@ -0,0 +1,107 @@
+from abc import ABC, abstractmethod
+
+from prompt_toolkit.completion import Completer, WordCompleter
+from prompt_toolkit.document import Document
+from prompt_toolkit.validation import ValidationError, Validator
+
+from python_tty.commands.registry import ArgSpec
+
+
+class GeneralValidator(Validator):
+    """Default validator that checks argument count and allows custom validation."""
+    def __init__(self, console, func, arg_spec=None):
+        self.console = console
+        self.func = func
+        self.arg_spec = arg_spec or ArgSpec.from_signature(func)
+        super().__init__()
+
+    def validate(self, document: Document) -> None:
+        try:
+            args = self.arg_spec.parse(document.text)
+            self.arg_spec.validate_count(len(args))
+        except ValidationError:
+            raise
+        except ValueError as exc:
+            raise ValidationError(message=str(exc)) from exc
+        try:
+            self.custom_validate(args, document.text)
+        except TypeError:
+            self.custom_validate(document.text)
+
+    def custom_validate(self, args, text: str):
+        pass
+
+
+def _allow_complete_for_spec(arg_spec, text, args):
+    if arg_spec.max_args is None:
+        return True
+    if text != "" and text[-1].isspace():
+        return len(args) < arg_spec.max_args
+    return len(args) <= arg_spec.max_args
+
+
+class GeneralCompleter(Completer, ABC):
+    """Base completer with ArgSpec-aware completion and console injection."""
+    def __init__(self, console, arg_spec=None, ignore_case=True):
+        self.console = console
+        self.arg_spec = arg_spec or ArgSpec()
+        self.ignore_case = ignore_case
+        super().__init__()
+
+    @abstractmethod
+    def get_candidates(self, args, text: str):
+        pass
+
+    def get_completions(self, document, complete_event):
+        text = document.text_before_cursor
+        try:
+            args = self.arg_spec.parse(text)
+        except ValueError:
+            return
+        if not _allow_complete_for_spec(self.arg_spec, text, args):
+            return
+        words = self.get_candidates(args, text)
+        if not words:
+            return
+        completer = WordCompleter(words, ignore_case=self.ignore_case)
+        yield from completer.get_completions(document, complete_event)
+
+    def _allow_complete(self, text, args):
+        return _allow_complete_for_spec(self.arg_spec, text, args)
+
+
+class PromptToolkitCompleterAdapter(Completer):
+    completer_cls = None
+    completer_kwargs = {}
+
+    def __init__(self, console, arg_spec=None):
+        self.console = console
+        self.arg_spec = arg_spec or ArgSpec()
+        if self.completer_cls is None:
+            raise ValueError("completer_cls must be set for adapter")
+        self._inner = self.completer_cls(**self.get_completer_kwargs())
+        super().__init__()
+
+    def get_completer_kwargs(self):
+        return dict(self.completer_kwargs)
+
+    def get_completions(self, document, complete_event):
+        text = document.text_before_cursor
+        try:
+            args = self.arg_spec.parse(text)
+        except ValueError:
+            return
+        if not _allow_complete_for_spec(self.arg_spec, text, args):
+            return
+        yield from self._inner.get_completions(document, complete_event)
+
+
+def completer_from(completer_cls, **kwargs):
+    """Build a completer adapter class for a prompt_toolkit completer."""
+    class _Adapter(PromptToolkitCompleterAdapter):
+        pass
+
+    _Adapter.completer_cls = completer_cls
+    _Adapter.completer_kwargs = kwargs
+    return _Adapter
+

python_tty-0.1.0/src/python_tty/commands/mixins.py

@@ -0,0 +1,52 @@
+import inspect
+
+from python_tty.ui.output import proxy_print
+from python_tty.commands import BaseCommands
+from python_tty.commands.decorators import register_command
+from python_tty.commands.general import GeneralValidator
+from python_tty.exceptions.console_exception import ConsoleExit, SubConsoleExit
+from python_tty.utils.table import Table
+
+
+class CommandMixin:
+    pass
+
+
+class BackMixin(CommandMixin):
+    @register_command("back", "Back to forward tty", validator=GeneralValidator)
+    def run_back(self):
+        raise SubConsoleExit
+
+
+class QuitMixin(CommandMixin):
+    @register_command("quit", "Quit Console", ["exit", "q"], validator=GeneralValidator)
+    def run_quit(self):
+        raise ConsoleExit
+
+
+class HelpMixin(CommandMixin):
+    @register_command("help", "Display help information", ["?"], validator=GeneralValidator)
+    def run_help(self):
+        header = ["Command", "Description"]
+        base_funcs = []
+        custom_funcs = []
+        base_commands_funcs = []
+        for cls in self.__class__.mro():
+            if cls is CommandMixin:
+                continue
+            if issubclass(cls, CommandMixin):
+                base_commands_funcs.extend([member[1] for member in inspect.getmembers(cls, inspect.isfunction)])
+        for name, func in self.command_funcs.items():
+            row = [name, func.info.func_description]
+            if func in base_commands_funcs:
+                base_funcs.append(row)
+            else:
+                custom_funcs.append(row)
+        if base_funcs:
+            proxy_print(Table(header, base_funcs, "Core Commands"))
+        if custom_funcs:
+            proxy_print(Table(header, custom_funcs, "Custom Commands"))
+
+class DefaultCommands(BaseCommands, HelpMixin, QuitMixin):
+    pass
+