Module validation

Jaguar keywords input validation and custom Exceptions

Classes

JaguarKeywordException
Base exception class for all custom Jaguar keyword validation errors

JaguarKeywordError
Exception class raised when nonexistant Jaguar keyword is requested

JaguarKeywordValueTypeError
Exception class raised when Jaguar keyword value has wrong type

JaguarKeywordValueError
Exception class raised when Jaguar keyword value is invalid

JaguarKeywordFormatError
Exception class raised when a string not in the keyword=value format is found

Functions

value_is_type(valid_type, value)
Check if value has type equivalent to valid_type after converting string

keyword_value_pair_is_valid(keyword, value)
Validate a specific keyword=value pair.

keyword_value_pairs_are_valid(pairs)
Validate a string of keyword=value pairs

Variables

STRING = 'string'

INTEGER = 'integer'

REAL = 'real'

_keywords_dict = None
hash(x)

_keywords_list = None
hash(x)

__package__ = 'schrodinger.application.jaguar'

Function Details

Check if value has type equivalent to valid_type after converting string

Parameters:

Returns:

True or False

Validate a specific keyword=value pair. The checks are case insensitive.

Parameters:

Returns:

True if all pairs valid, otherwise raise specialized exceptions.

Validate a string of keyword=value pairs

Parameters:

Returns:

True if all pairs valid, otherwise raise specialized exceptions.