k3shell 0.1.0__tar.gz → 0.1.1__tar.gz

k3shell-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 张炎泼
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

k3shell-0.1.1/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: k3shell
+Version: 0.1.1
+Summary: Shell command dispatcher with nested subcommand support
+Author-email: Zhang Yanpo <drdr.xp@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/pykit3/k3shell
+Project-URL: Documentation, https://k3shell.readthedocs.io
+Keywords: shell,command,cli,subcommand,argparse
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: k3dict
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
+Requires-Dist: pk3; extra == "publish"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
+Dynamic: license-file
+
+# k3shell
+
+[![Action-CI](https://github.com/pykit3/k3shell/actions/workflows/python-package.yml/badge.svg)](https://github.com/pykit3/k3shell/actions/workflows/python-package.yml)
+[![Build Status](https://travis-ci.com/pykit3/k3shell.svg?branch=master)](https://travis-ci.com/pykit3/k3shell)
+[![Documentation Status](https://readthedocs.org/projects/k3shell/badge/?version=stable)](https://k3shell.readthedocs.io/en/stable/?badge=stable)
+[![Package](https://img.shields.io/pypi/pyversions/k3shell)](https://pypi.org/project/k3shell)
+
+A python module to manage commands.
+
+k3shell is a component of [pykit3] project: a python3 toolkit set.
+
+
+#   Name
+
+k3shell
+
+#   Status
+
+The library is considered production ready.
+
+
+
+
+# Install
+
+```
+pip install k3shell
+```
+
+# Synopsis
+
+```python
+
+import k3shell
+import sys
+arguments = {
+    'echo_repr': (
+        lambda x: sys.stdout.write(repr(x)),
+        ('x', {'nargs': '+', 'help': 'just an input message'}),
+    ),
+
+    'foo': {
+        'bar': lambda: sys.stdout.write('bar'),
+
+        'bob': {
+            'plus': (
+                lambda x, y: sys.stdout.write(str(x + y)),
+                ('x', {'type': int, help: 'an int is needed'}),
+                ('y', {'type': int, help: 'an int is needed'}),
+            ),
+        },
+    },
+
+    '__add_help__': {
+        ('echo_repr',)           : 'output what is input.',
+        ('foo', 'bar',)          : 'print a "bar".',
+        ('foo', 'bob', 'plus',)  : 'do addition operation with 2 numbers.',
+    },
+
+    '__description__': 'this is an example command.',
+}
+
+k3shell.command(**arguments)
+"""
+
+then you can execute your command as:
+
+python demo.py echo_repr hello!
+# 'hello!'
+
+python demo.py foo bar
+# 'bar'
+
+python demo.py foo bob plus 1 2
+# 3
+
+
+and you can get a usage help message like:
+
+$ python demo.py -h
+---------------------------
+usage: demo.py [-h] {echo_repr, foo bar, foo bob plus} ...
+
+this is an example command.
+
+positional arguments:
+  {echo_repr, foo bar, foo bob plus} commands to select ...
+    echo_repr            output what is input.
+    foo bar              print a "bar".
+    foo bob plus         do addition operation with 2 numbers.
+
+optional arguments:
+    -h, --help           show this help message and exit
+
+
+$ python demo.py foo bob plus -h
+--------------------------
+usage: demo.py foo bob plus [-h] x y
+
+positional arguments:
+    x   an int is need
+    y   an int is need
+
+optional arguments:
+    -h, --help           show this help message and exit
+
+"""
+```
+
+#   Author
+
+Wenbo Li(李文博) <wenbo.li@baishancloud.com>
+
+#   Copyright and License
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Wenbo Li(李文博) <wenbo.li@baishancloud.com>
+
+
+[pykit3]: https://github.com/pykit3

k3shell-0.1.0/k3shell/synopsis.py → k3shell-0.1.1/README.md

@@ -1,74 +1,121 @@
-import k3shell
-import sys
-arguments = {
-    'echo_repr': (
-        lambda x: sys.stdout.write(repr(x)),
-        ('x', {'nargs': '+', 'help': 'just an input message'}),
-    ),
-
-    'foo': {
-        'bar': lambda: sys.stdout.write('bar'),
-
-        'bob': {
-            'plus': (
-                lambda x, y: sys.stdout.write(str(x + y)),
-                ('x', {'type': int, help: 'an int is needed'}),
-                ('y', {'type': int, help: 'an int is needed'}),
-            ),
-        },
-    },
-
-    '__add_help__': {
-        ('echo_repr',)           : 'output what is input.',
-        ('foo', 'bar',)          : 'print a "bar".',
-        ('foo', 'bob', 'plus',)  : 'do addition operation with 2 numbers.',
-    },
-
-    '__description__': 'this is an example command.',
-}
-
-k3shell.command(**arguments)
-"""
-
-then you can execute your command as:
-
-python demo.py echo_repr hello!
-# 'hello!'
-
-python demo.py foo bar
-# 'bar'
-
-python demo.py foo bob plus 1 2
-# 3
-
-
-and you can get a usage help message like:
-
-$ python demo.py -h
----------------------------
-usage: demo.py [-h] {echo_repr, foo bar, foo bob plus} ...
-
-this is an example command.
-
-positional arguments:
-  {echo_repr, foo bar, foo bob plus} commands to select ...
-    echo_repr            output what is input.
-    foo bar              print a "bar".
-    foo bob plus         do addition operation with 2 numbers.
-
-optional arguments:
-    -h, --help           show this help message and exit
-
-
-$ python demo.py foo bob plus -h
---------------------------
-usage: demo.py foo bob plus [-h] x y
-
-positional arguments:
-    x   an int is need
-    y   an int is need
-
-optional arguments:
-    -h, --help           show this help message and exit
-
-"""
+# k3shell
+
+[![Action-CI](https://github.com/pykit3/k3shell/actions/workflows/python-package.yml/badge.svg)](https://github.com/pykit3/k3shell/actions/workflows/python-package.yml)
+[![Build Status](https://travis-ci.com/pykit3/k3shell.svg?branch=master)](https://travis-ci.com/pykit3/k3shell)
+[![Documentation Status](https://readthedocs.org/projects/k3shell/badge/?version=stable)](https://k3shell.readthedocs.io/en/stable/?badge=stable)
+[![Package](https://img.shields.io/pypi/pyversions/k3shell)](https://pypi.org/project/k3shell)
+
+A python module to manage commands.
+
+k3shell is a component of [pykit3] project: a python3 toolkit set.
+
+
+#   Name
+
+k3shell
+
+#   Status
+
+The library is considered production ready.
+
+
+
+
+# Install
+
+```
+pip install k3shell
+```
+
+# Synopsis
+
+```python
+
+import k3shell
+import sys
+arguments = {
+    'echo_repr': (
+        lambda x: sys.stdout.write(repr(x)),
+        ('x', {'nargs': '+', 'help': 'just an input message'}),
+    ),
+
+    'foo': {
+        'bar': lambda: sys.stdout.write('bar'),
+
+        'bob': {
+            'plus': (
+                lambda x, y: sys.stdout.write(str(x + y)),
+                ('x', {'type': int, help: 'an int is needed'}),
+                ('y', {'type': int, help: 'an int is needed'}),
+            ),
+        },
+    },
+
+    '__add_help__': {
+        ('echo_repr',)           : 'output what is input.',
+        ('foo', 'bar',)          : 'print a "bar".',
+        ('foo', 'bob', 'plus',)  : 'do addition operation with 2 numbers.',
+    },
+
+    '__description__': 'this is an example command.',
+}
+
+k3shell.command(**arguments)
+"""
+
+then you can execute your command as:
+
+python demo.py echo_repr hello!
+# 'hello!'
+
+python demo.py foo bar
+# 'bar'
+
+python demo.py foo bob plus 1 2
+# 3
+
+
+and you can get a usage help message like:
+
+$ python demo.py -h
+---------------------------
+usage: demo.py [-h] {echo_repr, foo bar, foo bob plus} ...
+
+this is an example command.
+
+positional arguments:
+  {echo_repr, foo bar, foo bob plus} commands to select ...
+    echo_repr            output what is input.
+    foo bar              print a "bar".
+    foo bob plus         do addition operation with 2 numbers.
+
+optional arguments:
+    -h, --help           show this help message and exit
+
+
+$ python demo.py foo bob plus -h
+--------------------------
+usage: demo.py foo bob plus [-h] x y
+
+positional arguments:
+    x   an int is need
+    y   an int is need
+
+optional arguments:
+    -h, --help           show this help message and exit
+
+"""
+```
+
+#   Author
+
+Wenbo Li(李文博) <wenbo.li@baishancloud.com>
+
+#   Copyright and License
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Wenbo Li(李文博) <wenbo.li@baishancloud.com>
+
+
+[pykit3]: https://github.com/pykit3

{k3shell-0.1.0/k3shell → k3shell-0.1.1}/__init__.py

@@ -8,8 +8,10 @@ k3shell
 The library is considered production ready.
 
 """
-__version__ = "0.1.0"
-__name__ = "k3shell"
+
+from importlib.metadata import version
+
+__version__ = version("k3shell")
 
 from .command import (
     command,

{k3shell-0.1.0/k3shell → k3shell-0.1.1}/command.py

@@ -45,16 +45,14 @@ def command(**kwargs):
     try:
         cmds = []
         while len(inputs) > 0 and inputs[0] in root:
-
             k = inputs.pop(0)
             cmds.append(k)
             node = root[k]
 
             if is_node_executable(node):
-
                 call_able, args = parse_executable_node(parser, cmds, node, inputs)
                 try:
-                    logger.debug("command: " + repr(cmds) + ' args: ' + repr(args) + ' cwd: ' + repr(os.getcwd()))
+                    logger.debug("command: " + repr(cmds) + " args: " + repr(args) + " cwd: " + repr(os.getcwd()))
                     rc = call_able(*args)
                     logger.debug(repr(rc))
                     if rc is True or rc == 0 or rc is None:
@@ -71,15 +69,14 @@ def command(**kwargs):
                 root = node
 
         if need_to_show_help(parser):
-
             if len(cmds) > 0:
-                argv = [' '.join(cmds)] + inputs
+                argv = [" ".join(cmds)] + inputs
             else:
                 argv = inputs
 
             parser.parse_args(argv)
         else:
-            sys.stderr.write('No such command: ' + ' '.join(sys.argv[1:]))
+            sys.stderr.write("No such command: " + " ".join(sys.argv[1:]))
 
         sys.exit(2)
 
@@ -92,24 +89,23 @@ def command(**kwargs):
 def add_command_help(commands):
     new_cmds = copy.deepcopy(commands)
 
-    help_msgs = new_cmds.get('__add_help__')
-    desc = new_cmds.get('__description__')
+    help_msgs = new_cmds.get("__add_help__")
+    desc = new_cmds.get("__description__")
 
-    for k in ('__add_help__', '__description__'):
+    for k in ("__add_help__", "__description__"):
         if k in new_cmds:
             del new_cmds[k]
 
     if help_msgs is None:
         return new_cmds, None
 
-    parser = argparse.ArgumentParser(description=desc, epilog='\n')
+    parser = argparse.ArgumentParser(description=desc, epilog="\n")
 
-    subparsers = parser.add_subparsers(help=' command(s) to select ...')
+    subparsers = parser.add_subparsers(help=" command(s) to select ...")
 
     for cmds, execute_able in k3dict.depth_iter(new_cmds):
-
-        help = help_msgs.get(tuple(cmds), '')
-        cmd = ' '.join(cmds)
+        help = help_msgs.get(tuple(cmds), "")
+        cmd = " ".join(cmds)
 
         cmd_parser = subparsers.add_parser(cmd, help=help)
 
@@ -129,7 +125,7 @@ def add_param_help(parser, param_msgs):
     params = []
     for param, msg in param_msgs:
         parser.add_argument(param, **msg)
-        param = param.lstrip('-')
+        param = param.lstrip("-")
         params.append(param)
 
     return params
@@ -137,14 +133,13 @@ def add_param_help(parser, param_msgs):
 
 def parse_executable_node(parser, cmds, execute_able, args):
     if not need_to_show_help(parser):
-
         # no __add_help__ but has paramter help message
         if args_need_to_parse(execute_able):
             return execute_able[0], args
 
         return execute_able, args
 
-    args_parsed = parser.parse_args([' '.join(cmds)] + args)
+    args_parsed = parser.parse_args([" ".join(cmds)] + args)
     # to dict
     args_parsed = vars(args_parsed)
 
@@ -155,7 +150,6 @@ def parse_executable_node(parser, cmds, execute_able, args):
 
     args = [args_parsed.get(x) for x in params]
 
-
     return call_able, args
 
 

k3shell-0.1.1/k3shell.egg-info/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: k3shell
+Version: 0.1.1
+Summary: Shell command dispatcher with nested subcommand support
+Author-email: Zhang Yanpo <drdr.xp@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/pykit3/k3shell
+Project-URL: Documentation, https://k3shell.readthedocs.io
+Keywords: shell,command,cli,subcommand,argparse
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: k3dict
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
+Requires-Dist: pk3; extra == "publish"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
+Dynamic: license-file
+
+# k3shell
+
+[![Action-CI](https://github.com/pykit3/k3shell/actions/workflows/python-package.yml/badge.svg)](https://github.com/pykit3/k3shell/actions/workflows/python-package.yml)
+[![Build Status](https://travis-ci.com/pykit3/k3shell.svg?branch=master)](https://travis-ci.com/pykit3/k3shell)
+[![Documentation Status](https://readthedocs.org/projects/k3shell/badge/?version=stable)](https://k3shell.readthedocs.io/en/stable/?badge=stable)
+[![Package](https://img.shields.io/pypi/pyversions/k3shell)](https://pypi.org/project/k3shell)
+
+A python module to manage commands.
+
+k3shell is a component of [pykit3] project: a python3 toolkit set.
+
+
+#   Name
+
+k3shell
+
+#   Status
+
+The library is considered production ready.
+
+
+
+
+# Install
+
+```
+pip install k3shell
+```
+
+# Synopsis
+
+```python
+
+import k3shell
+import sys
+arguments = {
+    'echo_repr': (
+        lambda x: sys.stdout.write(repr(x)),
+        ('x', {'nargs': '+', 'help': 'just an input message'}),
+    ),
+
+    'foo': {
+        'bar': lambda: sys.stdout.write('bar'),
+
+        'bob': {
+            'plus': (
+                lambda x, y: sys.stdout.write(str(x + y)),
+                ('x', {'type': int, help: 'an int is needed'}),
+                ('y', {'type': int, help: 'an int is needed'}),
+            ),
+        },
+    },
+
+    '__add_help__': {
+        ('echo_repr',)           : 'output what is input.',
+        ('foo', 'bar',)          : 'print a "bar".',
+        ('foo', 'bob', 'plus',)  : 'do addition operation with 2 numbers.',
+    },
+
+    '__description__': 'this is an example command.',
+}
+
+k3shell.command(**arguments)
+"""
+
+then you can execute your command as:
+
+python demo.py echo_repr hello!
+# 'hello!'
+
+python demo.py foo bar
+# 'bar'
+
+python demo.py foo bob plus 1 2
+# 3
+
+
+and you can get a usage help message like:
+
+$ python demo.py -h
+---------------------------
+usage: demo.py [-h] {echo_repr, foo bar, foo bob plus} ...
+
+this is an example command.
+
+positional arguments:
+  {echo_repr, foo bar, foo bob plus} commands to select ...
+    echo_repr            output what is input.
+    foo bar              print a "bar".
+    foo bob plus         do addition operation with 2 numbers.
+
+optional arguments:
+    -h, --help           show this help message and exit
+
+
+$ python demo.py foo bob plus -h
+--------------------------
+usage: demo.py foo bob plus [-h] x y
+
+positional arguments:
+    x   an int is need
+    y   an int is need
+
+optional arguments:
+    -h, --help           show this help message and exit
+
+"""
+```
+
+#   Author
+
+Wenbo Li(李文博) <wenbo.li@baishancloud.com>
+
+#   Copyright and License
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Wenbo Li(李文博) <wenbo.li@baishancloud.com>
+
+
+[pykit3]: https://github.com/pykit3

k3shell-0.1.1/k3shell.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+__init__.py
+command.py
+pyproject.toml
+synopsis.py
+./__init__.py
+./command.py
+./synopsis.py
+k3shell.egg-info/PKG-INFO
+k3shell.egg-info/SOURCES.txt
+k3shell.egg-info/dependency_links.txt
+k3shell.egg-info/requires.txt
+k3shell.egg-info/top_level.txt
+test/test_doctest.py
+test/test_k3shell.py

k3shell-0.1.1/k3shell.egg-info/requires.txt

@@ -0,0 +1,16 @@
+k3dict
+
+[dev]
+pytest>=7.0
+ruff
+coverage
+
+[docs]
+mkdocs>=1.5
+mkdocs-material>=9.0
+mkdocstrings[python]>=0.24
+
+[publish]
+build
+twine
+pk3