module documentation

############################################################################### # List of tools for testing ############################################################################### # Usage: # from bootstraparse.modules.tools import __GLk, __GL, find_*_in_file # __GLk(n) # Returns a file link n traceback objects back # __GL() # Returns a line number at current position # find_*_in_file(file) # Try to find (class, function or variable) in file and return its line number

Function dict_check Helper function to test existence of a list of succesive keys within a nested dictionary. :param dic: The dictionary of dictionaries to check :param args: Any number of keys to check the dictionaries for :type dic: dict | config...
Function find_classes_in_file Find the class in the file stream :param file_path: Path of the file :type file_path: str :param list_class_name: List of class name to find :type list_class_name: iterable :return: Dict of class found and line number :rtype: dict...
Function find_functions_in_file Find the function in the file stream :param file_path: Path of the file :type file_path: str :param list_function_name: List of function name to find :type list_function_name: iterable :return: Dict of function found and line number :rtype: dict...
Function find_string_in_file Find the string in the file stream :param file_path: Path of the file :type file_path: str :param list_regex_to_find: List of string to find :type list_regex_to_find: list :return: Dict of string found and line number :rtype: dict...
Function find_variables_in_file Find the variable in the file stream :param file_path: Path of the file :type file_path: str :param list_variable_name: List of variable name to find :type list_variable_name: iterable :return: Dict of variable found and line number :rtype: dict...
Function str_dict_check Helper function to test existence within a dictionary and return a string of the values of the keys checked and wether they exist. 'arg[0]' : True or False :param dic: The nested dictionary to check :param args: Any number of keys to check successively :type dic: dict :type args: str :return: A string of the values of the keys checked and wether they exist...
Function __base Return the path of the main module (relative to the tests) :return: Path of the main module :rtype: str
Function __GFi Undocumented
Function __GFu Undocumented
Function __GL Undocumented
Function __GLk Undocumented
Function __module_path Return the path of the module module_name :param module_name: Name of the module :type module_name: str :return: Path of the module :rtype: str
Function __prev_stack Return the nth previous stack :return: Previous stack :rtype: inspect.Traceback
def dict_check(dic, *args):

Helper function to test existence of a list of succesive keys within a nested dictionary. :param dic: The dictionary of dictionaries to check :param args: Any number of keys to check the dictionaries for :type dic: dict | config.ConfigLoader :type args: str :return: A table of Booleans for every key checked.

def find_classes_in_file(file_path, list_class_name):

Find the class in the file stream :param file_path: Path of the file :type file_path: str :param list_class_name: List of class name to find :type list_class_name: iterable :return: Dict of class found and line number :rtype: dict

def find_functions_in_file(file_path, list_function_name):

Find the function in the file stream :param file_path: Path of the file :type file_path: str :param list_function_name: List of function name to find :type list_function_name: iterable :return: Dict of function found and line number :rtype: dict

def find_string_in_file(file_path, list_regex_to_find):

Find the string in the file stream :param file_path: Path of the file :type file_path: str :param list_regex_to_find: List of string to find :type list_regex_to_find: list :return: Dict of string found and line number :rtype: dict

def find_variables_in_file(file_path, list_variable_name):

Find the variable in the file stream :param file_path: Path of the file :type file_path: str :param list_variable_name: List of variable name to find :type list_variable_name: iterable :return: Dict of variable found and line number :rtype: dict

def str_dict_check(dic, *args):

Helper function to test existence within a dictionary and return a string of the values of the keys checked and wether they exist. 'arg[0]' : True or False :param dic: The nested dictionary to check :param args: Any number of keys to check successively :type dic: dict :type args: str :return: A string of the values of the keys checked and wether they exist. :rtype: str

def __base():

Return the path of the main module (relative to the tests) :return: Path of the main module :rtype: str

def __GFi():

Undocumented

def __GFu():

Undocumented

def __GL():

Undocumented

def __GLk(n=2):

Undocumented

def __module_path(module_name):

Return the path of the module module_name :param module_name: Name of the module :type module_name: str :return: Path of the module :rtype: str

def __prev_stack(nb=0):

Return the nth previous stack :return: Previous stack :rtype: inspect.Traceback