checksit.utils

Generic utility functions

Functions

extension(file_path)	Return file extension of string file name.
get_file_base(file_path)	Return file name up to the final underscore.
get_public_funcs(module)	Get all public functions from a module.
is_undefined(x)	Check if value is undefined.
map_to_rule(func)	Convert function name to spec file rule name.
string_to_dict(s)	Convert string value into dictionary.
string_to_list(s)	Convert string value into a list.

checksit.utils.extension(file_path: str) → str

Return file extension of string file name.

Returns the characters after the final “.” in a string, which in a file name is typically the extension denoting the file type.

Parameters:

file_path – string of which to get the file extension

Returns:

File extension as string.

checksit.utils.get_file_base(file_path: str) → str

Return file name up to the final underscore.

Splits the file name by underscores, and returns the string up to the final underscore. For use with file names in the template cache.

Parameters:

file_path – string of which to get the file base

Returns:

File base as string.

checksit.utils.get_public_funcs(module: object) → List[Callable[[...], Any]]

Get all public functions from a module.

Get all public functions from a given module. Public functions are those that do not begin with an underscore.

Parameters:

module – module from which to get public functions

Returns:

List of public functions from the module.

checksit.utils.is_undefined(x: Any) → bool

Check if value is undefined.

Parameters:

x – value to check

Returns:

True if value is undefined, False otherwise.

checksit.utils.map_to_rule(func: Callable[[...], Any]) → str

Convert function name to spec file rule name.

Convert the function name into the rule name used in the spec files by replacing underscores with hyphens. Underscores cannot be used in the spec files, so hyphens are used instead. This function is used with the describe functionality in printing out rules and their docstrings to terminal.

Parameters:

func – function to convert to rule name

Returns:

Rule name as string, with underscores replaced by hyphens.

checksit.utils.string_to_dict(s: str) → Dict[str, str]

Convert string value into dictionary.

Takes a string value, splits string by comma into key-value pairs, splits the key-value pairs by “=”, and creates a dictionary for those keys and values.

Parameters:

s – string to convert

Returns:

Dictionary from string value.

checksit.utils.string_to_list(s: str) → List[str]

Convert string value into a list.

Takes a string value, splits by comma, and returns the resulting list.

Parameters:

s – string to split

Returns:

List from string value.