An advanced parameter parser for Python.
Project description
Parameter Parser (Python)
Parameter Parser is a simple library used to parse intricate parameters from an array of strings.
Hint: This package is available through
Python PIP
.pip install parameterparser
Supports Python 2.7+
Documentation - Advanced Code Examples - Looking for the PHP version?
Features
- Parse command line parameters.
- Assign aliases to parameters.
- Custom closures for each command line parameter.
- Variadic closure support for arguments taking more than one value.
- Customize the way the command line is parsed.
Example Usage
import sys
from parameterparser import Parameter, Cluster, Parser
# Initialize a new Cluster
parameters = Cluster()
# Add a Parameter to the Cluster
parameter = Parameter("-", "name", lambda name: name)
parameter.set_required(True)\
.set_description("Your name.")
parameters.add(parameter)
# Create a new Parser using the Cluster
parser = Parser(sys.argv, parameters)
# Parse the parameters using the Parser.
results = parser.parse()
# Verify that the parameters were valid after parsing.
if not parser.is_valid():
# Since it was not valid, output usage.
parameters.print_full_usage(
"Parameter Parser",
"An advanced parameter parser for Python",
"v1.0.0"
)
else:
# Retrieve the name from the results
name = results['name']
# Output the name
print("Your name is " + name + os.linesep)
Output
~/ python test.py -name 'Nathan Fiscaletti'
Your name is Nathan Fiscaletti
Development
Before commiting anything, please create a pre-commit hook with the following content.
This will ensure that the pycodestyle badge is properly updated.
#!/bin/bash
python3 tests/style.py
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
parameterparser-0.1.7.tar.gz
(9.3 kB
view hashes)
Built Distribution
Close
Hashes for parameterparser-0.1.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1084457295b9e06f47cc1f0c51323a81e7b8a5867427a8536a76ff2583b0497 |
|
MD5 | 3fe3f09a2a86bda714e5e0bc3a1c5a52 |
|
BLAKE2b-256 | 320e3b2a532184aded3b0d5aec9d1914a1e98a48999688698deffcee59ac028b |