commandlines 
What is Commandlines?
Commandlines is a Python library for command line application development that supports command line argument parsing, command string validation testing, & application logic. It has no external dependencies and provides broad Python interpreter support for Python 2.6+, Python 3.3+, pypy, and pypy3 across OS X, Linux, and Windows platforms.
How Do I Use It?
The command line string to your executable script is parsed to multiple objects that are derived from builtin Python types.
The Command Object
Instantiate a commandlines Command object:
from commandlines import Command
c = Command()and you have access to:
Arguments
Command Line Arguments |
Command Example |
Accessed/Tested With |
|---|---|---|
Length of arg list |
$ spam eggs -t --out file |
c.argc == 4 |
Command suite sub-commands |
$ spam eggs |
c.subcmd == "eggs" |
Command suite sub-sub-commands |
$ spam eggs overeasy |
c.subsubcmd == "overeasy" |
Short switch syntax |
$ spam -e |
c.contains_switches('e') |
Long switch syntax |
$ spam --eggs |
c.contains_switches('eggs') |
Multiple switches |
$ spam -e --eggs |
c.contains_switches('e', 'eggs') |
Short opt-arg definition syntax |
$ spam -o eggs |
c.get_definition('o') |
Long opt-arg definition syntax |
$ spam --out egg s |
c.get_definition('out') |
Alt long opt-arg definition syntax |
$ spam --out=egg s |
c.get_definition('out') |
Multiple same option definitions |
$ spam -o eggs -o omelets |
c.get_multiple_definitions('o') |
Multi-option short syntax switches |
$ spam -mpns egg s |
c.contains_mops('m') |
Next positional argument |
$ spam eggs test/path |
c.get_arg_after('eggs') |
Positional Arguments
Positional arguments use a 0 based index starting at the first argument to the executable (i.e. sys.argv[1:]) and are maintained as attributes in the Command object. Individual attribute support is provided for the first five positional arguments and the last positional argument. An ordered list of all positional arguments is available in the arguments attribute.
Positional Argument |
Command Example |
Accessed/Tested With |
|---|---|---|
Positional argument at index 0 |
$ spam eggs |
c.arg0 |
Positional argument at index 1 |
$ spam eggs bacon |
c.arg1 |
Positional argument at index 2 |
$ spam eggs bacon toast |
c.arg2 |
Positional argument at index 3 |
$ spam eggs bacon toast cereal |
c.arg3 |
Positional argument at index 4 |
$ spam eggs bacon toast cereal milk |
c.arg4 |
Last positional argument |
$ spam eggs -b --toast filepath |
c.arglp |
All positional arguments |
$ spam eggs -b - -toast filepath |
c.arguments |
Special Command Line Idioms
Command Line Idioms |
Command Example |
Accessed/Tested With |
|---|---|---|
Double dash idiom |
$ spam eggs -- -badfile |
c.has_double_dash() |
Double dash arguments |
$ spam eggs -- -badfile -badfile2 |
c.get_double_dash_args() |
Application Logic Testing Methods
Test Type |
Command Example |
Tested With |
|---|---|---|
Positional command sequence |
$ spam eggs doit |
c.has_command_sequence('eggs', 'doit') |
Single switch |
$ spam -s |
c.contains_switches('s') |
Multiple switch |
$ spam -s --eggs |
c.contains_switches('s', 'eggs') |
Single definition |
$ spam -o eggs |
c.contains_definitions('o') |
Multiple different definitions |
$ spam -o eggs --with bacon |
c.contains_definitions('o', 'with') |
Multiple same definitions |
$ spam -o eggs -o bacon |
c.contains_multi_definitions('o') |
Positional argument |
$ spam eggs --coffee |
c.has_args_after('eggs') |
Acceptable positional arg |
$ spam eggs toaster |
c.next_arg_is_in('eggs', ['toaster', 'coffeepot']) |
Command String Validation Methods
Test Type |
Failure Example |
Tested With |
|---|---|---|
Missing arguments |
$ spam |
c.does_not_validate_missing_args() |
Expected argument number |
$ spam eggs |
c.does_not_validate_n_args(2) |
Missing opt-arg definitions |
$ spam -o --eggs |
c.does_not_validate_missing_defs() |
Missing switches |
$ spam eggs |
c.does_not_validate_missing_switches() |
Missing multi-option short syntax switches |
$ spam -o eggs |
c.does_not_validate_missing_mops() |
Help, Usage, and Version Request Testing Methods
Test Type |
Command Example |
Tested With |
|---|---|---|
Help request, short |
$ spam -h |
c.is_help_request() |
Help request, long |
$ spam --help |
c.is_help_request() |
Usage request |
$ spam --usage |
c.is_usage_request() |
Version request, short |
$ spam -v |
c.is_version_request() |
Version request, long |
$ spam --version |
c.is_version_request() |
API Documentation
You can view the full documentation for the Command class here.
If you would like to dig into lower level objects in the commandlines package, you can view the library API documentation.
Exceptions that are used in the commandlines package are documented here.
How to Include Commandlines in Your Project
For Projects That Will Be Distributed to Others
Add the commandlines package dependency to your project setup.py file in the install_requires field like so:
setup(
...
install_requires=["commandlines"],
...
)Then, enter the following command to test your project locally:
$ python setup.py develop
Import the commandlines package in your project and instantiate a Command object by adding the following lines to your Python script:
from commandlines import Command
c = Command()And away you go…
The Commandlines package will be installed automatically for users who install your releases via pip or your project setup.py file (i.e. with the command $ python setup.py install).
For Local Projects That Are Not Intended for Redistribution
Install the Commandlines package with the command:
$ pip install commandlines
Import the commandlines package in your project and instantiate a Command object by adding the following lines to your Python script:
from commandlines import Command
c = Command()License
Commandlines is licensed under the MIT license.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file commandlines-0.3.0.tar.gz.
File metadata
- Download URL: commandlines-0.3.0.tar.gz
- Upload date:
- Size: 15.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a3116a88584b8c9a39ac5b3292e78e0d8b0ab9e58228d984969e6ab3e1616c3c
|
|
| MD5 |
e7713ee1f1ee072d43c049ea0f96085d
|
|
| BLAKE2b-256 |
5b3d9c4bc3f15df8a153cb236876b8507e08db2056bbd508039dec3366141c23
|
File details
Details for the file commandlines-0.3.0-py2.py3-none-any.whl.
File metadata
- Download URL: commandlines-0.3.0-py2.py3-none-any.whl
- Upload date:
- Size: 16.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3c7cbc04477610ea08fcbec01beb0bde1d87bffb1e32a1d83631e40d7af51430
|
|
| MD5 |
eae1a3ac4b06e0b063ab9164836120f7
|
|
| BLAKE2b-256 |
a093321c8be58fc11aa0f38bd9f3efec8000a0e8768f77450401a77f46e8e6ae
|
