A compilation of useful python functions which all work in both Python2 and Python3, and without ANY non-native modules. You can import pysnips as a module, or just grab a specific method and use it directly in your code.
##UI Stuff
Easy method to write color to a str output then switch back to default black color (Works in Linux only)
INPUT: Input argument
input(str) is a string of text to color
INPUT: Input argument
inputcolor(obj var) is one of the pre-defined colors
OUTPUT: Output is the printable string colored appropriately
Create a pretty and printable table of data from a list of dictionaries where the key in each dict is the header and the val is the column value
INPUT: The
tabledataargument is the list of dictionaries and thecolumnorderargument is an ordered list of how the columns should be displayed
OUTPUT: The output of the method is a string of text which can be printed as an automatically formatted table.
Print out an animated (but utterly useless) progress bar to the console which makes it look like your app is doing a bunch of important stuff in the background.
INPUT: The
messageargument is a string used as the progress bar descriptor, thesecondsargument is the number of seconds that the progress bar animation should last.
OUTPUT: The printed output is animated and looks like:
<message> [================= ]
##Input Checkers
Report on standard status messages coming from other input check functions in pysnips. The status reporter is built around a standard messaging format in pysnips which is defined below.
Messaging Standard
- A standard status message from a "check" method is dictionary formatted as
{'status': <pass, warning, or fail>, 'messages': [<list of dicts>]} - The 'messages' value is a list of dicts. Each dict in the list is formatted as
{<OK, WARNING, or FATAL>: <Readable message from the specific check>}
Status Reporter Details
INPUT: Input argument
statusdatais a standard check message as defined in the "Messaging Standard" section.
INPUT: Input argument
reportlevelcan have values (onfail | onwarning | all) which set the level of report by the function
OUTPUT: Output is a string of printable status messages which report on the different checks
Check a domain or FQDN host name for legitimacy and proper formatting.
INPUT: Input
domainnameis a string of the domain name
OUTPUT: Output will be a pass/fail with status messages formatted in the standard messaging format (see "Status Reporter" for more info)
Check for a legitimate IPv4 address
INPUT: Input argument
iptype(str) can be (address | cidr) and argumentipdata(str) should be the IP address
OUTPUT: Output will be a pass/fail with status messages formatted in the standard messaging format (see "Status Reporter" for more info)
Check a Unix/Linux file or directory path for illegal patterns/characters and for required patterns
INPUT: Input
pathtypeargument (str) can be "dir" or "file" (depending on if the input is a file path or a directory path)
OUTPUT: Output will be a pass/fail with status messages formatted in the standard messaging format (see "Status Reporter" for more info)
##File System
List all files in a directory path and subdirs
INPUT: Input
dirpath(str) is the path of a directory to search
Input for a Linux path can look like
/root/somedir/. Windows must use double-backslash likeC:\\somedir
OUTPUT: Output is a list of all files (full filepath) in the search directory