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

Uploaded Source

Built Distribution

commandlet-0.2.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commandlet-0.2.0.tar.gz
  • Upload date:
  • Size: 10.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.2.0.tar.gz
Algorithm Hash digest
SHA256 8ac9440e61cadefee31a9f7f17fc5beeeb6ea7d969e37cccf63817dfa0475af8
MD5 ae6ea2cbd55be20149d7fe91d4ade18e
BLAKE2b-256 2438e1bdd0e163ebdbd7388131672ac817105dafdc84e5d481b5dea7df823dfa

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: commandlet-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 10.9 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 44e4ceed437a01f13acdb514dfdd876c2cb8c354178b129c2068ed0ae18691a9
MD5 bfc6b9b61d60fc3a646af4c39be76f62
BLAKE2b-256 ea2ea031318dad804d7edda784a16aae2a0db51070f9b8c6f44b68151eb1bcb9

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