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.4.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

commandlet-0.4.4-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file commandlet-0.4.4.tar.gz.

File metadata

  • Download URL: commandlet-0.4.4.tar.gz
  • Upload date:
  • Size: 11.6 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.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for commandlet-0.4.4.tar.gz
Algorithm Hash digest
SHA256 ae6b01921655309c4909e9b7f940707d1ef79f390d5d4cffdf5186f21ad168ba
MD5 03957908b17852209de7e7518a0f7de7
BLAKE2b-256 ff63c7adc68cdb07f40691e2d37f7f92722d4cc5038575b7a93f7e625060a828

See more details on using hashes here.

Provenance

File details

Details for the file commandlet-0.4.4-py3-none-any.whl.

File metadata

  • Download URL: commandlet-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 11.5 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.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for commandlet-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 478a68cd85437727ff2598ded3e49a4b49b2aaab8515a5d652748c2061f663aa
MD5 569ff0418ffb736f7d97c2886920ce40
BLAKE2b-256 e3e55d83080adf8ff7a45403dcfa84f1d18c81a697432704643befb0cf178bcf

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