janware/jw-pkg
1
Code Pull requests Activity Actions

lib.Cmd: Add description property

Browse source 
Add keyword-argument description to Cmd.__init__(), and default it to help. Also, add a property .description returning it, and add it to add_parser() so that it shows up in the usage message.
Signed-off-by: Jan Lindemann <jan@janware.com>
This commit is contained in:
Jan Lindemann 2026-04-24 11:53:49 +02:00
commit cc6febcda3
Signed by: Jan Lindemann
GPG key ID: 3750640C9E25DD61
2 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/python/jw/pkg/lib/App.py
View file

@ -27,7 +27,12 @@ class App: # export
def __init__(self, description: str = '', name_filter: str = '^Cmd.*', modules: None=None, eloop: None=None) -> None: def __init__(self, description: str = '', name_filter: str = '^Cmd.*', modules: None=None, eloop: None=None) -> None:
def add_cmd_to_parser(cmd, parsers): def add_cmd_to_parser(cmd, parsers):
parser = parsers.add_parser(cmd.name, help=cmd.help, formatter_class=argparse.ArgumentDefaultsHelpFormatter) parser = parsers.add_parser(
cmd.name,
help = cmd.help,
description = cmd.description,
formatter_class = argparse.ArgumentDefaultsHelpFormatter,
)
parser.set_defaults(func=cmd.run) parser.set_defaults(func=cmd.run)
cmd.add_arguments(parser) cmd.add_arguments(parser)
cmd.set_parser(parser) cmd.set_parser(parser)

7
src/python/jw/pkg/lib/Cmd.py
View file

@ -12,12 +12,13 @@ from .Types import Types
class Cmd(abc.ABC): # export class Cmd(abc.ABC): # export
def __init__(self, parent: App|Cmd, name: str, help: str) -> None: def __init__(self, parent: App|Cmd, name: str, help: str, description: str|None=None) -> None:
from . import App from . import App
self.__parent: App|Cmd|None = parent self.__parent: App|Cmd|None = parent
self.__app: App|None = None self.__app: App|None = None
self.__name = name self.__name = name
self.__help = help self.__help = help
self.__description = description if description else help
self.__children: list[Cmd] = [] self.__children: list[Cmd] = []
self.__child_classes: list[type[Cmd]] = [] self.__child_classes: list[type[Cmd]] = []
self.__parser: ArgumentParser|None = None self.__parser: ArgumentParser|None = None
@ -67,6 +68,10 @@ class Cmd(abc.ABC): # export
def help(self) -> str: def help(self) -> str:
return self.__help return self.__help
@property
def description(self) -> str:
return self.__description
@property @property
def children(self) -> list[Cmd]: def children(self) -> list[Cmd]:
return tuple(self.__children) return tuple(self.__children)