python-tty 0.1.2rc2__tar.gz → 0.1.5__tar.gz

python_tty-0.1.5/.github/workflows/python-publish.yml

@@ -0,0 +1,115 @@
+name: Build & Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+# workflow 级最小权限；发布 job 再单独提升 id-token
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    outputs:
+      is_prerelease: ${{ steps.tag.outputs.is_prerelease }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Upgrade packaging tools
+        run: |
+          python -m pip install -U pip setuptools wheel
+
+      - id: tag
+        name: Classify tag
+        shell: bash
+        run: |
+          set -euo pipefail
+          TAG="${GITHUB_REF_NAME}"
+          # 仅基于 tag 名判断（不含 refs/tags 前缀）
+          # 允许：
+          #   vX.Y.Z
+          #   vX.Y.ZaN / vX.Y.ZbN / vX.Y.ZrcN
+          #   vX.Y.Z.devN  或  vX.Y.ZdevN（两种都兼容）
+          if [[ "$TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+((a|b|rc)[0-9]+|(\.dev|dev)[0-9]+)$ ]]; then
+            echo "is_prerelease=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "is_prerelease=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Build dists
+        run: |
+          python -m pip install -U build
+          python -m build
+      - name: Verify version matches tag
+        shell: bash
+        run: |
+          set -euo pipefail
+          TAG_VERSION="${GITHUB_REF_NAME#v}"
+
+          python -m pip install -U pip
+          python -m pip install dist/*.whl
+
+          PKG_VERSION="$(python -c "import importlib.metadata as m; print(m.version('python-tty'))")"
+
+          echo "tag:  $TAG_VERSION"
+          echo "pkg:  $PKG_VERSION"
+
+          if [ "$TAG_VERSION" != "$PKG_VERSION" ]; then
+            echo "ERROR: Tag version ($TAG_VERSION) != package version ($PKG_VERSION)"
+            exit 1
+          fi
+          
+      - name: Upload dist artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+  publish_testpypi:
+    needs: build
+    if: needs.build.outputs.is_prerelease == 'true'
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish to TestPyPI (Trusted Publishing)
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+          verbose: true
+
+  publish_pypi:
+    needs: build
+    if: needs.build.outputs.is_prerelease != 'true'
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/python-tty
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish to PyPI (Trusted Publishing)
+        uses: pypa/gh-action-pypi-publish@release/v1

python_tty-0.1.5/.gitignore

@@ -0,0 +1,317 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+virEnv/
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+!*.code-workspace
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+# Covers JetBrains IDEs: IntelliJ, GoLand, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+.idea/
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+.idea/sonarlint.xml # see https://community.sonarsource.com/t/is-the-file-idea-idea-idea-sonarlint-xml-intended-to-be-under-source-control/121119
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based HTTP Client
+.idea/httpRequests
+http-client.private.env.json
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+# Apifox Helper cache
+.idea/.cache/.Apifox_Helper
+.idea/ApifoxUploaderProjectSetting.xml
+
+# Github Copilot persisted session migrations, see: https://github.com/microsoft/copilot-intellij-feedback/issues/712#issuecomment-3322062215
+.idea/**/copilot.data.migration.*.xml

{python_tty-0.1.2rc2/src/python_tty.egg-info → python_tty-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-tty
-Version: 0.1.2rc2
+Version: 0.1.5
 Summary: A multi-console TTY framework for complex CLI/TTY apps
 Home-page: https://github.com/ROOKIEMIE/python-tty
 Author: ROOKIEMIE
@@ -12,8 +12,12 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
+Requires-Dist: fastapi>=0.110.0
+Requires-Dist: grpcio>=1.60.0
 Requires-Dist: prompt_toolkit>=3.0.32
+Requires-Dist: protobuf>=4.25.0
 Requires-Dist: tqdm
+Requires-Dist: uvicorn>=0.27.0
 Dynamic: author
 Dynamic: classifier
 Dynamic: description

python_tty-0.1.5/demos/file_manager/__init__.py

@@ -0,0 +1,12 @@
+def injector(service):
+    def class_decorator(cls):
+        original_init = cls.__init__
+
+        def modified_init(self, *args, **kwargs):
+            self.service = service
+            original_init(self, *args, **kwargs)
+
+        cls.__init__ = modified_init
+        return cls
+
+    return class_decorator

python_tty-0.1.5/demos/file_manager/commands/__init__.py

@@ -0,0 +1,188 @@
+import enum
+import inspect
+import re
+import shlex
+from abc import ABC
+from functools import wraps
+
+from prompt_toolkit.completion import NestedCompleter
+from prompt_toolkit.document import Document
+from prompt_toolkit.validation import DummyValidator, Validator, ValidationError
+from demos.file_manager.consoles import proxy_print
+from demos.file_manager.exceptions.console_exception import ConsoleExit, ConsoleInitException
+from demos.file_manager.utils.table import Table
+
+
+class CommandStyle(enum.Enum):
+    NONE = 0  # ClassName => ClassName
+    LOWERCASE = 1  # ClassName => classname
+    UPPERCASE = 2  # ClassName => CLASSNAME
+    POWERSHELL = 3  # ClassName => Class-Name
+    SLUGIFIED = 4  # ClassName => class-name
+
+
+class CommandInfo:
+    def __init__(self, func_name, func_description,
+                 completer=None, validator=None,
+                 command_alias=None):
+        self.func_name = func_name
+        self.func_description = func_description
+        self.completer = completer
+        self.validator = validator
+        if command_alias is None:
+            self.alias = []
+        else:
+            if type(command_alias) == str:
+                self.alias = [command_alias]
+            elif type(command_alias) == list:
+                self.alias = command_alias
+            else:
+                self.alias = []
+
+
+def define_command_style(command_name, style):
+    if style == CommandStyle.NONE:
+        return command_name
+    elif style == CommandStyle.LOWERCASE:
+        return command_name.lower()
+    elif style == CommandStyle.UPPERCASE:
+        return command_name.upper()
+    command_name = re.sub(r'(.)([A-Z][a-z]+)', r'\1-\2', command_name)
+    command_name = re.sub(r'([a-z0-9])([A-Z])', r'\1-\2', command_name)
+    if style == CommandStyle.POWERSHELL:
+        return command_name
+    elif style == CommandStyle.SLUGIFIED:
+        return command_name.lower()
+
+
+def register_command(command_name: str, command_description: str, command_alias=None,
+                     command_style=CommandStyle.LOWERCASE,
+                     completer=None, validator=None):
+    def inner_wrapper(func):
+        func.info = CommandInfo(define_command_style(command_name, command_style), command_description,
+                                completer, validator, command_alias)
+        func.type = None
+
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            result = func(*args, **kwargs)
+            return result
+
+        return wrapper
+
+    return inner_wrapper
+
+
+class GeneralValidator(Validator, ABC):
+    def __init__(self, console, func):
+        self.console = console
+        self.func = func
+        super().__init__()
+
+
+class NoneArgumentValidator(GeneralValidator):
+    def __init__(self, console, func):
+        super().__init__(console, func)
+
+    def validate(self, document: Document) -> None:
+        sig = inspect.signature(self.func)
+        name_list = []
+        for name, param in sig.parameters.items():
+            name_list.append(name)
+        args = shlex.split(document.text)
+        if len(args) != (len(name_list) - 1):
+            raise ValidationError(message="Too many arguments!")
+
+
+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:
+        args_l = shlex.split(document.text.strip())
+        if len(args_l) <= 0:
+            return
+        cmd = args_l[0]
+        if cmd in self.command_validators.keys():
+            cmd_validator = self.command_validators[cmd]
+            cmd_validator.validate(Document(text=' '.join(args_l[1:])))
+        else:
+            if not self.enable_undefined_command:
+                raise ValidationError(message="Bad command")
+
+
+class BaseCommands:
+    def __init__(self, console):
+        self.console = console
+        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):
+        # Separate function and inner class
+        funcs = self._get_funcs()
+        self._collect_completer_and_validator(funcs)
+
+    def _get_funcs(self):
+        cls = self.__class__
+        funcs = []
+        for member_name in dir(cls):
+            # Skip all include '_' method
+            if member_name.startswith("_"):
+                continue
+            member = getattr(cls, member_name)
+            # Include 'type' attr should be collected
+            if (inspect.ismethod(member) or inspect.isfunction(member)) and hasattr(member, "type"):
+                funcs.append(member)
+        return funcs
+
+    def _collect_completer_and_validator(self, funcs):
+        if self.console is None:
+            raise ConsoleInitException("Console is None")
+        for func in funcs:
+            command_info: CommandInfo = func.info
+            self._map_components(command_info.func_name, func, command_info.completer, command_info.validator)
+            if len(command_info.alias) > 0:
+                for alia in command_info.alias:
+                    self._map_components(alia, func, command_info.completer, command_info.validator)
+
+    def _map_components(self, command_name, func, completer, validator):
+        self.command_funcs[command_name] = func
+        if completer is None:
+            self.command_completers[command_name] = None
+        else:
+            self.command_completers[command_name] = completer(self.console)
+        if validator is None:
+            self.command_validators[command_name] = DummyValidator()
+        else:
+            self.command_validators[command_name] = validator(self.console, func)
+
+    @register_command("quit", "Quit Console", "exit", validator=NoneArgumentValidator)
+    def run_quit(self):
+        raise ConsoleExit
+
+    @register_command("help", "Display help information", ["?"], validator=NoneArgumentValidator)
+    def run_help(self):
+        header = ["Command", "Description"]
+        base_funcs = []
+        customer_funcs = []
+        base_commands_funcs = [member[1] for member in inspect.getmembers(BaseCommands, inspect.isfunction)]
+        for name, func in self.command_funcs.items():
+            if func in base_commands_funcs:
+                base_funcs.append([name, func.info.func_description])
+            else:
+                customer_funcs.append([name, func.info.func_description])
+        proxy_print("")
+        proxy_print(Table(header, base_funcs, "Core Commands"))
+        proxy_print("")
+        proxy_print(Table(header, customer_funcs, "Customer Commands"))
+        proxy_print("")

python_tty-0.1.5/demos/file_manager/commands/root_commands.py

@@ -0,0 +1,51 @@
+import inspect
+import shlex
+
+from prompt_toolkit.completion import WordCompleter
+from prompt_toolkit.document import Document
+from prompt_toolkit.validation import ValidationError
+
+from demos.file_manager.commands import BaseCommands, register_command, GeneralValidator
+from demos.file_manager.consoles import proxy_print
+
+
+class RootCommands(BaseCommands):
+    # def enable_undefined_command(self):
+    #     return True
+
+    class EnvValidator(GeneralValidator):
+        def __init__(self, console, func):
+            super().__init__(console, func)
+
+        def validate(self, document: Document) -> None:
+            sig = inspect.signature(self.func)
+            name_list = []
+            for name, param in sig.parameters.items():
+                name_list.append(name)
+            name_list = name_list[1:]
+            args = shlex.split(document.text)
+            if len(args) <= 0:
+                raise ValidationError(message="At least one parameter is missing")
+            elif len(args) > len(name_list):
+                raise ValidationError(message="Too many parameter to get")
+
+    class EnvCompleter(WordCompleter):
+        def __init__(self, console):
+            super().__init__(console.service.env_keys)
+
+    @register_command("env", "Display env information", [], completer=EnvCompleter, validator=EnvValidator)
+    def run_env(self, env_key):
+        proxy_print()
+        table = ""
+        if env_key == "disk":
+            table = self.console.service.display_disks()
+        elif env_key == "os":
+            table = self.console.service.display_os()
+        elif env_key == "network":
+            table = self.console.service.display_network()
+        proxy_print(table)
+        proxy_print()
+
+
+if __name__ == '__main__':
+    pass