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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commandlet-0.4.2.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.tar.gz
Algorithm Hash digest
SHA256 340788b6eca1120c176b0ccf8c000b63fe234aa685c7f271efe0d6f9f1f55a3d
MD5 f9a663a874194c634399103f527b9903
BLAKE2b-256 5f480bd193619f4033895a15bf67bca6e5412db7ba48309066962363c1ee6f6c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: commandlet-0.4.2-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.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for commandlet-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3d6c8622510c8b1fc3b324189a8a3a1d3958b562d3202c2867de967ae3bd0bef
MD5 e5dd894b3acad19a387ae10df9400ee6
BLAKE2b-256 e1d7fd3ac45c893f102e6882392554a11bda61055891d587d08f690551a99352

See more details on using hashes here.

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