Skip to content

Latest commit

 

History

History
112 lines (65 loc) · 1.86 KB

audit.md

File metadata and controls

112 lines (65 loc) · 1.86 KB

Audit

Fhmake Index / Fhmake / Audit

Auto-generated documentation for fhmake.audit module.

getCCGrade

Show source in audit.py:77

Calculate the cc grade from the complexity.

Arguments


  • complexity float - the complexity of a file/ project

Returns


  • str - the grade

Signature

def getCCGrade(complexity: float) -> str: ...

getTotalLines

Show source in audit.py:16

Get the total number of lines python files under the project directory.

Returns

int: total number of lines

Signature

def getTotalLines() -> int: ...

subtaskDup

Show source in audit.py:92

Calculate the amount of duplicated code using the total number of lines and pylint output.

Arguments


  • totalLines int - total number of lines

Signature

def subtaskDup(totalLines: int) -> None: ...

subtaskScore

Show source in audit.py:31

Calculate a score for the module files using the total number of lines and pylint output.

Arguments


  • totalLines int - total number of lines for /.

Signature

def subtaskScore(totalLines: int) -> None: ...

taskAudit

Show source in audit.py:113

Do the audit task, this includes checking requirements are up to date security analysis and code complexity metrics.

Arguments


  • kwargs list[str] - optional args

Signature

def taskAudit(kwargs: list[str]) -> None: ...