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

Uploaded Source

Built Distribution

commandlet-0.4.0-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commandlet-0.4.0.tar.gz
  • Upload date:
  • Size: 10.9 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.0.tar.gz
Algorithm Hash digest
SHA256 446877647a4d31794814a8e6cdbd533f1b4b88823b05a182798ca9df749affdb
MD5 8ec6533790dd4aafe54e45b762005152
BLAKE2b-256 d3f46bc98fb3fc8c7b37f1f420cc0a800606cd11beb1fee4d33bc4823fc18802

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: commandlet-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 11.3 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec7bd81502aaaf3abc677fb1a8035ffe1e38d07c708ae643ca4baf8c678f4305
MD5 1e82362e9759134fa72ddf07a3de949e
BLAKE2b-256 e459004a3eb312d875ce1228dacb72e914770b9539def605209c8cdd267cca02

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