codeaudit 0.9.0__tar.gz → 0.9.1__tar.gz

{codeaudit-0.9.0 → codeaudit-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codeaudit
-Version: 0.9.0
+Version: 0.9.1
 Summary: Simplified static security checks for Python 
 Project-URL: Documentation, https://github.com/nocomplexity/codeaudit#readme
 Project-URL: Issues, https://github.com/nocomplexity/codeaudit/issues

{codeaudit-0.9.0 → codeaudit-0.9.1}/docs/modulescan.md

@@ -15,7 +15,7 @@ The `<INPUTFILE>` is mandatory. Codeaudit will create a modulescan report for th
 If you do not specify [OUTPUTFILE], a HTML output file, a HTML report file is created in the current directory and will be named `codeaudit-report.html`.
 
 When running `codeaudit modulescan` detailed information is determined for a Python file of:
-* Core modules used and
+* Core modules used (aka "built-in modules" or "standard modules") and
 * Imported modules used (aka external modules that are not part of the Python Standard Library)
 * Vulnerability information (**if available**) for all imported modules. The OSV (Open Source Vulnerability Data is used) for retrieving vulnerability information. OSV is a Google FOSS project to improve the security of FOSS projects. See the [Open Security Architecture](https://nocomplexity.com/documents/securityarchitecture/references/vulnerabilitydatabases.html#vulnerability-databases) for more information.
 

{codeaudit-0.9.0 → codeaudit-0.9.1}/src/codeaudit/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2025-present Maikel Mardjan <mike@bm-support.org>
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
-__version__ = "0.9.0"
+__version__ = "0.9.1"

{codeaudit-0.9.0 → codeaudit-0.9.1}/src/codeaudit/altairplots.py

@@ -51,7 +51,7 @@ def multi_bar_chart(df):
     metrics = [
         "Number_Of_Lines",
         "AST_Nodes",
-        "Modules",
+        "External-Modules",
         "Functions",
         "Comment_Lines",
         "Complexity_Score",

{codeaudit-0.9.0 → codeaudit-0.9.1}/src/codeaudit/checkmodules.py

@@ -120,16 +120,11 @@ def get_all_modules(directory_to_scan):
 
 
 def get_imported_modules_by_file(python_file_name):
-    "Function to get all modules of a package or directory of Python files - never trust requirements.txt or project.toml"
-    #total_result=[]        
+    "Function to get all modules of a single Python file - never trust requirements.txt or project.toml"    
     source = read_in_source_file(python_file_name)
     used_modules = get_imported_modules(source)
     core_modules = used_modules['core_modules']
-    external_modules = used_modules['imported_modules'] 
-    # result = { "filename" : python_file ,
-    #             "used_modules" : core_modules,
-    #             "external_modules": external_modules } 
-    #total_result.append(result)
+    external_modules = used_modules['imported_modules']     
     all_modules_discovered = {
         "core_modules": sorted(core_modules),
         "imported_modules": sorted(external_modules) }    

{codeaudit-0.9.0 → codeaudit-0.9.1}/src/codeaudit/reporting.py

@@ -22,7 +22,7 @@ import datetime
 from codeaudit.security_checks import perform_validations , ast_security_checks
 from codeaudit.filehelpfunctions import get_filename_from_path , collect_python_source_files , read_in_source_file 
 from codeaudit.altairplots import multi_bar_chart
-from codeaudit.totals import get_statistics , overview_count , overview_per_file
+from codeaudit.totals import get_statistics , overview_count , overview_per_file , total_modules
 from codeaudit.checkmodules import get_imported_modules , check_module_on_vuln , get_all_modules , get_imported_modules_by_file
 from codeaudit.htmlhelpfunctions import dict_to_html , json_to_html , dict_list_to_html_table
 from codeaudit import __version__
@@ -51,8 +51,11 @@ def overview_report(directory, filename=DEFAULT_OUTPUT_FILE):
         print(f"ERROR: '{directory}' is not a directory (maybe you try to run it for a single file)")
         print(f"This function only works for directories which contains one or more Python source code files (*.py). ")
         exit(1)
-    result = get_statistics(directory)    
+    result = get_statistics(directory)
+    modules = total_modules(directory)    
     df = pd.DataFrame(result)
+    df['Std-Modules'] = modules['Std-Modules']
+    df['External-Modules'] = modules['External-Modules']
     overview_df = overview_count(df)
     html = '<h1>' + f'Codeaudit overview report' + '</h1><br>'
     html += f'<p>Codeaudit overview scan of the directory:<b> {directory}</b></p>' 
@@ -83,8 +86,9 @@ def overview_report(directory, filename=DEFAULT_OUTPUT_FILE):
     html += df.to_html(escape=True,index=False)        
     html += '</details>'           
     # I now want only a plot for LoC, so drop other columns from Dataframe
-    df = df.drop(columns=['FilePath'])
-    plot = multi_bar_chart(df)
+    df_plot = pd.DataFrame(result) # again make the df from the result variable
+    df_plot = df_plot.drop(columns=['FilePath'])
+    plot = multi_bar_chart(df_plot)
     plot_html = plot.to_html()    
     html += '<br><br>'
     html += '<h2>Visual Overview</h2>'    

{codeaudit-0.9.0 → codeaudit-0.9.1}/src/codeaudit/totals.py

@@ -25,6 +25,8 @@ from codeaudit.complexitycheck import (
     count_static_warnings_in_file,
 )
 
+from codeaudit.checkmodules import get_imported_modules , get_all_modules
+
 
 def count_ast_objects(source):
     """
@@ -37,23 +39,27 @@ def count_ast_objects(source):
         tree = ast.parse(source)
 
     ast_nodes = 0
-    ast_functions = 0
-    ast_modules = 0
+    ast_functions = 0    
     ast_classes = 0
-
+    
     for node in ast.walk(tree):
         if hasattr(node, "lineno") and isinstance(node, (ast.stmt, ast.Expr)):
             ast_nodes += 1
         if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)):
             ast_functions += 1
-        if isinstance(node, (ast.Import, ast.ImportFrom)):
-            ast_modules += 1
+        # if isinstance(node, (ast.Import, ast.ImportFrom)):
+        #     ast_modules += 1
         if isinstance(node, ast.ClassDef):
             ast_classes += 1
+    
+    used_modules = get_imported_modules(source)
+    number_core_modules = len(used_modules.get('core_modules',[])) 
+    number_external_modules = len(used_modules.get('imported_modules',[]))
 
     result = {
         "AST_Nodes": ast_nodes,
-        "Modules": ast_modules,
+        "Std-Modules": number_core_modules,
+        "External-Modules" : number_external_modules,
         "Functions": ast_functions,
         "Classes": ast_classes,
     }
@@ -111,9 +117,18 @@ def get_statistics(directory):
     total_result = []
     for python_file in files_to_check:
         result = overview_per_file(python_file)
-        total_result.append(result)
+        total_result.append(result)    
     return total_result
 
+def total_modules(directory):
+    """get the total number of modules (core and imported) for the overview"""
+    used_modules = get_all_modules(directory)
+    number_core_modules = len(used_modules.get('core_modules',[])) 
+    number_external_modules = len(used_modules.get('imported_modules',[]))
+    module_result =  {"Std-Modules": number_core_modules,
+               "External-Modules" : number_external_modules}
+    return module_result
+
 
 def overview_per_file(python_file):
     """gets the overview per file."""
@@ -143,8 +158,7 @@ def overview_count(df):
     """returns a dataframe with simple overview of all files"""
     columns_to_sum = [
         "Number_Of_Lines",
-        "AST_Nodes",
-        "Modules",
+        "AST_Nodes",        
         "Functions",
         "Classes",
         "Comment_Lines",
@@ -154,6 +168,14 @@ def overview_count(df):
     df_totals.insert(
         0, "Number_Of_Files", total_number_of_files
     )  # insert new column as first colum
+    number_cm = df.at[0, "Std-Modules"]
+    df_totals.insert(
+        3, "Core Modules", number_cm
+    )  
+    number_em = df.at[0, "External-Modules"]
+    df_totals.insert(
+        4, "External Modules", number_em
+    )  
     median_complexity = round(df["Complexity_Score"].mean(), 1)
     df_totals["Median_Complexity"] = median_complexity
     maximum_complexity = df["Complexity_Score"].max()