termkit 0.2.3__tar.gz → 0.2.4__tar.gz

{termkit-0.2.3 → termkit-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: termkit
-Version: 0.2.3
+Version: 0.2.4
 Summary: Python command line application framework
 License: MIT
 Author: Thomas Mahé

{termkit-0.2.3 → termkit-0.2.4}/pyproject.toml

@@ -3,7 +3,7 @@
 
 [tool.poetry]
 name = "termkit"
-version = "0.2.3"
+version = "0.2.4"
 description = "Python command line application framework"
 authors = ["Thomas Mahé <contact@tmahe.dev>"]
 license = "MIT"

{termkit-0.2.3 → termkit-0.2.4}/setup.py

@@ -9,7 +9,7 @@ package_data = \
 
 setup_kwargs = {
     'name': 'termkit',
-    'version': '0.2.3',
+    'version': '0.2.4',
     'description': 'Python command line application framework',
     'long_description': '<p align="center">\n    <img alt="Termkit" title="Termkit" src="docs/images/banner.png#gh-dark-mode-only" width="450">\n    <img alt="Termkit" title="Termkit" src="docs/images/banner_light.png#gh-light-mode-only" width="450">\n</p>\n<div align="center">\n  <b><i>Command Line Tools with... ease.</i></b>\n<hr>\n\n</div>\n\n## Introduction\n\nTermkit is a Python framework designed for building command line interface applications using functions \nand type hints [[PEP 484]](https://peps.python.org/pep-0484/). \n**Solely written using [Python Standard Library](https://docs.python.org/3/library/)** and will always be to ensure\nminimal dependency footprint within your project.\n\n## Features\n\n- Build CLI Tools from functional code\n- Create fast prototypes using implicit arguments\n- Compatible with [argcomplete](https://pypi.org/project/argcomplete/) for autocompletion\n\n## Usage\n\nTo get started, follow these steps:\n\n#### 1. Install Termkit using pip\n```shell\n$ pip install termkit\n```\n#### 2. Test it with given example\n\n```python\n# app.py\nfrom termkit import Termkit\n\napp = Termkit()\n\n@app.command()\ndef greet(name, count=2):\n    for _ in range(count):\n        print(name)\n\nif __name__ == "__main__":\n    app()\n\n```\n```shell\n$ python3 ./app.py "Hello Termkit" --count 3\nHello Termkit\nHello Termkit\nHello Termkit\n```\n\n\n## Work in Progress Disclaimer\n\n🛠️ **Please Note: This documentation is a work in progress.** 🛠️\n\nTermkit is constantly evolving, and we are actively working on expanding and improving this documentation. Some sections may be incomplete or subject to change. We appreciate your patience and understanding as we continue to enhance this resource.\n\nIf you have any questions or encounter any issues while using Termkit, please feel free to reach me at [contact@tmahe.dev](mailto:contact@tmahe.dev).\n\nThank you for being a part of Termkit journey! 🌟\n',
     'author': 'Thomas Mahé',

{termkit-0.2.3 → termkit-0.2.4}/termkit/arguments.py

@@ -12,7 +12,7 @@ from termkit.groups import _TermkitGroup, get_parser_from_group
 
 
 class _TermkitArgument:
-    _ignored_params = ["flags", "group"]
+    _ignored_params = ["flags", "group", "help"]
 
     @abstractmethod
     def _populate(self, parser: argparse.ArgumentParser, dest: str, help: str):
@@ -34,11 +34,13 @@ class Positional(_TermkitArgument):
         metavar: Optional[str] = None,
         nargs: Optional[typing.Union[int, str]] = None,
         choices: Optional[typing.Container] = None,
+        help: Optional[str] = None,
     ):
         self.type = type
         self.metavar = metavar
         self.nargs = nargs
         self.choices = choices
+        self.help = help
 
     def _populate(self, parser: argparse.ArgumentParser, dest: str, help: str):
         parser.add_argument(dest, **self.argparse_params, help=help)
@@ -55,6 +57,7 @@ class Option(_TermkitArgument):
         group: Optional[_TermkitGroup] = None,
         nargs: Optional[typing.Union[int, str]] = None,
         choices: Optional[typing.Container] = None,
+        help: Optional[str] = None,
     ):
         self.flags = flags
         self.type = type
@@ -64,24 +67,27 @@ class Option(_TermkitArgument):
         self.default = default
         self.group = group
         self.choices = choices
+        self.help = help
 
     def _populate(self, parser: argparse.ArgumentParser, dest: str, help: str):
         parser = get_parser_from_group(parser, self.group)
-        parser.add_argument(*self.flags, **self.argparse_params, dest=dest, help=help)
+        parser.add_argument(*sorted(self.flags, key=len), **self.argparse_params, dest=dest, help=help)
 
 
 class Flag(_TermkitArgument):
-    _ignored_params = ["flags", "type", "group"]
+    _ignored_params = ["flags", "type", "group", "help"]
 
     def __init__(
         self,
         *flags: str,
         store: Optional[typing.Any] = True,
         group: Optional[_TermkitGroup] = None,
+        help: Optional[str] = None,
     ):
         self.flags = flags
         self.type = None
         self.group = group
+        self.help = help
         if store is True:
             self.action = "store_true"
         if store is False:
@@ -92,4 +98,4 @@ class Flag(_TermkitArgument):
 
     def _populate(self, parser: argparse.ArgumentParser, dest: str, help: str):
         parser = get_parser_from_group(parser, self.group)
-        parser.add_argument(*self.flags, **self.argparse_params, dest=dest, help=help)
+        parser.add_argument(*sorted(self.flags, key=len), **self.argparse_params, dest=dest, help=help)

{termkit-0.2.3 → termkit-0.2.4}/termkit/parser.py

@@ -16,11 +16,14 @@ __BUILTIN_TYPES__ = [str, int, float, complex, bool]
 
 class TermkitParser(argparse.ArgumentParser):
     def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs, add_help=False)
 
         self._optionals.title = "Options"
         self._positionals.title = "Positionals"
 
+        self.add_argument('-h', '--help', action='help', default=argparse.SUPPRESS,
+                          help='Show this help message and exit')
+
         if kwargs.get("formatter_class", None) is None:
             self.formatter_class = TermkitDefaultFormatter
 
@@ -56,6 +59,7 @@ class ArgumentHandler:
                 elif typing.get_origin(param.annotation) is typing.Annotated:
                     _type, option = typing.get_args(param.annotation)
                     if isinstance(option, _TermkitArgument):
+                        param_help = option.help if option.help is not None else param_help
                         option._populate(self.parser, dest=param_name, help=param_help)
 
             # f(param : <annotation> = <default>)