module documentation

Undocumented

Class CodeInspection No class docstring; 0/17 instance variable, 18/25 methods documented
Function create_output_dirs create_output_dirs creates two subdirectories to save the results. ControlFlow to save the cfg information (txt and PNG) and JsonFiles to save the aggregated json file with all the information extracted per file...
Function main Undocumented
Variable builtin_function_names Undocumented
def create_output_dirs(output_dir, control_flow): (source)

create_output_dirs creates two subdirectories to save the results. ControlFlow to save the cfg information (txt and PNG) and JsonFiles to save the aggregated json file with all the information extracted per file. :param str output_dir: Output Directory in which the new subdirectories will be created. :param bool control_flow: Boolean to indicate the generation of the control flow

@click.command()
@click.version_option(__version__)
@click.option('-i', '--input_path', type=str, required=True, help='input path of the file or directory to inspect.')
@click.option('-o', '--output_dir', type=str, default='output_dir', help='output directory path to store results. If the directory does not exist, the tool will create it.')
@click.option('-st', '--symbol_table', type=str, default='my_language.so', help='symbol table for the target function')
@click.option('-ignore_dir', '--ignore_dir_pattern', multiple=True, default=['.', '__pycache__'], help='ignore directories starting with a certain pattern. This parameter can be provided multiple times to ignore multiple directory patterns.')
@click.option('-ignore_file', '--ignore_file_pattern', multiple=True, default=['.', '__pycache__'], help='ignore files starting with a certain pattern. This parameter can be provided multiple times to ignore multiple file patterns.')
@click.option('-r', '--requirements', type=bool, is_flag=True, help='find the requirements of the repository.')
@click.option('-html', '--html_output', type=bool, is_flag=True, help='generates an html file of the DirJson in the output directory.')
@click.option('-cl', '--call_list', type=bool, is_flag=True, help='generates the call list in a separate html file.')
@click.option('-cf', '--control_flow', type=bool, is_flag=True, help='generates the call graph for each file in the target repository.')
@click.option('-dt', '--directory_tree', type=bool, is_flag=True, help='captures the file directory tree from the root path of the target repository.')
@click.option('-si', '--software_invocation', type=bool, is_flag=True, help='generates which are the software invocation commands to run and test the target repository.')
@click.option('-ast', '--abstract_syntax_tree', type=bool, is_flag=True, help='generates abstract syntax tree in json format.')
@click.option('-sc', '--source_code', type=bool, is_flag=True, help='generates the source code of each ast node.')
@click.option('-ld', '--license_detection', type=bool, is_flag=True, help='detects the license of the target repository.')
@click.option('-rm', '--readme', type=bool, is_flag=True, help='extract all readme files in the target repository.')
@click.option('-md', '--metadata', type=bool, is_flag=True, help='extract metadata of the target repository using Github API. (requires repository to have the .git folder)')
@click.option('-df', '--data_flow', type=bool, is_flag=True, help='extract data flow graph of every function in the target repository')
def main(input_path, output_dir, ignore_dir_pattern, ignore_file_pattern, requirements, html_output, call_list, control_flow, directory_tree, software_invocation, abstract_syntax_tree, source_code, license_detection, readme, metadata, data_flow, symbol_table): (source)

Undocumented

builtin_function_names = (source)

Undocumented