schrodinger.application.jaguar.validation module¶

Jaguar keywords input validation and custom Exceptions

exception schrodinger.application.jaguar.validation.JaguarKeywordError(keyword, allowed_keywords)¶

Exception class raised when nonexistant Jaguar keyword is requested

exception schrodinger.application.jaguar.validation.JaguarKeywordException¶

Base exception class for all custom Jaguar keyword validation errors

exception schrodinger.application.jaguar.validation.JaguarKeywordFormatError(token)¶

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

exception schrodinger.application.jaguar.validation.JaguarKeywordValueError(keyword, value, settings)¶

Exception class raised when Jaguar keyword value is invalid

exception schrodinger.application.jaguar.validation.JaguarKeywordValueTypeError(keyword, value, valid_type)¶

Exception class raised when Jaguar keyword value has wrong type

schrodinger.application.jaguar.validation.keyword_value_pair_is_valid(keyword, value)¶

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

Parameters:	keyword (string) – e.g. ‘igeopt’ value (string) – e.g. ‘2’ or ‘0.004’ or any string
Returns:	True if all pairs valid, otherwise raise specialized exceptions.

schrodinger.application.jaguar.validation.keyword_value_pairs_are_valid(pairs)¶

Validate a string of keyword=value pairs

Parameters:	pairs (string) – e.g. ‘-keyword1=val1 -keyword2=value2 -keyword3=value3’
Returns:	True if all pairs valid, otherwise raise specialized exceptions.

schrodinger.application.jaguar.validation.value_is_type(valid_type, value)¶

Check if value has type equivalent to valid_type after converting string

Parameters:	valid_type (string) – types as described in keywordsDB.py value (string) – keyword value from input
Returns:	True or False