Skip to main content

Werkzeug-style command parsing.

Project description

# commandlet
Werkzeug-style commands.

## Usage
```
from commandlet.parser import Parser

p = Parser()


@p.command('test', 'test <int:times> <str:string>')
def do_test(times, string):
"""Test a certain number of times."""
for n in range(times):
print('[%d]: %s' % (n, string))


p.handle_command('test 4 Hello world.')
```

As you can see, you can decorate functions with the Parser.command decorator to make them callable. They should all be given a name (used for pretty-printing mainly), and an argument string, which looks very similar to those seen in command line programs... And [Werkzeug](https://palletsprojects.com/p/werkzeug/).

You can also add extra filters:

```
@p.filter('reverse')
def do_reverse(text):
return (text, ''.join(reversed(text)))


@p.command('reverse', 'reverse <reverse:string>')
def reverse_command(string):
original, new = string
print('Reversing %r gives %r.' % (original, new))
```

You can see the full list of filters by examining the Parser.filters dictionary. By default, str, int, and float are supported.



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

commandlet-0.4.2.dev1.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

commandlet-0.4.2.dev1-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file commandlet-0.4.2.dev1.tar.gz.

File metadata

  • Download URL: commandlet-0.4.2.dev1.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for commandlet-0.4.2.dev1.tar.gz
Algorithm Hash digest
SHA256 11c537e0600d73afbcdc929bba03314962a3198392ee8627d7e7af26bf71ab72
MD5 a22f3f07c850405674b523c69c21bc00
BLAKE2b-256 76582087b025764922a25efda1603fe14257c716d824abdc1e0c23988256cb6f

See more details on using hashes here.

Provenance

File details

Details for the file commandlet-0.4.2.dev1-py3-none-any.whl.

File metadata

  • Download URL: commandlet-0.4.2.dev1-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for commandlet-0.4.2.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 51747982072d38d8400aa9c3cf592fa0219dd2c12cd9baee0145b1e9beb313ba
MD5 77f2804b4c7a8478074c211fdf253f71
BLAKE2b-256 4f99eece3a4381ea08b71d41c903f18341ee09faf6e8247eb387adf232d5e250

See more details on using hashes here.

Provenance

Supported by

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