xkits-command 0.6__py3-none-any.whl

xkits_command/__init__.py

@@ -0,0 +1,9 @@
+# coding:utf-8
+
+from xkits_command.actuator import Command  # noqa:F401
+from xkits_command.actuator import CommandArgument  # noqa:F401,H306
+from xkits_command.actuator import CommandCreation  # noqa:F401
+from xkits_command.actuator import CommandDeletion  # noqa:F401
+from xkits_command.actuator import CommandExecutor  # noqa:F401
+from xkits_command.actuator import Namespace  # noqa:F401
+from xkits_command.parser import ArgParser  # noqa:F401

xkits_command/actuator.py

@@ -0,0 +1,724 @@
+# coding:utf-8
+
+from argparse import Namespace
+from errno import ECANCELED
+from errno import EINVAL
+from errno import ENOENT
+from errno import ENOTRECOVERABLE
+import logging
+from logging import Logger
+from os import getenv
+import sys
+from typing import Any
+from typing import Callable
+from typing import Dict
+from typing import List
+from typing import Optional
+from typing import Sequence
+from typing import Tuple
+
+from xkits_logger.logger import Logger as Log
+
+from xkits_command.attribute import __project_name__
+from xkits_command.parser import ArgParser
+
+
+class CommandArgument:
+    """Define a new command-line node.
+
+    For example:
+
+    >>> from xkits_command import ArgParser\n
+    >>> from xkits_command import CommandArgument\n
+
+    >>> @CommandArgument("example")\n
+    >>> def cmd(_arg: ArgParser):\n
+    >>>     _arg.add_opt_on("-t", "--test")\n
+    """
+
+    def __init__(self, name: str, **kwargs):
+        """Initialize the node.
+
+        @param name: Node name
+        @type name: str
+
+        @param description: Text to display before the argument help
+        @type description: str (by default, no text)
+
+        @param epilog: Text to display after the argument help
+        @type epilog: str (by default, no text)
+
+        @param help: Help message as a subcommand
+        @type help: str
+
+        @param add_help: Add a -h/--help option to the node
+        @type add_help: bool (default: True)
+        """
+        if "help" in kwargs and "description" not in kwargs:
+            kwargs["description"] = kwargs["help"]
+        if "description" in kwargs and "help" not in kwargs:
+            kwargs["help"] = kwargs["description"]
+        self.__name: str = name
+        self.__prev: CommandArgument = self
+        self.__cmds: Command = Command()
+        self.__options: Dict[str, Any] = kwargs
+        self.__bind: Optional[CommandExecutor] = None
+        self.__subs: Optional[Tuple[CommandArgument, ...]] = None
+        self.__func: Optional[Callable[[ArgParser], None]] = None
+
+    def __call__(self, cmd_func: Callable[[ArgParser], None]):
+        self.__func = cmd_func
+        return self
+
+    @property
+    def func(self) -> Callable[[ArgParser], None]:
+        if self.__func is None:
+            raise ValueError("No function")  # pragma: no cover
+        return self.__func
+
+    @property
+    def name(self) -> str:
+        return self.__name
+
+    @property
+    def root(self) -> "CommandArgument":
+        root = self.__prev
+        while root.prev != root:
+            root = root.prev
+        return root
+
+    @property
+    def prev(self) -> "CommandArgument":
+        return self.__prev
+
+    @prev.setter
+    def prev(self, value: "CommandArgument"):
+        assert isinstance(value, CommandArgument)
+        self.__prev = value
+
+    @property
+    def cmds(self) -> "Command":
+        return self.__cmds
+
+    @property
+    def options(self) -> Dict[str, Any]:
+        return self.__options
+
+    @property
+    def bind(self) -> Optional["CommandExecutor"]:
+        return self.__bind
+
+    @bind.setter
+    def bind(self, value: "CommandExecutor"):
+        assert isinstance(value, CommandExecutor)
+        self.__bind = value
+
+    @property
+    def subs(self) -> Optional[Tuple["CommandArgument", ...]]:
+        return self.__subs
+
+    @subs.setter
+    def subs(self, value: Tuple["CommandArgument", ...]):
+        assert isinstance(value, Tuple)
+        for sub in value:
+            assert isinstance(sub, CommandArgument)
+        self.__subs = value
+
+    @property
+    def sub_dest(self) -> str:
+        node: CommandArgument = self
+        subs: List[str] = [self.name]
+        while node.prev is not node:
+            node = node.prev
+            subs.insert(0, node.name)
+        name = "_".join(subs)
+        return f"__sub_dest_{name}__"
+
+
+class CommandExecutor:
+    """Define the main callback function, and bind it to a node and
+    all subcommands.
+
+    For example:
+
+    >>> from xkits_command import Command\n
+    >>> from xkits_command import CommandExecutor\n
+
+    >>> @CommandExecutor(cmd, cmd_get, cmd_set)\n
+    >>> def run(cmds: Command) -> int:\n
+    >>>     return 0\n
+    """
+
+    def __init__(self, cmd_bind: CommandArgument, *sub_cmds: CommandArgument,
+                 skip: bool = False):
+        """Initialize the node.
+
+        @param cmd_bind: Bind to a root command node
+        @type name: CommandArgument
+
+        @param *sub_cmds: All required subcommands
+        @type *sub_cmds: CommandArgument
+
+        @param skip: This node (CommandExecutor, CommandCreation and
+        CommandDeletion) does not run when a subcommand is specified,
+        run this node without any subcommands
+        @type skip: bool (default: False)
+        """
+        assert isinstance(cmd_bind, CommandArgument)
+        assert isinstance(skip, bool)
+        cmd_bind.bind = self
+        cmd_bind.subs = sub_cmds
+        for sub in sub_cmds:
+            sub.prev = cmd_bind
+        cmd_bind.cmds.root = cmd_bind.root
+        self.__skip: bool = skip
+        self.__bind: CommandArgument = cmd_bind
+        self.__prep: Optional["CommandCreation"] = None
+        self.__done: Optional["CommandDeletion"] = None
+        self.__func: Optional[Callable[["Command"], int]] = None
+
+    def __call__(self, run_func: Callable[["Command"], int]):
+        self.__func = run_func
+        return self
+
+    @property
+    def func(self) -> Callable[["Command"], int]:
+        if self.__func is None:
+            raise ValueError("No function")  # pragma: no cover
+        return self.__func
+
+    @property
+    def bind(self) -> CommandArgument:
+        return self.__bind
+
+    @property
+    def prep(self) -> Optional["CommandCreation"]:
+        return self.__prep
+
+    @prep.setter
+    def prep(self, value: "CommandCreation"):
+        assert isinstance(value, CommandCreation)
+        self.__prep = value
+
+    @property
+    def done(self) -> Optional["CommandDeletion"]:
+        return self.__done
+
+    @done.setter
+    def done(self, value: "CommandDeletion"):
+        assert isinstance(value, CommandDeletion)
+        self.__done = value
+
+    @property
+    def skip(self) -> bool:
+        return self.__skip
+
+
+class CommandCreation:
+    """Define prepare callback function, and bind it with main callback.
+
+    For example:
+
+    >>> from xkits_command import Command\n
+    >>> from xkits_command import CommandCreation\n
+    >>> from xkits_command import CommandExecutor\n
+
+    >>> @CommandExecutor(cmd, cmd_get, cmd_set)\n
+    >>> def run(cmds: Command) -> int:\n
+    >>>     return 0\n
+
+    >>> @CommandCreation(run)\n
+    >>> def pre(cmds: Command) -> int:\n
+    >>>     return 0\n
+    """
+
+    def __init__(self, run_bind: CommandExecutor):
+        """Initialize the node.
+
+        @param cmd_bind: Bind to a root command node
+        @type name: CommandArgument
+        """
+        assert isinstance(run_bind, CommandExecutor)
+        run_bind.prep = self
+        self.__main: CommandExecutor = run_bind
+        self.__func: Optional[Callable[["Command"], int]] = None
+
+    def __call__(self, run_func: Callable[["Command"], int]):
+        self.__func = run_func
+        return self
+
+    @property
+    def func(self) -> Callable[["Command"], int]:
+        if self.__func is None:
+            raise ValueError("No function")  # pragma: no cover
+        return self.__func
+
+    @property
+    def main(self) -> CommandExecutor:
+        return self.__main
+
+
+class CommandDeletion:
+    """Define purge callback function, and bind it with main callback.
+
+    For example:
+
+    >>> from xkits_command import Command\n
+    >>> from xkits_command import CommandDeletion\n
+    >>> from xkits_command import CommandExecutor\n
+
+    >>> @CommandExecutor(cmd, cmd_get, cmd_set)\n
+    >>> def run(cmds: Command) -> int:\n
+    >>>     return 0\n
+
+    >>> @CommandDeletion(run)\n
+    >>> def end(cmds: Command) -> int:\n
+    >>>     return 0\n
+    """
+
+    def __init__(self, run_bind: CommandExecutor):
+        """Initialize the node.
+
+        @param cmd_bind: Bind to a root command node
+        @type name: CommandArgument
+        """
+        assert isinstance(run_bind, CommandExecutor)
+        run_bind.done = self
+        self.__main: CommandExecutor = run_bind
+        self.__func: Optional[Callable[["Command"], int]] = None
+
+    def __call__(self, run_func: Callable[["Command"], int]):
+        self.__func = run_func
+        return self
+
+    @property
+    def func(self) -> Callable[["Command"], int]:
+        if self.__func is None:
+            raise ValueError("No function")  # pragma: no cover
+        return self.__func
+
+    @property
+    def main(self) -> CommandExecutor:
+        return self.__main
+
+
+class Command(Log):
+    """Singleton command-line tool based on argparse.
+
+    Define and bind all callback functions before calling run() or parse().
+
+    For example:
+
+    >>> from typing import Optional\n
+    >>> from typing import Sequence\n
+
+    >>> from xkits_command import ArgParser\n
+    >>> from xkits_command import Command\n
+    >>> from xkits_command import CommandArgument\n
+    >>> from xkits_command import CommandCreation\n
+    >>> from xkits_command import CommandDeletion\n
+    >>> from xkits_command import CommandExecutor\n
+
+    >>> @CommandArgument("example")\n
+    >>> def cmd(_arg: ArgParser):\n
+    >>>     _arg.add_opt_on("-t", "--test")\n
+
+    >>> @CommandExecutor(cmd, cmd_get, cmd_set)\n
+    >>> def run(cmds: Command) -> int:\n
+    >>>     return 0\n
+
+    >>> @CommandCreation(run)\n
+    >>> def pre(cmds: Command) -> int:\n
+    >>>     return 0\n
+
+    >>> @CommandDeletion(run)\n
+    >>> def end(cmds: Command) -> int:\n
+    >>>     return 0\n
+
+    >>> def main(argv: Optional[Sequence[str]] = None) -> int:\n
+    >>>     return Command().run(\n
+    >>>         root=cmd,\n
+    >>>         argv=argv,\n
+    >>>         prog="xkits-command-example",\n
+    >>>         description="Simple command-line tool based on argparse.")\n
+    """
+
+    LOGGER_ARGUMENT_GROUP = "logger options"
+
+    __INSTANCE: Optional["Command"] = None
+    __INITIALIZED: bool = False
+
+    def __init__(self):
+        if not self.__INITIALIZED:
+            self.__prog: str = __project_name__
+            self.__root: Optional[CommandArgument] = None
+            self.__args: Namespace = Namespace()
+            self.__version: Optional[str] = None
+            self.__enabled_logger: bool = True
+            self.__INITIALIZED = True
+            super().__init__()
+
+    def __new__(cls):
+        if not cls.__INSTANCE:
+            cls.__INSTANCE = super(Command, cls).__new__(cls)
+        return cls.__INSTANCE
+
+    @property
+    def prog(self) -> str:
+        return self.__prog
+
+    @property
+    def root(self) -> Optional[CommandArgument]:
+        """Root Command."""
+        return self.__root
+
+    @root.setter
+    def root(self, value: CommandArgument):
+        assert isinstance(value, CommandArgument)
+        self.__root = value
+
+    @property
+    def args(self) -> Namespace:
+        """Namespace after parse arguments."""
+        assert isinstance(self.__args, Namespace)
+        return self.__args
+
+    @args.setter
+    def args(self, value: Namespace):
+        assert isinstance(value, Namespace)
+        self.__args = value
+
+    @property
+    def version(self) -> Optional[str]:
+        """Custom version for "-v" or "--version" output."""
+        return self.__version
+
+    @version.setter
+    def version(self, value: str):
+        assert isinstance(value, str)
+        _version = value.strip()
+        self.__version = _version
+
+    @property
+    def enabled_logger(self) -> bool:
+        return self.__enabled_logger
+
+    @enabled_logger.setter
+    def enabled_logger(self, value: bool):
+        assert isinstance(value, bool)
+        self.__enabled_logger = value
+
+    @property
+    def logger(self) -> Logger:
+        """Logger."""
+        return self.get_logger(self.prog)
+
+    def __add_optional_version(self, _arg: ArgParser):
+        version = self.version
+        if not isinstance(version, str):
+            return  # pragma: no cover
+
+        options = _arg.filter_optional_name("-v", "--version")
+        if len(options) > 0:
+            _arg.add_argument(*options, action="version",
+                              version=f"%(prog)s {version.strip()}")
+
+    def __add_inner_parser_tail(self, _arg: ArgParser):
+
+        def filter_optional_name(*name: str) -> Optional[str]:
+            options = _arg.filter_optional_name(*name)
+            if len(options) > 0:
+                for i in name:
+                    if i in options:
+                        return i
+            return None
+
+        def add_optional_level():
+            group = _arg.argument_group(self.LOGGER_ARGUMENT_GROUP)
+            group_level = group.add_mutually_exclusive_group()
+
+            option_level = filter_optional_name("--level", "--log-level")
+            if isinstance(option_level, str):
+                DEF_LOG_LEVEL: str = getenv("LOG_LEVEL", self.LOG_LEVELS.INFO.value).lower()  # noqa:E501
+                group_level.add_argument(
+                    option_level,
+                    type=str,
+                    nargs="?",
+                    const=DEF_LOG_LEVEL,
+                    default=DEF_LOG_LEVEL,
+                    choices=self.ALLOWED_LOG_LEVELS,
+                    dest="_log_level_str_",
+                    help=f"Logger output level, default is {DEF_LOG_LEVEL}.")
+
+            for level in self.ALLOWED_LOG_LEVELS:
+                options = []
+                if isinstance(filter_optional_name(f"-{level[0]}"), str):
+                    options.append(f"-{level[0]}")
+                if isinstance(filter_optional_name(f"--{level}"), str):
+                    options.append(f"--{level}")
+                elif isinstance(filter_optional_name(f"--{level}-level"), str):
+                    options.append(f"--{level}-level")
+
+                if not options:
+                    continue
+                group_level.add_argument(*options,
+                                         action="store_const",
+                                         const=level,
+                                         dest="_log_level_str_",
+                                         help=f"Logger level set to {level}.")
+
+        def add_optional_stream():
+            option = filter_optional_name("--log", "--log-file")
+            if not isinstance(option, str):
+                return
+
+            group = _arg.argument_group(self.LOGGER_ARGUMENT_GROUP)
+            group.add_argument(option,
+                               type=str,
+                               nargs=1,
+                               default=[],
+                               metavar="FILE",
+                               action="extend",
+                               dest="_log_files_",
+                               help="Logger output to file.")
+
+        def add_optional_format():
+            option = filter_optional_name("--format", "--log-format")
+            if not isinstance(option, str):
+                return
+
+            DEFAULT_LOG_FMT = "%(log_color)s%(asctime)s"\
+                " %(process)d %(threadName)s %(levelname)s"\
+                " %(funcName)s %(filename)s:%(lineno)s"\
+                " %(message)s"
+
+            group = _arg.argument_group(self.LOGGER_ARGUMENT_GROUP)
+            group.add_argument(option,
+                               type=str,
+                               nargs="?",
+                               const=DEFAULT_LOG_FMT,
+                               default=self.DEFAULT_LOG_FORMAT,
+                               metavar="STRING",
+                               dest="_log_format_",
+                               help="Logger output format.")
+
+        def add_optional_console():
+            group = _arg.argument_group(self.LOGGER_ARGUMENT_GROUP)
+            group_std = group.add_mutually_exclusive_group()
+
+            option = filter_optional_name("--stdout", "--log-stdout")
+            if isinstance(option, str):
+                group_std.add_argument(option,
+                                       const=sys.stdout,
+                                       action="store_const",
+                                       dest="_log_console_",
+                                       help="Logger output to stdout.")
+
+            option = filter_optional_name("--stderr", "--log-stderr")
+            if isinstance(option, str):
+                group_std.add_argument(option,
+                                       const=sys.stderr,
+                                       action="store_const",
+                                       dest="_log_console_",
+                                       help="Logger output to stderr.")
+
+        if self.enabled_logger:
+            add_optional_level()
+            add_optional_stream()
+            add_optional_format()
+            add_optional_console()
+
+    def __parse_logger(self, args: Namespace):
+        if not self.enabled_logger:
+            return
+
+        def parse_format() -> Optional[str]:
+            if hasattr(args, "_log_format_"):
+                fmt = getattr(args, "_log_format_")
+                if isinstance(fmt, str):
+                    return fmt
+            return None
+
+        def parse_level() -> Optional[str]:
+            if hasattr(args, "_log_level_str_"):
+                level = getattr(args, "_log_level_str_")
+                if isinstance(level, str):
+                    return level.upper()
+            return None
+
+        def parse_console() -> Optional[Any]:
+            return getattr(args, "_log_console_", None)
+
+        def parse_files() -> List[str]:
+            return getattr(args, "_log_files_", [])
+
+        fmt: Optional[str] = parse_format()
+        level_name: Optional[str] = parse_level()
+        console: Optional[Any] = parse_console()
+
+        handlers: List[logging.Handler] = []
+        if console is not None:
+            handlers.append(Log.new_stream_handler(stream=console, fmt=fmt))
+        for filename in parse_files():
+            handlers.append(Log.new_file_handler(filename=filename, fmt=fmt))
+        self.initiate_logger(self.logger, level=level_name, handlers=handlers)
+
+    def __add_parser(self, _map: Dict[CommandArgument, ArgParser],
+                     arg_root: ArgParser, cmd_root: CommandArgument, **kwargs):
+        assert isinstance(cmd_root, CommandArgument)
+        assert cmd_root not in _map
+        _map[cmd_root] = arg_root
+
+        if not cmd_root.subs or len(cmd_root.subs) <= 0:
+            return
+
+        _sub = arg_root.add_subparsers(dest=cmd_root.sub_dest)
+        for sub in cmd_root.subs:
+            assert isinstance(sub, CommandArgument)
+            options = sub.options.copy()
+            for key, value in kwargs.items():
+                options.setdefault(key, value)
+            options.setdefault("epilog", arg_root.epilog)
+            options.setdefault("prev_parser", arg_root)
+            _arg: ArgParser = _sub.add_parser(sub.name, **options)
+            self.__add_parser(_map, _arg, sub)
+
+    def __add_option(self, _map: Dict[CommandArgument, ArgParser]):
+        for _cmd, _arg in _map.items():
+            _cmd.func(_arg)
+            self.__add_inner_parser_tail(_arg)
+
+    @classmethod
+    def check_error(cls, value: Any) -> int:
+        """Check for any errors in value.
+
+        Return 0 if value is None or True, otherwise return EINVAL.
+        """
+        return value if isinstance(value, int) else 0 if value in (None, True) else EINVAL  # noqa:E501
+
+    def parse(self, root: Optional[CommandArgument] = None,
+              argv: Optional[Sequence[str]] = None, **kwargs) -> Namespace:
+        """Parse the command line."""
+        if root is None:
+            root = self.root
+        assert isinstance(root, CommandArgument)
+
+        _map: Dict[CommandArgument, ArgParser] = {}
+        _arg = ArgParser(argv=argv, **kwargs)
+        self.__prog = _arg.prog
+        self.__add_optional_version(_arg)
+        # To support preparse_from_sys_argv(), all subparsers must be added
+        # first. Otherwise, an error will occur during the help action.
+        self.__add_parser(_map, _arg, root, **kwargs)
+        self.__add_option(_map)
+
+        args = _arg.parse_args(args=argv)
+        assert isinstance(args, Namespace)
+        self.__parse_logger(args)
+        self.args = args
+        return self.args
+
+    def has_sub(self, root: CommandArgument,
+                args: Optional[Namespace] = None) -> bool:
+        """If the root command node has any subcommand nodes, return true.
+
+        @param root: Command node
+        @type root: CommandArgument
+
+        @param args: Command arguments
+        @type args: Namespace or None (default self.args if None is specified)
+
+        @return: bool
+        """
+        if args is None:
+            args = self.args
+        assert isinstance(root, CommandArgument)
+        assert isinstance(args, Namespace)
+        return isinstance(getattr(args, root.sub_dest), str)\
+            if hasattr(args, root.sub_dest) else False
+
+    def __run(self, args: Namespace, root: CommandArgument) -> int:
+        assert isinstance(root, CommandArgument)
+        assert isinstance(root.bind, CommandExecutor)
+
+        if not root.bind.skip or not self.has_sub(root, args):
+            ret = root.bind.func(self)
+            if self.check_error(ret):
+                return ret
+
+        if hasattr(args, root.sub_dest):
+            sub_dest = getattr(args, root.sub_dest)
+            if isinstance(sub_dest, str):
+                assert isinstance(root.subs, (list, tuple))
+                for sub in root.subs:
+                    assert isinstance(sub, CommandArgument)
+                    if sub.name == sub_dest:
+                        ret = self.__run(args, sub)
+                        if self.check_error(ret):
+                            return ret
+
+        done = root.bind.done
+        if done is not None:
+            assert isinstance(done, CommandDeletion)
+            if not root.bind.skip or not self.has_sub(root, args):
+                ret = done.func(self)  # purge
+                if self.check_error(ret):
+                    return ret
+        return 0
+
+    def __pre(self, args: Namespace, root: CommandArgument) -> int:
+        assert isinstance(root, CommandArgument)
+        assert isinstance(root.bind, CommandExecutor)
+
+        prep = root.bind.prep
+        if prep is not None:
+            assert isinstance(prep, CommandCreation)
+            if not root.bind.skip or not self.has_sub(root, args):
+                ret = prep.func(self)
+                if self.check_error(ret):
+                    return ret
+
+        if hasattr(args, root.sub_dest):
+            sub_dest = getattr(args, root.sub_dest)
+            if isinstance(sub_dest, str):
+                assert isinstance(root.subs, (list, tuple))
+                for sub in root.subs:
+                    assert isinstance(sub, CommandArgument)
+                    if sub.name == sub_dest:
+                        return self.__pre(args, sub)
+        return 0
+
+    def run(self,
+            root: Optional[CommandArgument] = None,
+            argv: Optional[Sequence[str]] = None,
+            **kwargs) -> int:
+        """Parse and run the command line."""
+        if root is None:
+            root = self.root
+
+        if not isinstance(root, CommandArgument):
+            self.logger.debug("cannot find root")
+            return ENOENT
+
+        kwargs.pop("prog", None)  # Please do not specify prog
+        if "description" in root.options:  # Default use root's description
+            kwargs["description"] = root.options["description"]
+        args = self.parse(root, argv, **kwargs)
+        self.logger.debug("%s", args)
+
+        try:
+            version = self.version
+            if isinstance(version, str):
+                # Output version for the debug level. Internal log
+                # items are debug level only, except for errors.
+                self.logger.debug("version: %s", version)
+
+            ret = self.__pre(args, root)
+            if self.check_error(ret):
+                return ret
+            return self.__run(args, root)
+        except KeyboardInterrupt:
+            return ECANCELED
+        except BaseException:  # pylint: disable=broad-except
+            self.logger.exception("Something went wrong:")
+            return ENOTRECOVERABLE

xkits_command/attribute.py

@@ -0,0 +1,8 @@
+# coding:utf-8
+
+__version__ = "0.6"
+
+# project info
+__project_name__ = "xcommand"
+__project_home__ = "https://github.com/bondbox/xcommand/"
+__project_desc__ = "Command line module"

xkits_command/parser.py

@@ -0,0 +1,233 @@
+# coding:utf-8
+
+from argparse import ArgumentParser
+from argparse import Namespace
+from argparse import _ArgumentGroup  # noqa:H306
+from argparse import _HelpAction
+from argparse import _SubParsersAction
+from typing import Dict
+from typing import List
+from typing import Optional
+from typing import Sequence
+from typing import Set
+from typing import Tuple
+
+from xkits_command.attribute import __project_name__
+from xkits_command.attribute import __project_home__
+
+
+class Checker():
+
+    prefix_chars = "-"
+
+    @classmethod
+    def check_name_pos(cls, fn):
+        """check positional argument name"""
+
+        def inner(self, name: str, **kwargs):
+            assert isinstance(name, str) and name[0] not in cls.prefix_chars, \
+                f"{name} is not a positional argument name"
+            return fn(self, name, **kwargs)
+
+        return inner
+
+    @classmethod
+    def check_name_opt(cls, fn):
+        """check optional argument name"""
+
+        def inner(self, *name: str, **kwargs):
+            # 1. check short form optional argument ("-x")
+            # 2. check long form optional argument ("--xx")
+            # 3. only short form or long form or short form + long form
+            # 模棱两可的数据（-1可以是一个负数的位置参数）
+            for n in name:
+                assert isinstance(n, str) and n[0] in cls.prefix_chars, \
+                    f"{n} is not an optional argument name"
+            return fn(self, *name, **kwargs)
+
+        return inner
+
+    @classmethod
+    def check_nargs_opt(cls, fn):
+        """nargs hook function:
+            nargs < -1: using "?", 0 or 1 argument, default value
+            nargs = -1: using "+", arguments list, at least 1
+            nargs = 0: using "*", arguments list, allow to be empty
+            nargs = 1: redirect to "?", 0 or 1 argument
+            nargs > 1: N arguments list
+        """
+
+        def inner(self, *args, **kwargs):
+            _nargs = kwargs.get("nargs", -2)
+            if isinstance(_nargs, int) and _nargs < 2:
+                _nargs = {1: "?", 0: "*", -1: "+"}.get(_nargs, "?")
+            kwargs.update({"nargs": _nargs})
+            return fn(self, *args, **kwargs)
+
+        return inner
+
+
+class ArgParser(ArgumentParser):
+    """Simple command-line tool based on argparse."""
+
+    def __init__(self,  # pylint: disable=R0913,R0917
+                 argv: Optional[Sequence[str]] = None,
+                 prog: Optional[str] = None,
+                 usage: Optional[str] = None,
+                 prev_parser: Optional["ArgParser"] = None,
+                 description: Optional[str] = f"Command-line based on {__project_name__}.",  # noqa:E501
+                 epilog: Optional[str] = f"For more, please visit {__project_home__}",  # noqa:E501
+                 **kwargs):
+        kwargs.setdefault("prog", prog)
+        kwargs.setdefault("usage", usage)
+        kwargs.setdefault("description", description)
+        kwargs.setdefault("epilog", epilog)
+        ArgumentParser.__init__(self, **kwargs)
+        self.__argv: Optional[Sequence[str]] = argv
+        self.__help_option: Dict[str, _HelpAction] = {}
+        self.__prev_parser: ArgParser = prev_parser or self
+        self.__next_parser: List[ArgParser] = []
+        if prev_parser is not None:
+            prev_parser.next_parser.append(self)
+
+    @property
+    def argv(self) -> Optional[Sequence[str]]:
+        root = self.root_parser
+        return root.argv if root is not self else self.__argv
+
+    @property
+    def prev_parser(self) -> "ArgParser":
+        return self.__prev_parser
+
+    @property
+    def next_parser(self) -> List["ArgParser"]:
+        return self.__next_parser
+
+    @property
+    def root_parser(self) -> "ArgParser":
+        root = self.prev_parser
+        while root.prev_parser != root:
+            root = root.prev_parser
+        return root
+
+    def argument_group(self,
+                       title: Optional[str] = None,
+                       description: Optional[str] = None,
+                       **kwargs) -> _ArgumentGroup:
+        """Find the created argument group by title, create if not exist."""
+        for group in self._action_groups:
+            if title == group.title:
+                return group
+        return self.add_argument_group(title, description, **kwargs)
+
+    @Checker.check_name_opt
+    def filter_optional_name(self, *name: str) -> Sequence[str]:
+        """Filter defined optional argument name."""
+        option_strings: Set[str] = set()
+        for action in self._get_optional_actions():
+            option_strings.update(action.option_strings)
+        return [n for n in name if n not in option_strings]
+
+    @Checker.check_name_pos
+    def add_pos(self, name: str, **kwargs) -> None:
+        """Add positional argument."""
+        assert "dest" not in kwargs, \
+            "dest supplied twice for positional argument"
+        self.add_argument(name, **kwargs)
+
+    @Checker.check_name_opt
+    @Checker.check_nargs_opt
+    def add_opt(self, *name: str, **kwargs) -> None:
+        """Add optional argument."""
+        self.add_argument(*name, **kwargs)
+
+    @Checker.check_name_opt
+    def add_opt_on(self, *name: str, **kwargs) -> None:
+        """Add boolean optional argument, default value is False."""
+        kwargs.update({"action": "store_true"})
+        for key in ("type", "nargs", "const", "default", "choices"):
+            assert key not in kwargs, f"'{key}' is an invalid argument"
+        self.add_argument(*name, **kwargs)
+
+    @Checker.check_name_opt
+    def add_opt_off(self, *name: str, **kwargs) -> None:
+        """Add boolean optional argument, default value is True."""
+        kwargs.update({"action": "store_false"})
+        for key in ("type", "nargs", "const", "default", "choices"):
+            assert key not in kwargs, f"'{key}' is an invalid argument"
+        self.add_argument(*name, **kwargs)
+
+    def add_subparsers(self, *args, **kwargs) -> _SubParsersAction:
+        """Add subparsers."""
+        # subparser: cannot have multiple subparser arguments
+        kwargs.setdefault("title", "subcommands")
+        kwargs.setdefault("description", None)
+        kwargs.setdefault("dest", f"subcmd_{self.prog}")
+        kwargs.setdefault("help", None)
+        kwargs.setdefault("metavar", None)
+        return ArgumentParser.add_subparsers(self, *args, **kwargs)
+
+    def parse_args(  # pylint: disable=useless-parent-delegation
+        self, args: Optional[Sequence[str]] = None,
+        namespace: Optional[Namespace] = None
+    ) -> Namespace:
+        try:
+            from argcomplete import autocomplete  # pylint: disable=C0415
+            autocomplete(self)  # For tab completion
+        except ModuleNotFoundError:  # pragma: no cover
+            pass  # pragma: no cover
+        except NameError:  # pragma: no cover
+            pass  # pragma: no cover
+        return super().parse_args(args, namespace)  # type: ignore
+
+    def parse_known_args(  # pylint: disable=useless-parent-delegation
+            self, args: Optional[Sequence[str]] = None,
+            namespace: Optional[Namespace] = None
+    ) -> Tuple[Namespace, List[str]]:
+        return super().parse_known_args(args, namespace)  # type: ignore
+
+    def __enable_help_action(self):  # pylint: disable=unused-private-member
+        while len(self.__help_option) > 0:
+            option, action = self.__help_option.popitem()
+            self._option_string_actions[option] = action
+        assert len(self.__help_option) == 0
+
+    def __disable_help_action(self):  # pylint: disable=unused-private-member
+        assert len(self.__help_option) == 0
+        for option, action in self._option_string_actions.items():
+            if isinstance(action, _HelpAction):
+                self.__help_option[option] = action
+        for option in self.__help_option:
+            self._option_string_actions.pop(option)
+
+    def preparse_from_sys_argv(self) -> Namespace:
+        """Preparse some arguments from sys.argv for tab completion.
+
+        When arguments contain the help option, call parse_known_args()
+        will print help message and exit. The command line can parse
+        normally.
+
+        But parameters added after calling preparse_from_sys_argv() will
+        not show in the help message, because the exit occurred before
+        adding parameters.
+
+        So, disable the help action before calling parse_known_args().
+        The help option will be stored, and restored after the call ends.
+        """
+
+        def __dfs_enable_help_action(root: ArgParser):
+            root.__enable_help_action()  # pylint: disable=protected-access
+            for _sub in root.next_parser:
+                __dfs_enable_help_action(_sub)
+
+        def __dfs_disable_help_action(root: ArgParser):
+            root.__disable_help_action()  # pylint: disable=protected-access
+            for _sub in root.next_parser:
+                __dfs_disable_help_action(_sub)
+
+        try:
+            __dfs_disable_help_action(self.root_parser)
+            namespace, _ = self.root_parser.parse_known_args(self.argv)
+            return namespace
+        finally:
+            __dfs_enable_help_action(self.root_parser)

xkits_command-0.6.dist-info/METADATA

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: xkits-command
+Version: 0.6
+Summary: Command line module
+Project-URL: Homepage, https://github.com/bondbox/xcommand/
+Author-email: Mingzhe Zou <zoumingzhe@outlook.com>
+License-File: LICENSE
+Keywords: argcomplete,argparse,bash,command-line,shell,terminal
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: argcomplete>=3.2.1
+Requires-Dist: xkits-logger>=0.3
+Description-Content-Type: text/markdown
+
+# xcommand
+
+> Command line module

xkits_command-0.6.dist-info/RECORD

@@ -0,0 +1,8 @@
+xkits_command/__init__.py,sha256=wXuMzN8SfVZw0wIyFZmVd37SmxhPK6lpceGgx3xDmeQ,447
+xkits_command/actuator.py,sha256=kRGCk0FboarCrme3-V5Bbk3lpGnDicTBUogr8deRyV8,24276
+xkits_command/attribute.py,sha256=aZgBMApRP8lX4n8BhngiQu4H_45PlU_SWd95ucH7gcQ,181
+xkits_command/parser.py,sha256=KJVtt-AKEYdxxv0JTupQt4PCs2Vf08ZvMDftp8gg0JI,9160
+xkits_command-0.6.dist-info/METADATA,sha256=EGC6Hk5H7Vtt8dmB_Y1bBMqeT51H5HxD0xBw7ofq2u4,537
+xkits_command-0.6.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+xkits_command-0.6.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+xkits_command-0.6.dist-info/RECORD,,

xkits_command-0.6.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

xkits_command-0.6.dist-info/licenses/LICENSE

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.