xkits-command 0.2__tar.gz → 0.3__tar.gz

{xkits_command-0.2 → xkits_command-0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xkits-command
-Version: 0.2
+Version: 0.3
 Summary: Command line module
 Home-page: https://github.com/bondbox/xcommand/
 Author: Mingzhe Zou
@@ -17,7 +17,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: argcomplete>=3.2.1
-Requires-Dist: xkits_logger>=0.1
+Requires-Dist: xkits-logger>=0.2
 
 # xcommand
 

{xkits_command-0.2 → xkits_command-0.3}/setup.py

@@ -1,8 +1,10 @@
 # coding=utf-8
 
+from urllib.parse import urljoin
+
 from setuptools import find_packages
 from setuptools import setup
-from urllib.parse import urljoin
+from setuptools.command.install import install
 
 from xkits_command.attribute import __author__
 from xkits_command.attribute import __author_email__
@@ -25,6 +27,14 @@ def all_requirements():
     return requirements
 
 
+class CustomInstallCommand(install):
+    """Customized setuptools install command"""
+
+    def run(self):
+        install.run(self)  # Run the standard installation
+        # Execute your custom code after installation
+
+
 setup(
     name=__project__,
     version=__version__,
@@ -35,5 +45,9 @@ setup(
     project_urls={"Source Code": __urlcode__,
                   "Bug Tracker": __urlbugs__,
                   "Documentation": __urldocs__},
-    packages=find_packages(include=["xkits_command*"], exclude=["xkits_command.unittest"]),
-    install_requires=all_requirements())
+    packages=find_packages(include=["xkits_command*"], exclude=["xkits_command.unittest"]),  # noqa:E501
+    install_requires=all_requirements(),
+    cmdclass={
+        "install": CustomInstallCommand,
+    }
+)

{xkits_command-0.2 → xkits_command-0.3}/xkits_command/actuator.py

@@ -24,7 +24,7 @@ from xkits_command.parser import ArgParser
 
 
 class CommandArgument:
-    '''Define a new command-line node.
+    """Define a new command-line node.
 
     For example:
 
@@ -34,10 +34,10 @@ class CommandArgument:
     >>> @CommandArgument("example")\n
     >>> def cmd(_arg: ArgParser):\n
     >>>     _arg.add_opt_on("-t", "--test")\n
-    '''
+    """
 
     def __init__(self, name: str, **kwargs):
-        '''Initialize the node.
+        """Initialize the node.
 
         @param name: Node name
         @type name: str
@@ -53,7 +53,7 @@ class CommandArgument:
 
         @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:
@@ -136,7 +136,7 @@ class CommandArgument:
 
 
 class CommandExecutor:
-    '''Define the main callback function, and bind it to a node and
+    """Define the main callback function, and bind it to a node and
     all subcommands.
 
     For example:
@@ -147,11 +147,11 @@ class CommandExecutor:
     >>> @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.
+        """Initialize the node.
 
         @param cmd_bind: Bind to a root command node
         @type name: CommandArgument
@@ -163,7 +163,7 @@ class CommandExecutor:
         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
@@ -215,7 +215,7 @@ class CommandExecutor:
 
 
 class CommandCreation:
-    '''Define prepare callback function, and bind it with main callback.
+    """Define prepare callback function, and bind it with main callback.
 
     For example:
 
@@ -230,14 +230,14 @@ class CommandCreation:
     >>> @CommandCreation(run)\n
     >>> def pre(cmds: Command) -> int:\n
     >>>     return 0\n
-    '''
+    """
 
     def __init__(self, run_bind: CommandExecutor):
-        '''Initialize the node.
+        """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
@@ -259,7 +259,7 @@ class CommandCreation:
 
 
 class CommandDeletion:
-    '''Define purge callback function, and bind it with main callback.
+    """Define purge callback function, and bind it with main callback.
 
     For example:
 
@@ -274,14 +274,14 @@ class CommandDeletion:
     >>> @CommandDeletion(run)\n
     >>> def end(cmds: Command) -> int:\n
     >>>     return 0\n
-    '''
+    """
 
     def __init__(self, run_bind: CommandExecutor):
-        '''Initialize the node.
+        """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
@@ -303,7 +303,7 @@ class CommandDeletion:
 
 
 class Command(Log):
-    '''Singleton command-line tool based on argparse.
+    """Singleton command-line tool based on argparse.
 
     Define and bind all callback functions before calling run() or parse().
 
@@ -341,7 +341,7 @@ class Command(Log):
     >>>         argv=argv,\n
     >>>         prog="xkits-command-example",\n
     >>>         description="Simple command-line tool based on argparse.")\n
-    '''
+    """
 
     LOGGER_ARGUMENT_GROUP = "logger options"
 
@@ -369,7 +369,7 @@ class Command(Log):
 
     @property
     def root(self) -> Optional[CommandArgument]:
-        '''Root Command.'''
+        """Root Command."""
         return self.__root
 
     @root.setter
@@ -379,7 +379,7 @@ class Command(Log):
 
     @property
     def args(self) -> Namespace:
-        '''Namespace after parse arguments.'''
+        """Namespace after parse arguments."""
         assert isinstance(self.__args, Namespace)
         return self.__args
 
@@ -390,7 +390,7 @@ class Command(Log):
 
     @property
     def version(self) -> Optional[str]:
-        '''Custom version for "-v" or "--version" output.'''
+        """Custom version for "-v" or "--version" output."""
         return self.__version
 
     @version.setter
@@ -410,7 +410,7 @@ class Command(Log):
 
     @property
     def logger(self) -> Logger:
-        '''Logger.'''
+        """Logger."""
         return self.get_logger(self.prog)
 
     def __add_optional_version(self, _arg: ArgParser):
@@ -590,15 +590,15 @@ class Command(Log):
 
     @classmethod
     def check_error(cls, value: Any) -> int:
-        '''Check value is an error.
+        """Check value is an error.
 
         Return True if value is an error, otherwise False.
-        '''
+        """
         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.'''
+        """Parse the command line."""
         if root is None:
             root = self.root
         assert isinstance(root, CommandArgument)
@@ -620,7 +620,7 @@ class Command(Log):
 
     def has_sub(self, root: CommandArgument,
                 args: Optional[Namespace] = None) -> bool:
-        '''If the root command node has any subcommand nodes, return true.
+        """If the root command node has any subcommand nodes, return true.
 
         @param root: Command node
         @type root: CommandArgument
@@ -629,7 +629,7 @@ class Command(Log):
         @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)
@@ -692,7 +692,7 @@ class Command(Log):
             root: Optional[CommandArgument] = None,
             argv: Optional[Sequence[str]] = None,
             **kwargs) -> int:
-        '''Parse and run the command line.'''
+        """Parse and run the command line."""
         if root is None:
             root = self.root
 

{xkits_command-0.2 → xkits_command-0.3}/xkits_command/attribute.py

@@ -1,9 +1,9 @@
 # coding:utf-8
 
 __project__ = "xkits-command"
-__version__ = "0.2"
-__description__ = "Command line module"
+__version__ = "0.3"
 __urlhome__ = "https://github.com/bondbox/xcommand/"
+__description__ = "Command line module"
 
 # author
 __author__ = "Mingzhe Zou"

{xkits_command-0.2 → xkits_command-0.3}/xkits_command/parser.py

@@ -12,11 +12,6 @@ from typing import Sequence
 from typing import Set
 from typing import Tuple
 
-try:
-    from argcomplete import autocomplete
-except ModuleNotFoundError:  # pragma: no cover
-    pass  # pragma: no cover
-
 from xkits_command.attribute import __project__
 from xkits_command.attribute import __urlhome__
 
@@ -27,7 +22,7 @@ class Checker():
 
     @classmethod
     def check_name_pos(cls, fn):
-        '''check positional argument name'''
+        """check positional argument name"""
 
         def inner(self, name: str, **kwargs):
             assert isinstance(name, str) and name[0] not in cls.prefix_chars, \
@@ -38,7 +33,7 @@ class Checker():
 
     @classmethod
     def check_name_opt(cls, fn):
-        '''check optional argument name'''
+        """check optional argument name"""
 
         def inner(self, *name: str, **kwargs):
             # 1. check short form optional argument ("-x")
@@ -54,13 +49,13 @@ class Checker():
 
     @classmethod
     def check_nargs_opt(cls, fn):
-        '''nargs hook function:
+        """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)
@@ -73,7 +68,7 @@ class Checker():
 
 
 class ArgParser(ArgumentParser):
-    '''Simple command-line tool based on argparse.'''
+    """Simple command-line tool based on argparse."""
 
     def __init__(self,  # pylint: disable=R0913,R0917
                  argv: Optional[Sequence[str]] = None,
@@ -119,7 +114,7 @@ class ArgParser(ArgumentParser):
                        title: Optional[str] = None,
                        description: Optional[str] = None,
                        **kwargs) -> _ArgumentGroup:
-        '''Find the created argument group by title, create if not exist.'''
+        """Find the created argument group by title, create if not exist."""
         for group in self._action_groups:
             if title == group.title:
                 return group
@@ -127,7 +122,7 @@ class ArgParser(ArgumentParser):
 
     @Checker.check_name_opt
     def filter_optional_name(self, *name: str) -> Sequence[str]:
-        '''Filter defined optional argument name.'''
+        """Filter defined optional argument name."""
         option_strings: Set[str] = set()
         for action in self._get_optional_actions():
             option_strings.update(action.option_strings)
@@ -135,7 +130,7 @@ class ArgParser(ArgumentParser):
 
     @Checker.check_name_pos
     def add_pos(self, name: str, **kwargs) -> None:
-        '''Add positional argument.'''
+        """Add positional argument."""
         assert "dest" not in kwargs, \
             "dest supplied twice for positional argument"
         self.add_argument(name, **kwargs)
@@ -143,12 +138,12 @@ class ArgParser(ArgumentParser):
     @Checker.check_name_opt
     @Checker.check_nargs_opt
     def add_opt(self, *name: str, **kwargs) -> None:
-        '''Add optional argument.'''
+        """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.'''
+        """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"
@@ -156,14 +151,14 @@ class ArgParser(ArgumentParser):
 
     @Checker.check_name_opt
     def add_opt_off(self, *name: str, **kwargs) -> None:
-        '''Add boolean optional argument, default value is True.'''
+        """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.'''
+        """Add subparsers."""
         # subparser: cannot have multiple subparser arguments
         kwargs.setdefault("title", "subcommands")
         kwargs.setdefault("description", None)
@@ -177,7 +172,10 @@ class ArgParser(ArgumentParser):
         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
@@ -203,7 +201,7 @@ class ArgParser(ArgumentParser):
             self._option_string_actions.pop(option)
 
     def preparse_from_sys_argv(self) -> Namespace:
-        '''Preparse some arguments from sys.argv for tab completion.
+        """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
@@ -215,7 +213,7 @@ class ArgParser(ArgumentParser):
 
         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

{xkits_command-0.2 → xkits_command-0.3}/xkits_command.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xkits-command
-Version: 0.2
+Version: 0.3
 Summary: Command line module
 Home-page: https://github.com/bondbox/xcommand/
 Author: Mingzhe Zou
@@ -17,7 +17,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: argcomplete>=3.2.1
-Requires-Dist: xkits_logger>=0.1
+Requires-Dist: xkits-logger>=0.2
 
 # xcommand
 

{xkits_command-0.2 → xkits_command-0.3}/xkits_command.egg-info/requires.txt

@@ -1,2 +1,2 @@
 argcomplete>=3.2.1
-xkits_logger>=0.1
+xkits-logger>=0.2