handofcats 0.2.2

python function to command translator

A tiny Converter that making executable command script from python function. If the function has sphinx autodoc style docstring, it is also used.

this module has two functions.

• as_command()

• describe()

If you just convert python function to executable command, then use as_command(). And, you want to show a list of managemented commands, describe() is helpful.

as_command()

# greeting.py
from handofcats import as_command

@as_command
def greeting(message, is_surprised=False, name="foo"):
    suffix = "!" if is_surprised else ""
    print("{name}: {message}{suffix}".format(name=name, message=message, suffix=suffix))

$ python greeting.py
usage: greeting.py [-h] [--is_surprised] [--name NAME] message
greeting.py: error: too few arguments
$ python greeting.py -h
usage: greeting.py [-h] [--is_surprised] [--name NAME] message

positional arguments:
  message

optional arguments:
  -h, --help      show this help message and exit
  --is_surprised
  --name NAME
$ python greeting.py hello
foo: hello
$ python greeting.py --is_surprised hello
foo: hello!
$ python greeting.py --is_surprised --name=bar bye
bar: bye!

with docstring (additional feature)

from handofcats import as_command


@as_command
def greeting(message, is_surprised=False, name="foo"):
    """ greeting message

    :param message: message of greeting
    :param is_surprised: surprised or not (default=False)
    :param name: name of actor
    """
    suffix = "!" if is_surprised else ""
    print("{name}: {message}{suffix}".format(name=name, message=message, suffix=suffix))

$ python greeting.py -h
usage: greeting.py [-h] [--is_surprised] [--name NAME] message

greeting message

positional arguments:
  message         message of greeting

optional arguments:
  -h, --help      show this help message and exit
  --is_surprised  surprised or not (default=False)
  --name NAME     name of actor

describe()

$ tree foo/
foo/
├── __init__.py
├── __main__.py
├── bye.py
└── hello.py

$ cat foo/__main__.py
from handofcats import describe
describe()

$ python -m foo
avaiable commands are here. (with --full option, showing full text)

- foo.bye
- foo.hello -- hello message

$ cat foo/hello.py
from handofcats import as_command


@as_command
def hello():
    """
    hello message
    """
    print("hello")