jc/docs/utils.md

utils

jc - JSON CLI output utility utils

warning_message

warning_message(message)

Prints a warning message for non-fatal issues

Parameters:

message:        (string) text of message

Returns:

None - just prints output to STDERR

error_message

error_message(message)

Prints an error message for fatal issues

Parameters:

message:        (string) text of message

Returns:

None - just prints output to STDERR

compatibility

compatibility(mod_name, compatible)

Checks for the parser's compatibility with the running OS platform.

Parameters:

mod_name:       (string) __name__ of the calling module

compatible:     (list) sys.platform name(s) compatible with the parser
                compatible options:
                linux, darwin, cygwin, win32, aix, freebsd

Returns:

None - just prints output to STDERR

has_data

has_data(data)

Checks if the input contains data. If there are any non-whitespace characters then return True, else return False

Parameters:

data:        (string) input to check whether it contains data

Returns:

Boolean      True if input string (data) contains non-whitespace characters, otherwise False

timestamp

timestamp(datetime_string)

Input a date-time text string of several formats and convert to a naive or timezone-aware epoch timestamp in UTC

Parameters: datetime_string: (str) a string representation of a date-time in several supported formats

Attributes: string (str) the input datetime string format (int) the format rule that was used to decode the datetime string naive (int) timestamp based on locally configured timezone. None if conversion fails utc (int) aware timestamp only if UTC timezone detected in datetime string. None if conversion fails