python-tty 0.1.1__tar.gz

python_tty-0.1.1/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

python_tty-0.1.1/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include README_zh.md
+include LICENSE

python_tty-0.1.1/NOTICE

@@ -0,0 +1,3 @@
+python-tty
+Copyright 2026 ROOKIEMIE
+Licensed under the Apache License, Version 2.0

python_tty-0.1.1/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: python-tty
+Version: 0.1.1
+Summary: A multi-console TTY framework for complex CLI/TTY apps
+Home-page: https://github.com/ROOKIEMIE/python-tty
+Author: ROOKIEMIE
+License: Apache-2.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: prompt_toolkit>=3.0.32
+Requires-Dist: tqdm
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+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 `python_tty/consoles/examples` and `python_tty/commands/examples`).
+2) Ensure console modules are imported so decorators can register them:
+   - Update `DEFAULT_CONSOLE_MODULES` in `python_tty/consoles/loader.py`, or
+   - Call `load_consoles([...])` manually.
+3) Start the factory:
+
+```python
+from python_tty.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:
+- `python_tty/consoles/core.py`: `BaseConsole`, `MainConsole`, `SubConsole`
+- `python_tty/consoles/manager.py` and `python_tty/consoles/registry.py` for lifecycle and registration
+
+Commands layer:
+- `python_tty/commands/core.py`: `BaseCommands`, `CommandValidator`
+- `python_tty/commands/registry.py`: `CommandRegistry`, `ArgSpec`
+- `python_tty/commands/general.py`: `GeneralValidator`, `GeneralCompleter`
+- `python_tty/commands/mixins.py`: `CommandMixin` and built-in mixins
+
+UI and utilities:
+- `python_tty/core/events.py`: `UIEvent`, `UIEventLevel`, `UIEventSpeaker`
+- `python_tty/ui/output.py`: `proxy_print`
+- `python_tty/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.1/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 `python_tty/consoles/examples` and `python_tty/commands/examples`).
+2) Ensure console modules are imported so decorators can register them:
+   - Update `DEFAULT_CONSOLE_MODULES` in `python_tty/consoles/loader.py`, or
+   - Call `load_consoles([...])` manually.
+3) Start the factory:
+
+```python
+from python_tty.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:
+- `python_tty/consoles/core.py`: `BaseConsole`, `MainConsole`, `SubConsole`
+- `python_tty/consoles/manager.py` and `python_tty/consoles/registry.py` for lifecycle and registration
+
+Commands layer:
+- `python_tty/commands/core.py`: `BaseCommands`, `CommandValidator`
+- `python_tty/commands/registry.py`: `CommandRegistry`, `ArgSpec`
+- `python_tty/commands/general.py`: `GeneralValidator`, `GeneralCompleter`
+- `python_tty/commands/mixins.py`: `CommandMixin` and built-in mixins
+
+UI and utilities:
+- `python_tty/core/events.py`: `UIEvent`, `UIEventLevel`, `UIEventSpeaker`
+- `python_tty/ui/output.py`: `proxy_print`
+- `python_tty/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.1/README_zh.md

@@ -0,0 +1,46 @@
+# 命令行框架 (V2: Web/RPC 方向)
+
+该分支面向 Web + RPC 能力扩展，目前代码仍以 TTY 核心为主，Web/RPC 尚未落地。
+
+## 快速开始（TTY 核心）
+
+1) 定义 consoles 与 commands（示例见 `python_tty/consoles/examples` 与 `python_tty/commands/examples`）。
+2) 确保 console 模块被导入以触发装饰器注册：
+   - 修改 `python_tty/consoles/loader.py` 中的 `DEFAULT_CONSOLE_MODULES`，或
+   - 手动调用 `load_consoles([...])`。
+3) 启动工厂：
+
+```python
+from python_tty.console_factory import ConsoleFactory
+
+factory = ConsoleFactory(service=my_business_core)
+factory.start()
+```
+
+传入的 `service` 可在 console 中通过 `console.service` 访问，在 commands 中通过 `self.console.service` 访问。若 `service` 未继承 `UIEventSpeaker`，启动时会给出警告。
+
+## 当前能力（TTY 核心）
+
+Console 层：
+- `python_tty/consoles/core.py`：`BaseConsole`、`MainConsole`、`SubConsole`
+- `python_tty/consoles/manager.py` 与 `python_tty/consoles/registry.py` 负责生命周期与注册
+
+Commands 层：
+- `python_tty/commands/core.py`：`BaseCommands`、`CommandValidator`
+- `python_tty/commands/registry.py`：`CommandRegistry`、`ArgSpec`
+- `python_tty/commands/general.py`：`GeneralValidator`、`GeneralCompleter`
+- `python_tty/commands/mixins.py`：`CommandMixin` 及内置 mixins
+
+UI 与工具：
+- `python_tty/core/events.py`：`UIEvent`、`UIEventLevel`、`UIEventSpeaker`
+- `python_tty/ui/output.py`：`proxy_print`
+- `python_tty/utils/`：`tokenize.py`、`table.py`、`ui_logger.py`
+
+## V2 路线图
+
+Web + RPC 规划里程碑：
+- M1：Meta Descriptor v1 + Exporter
+- M2：RPC proto v1 + 本地序列化/反序列化
+- M3：Meta Web Server（HTTP + WS）
+- M4：RPC Server（mTLS + allowlist + audit）
+- M5：统一执行系统（CommandExecutor）

python_tty-0.1.1/pyproject.toml

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

python_tty-0.1.1/setup.cfg

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

python_tty-0.1.1/setup.py

@@ -0,0 +1,29 @@
+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",
+    version="0.1.1",
+    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",
+    ],
+    license="Apache-2.0",
+    classifiers=[
+        "License :: OSI Approved :: Apache Software License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3 :: Only",
+    ],
+)

python_tty-0.1.1/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.1/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.1/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.1/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.1/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.1/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.1/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
+