# -*- coding: utf-8 -*- """ Created on Thu Apr 27 12:33:59 2023 @author: Edward Middleton-Smith Argument Validation """ # CLASSES # ATTRIBUTE DECLARATION # METHODS # FUNCTION # ARGUMENTS # ARGUMENT VALIDATION # ATTRIBUTE + VARIABLE INSTANTIATION # METHODS # RETURNS # NORMAL METHODS # FUNCTION # ARGUMENTS # ARGUMENT VALIDATION # VARIABLE INSTANTIATION # METHODS # RETURNS from typing import Optional def error_msg_str(method, v_name, v, v_type, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # return error message string for output of invalid argument / attribute to user # ARGUMENTS # str method - name of parent method which calls this function # str arg_name - name of argument throwing error # ? v - erroneous variable # str v_type - desired / expected variable type # str arg_type - e.g. argument, attribute # bool suppress_errors - should outputs not be raised as errors? # bool suppress_console_outputs # ARGUMENT VALIDATION my_f = 'error_msg_str' # suppress_errors if not val_bool(suppress_errors, 'suppress_errors', my_f): error_msg = error_msg_str(my_f, 'suppress_errors', suppress_errors, "") raise ValueError(error_msg) # suppress_console_outputs if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): error_msg = error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors) if suppress_errors: print(error_msg) return error_msg else: raise ValueError(error_msg) # method if not val_str(method, 'method', my_f, suppress_errors=suppress_errors, suppress_console_outputs=suppress_console_outputs): error_msg = error_msg_str(my_f, 'method', method, "", suppress_errors, suppress_console_outputs) if suppress_errors: if not suppress_console_outputs: print(error_msg) return error_msg else: raise ValueError(error_msg) my_f = method + '.' + my_f # v_name if not val_str(v_name, 'v_name', my_f, -1, -1, suppress_errors, suppress_console_outputs): error_msg = error_msg_str(my_f, 'v_name', v_name, "", suppress_errors, suppress_console_outputs) if suppress_errors: if not suppress_console_outputs: print(error_msg) return error_msg else: raise ValueError(error_msg) # v_type if not val_str(v_type, 'v_type', my_f, -1, -1, suppress_errors, suppress_console_outputs): error_msg = error_msg_str(my_f, 'v_type', v_type, "", suppress_errors, suppress_console_outputs) if suppress_errors: if not suppress_console_outputs: print(error_msg) return error_msg else: raise ValueError(error_msg) # v_arg_type if not val_str(v_arg_type, 'v_arg_type', my_f, -1, -1, suppress_errors, suppress_console_outputs): error_msg = error_msg_str(my_f, 'v_arg_type', v_arg_type, "", suppress_errors, suppress_console_outputs) if suppress_errors: if not suppress_console_outputs: print(error_msg) return error_msg else: raise ValueError(error_msg) # RETURNS return f"Invalid {method} {v_type} {v_arg_type} {v_name}. Type = {str(type(v))}. Value = {v}" def val_bool(v_input, v_name, method, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # validate that myinput is of type bool # ARGUMENTS # bool (hopefully) myinput # str v_name # str method # optional bool suppress_errors # optional bool suppress_console_outputs # optional str v_arg_type # ARGUMENT VALIDATION # validate bool inputs first v_type = "" my_f = 'val_bool' if str(type(suppress_errors)) != v_type: raise ValueError(error_msg_str(my_f, 'suppress_errors', suppress_errors, v_type)) if str(type(suppress_console_outputs)) != v_type: error_msg = error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, v_type, suppress_errors) if suppress_errors: print(error_msg) return False raise ValueError(error_msg) v_type = "" # method valid = True if str(type(method)) != v_type: valid = False else: if len(method) < 1: valid = False if not valid: error_msg = error_msg_str(my_f, 'method', method, v_type, suppress_errors, suppress_console_outputs) if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) my_f = method + '.' + my_f # v_name valid = True if str(type(v_name)) != v_type: valid = False else: if len(v_name) < 1: valid = False if not valid: error_msg = error_msg_str(my_f, 'v_name', v_name, v_type, suppress_errors, suppress_console_outputs) if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) # v_arg_type valid = True if str(type(v_arg_type)) != v_type: valid = False else: if len(v_arg_type) < 1: valid = False if not valid: error_msg = error_msg_str(my_f, 'v_arg_type', v_arg_type, v_type, suppress_errors, suppress_console_outputs) if suppress_errors: if not suppress_console_outputs: print(error_msg) return False else: raise ValueError(error_msg) # v_input v_type = "" if (str(type(v_input)) != v_type): error_msg = error_msg_str(method, v_name, v_input, v_type, suppress_errors, suppress_console_outputs) if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) # RETURNS return True def val_str(v_input, v_name, method, min_len = -1, max_len = -1, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # validate that v_input is of type str # ARGUMENTS # str (hopefully) v_input # str v_name # str method # optional int min_len # optional int max_len # optional bool suppress_errors # optional bool suppress_console_outputs # optional str v_arg_type # ARGUMENT VALIDATION my_f = 'val_str' v_type = "" # suppress_errors val_bool(suppress_errors, 'suppress_errors', my_f) # suppress_console_outputs if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors)) return False # method valid = True if str(type(method)) != v_type: valid = False else: if len(method) < 1: valid = False if not valid: error_msg = error_msg_str(my_f, 'method', method, v_type) if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) my_f = method + '.' + my_f # v_name valid = True if str(type(v_name)) != v_type: valid = False else: if len(v_name) < 1: valid = False if not valid: error_msg = error_msg_str(my_f, 'v_name', v_name, v_type) if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) # v_arg_type valid = True if str(type(v_arg_type)) != v_type: valid = False else: if len(v_arg_type) < 1: valid = False if not valid: error_msg = error_msg_str(my_f, 'v_arg_type', v_arg_type, v_type) if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) # min_len v_type = "" if str(type(min_len)) != v_type: error_msg = error_msg_str(my_f, 'min_len', min_len, v_type) if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) # max_len v_type = "" valid = True if str(type(max_len)) != v_type: valid = False else: if max_len != -1 and max_len < min_len: valid = False if not valid: error_msg = error_msg_str(my_f, 'max_len', max_len, v_type) if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) # v_input # VARIABLE INSTANTIATION v_type = "" valid = True # METHODS if str(type(v_input)) != v_type: valid = False else: L = len(v_input) if min_len != -1 and L < min_len: valid = False print(f"Minimum str length {min_len} not met.") if max_len != -1 and L > max_len: print(f"Maximum str length {max_len} not met.") valid = False if not valid: error_msg = error_msg_str(method, v_name, v_input, v_type, suppress_errors, suppress_console_outputs, v_arg_type) if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) # RETURNS return True # def val_none(v_input, v_name, method, v_arg_type = 'argument', suppress_errors = False, suppress_console_outputs = False): # # FUNCTION # # evaluate if v_input is None # # ARGUMENTS # # ARGUMENT VALIDATION # # VARIABLE INSTANTIATION # # METHODS # # RETURNS def val_int(v_input, v_name, method, v_min: Optional[int] = None, v_max: Optional[int] = None, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # validate that myinput is of type int, and if not None, limited by v_min and v_max # ARGUMENTS # int (hopefully) myinput # str v_name # str method # optional int v_min # optional int v_max # optional bool suppress_errors # optional bool suppress_console_outputs # optional str v_arg_type # ARGUMENT VALIDATION my_f = 'val_int' # suppress_errors val_bool(suppress_errors, 'suppress_errors', my_f) # suppress_console_outputs if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors)) return False # method if not val_str(method, 'method', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False my_f = method + '.' + my_f # v_name if not val_str(v_name, 'v_name', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_arg_type if not val_str(v_arg_type, 'v_arg_type', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_min if (v_min != None): if not val_int(v_min, 'v_min', my_f, None, None, suppress_errors, suppress_console_outputs): return False # v_max if (v_max != None): if not val_int(v_max, 'v_max', my_f, None, None, suppress_errors, suppress_console_outputs): return False # v_input # VARIABLE INSTANTIATION mytype = "" # str(type(myinput)) error_msg = error_msg_str(method, v_name, v_input, mytype, suppress_errors, suppress_console_outputs, v_arg_type) # METHODS if not mytype == str(type(v_input)): if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) if (v_min != None and v_max != None): if (v_min > v_max): if suppress_errors: if not suppress_console_outputs: print(error_msg + f"\nInverted minimum and maximum values {v_min} and {v_max}.") return False raise ValueError(error_msg + f"\nInverted minimum and maximum values {v_min} and {v_max}.") if (v_min != None): if (v_input < v_min): if suppress_errors: if not suppress_console_outputs: print(error_msg + f"\nValue less than minimum {v_min}.") return False raise ValueError(error_msg + f"\nValue less than minimum {v_min}.") if (v_max != None): if (v_input > v_max): if suppress_errors: if not suppress_console_outputs: print(error_msg + f"\nValue greater than maximum {v_max}.") return False raise ValueError(error_msg + f"\nValue greater than maximum {v_max}.") # RETURNS return True def val_float(v_input, v_name, method, v_min = None, v_max = None, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # validate that v_input is of type float, and if not None, limited by v_min and v_max # ARGUMENTS # float (hopefully) v_input # str v_name # str method # optional float v_min # optional float v_max # optional bool suppress_errors # optional bool suppress_console_outputs # optional str v_arg_type # ARGUMENT VALIDATION my_f = 'val_float' # suppress_errors val_bool(suppress_errors, 'suppress_errors', my_f) # suppress_console_outputs if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors)) return False # v_name if not val_str(v_name, 'v_name', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # method if not val_str(method, 'method', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False my_f = method + '.' + my_f # v_arg_type if not val_str(v_arg_type, 'v_arg_type', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_min if (v_min != None): if not val_float(v_min, 'v_min', my_f, None, None, suppress_errors, suppress_console_outputs): return False # v_max if (v_max != None): if not val_float(v_max, 'v_max', my_f, None, None, suppress_errors, suppress_console_outputs): return False # v_input # VARIABLE INSTANTIATION mytype = "" # str(type(myinput)) error_msg = error_msg_str(method, v_name, v_input, mytype, suppress_errors, suppress_console_outputs, v_arg_type) # METHODS if not mytype == str(type(v_input)): if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) if (v_min != None and v_max != None): if (v_min > v_max): if suppress_errors: if not suppress_console_outputs: print(error_msg + f"\nInverted minimum and maximum values {v_min} and {v_max}.") return False raise ValueError(error_msg + f"\nInverted minimum and maximum values {v_min} and {v_max}.") if (v_min != None): if (v_input < v_min): if suppress_errors: if not suppress_console_outputs: print(error_msg + f"\nValue less than minimum {v_min}.") return False raise ValueError(error_msg + f"\nValue less than minimum {v_min}.") if (v_max != None): if (v_input > v_max): if suppress_errors: if not suppress_console_outputs: print(error_msg + f"\nValue greater than maximum {v_max}.") return False raise ValueError(error_msg + f"\nValue greater than maximum {v_max}.") # RETURNS return True def input_bool(v_input, v_name, method, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # input valid str, int, or bool representation of bool, or else None # ARGUMENTS # bool (hopefully) v_input # str v_name # str method # optional str v_arg_type # optional bool suppress_errors # optional bool suppress_console_outputs # ARGUMENT VALIDATION my_f = 'input_bool' # suppress_errors val_bool(suppress_errors, 'suppress_errors', my_f) # suppress_console_outputs if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors)) return None # v_name if not val_str(v_name, 'v_name', my_f, 1, -1, suppress_errors, suppress_console_outputs): return None # method if not val_str(method, 'method', my_f, 1, -1, suppress_errors, suppress_console_outputs): return None my_f = method + '.' + my_f # v_arg_type if not val_str(v_arg_type, 'v_arg_type', my_f, 1, -1, suppress_errors, suppress_console_outputs): return None # METHODS if not val_bool(v_input, v_name, my_f, suppress_errors, suppress_console_outputs): if not val_int(v_input, v_name, my_f, 0, 1, suppress_errors, suppress_console_outputs): error_msg = error_msg_str(method, v_name, v_input, "", suppress_errors, suppress_console_outputs, v_arg_type) if not val_str(v_input, v_name, my_f, suppress_errors, suppress_console_outputs): if suppress_errors: if not suppress_console_outputs: print(error_msg) return None raise ValueError(error_msg) else: my_truths = ['Y', 'YE', 'YES', 'YS', 'YESH', 'YEA', 'YEAH', 'TRUE', 'TRU', 'TRUTH', 'TURE', 'T'] my_falths = ['N', 'NO', 'FALSE', 'F', 'FAIL', 'FALS'] for i in range(len(my_truths)): if my_truths[i] == v_input: return True for i in range(len(my_falths)): if my_falths[i] == v_input: return False if suppress_errors: if not suppress_console_outputs: print(error_msg) return None raise ValueError(error_msg) else: return False if v_input == 0 else True # RETURNS return v_input def full_val_bool(v_input, v_name, method, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # validate that bool input is bool or valid equivalent # ARGUMENTS # bool (hopefully) my_input # str v_name # str method # optional bool suppress_errors # optional bool suppress_console_outputs # optional str v_arg_type # ARGUMENT VALIDATION my_f = 'full_val_bool' val_bool(suppress_errors, 'suppress_errors', my_f) if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors)) return False # method if not val_str(method, 'method', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False my_f = method + '.' + my_f # v_name if not val_str(v_name, 'v_name', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_arg_type if not val_str(v_arg_type, 'v_arg_type', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # RETURNS return not (str(type(input_bool(v_input, v_name, method, suppress_errors, suppress_console_outputs, v_arg_type))) == "") def input_int(v_input, v_name, method, v_min = None, v_max = None, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # input int or valid equivalent, or else None # ARGUMENTS # int or str v_input # str v_name # str method # v_min # v_min # bool suppress_errors # bool suppress_console_outputs # optional str v_arg_type # ARGUMENT VALIDATION my_f = 'input_int' val_bool(suppress_errors, 'suppress_errors', my_f) if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors)) return None # method if not val_str(method, 'method', my_f, 1, -1, suppress_errors, suppress_console_outputs): return None my_f = method + '.' + my_f # v_name if not val_str(v_name, 'v_name', my_f, 1, -1, suppress_errors, suppress_console_outputs): return None # v_arg_type if not val_str(v_arg_type, 'v_arg_type', my_f, 1, -1, suppress_errors, suppress_console_outputs): return None # v_min if not str(type(v_min)) == "": v_min = input_int(v_min, 'v_min', my_f, None, v_max, suppress_errors, suppress_console_outputs) if str(type(v_min)) == "": return None # v_max if not str(type(v_max)) == "": v_max = input_int(v_max, 'v_min', my_f, v_min, None, suppress_errors, suppress_console_outputs) if str(type(v_max)) == "": return None # METHODS error_msg = error_msg_str(method, v_name, v_input, "", suppress_errors, suppress_console_outputs, v_arg_type) # v_input try: my_int = int(v_input) except: if suppress_errors: if not suppress_console_outputs: print(error_msg) return None int(v_input) if not str(type(v_min)) == "": if my_int < v_min: if suppress_errors: if not suppress_console_outputs: print(f"{error_msg}\nInt input less than minimum value. Value = {v_input}, minimum = {v_min}.") return None if not str(type(v_max)) == "": if my_int > v_max: if suppress_errors: if not suppress_console_outputs: print(f"{error_msg}\nInt input greater than maximum value. Value = {v_input}, maximum = {v_max}.") return None # RETURNS return my_int def full_val_int(v_input, v_name, method, v_min = None, v_max = None, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # validate that v_input is int or equivalent, else False, limited by v_min and v_max # ARGUMENTS # int (hopefully) v_input # str v_name # str method # optional float v_min # optional float v_max # optional bool suppress_errors # optional bool suppress_console_outputs # optional str v_arg_type # ARGUMENT VALIDATION my_f = 'full_val_int' val_bool(suppress_errors, 'suppress_errors', my_f) if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors)) return False # v_name if not val_str(v_name, 'v_name', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # method if not val_str(method, 'method', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_min if not str(type(v_min)) == "": v_min = input_int(v_min, 'v_min', method, None, v_max, suppress_errors, suppress_console_outputs) if str(type(v_min)) == "": return False # v_max if not str(type(v_max)) == "": v_max = input_int(v_max, 'v_min', method, v_min, None, suppress_errors, suppress_console_outputs) if str(type(v_max)) == "": return False # RETURNS return not (str(type(input_int(v_input, v_name, method, v_min, v_max, suppress_errors, suppress_console_outputs))) == "") def input_float(v_input, v_name, method, v_min = None, v_max = None, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # input float, else return None # ARGUMENTS # float/int/str(numeric) v_input # str v_name # str method # optional float v_min # optional float v_min # optional bool suppress_errors # optional bool suppress_console_outputs # optional str v_arg_type # ARGUMENT VALIDATION my_f = 'input_float' val_bool(suppress_errors, 'suppress_errors', my_f) if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors)) return None # method if not val_str(method, 'method', my_f, 1, -1, suppress_errors, suppress_console_outputs): return None my_f = method + '.' + my_f # v_name if not val_str(v_name, 'v_name', my_f, 1, -1, suppress_errors, suppress_console_outputs): return None # v_arg_type if not val_str(v_arg_type, 'v_arg_type', my_f, 1, -1, suppress_errors, suppress_console_outputs): return None # v_min if not str(type(v_min)) == "": v_min = input_float(v_min, 'v_min', my_f, None, v_max, suppress_errors, suppress_console_outputs) if str(type(v_min)) == "": return None # v_max if not str(type(v_max)) == "": v_max = input_float(v_max, 'v_min', my_f, v_min, None, suppress_errors, suppress_console_outputs) if str(type(v_max)) == "": return None # METHODS error_msg = error_msg_str(method, v_name, v_input, "", suppress_errors, suppress_console_outputs, v_arg_type) # v_input try: my_float = float(v_input) except: if suppress_errors: if not suppress_console_outputs: print(error_msg) return None float(v_input) if not str(type(v_min)) == "": if v_input < v_min: if suppress_errors: if not suppress_console_outputs: print(f"{error_msg}\nInt input less than minimum value. Value = {v_input}, minimum = {v_min}.") return None if not str(type(v_max)) == "": if v_input > v_max: if suppress_errors: if not suppress_console_outputs: print(f"{error_msg}\nInt input greater than maximum value. Value = {v_input}, maximum = {v_max}.") return None # RETURNS return my_float def full_val_float(v_input, v_name, method, v_min = None, v_max = None, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # validate that v_input is numeric, and if not False, limited by v_min and v_max # ARGUMENTS # float (hopefully) v_input # str v_name # str method # optional float v_min # optional float v_max # optional bool suppress_errors # optional bool suppress_console_outputs # ARGUMENT VALIDATION my_f = 'full_val_float' val_bool(suppress_errors, 'suppress_errors', my_f) if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors)) return False # method if not val_str(method, 'method', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False my_f = method + '.' + my_f # v_name if not val_str(v_name, 'v_name', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_arg_type if not val_str(v_arg_type, 'v_arg_type', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_min if not str(type(v_min)) == "": v_min = input_float(v_min, 'v_min', method, None, v_max, suppress_errors, suppress_console_outputs) if str(type(v_min)) == "": return False # v_max if not str(type(v_max)) == "": v_max = input_float(v_max, 'v_min', method, v_min, None, suppress_errors, suppress_console_outputs) if str(type(v_max)) == "": return False # RETURNS return not (str(type(input_float(v_input, v_name, method, v_min, v_max, suppress_errors, suppress_console_outputs))) == "") def make_ordinal(n): # FUNCTION # Get ordinal representation of number # ARGUMENTS # int n # ARGUMENT VALIDATION full_val_int(n, 'n', 'make_ordinal', 0) # VARIABLE INSTANTIATION n = int(n) # METHODS if 11 <= (n % 100): suffix= 'th' else: suffix = ['th', 'st', 'nd', 'rd', 'th'][min(n % 10, 4)] # RETURNS return str(n) + suffix def val_type(v_input, v_type, v_name, method, suppress_errors = False, suppress_console_outputs = False, v_arg_type = 'argument'): # FUNCTION # validate that v_input is of type v_type # ARGUMENTS # v_type (hopefully) v_input # str v_type # str v_name # str method # optional bool suppress_errors # optional bool suppress_console_outputs # str v_arg_type # ARGUMENT VALIDATION my_f = 'val_type' val_bool(suppress_errors, 'suppress_errors', my_f) if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors)) return False # method if not val_str(method, 'method', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False my_f = method + '.' + my_f # v_name if not val_str(v_name, 'v_name', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_arg_type if not val_str(v_arg_type, 'v_arg_type', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_type if not val_str(v_type, 'v_type', my_f, 6, -1, suppress_errors, suppress_console_outputs): return False # v_input error_message = error_msg_str(method, v_name, v_input, v_arg_type) mytype = str(type(v_input)) # if not (v_type == 'int' or v_type == 'bool' or v_type == 'float' or v_type == 'complex' or v_type == 'str' or v_type == 'NoneType'): if not mytype == v_type: # f"": if suppress_errors: if not suppress_console_outputs: print(error_message) return False raise ValueError(error_message) # RETURNS return True def val_list(v_input, v_name, method, v_type = '', min_len = -1, max_len = -1, suppress_errors = False, suppress_console_outputs: bool = False, v_arg_type = 'argument'): # FUNCTION # validate that v_input is of type list, and if defined: has v_len elements of type v_type # ARGUMENTS # list[v_type] (hopefully) v_input # str v_name - variable name # str method - parent method # str v_type - type of list items # int v_len - length of list # optional bool suppress_errors # optional bool suppress_console_outputs # optional str v_arg_type # ARGUMENT VALIDATION my_f = 'val_list' val_bool(suppress_errors, 'suppress_errors', my_f) if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "", suppress_errors)) return False # method if not val_str(method, 'method', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False my_f = method + '.' + my_f # v_name if not val_str(v_name, 'v_name', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_arg_type if not val_str(v_arg_type, 'v_arg_type', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_type if not val_str(v_type, 'v_type', my_f, -1, -1, suppress_errors, suppress_console_outputs): return False # min_len if not full_val_int(min_len, 'min_len', my_f, None, None if max_len == -1 else max_len, suppress_errors, suppress_console_outputs): return False # min_len = input_int(min_len, 'min_len', method, None, max_len, suppress_errors, suppress_console_outputs) # if str(type(min_len)) == "": return False # max_len if not full_val_int(max_len, 'max_len', my_f, None if max_len == -1 else (None if min_len == -1 else min_len), None, suppress_errors, suppress_console_outputs): return False # if not str(type(max_len)) == "": # max_len = input_int(max_len, 'max_len', method, min_len, None, suppress_errors, suppress_console_outputs) # if str(type(max_len)) == "": return False # v_input mytype = str(type(v_input)) error_msg = error_msg_str(method, v_name, v_input, "") if not mytype == "": if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) L = len(v_input) if max_len > -1 and L > max_len: if suppress_errors: if not suppress_console_outputs: print(error_msg + f'\nInvalid list length. Maximum = {max_len}, length = {L}') return False raise ValueError(error_msg + f'\nInvalid list length. Maximum = {max_len}, length = {L}') if L < min_len: if suppress_errors: if not suppress_console_outputs: print(error_msg + f"Invalid list length. Minimum = {min_len}, length = {L}") return False raise ValueError(error_msg + f'\nInvalid list length. Minimum = {min_len}, length = {L}') if v_type != '' and L > 0: for i in range(L): mytype = str(type(v_input[i])) if not mytype == v_type: error_msg = error_msg + '\n' + error_msg_str(my_f, v_name, v_input, v_type, False, False, 'list element') if suppress_errors: if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) # RETURNS return True def val_nested_list(v_input, depth_i, depth_max, v_name, method, v_type = '', v_min = -1, v_mins = [], v_max = -1, v_maxs: list = [], suppress_errors = False, suppress_console_outputs: bool = False, v_arg_type = 'argument'): # FUNCTION # validate that v_input is of type list, and if defined: has v_len elements of type v_type # for nested list of nested-index i # ARGUMENTS # list[v_type] (hopefully) v_input # int depth_i - current depth of nesting of lists # int depth_max - maximum depth of nesting of lists - base 0 # str v_name # str method # Optional[str] v_type - type of list items # Optional[int] v_min - minimum sublist size # Optional[list[int]] v_mins - minimum list sizes # Optional[int] v_max - maximum sublist size # Optional[list[int]] v_maxs - maximum list sizes # optional bool suppress_errors # optional bool suppress_console_outputs # optional str v_arg_type # ARGUMENT VALIDATION my_f = 'val_nested_list' val_bool(suppress_errors, 'suppress_errors', my_f) if not val_bool(suppress_console_outputs, 'suppress_console_outputs', my_f, suppress_errors): print(error_msg_str(my_f, 'suppress_console_outputs', suppress_console_outputs, "")) return False # method if not val_str(method, 'method', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False my_f = method + '.' + my_f # v_name if not val_str(v_name, 'v_name', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_arg_type if not val_str(v_arg_type, 'v_arg_type', my_f, 1, -1, suppress_errors, suppress_console_outputs): return False # v_type if not val_str(v_type, 'v_type', my_f, -1, -1, suppress_errors, suppress_console_outputs): return False # v_min if not val_int(v_min, 'v_min', my_f, -1, None, suppress_errors, suppress_console_outputs): return False # v_max if not val_int(v_max, 'v_max', my_f, -1, None, suppress_errors, suppress_console_outputs): return False # v_mins if not (val_list(v_mins, 'v_mins', my_f, "", depth_max + 1, depth_max + 1, True, True) or v_mins == []): error_msg = error_msg_str(my_f, 'v_mins', v_mins, "") if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) # v_maxs if not (val_list(v_maxs, 'v_maxs', my_f, "", depth_max + 1, depth_max + 1, True, True) or v_maxs == []): error_msg = error_msg_str(my_f, 'v_maxs', v_maxs, "") if not suppress_console_outputs: print(error_msg) return False raise ValueError(error_msg) # v_input mytype = v_type if depth_i == depth_max else "" error_msg = error_msg_str(method, v_name, v_input, mytype, suppress_errors, suppress_console_outputs, v_arg_type) if not val_list(v_input, v_name, method, mytype, v_min, v_max, suppress_errors, suppress_console_outputs, v_arg_type): if not suppress_console_outputs: print(error_msg) return False # METHODS L = len(v_input) if L == 0: if v_min > -1: if suppress_errors: if not suppress_console_outputs: print(error_msg + f'\nMinimum length {v_min} not met.') return False raise ValueError(error_msg + f'\nMinimum length {v_min} not met.') elif depth_i < depth_max: for i in range(L): if not (v_mins == [] or v_maxs == []): if not val_nested_list(v_input[i], depth_i + 1, depth_max, v_name, method, v_type, v_mins[depth_i + 1], v_mins, v_maxs[depth_i + 1], v_maxs, suppress_errors, suppress_console_outputs, v_arg_type): if not suppress_console_outputs: print(error_msg) return False elif not v_mins == []: if not val_nested_list(v_input[i], depth_i + 1, depth_max, v_name, method, v_type, v_mins[depth_i + 1], v_mins, -1, v_maxs, suppress_errors, suppress_console_outputs, v_arg_type): if not suppress_console_outputs: print(error_msg) return False elif not v_maxs == []: if not val_nested_list(v_input[i], depth_i + 1, depth_max, v_name, method, v_type, -1, v_mins, v_maxs[depth_i + 1], v_maxs, suppress_errors, suppress_console_outputs, v_arg_type): if not suppress_console_outputs: print(error_msg) return False else: if not val_nested_list(v_input[i], depth_i + 1, depth_max, v_name, method, v_type, -1, v_mins, -1, v_maxs, suppress_errors, suppress_console_outputs, v_arg_type): if not suppress_console_outputs: print(error_msg) return False # RETURNS return True