FoScanner.CliOptions.CliOptions Class Reference

Inheritance diagram for FoScanner.CliOptions.CliOptions:

Collaboration diagram for FoScanner.CliOptions.CliOptions:

Public Member Functions
def	update_args (self, Namespace args)

Public Attributes
	nomos
	copyright
	keyword
	ojo
	repo
	differential
	scan_only_deps
	scan_dir
	dir_path
	tags
	allowlist_path
	report_format
	keyword_conf_file_path
	sbom_path

Static Public Attributes
	bool
	tuple
	str
	ReportFormat

Detailed Description

Hold the various shared flags and data

:ivar nomos: run nomos scanner
:ivar ojo: run ojo scanner
:ivar copyright: run copyright scanner
:ivar keyword: run keyword scanner
:ivar repo: scan whole repo or just diff
:ivar differential: scan between two versions of a repo
:ivar scan_dir: Scan a particular subdirectory
:ivar tags: tuple of length 2: (from_tag , to_tag) to scan
:ivar diff_dir: directory to scan
:ivar dir_path: Path to subdirectory to scan
:ivar keyword_conf_file_path: path to custom keyword.conf file passed by user
:ivar allowlist_path: path to allowlist.json file
:ivar allowlist: information from allowlist.json
:ivar report_format: Report format to use
:ivar scan_only_deps: Scan only dependencies
:ivar sbom_path: Path to sbom file

Definition at line 24 of file CliOptions.py.

Member Function Documentation

update_args()

def FoScanner.CliOptions.CliOptions.update_args	(		self,
		Namespace	args
	)

Update options based on argsparse values.

:param args: Argparse from cli

Definition at line 65 of file CliOptions.py.

---

The documentation for this class was generated from the following file:

• utils/automation/FoScanner/CliOptions.py