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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commandlet-0.4.3.tar.gz
  • Upload date:
  • Size: 11.4 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.3.tar.gz
Algorithm Hash digest
SHA256 9ea4e9490cf2ce2df4d00023c683afc35bbf590c9f6cd628c540eeb6f6bc85a9
MD5 f21facb27a20d6fb2b55c04b5ab4ab94
BLAKE2b-256 1640f361eb404dee93d3a7652bd0338dfcad1f19010d643b2243c43eb0acf1b1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: commandlet-0.4.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0388f2fa320789a7217e85466f3211c93396bca27c7a557eb0933a98b9d71aed
MD5 d252395a7626e9c830f7eb899eee1123
BLAKE2b-256 4f857d0bbbe05ca9d5d3bccf909cdea98d8cd4736174d16a7daac93b8c298296

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