untils 1.0.0__tar.gz

untils-1.0.0/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: untils
+Version: 1.0.0
+Summary: Light-weight library for console games or small utils to process user input as commands and describe structure with config.
+Author: BesBobowyy
+Project-URL: GitHub, https://github.com/BesBobowyy/untils
+Keywords: cli,console,lightweight
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: README.md
+Provides-Extra: test
+Requires-Dist: pytest>=9.0.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.6.0; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Dynamic: license-file
+
+# Welcome to `untils`
+
+![Version](https://img.shields.io/badge/version-1.0.0-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+![Python](https://img.shields.io/badge/python-3.12-yellow)
+
+*untils* - Is light-weight library for console games or small utils to process user input as commands and describe structure with config.
+
+## Abilities
+
+- Module-based config in markup line.
+- Custom logic in OOP.
+- Validation and parsing user input for 10 lines.
+- Process exceptions.
+- Almost-perfect detailed annotations everywhere.
+- Fast command processing (~208µs).
+- Infinitely extendable abilities.
+- Calm about anything.
+
+## Architecture
+
+This library was builded with next architecture:
+
+![Architecture diagramm.](docs/assets/diagramm0.svg)
+
+## Installation
+
+```bash
+pip install untils
+```
+
+## Documentation
+
+[Start Course](start-guide/01-first-project.md "Beginner course into the library.")
+
+[API Reference](api-reference.md)
+
+## Roadmap
+
+I have resolve my thoughs to several categories:
+
+1. **Main**:
+    - [ ] Add command description in `"description"` field.
+    - [ ] Add reserved commands in format like internal state name: `"__help__"` - Get all and available commands.
+
+2. **Additional**:
+    - [ ] ...
+
+3. **Conceptions**:
+    - [ ] Typing system in config through `"type"` field.

untils-1.0.0/README.md

@@ -0,0 +1,50 @@
+# Welcome to `untils`
+
+![Version](https://img.shields.io/badge/version-1.0.0-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+![Python](https://img.shields.io/badge/python-3.12-yellow)
+
+*untils* - Is light-weight library for console games or small utils to process user input as commands and describe structure with config.
+
+## Abilities
+
+- Module-based config in markup line.
+- Custom logic in OOP.
+- Validation and parsing user input for 10 lines.
+- Process exceptions.
+- Almost-perfect detailed annotations everywhere.
+- Fast command processing (~208µs).
+- Infinitely extendable abilities.
+- Calm about anything.
+
+## Architecture
+
+This library was builded with next architecture:
+
+![Architecture diagramm.](docs/assets/diagramm0.svg)
+
+## Installation
+
+```bash
+pip install untils
+```
+
+## Documentation
+
+[Start Course](start-guide/01-first-project.md "Beginner course into the library.")
+
+[API Reference](api-reference.md)
+
+## Roadmap
+
+I have resolve my thoughs to several categories:
+
+1. **Main**:
+    - [ ] Add command description in `"description"` field.
+    - [ ] Add reserved commands in format like internal state name: `"__help__"` - Get all and available commands.
+
+2. **Additional**:
+    - [ ] ...
+
+3. **Conceptions**:
+    - [ ] Typing system in config through `"type"` field.

untils-1.0.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "untils"
+version = "1.0.0"
+authors = [{name = "BesBobowyy"}]
+description = "Light-weight library for console games or small utils to process user input as commands and describe structure with config."
+readme = "README.md"
+license-files = ["README.md"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14"
+]
+requires-python = ">=3.12"
+keywords = ["cli", "console", "lightweight"]
+
+[project.optional-dependencies]
+test = ["pytest>=9.0.0"]
+docs = ["mkdocs>=1.6.0", "mkdocs-material"]
+
+[tool.pytest]
+minversion = "9.0"
+addopts = ["-v"]
+testpaths = [
+    "tests",
+]
+
+[project.urls]
+GitHub = "https://github.com/BesBobowyy/untils"

untils-1.0.0/setup.cfg

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

untils-1.0.0/src/untils/__init__.py

@@ -0,0 +1,28 @@
+"""*untils* - Is light-weight library for console games or small utils to process user input as commands and describe structure with config."""
+
+# pyright: reportUnusedImport=false
+# ^^^^^^^ (Public imports.)
+
+from untils import utils
+
+from untils.command_system import CommandSystem
+from untils.command import (
+    AliasNode, CommandNode, CommandWordNode, CommandFallbackNode, CommandFlagNode,
+    CommandOptionNode, StateNode
+)
+from untils.commands_config import CommandsConfig
+from untils.config_validator import ConfigValidator
+from untils.factories import CommandNodeFactory
+from untils.input_token import (
+    RawInputToken, FinalInputTokenWord, FinalInputTokenFlag, FinalInputTokenOption
+)
+from untils.input_validator import InputValidator, ParsedInputValidator
+from untils.ioreader import IOReader
+from untils.iovalidator import IOValidator
+from untils.parser import Parser
+from untils.processor import Processor
+from untils.settings import Settings
+from untils.tokenizer import Tokenizer
+
+__version__ = "1.0.0"
+__author__ = "BesBobowyy"

untils-1.0.0/src/untils/command.py

@@ -0,0 +1,130 @@
+"""command.py - Command nodes."""
+
+from typing import List, Any
+
+from dataclasses import dataclass
+
+from untils.utils.type_aliases import CommandType
+
+@dataclass(frozen=True)
+class AliasNode():
+    """Command alias name container."""
+
+    original_name: str
+    """Original command name."""
+    alias_name: str
+    """Alias name."""
+
+    def __str__(self) -> str:
+        return f"AliasNode('{self.original_name}' -> '{self.alias_name}')"
+
+    def __eq__(self, value: object) -> bool:
+        if isinstance(value, AliasNode):
+            return self.original_name == value.original_name and self.alias_name == value.alias_name
+        if isinstance(value, CommandNode):
+            if value.type == "fallback":
+                return False
+            return self.original_name == value.name
+        if isinstance(value, str):
+            return self.original_name == value and self.alias_name == value
+        return False
+
+    def __ne__(self, value: object) -> bool:
+        if isinstance(value, AliasNode):
+            return self.original_name != value.original_name or self.alias_name != value.alias_name
+        if isinstance(value, CommandNode):
+            if value.type == "fallback":
+                return True
+            return self.original_name != value.name
+        if isinstance(value, str):
+            return self.original_name != value or self.alias_name != value
+        return True
+
+@dataclass(frozen=True)
+class CommandNode:
+    """Universal template for command nodes."""
+
+    name: str
+    """Command name."""
+    type: CommandType
+    """Command type."""
+
+    def __eq__(self, value: object) -> bool:
+        if isinstance(value, CommandNode):
+            return self.name == value.name and self.type == value.type
+        if isinstance(value, str):
+            if self.type != "fallback":
+                return self.name == value
+            return True
+        return False
+
+    def __ne__(self, value: object) -> bool:
+        if isinstance(value, CommandNode):
+            return self.name != value.name or self.type != value.type
+        if isinstance(value, str):
+            if self.type != "fallback":
+                return self.name != value
+            return False
+        return True
+
+@dataclass(frozen=True)
+class CommandWordNode(CommandNode):
+    """The word command type."""
+
+    aliases: List[AliasNode]
+    """Command aliases."""
+    children: List[CommandNode]
+    """Next commands below this."""
+
+    def __str__(self) -> str:
+        return f"CommandWordNode[{self.name} : {self.aliases}]{self.children}"
+
+@dataclass(frozen=True)
+class CommandFallbackNode(CommandNode):
+    """Command node for fallback type."""
+
+    default: str
+    """A default value."""
+    children: List[CommandNode]
+    """Next commands below this."""
+
+    def __str__(self) -> str:
+        return f"CommandFallbackNode[{self.name}](default='{self.default}'){self.children}"
+
+@dataclass(frozen=True)
+class CommandFlagNode(CommandNode):
+    """Command node for flag type."""
+
+    aliases: List[AliasNode]
+    """Command aliases."""
+    default: Any
+    """A default value."""
+
+    def __str__(self) -> str:
+        return f"CommandFlagNode[{self.name} : {self.aliases}](default={repr(self.default)})"
+
+@dataclass(frozen=True)
+class CommandOptionNode(CommandNode):
+    """Command node for option type."""
+
+    aliases: List[AliasNode]
+    """Command aliases."""
+    default: Any
+    """A default value."""
+
+    def __str__(self) -> str:
+        return f"CommandOptionNode[{self.name} : {self.aliases}](default={repr(self.default)})"
+
+@dataclass(frozen=True)
+class StateNode:
+    """A state node in config."""
+
+    name: str
+    """The state name."""
+    is_internal: bool
+    """Is internal state, which typed in the format `__{name}__`."""
+    commands: List[str]
+    """Allowed commands by this state."""
+
+    def __str__(self) -> str:
+        return f"StateNode[{'!' if self.is_internal else ''}{self.name}]{self.commands}"