Skip to main content

Turn a dict of arguments into cli commands, ideal companion of docopt.

Project description

commandopt

Turn a dict of arguments into cli commands, ideal companion of docopt.

Why ?

Using the commandopt.commandopt decorator, you are able to declare commands to be executed depending on the input arguments of your app (required or optional).

It reduces the boilerplate code in your main().

Signature

def commandopt(mandopts: List, opts: List = None):
    # ...

Call

@commandopt(mandatory_arguments, optional_arguments)
def xxxx(*args, **kwargs):

Example usage

#myapp/myapp.py
"""Naval Fate.

Usage:
  naval_fate.py ship new <name>...
  naval_fate.py new-ship [<name>]
  naval_fate.py --version

Options:
  --version     Show version.

"""
from commandopt import Command
from docopt import docopt

import myapp.commands.ship

if __name__ == '__main__':
    arguments = docopt(__doc__, version='Naval Fate 2.0')
    run = Command(arguments)  # get the registered function
    run(arguments)  # execute the function
    # or
    # run = Command(arguments, call=True)
#myapp/commands/ship.py
from commandopt import commandopt

class ShipCommand:

    @commandopt(["ship", "new", "<name>"])
    @commandopt(["new-ship"], ["<name>"])
    def new(arguments):
        """You can stack the decorator if you want."""
        name = arguments["<name>"] or "case when name is empty"
        # ... your code here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Commandopt-0.2.1.tar.gz (4.0 kB view details)

Uploaded Source

File details

Details for the file Commandopt-0.2.1.tar.gz.

File metadata

  • Download URL: Commandopt-0.2.1.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for Commandopt-0.2.1.tar.gz
Algorithm Hash digest
SHA256 89db15ad950b7b5eceaeb9977828918ca1544b37c4bdde4b26e0cf26ab975ae2
MD5 a477591cfc3849114af5b7d531ad17e4
BLAKE2b-256 0bd90c3e828d784210470bb200daacd47abae1139fc188d50e876b1102da624c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page