reuse.lint module

All linting happens here. The linting here is nothing more than reading the reports and printing some conclusions.

reuse.lint.add_arguments(parser)

Add arguments to parser.

reuse.lint.lint(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Lint the entire project.

Return type

bool

reuse.lint.lint_bad_licenses(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Lint for bad licenses. Bad licenses are licenses that are not in the SPDX License List or do not start with LicenseRef-.

Return type

Iterable[str]

reuse.lint.lint_deprecated_licenses(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Lint for deprecated licenses.

Return type

Iterable[str]

reuse.lint.lint_files_without_copyright_and_licensing(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Lint for files that do not have copyright or licensing information.

Return type

Iterable[str]

reuse.lint.lint_licenses_without_extension(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Lint for licenses without extensions.

Return type

Iterable[str]

reuse.lint.lint_missing_licenses(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Lint for missing licenses. A license is missing when it is referenced in a file, but cannot be found.

Return type

Iterable[str]

reuse.lint.lint_read_errors(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Lint for read errors.

Return type

Iterable[str]

reuse.lint.lint_summary(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Print a summary for linting.

Return type

None

reuse.lint.lint_unused_licenses(report, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Lint for unused licenses.

Return type

Iterable[str]

reuse.lint.run(args, project, out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

List all non-compliant files.