Simple python package to handle cli user input.
Project description
Simple python package to handle cli user input.
How do I install this package?
As usual, just download it using pip:
pip install userinputTests Coverage
- Since some software handling coverages sometimes
get slightly different results, here’s three of them:
Available validators
Some commonly used validators are available with the package.
Validator name |
Description |
|---|---|
Check if given input string is a valid email. |
|
version_code |
Check if given input string is a valid version code. |
url |
Check if given input string is a valid URL. Does not check if given URL is online. |
human_bool |
Check if given input string is a human Boolean, such as “yes”, “y”, “true”, “si”, “no”, “n”, “false”. |
integer |
Check if given input string is a integer numeric value. |
positive_integer |
Check if given input string is a positive integer numeric value. |
non_empty |
Check if given input string is not empty. |
hostname |
Check if given input string is a reachable host name. |
ip |
Check if given input string is a reachable IP address. |
Use them as follows:
from userinput import userinput
result = userinput(
"my_label",
validator="validator name goes here"
)You can also chain validators. They will be called in the order you provide.
from userinput import userinput
result = userinput(
"my_label",
validator=[
"validator name goes here",
my_custom_validation_function
]
)Available sanitizers
Some commonly used sanitizers are available with the package.
Validator name |
Description |
|---|---|
human_bool |
Cast human Boolean specified above in validators to python Booleans. |
strip |
Remove padding spaces and repeated spaces. |
Use them as follows:
from userinput import userinput
result = userinput(
"my_label",
sanitizer="sanitizer name goes here"
)You can also chain sanitizers. They will be called in the order you provide.
from userinput import userinput
result = userinput(
"my_label",
sanitizer=[
"sanitizer name goes here",
my_custom_sanitification_function
]
)Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file userinput-1.0.12.tar.gz.
File metadata
- Download URL: userinput-1.0.12.tar.gz
- Upload date:
- Size: 7.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7d3048f3f7e63d26266aec7f0c08e634113d31f58843b6e98301e6e276c02e76 |
|
| MD5 | f864ccd690715f41f3f9a0e73f727ca4 |
|
| BLAKE2b-256 | a40880364a20f3478ccccf971ba50a04f5ae26fef28787ea07d58b4392abfb7c |
