reuse.report module¶
Module that contains reports about files and projects for linting.
- class reuse.report.ProjectReportSubsetProtocol(*args, **kwargs)[source]¶
Bases:
Protocol
A
Protocol
that defines a subset of functionality ofProjectReport
, implemented byProjectSubsetReport
.- file_reports: set[FileReport]¶
- class reuse.report.ProjectReport(do_checksum: bool = True)[source]¶
Bases:
object
Object that holds linting report about the project.
- to_dict_lint() dict[str, Any] [source]¶
Collects and formats data relevant to linting from report and returns it as a dictionary.
- Returns:
Dictionary containing data from the ProjectReport object.
- bill_of_materials(creator_person: str | None = None, creator_organization: str | None = None) str [source]¶
Generate a bill of materials from the project.
- classmethod generate(project: Project, do_checksum: bool = True, multiprocessing: bool = True, add_license_concluded: bool = False) ProjectReport [source]¶
Generate a
ProjectReport
from aProject
.- Parameters:
project – The
Project
to lint.do_checksum – Generate a checksum of every file. If this is
False
, generate a random checksum for every file.multiprocessing – Whether to use multiprocessing.
add_license_concluded – Whether to aggregate all found SPDX expressions into a concluded license.
- class reuse.report.ProjectSubsetReport[source]¶
Bases:
object
Like a
ProjectReport
, but for a subset of the files using a subset of features.- classmethod generate(project: Project, subset_files: Collection[str | PathLike[str]], multiprocessing: bool = True) ProjectSubsetReport [source]¶
Generate a
ProjectSubsetReport
from aProject
.- Parameters:
project – The
Project
to lint.subset_files – Only lint the files in this list.
multiprocessing – Whether to use multiprocessing.
- class reuse.report.FileReport(name: str, path: str | PathLike[str], do_checksum: bool = True)[source]¶
Bases:
object
Object that holds a linting report about a single file.