reuse.report module¶
Module that contains reports about files and projects for linting.
-
class
reuse.report.
FileReport
(name: os.PathLike, path: os.PathLike, do_checksum: bool = True)[source]¶ Bases:
object
Object that holds a linting report about a single file. Importantly, it also contains SPDX File information in
spdxfile
.-
classmethod
generate
(project: reuse.project.Project, path: os.PathLike, do_checksum: bool = True) → reuse.report.FileReport[source]¶ Generate a FileReport from a path in a Project.
-
classmethod
-
class
reuse.report.
ProjectReport
(do_checksum: bool = True)[source]¶ Bases:
object
Object that holds linting report about the project.
-
property
files_without_copyright
¶ Iterable of paths that have no copyright information.
-
property
files_without_licenses
¶ Iterable of paths that have no license information.
-
classmethod
generate
(project: reuse.project.Project, do_checksum: bool = True, multiprocessing: bool = True) → reuse.report.ProjectReport[source]¶ Generate a ProjectReport from a Project.
-
property
unused_licenses
¶ Set of license identifiers that are not found in any file report.
-
property
used_licenses
¶ Set of license identifiers that are found in file reports.
-
property