Index

Symbols

--add-license-concluded command line option --all command line option --contributor command line option --copyright command line option --copyright-prefix command line option --creator-organization command line option --creator-person command line option --debug command line option --exclude-year command line option --fallback-dot-license command line option --force-dot-license command line option --help command line option, [1], [2], [3], [4], [5], [6], [7] --include-meson-subprojects command line option --include-submodules command line option --json command line option --license command line option --lines command line option, [1] --merge-copyrights command line option --multi-line command line option --no-multiprocessing command line option --no-replace command line option --output command line option, [1]

--plain command line option --quiet command line option, [1] --recursive command line option --root command line option --single-line command line option --skip-unrecognised command line option --source command line option --style command line option --suppress-deprecation command line option --template command line option --version command line option --year command line option -c command line option -j command line option -l command line option, [1], [2] -o command line option, [1] -p command line option -q command line option, [1] -r command line option -s command line option -t command line option -y command line option

A

add_new_header() (in module reuse.header) AGGREGATE (reuse.global_licensing.PrecedenceType attribute) all_files() (reuse.project.Project method) all_vcs_strategies() (in module reuse.vcs)

annotations (reuse.global_licensing.ReuseTOML attribute) AnnotationsItem (class in reuse.global_licensing) AppleScriptCommentStyle (class in reuse.comment) AspxCommentStyle (class in reuse.comment)

B

BatchFileCommentStyle (class in reuse.comment)

BibTexCommentStyle (class in reuse.comment) bill_of_materials() (reuse.report.ProjectReport method)

C

can_handle_multi() (reuse.comment.CommentStyle class method) can_handle_single() (reuse.comment.CommentStyle class method) CCommentStyle (class in reuse.comment) CLOSEST (reuse.global_licensing.PrecedenceType attribute) cls (reuse.project.GlobalLicensingFound attribute) command line option --add-license-concluded --all --contributor --copyright --copyright-prefix --creator-organization --creator-person --debug --exclude-year --fallback-dot-license --force-dot-license --help, [1], [2], [3], [4], [5], [6], [7] --include-meson-subprojects --include-submodules --json --license --lines, [1] --merge-copyrights --multi-line --no-multiprocessing --no-replace --output, [1] --plain --quiet, [1] --recursive --root --single-line --skip-unrecognised --source --style --suppress-deprecation --template --version --year -c -j -l, [1], [2] -o, [1] -p -q, [1] -r -s -t -y

comment_at_first_character() (reuse.comment.CommentStyle class method) (reuse.comment.EmptyCommentStyle class method) CommentCreateError CommentError CommentParseError CommentStyle (class in reuse.comment) contains_copyright_or_licensing() (reuse.ReuseInfo method) contains_copyright_xor_licensing() (reuse.ReuseInfo method) contains_info() (reuse.ReuseInfo method) contains_reuse_info() (in module reuse.extract) contributor_lines (reuse.ReuseInfo attribute) copy() (reuse.ReuseInfo method) copyright_lines (reuse.global_licensing.AnnotationsItem attribute) (reuse.ReuseInfo attribute) CppCommentStyle (class in reuse.comment) CppSingleCommentStyle (class in reuse.comment) create_comment() (reuse.comment.CommentStyle class method) (reuse.comment.EmptyCommentStyle class method) create_header() (in module reuse.header)

D

decoded_text_from_binary() (in module reuse.extract) DEP5 (reuse.SourceType attribute) dep5_copyright (reuse.global_licensing.ReuseDep5 attribute)

detect_line_endings() (in module reuse.extract) directory (reuse.global_licensing.ReuseTOML property) DOT_LICENSE (reuse.SourceType attribute) download_license() (in module reuse.download)

E

EmptyCommentStyle (class in reuse.comment) end (reuse.comment.MultiLineSegments attribute) EXE (reuse.vcs.VCSStrategy attribute) (reuse.vcs.VCSStrategyGit attribute) (reuse.vcs.VCSStrategyHg attribute) (reuse.vcs.VCSStrategyJujutsu attribute) (reuse.vcs.VCSStrategyPijul attribute)

EXTENSION_COMMENT_STYLE_MAP (in module reuse.comment) extract_reuse_info() (in module reuse.extract)

F

FILE_HEADER (reuse.SourceType attribute) file_reports (reuse.report.ProjectReportSubsetProtocol attribute) FileReport (class in reuse.report) files_without_copyright (reuse.report.ProjectReport property) (reuse.report.ProjectReportSubsetProtocol property) (reuse.report.ProjectSubsetReport property) files_without_licenses (reuse.report.ProjectReport property) (reuse.report.ProjectReportSubsetProtocol property) (reuse.report.ProjectSubsetReport property) filter_ignore_block() (in module reuse.extract) find_and_replace_header() (in module reuse.header) find_annotations_item() (reuse.global_licensing.ReuseTOML method) find_global_licensing() (reuse.project.Project class method) find_reuse_tomls() (reuse.global_licensing.NestedReuseTOML class method) find_root() (in module reuse.vcs) (reuse.vcs.VCSStrategy class method) (reuse.vcs.VCSStrategyGit class method) (reuse.vcs.VCSStrategyHg class method) (reuse.vcs.VCSStrategyJujutsu class method) (reuse.vcs.VCSStrategyNone class method) (reuse.vcs.VCSStrategyPijul class method)

find_spdx_tag() (in module reuse.extract) format_creator() (in module reuse.report) format_json() (in module reuse.lint) format_lines() (in module reuse.lint) format_lines_subset() (in module reuse.lint) format_plain() (in module reuse.lint) FortranCommentStyle (class in reuse.comment) from_dict() (reuse.global_licensing.AnnotationsItem class method) (reuse.global_licensing.ReuseTOML class method) from_directory() (reuse.project.Project class method) from_file() (reuse.global_licensing.GlobalLicensing class method) (reuse.global_licensing.NestedReuseTOML class method) (reuse.global_licensing.ReuseDep5 class method) (reuse.global_licensing.ReuseTOML class method) from_toml() (reuse.global_licensing.ReuseTOML class method) FtlCommentStyle (class in reuse.comment)

G

generate() (reuse.report.FileReport class method) (reuse.report.ProjectReport class method) (reuse.report.ProjectSubsetReport class method) get_comment_style() (in module reuse.comment) gettext() (in module reuse.i18n) global_licensing (reuse.project.Project attribute)

GlobalLicensing (class in reuse.global_licensing) GlobalLicensingConflictError GlobalLicensingFound (class in reuse.project) GlobalLicensingParseError GlobalLicensingParseTypeError GlobalLicensingParseValueError

H

HandlebarsCommentStyle (class in reuse.comment) has_style() (in module reuse.comment)

HaskellCommentStyle (class in reuse.comment) HtmlCommentStyle (class in reuse.comment)

I

in_repo() (reuse.vcs.VCSStrategy class method) (reuse.vcs.VCSStrategyGit class method) (reuse.vcs.VCSStrategyHg class method) (reuse.vcs.VCSStrategyJujutsu class method) (reuse.vcs.VCSStrategyNone class method) (reuse.vcs.VCSStrategyPijul class method) include_meson_subprojects (reuse.project.Project attribute) include_submodules (reuse.project.Project attribute) INDENT_AFTER_MIDDLE (reuse.comment.CCommentStyle attribute) (reuse.comment.CommentStyle attribute) (reuse.comment.CppCommentStyle attribute) (reuse.comment.MlCommentStyle attribute) (reuse.comment.PlantUmlCommentStyle attribute) (reuse.comment.XQueryCommentStyle attribute) INDENT_AFTER_SINGLE (reuse.comment.AppleScriptCommentStyle attribute) (reuse.comment.BatchFileCommentStyle attribute) (reuse.comment.CommentStyle attribute) (reuse.comment.CppCommentStyle attribute) (reuse.comment.CppSingleCommentStyle attribute) (reuse.comment.FortranCommentStyle attribute) (reuse.comment.HaskellCommentStyle attribute) (reuse.comment.JuliaCommentStyle attribute) (reuse.comment.LispCommentStyle attribute) (reuse.comment.M4CommentStyle attribute) (reuse.comment.ModernFortranCommentStyle attribute) (reuse.comment.PlantUmlCommentStyle attribute) (reuse.comment.PythonCommentStyle attribute) (reuse.comment.ReStructedTextCommentStyle attribute) (reuse.comment.SemicolonCommentStyle attribute) (reuse.comment.TexCommentStyle attribute) (reuse.comment.UnixManCommentStyle attribute) (reuse.comment.VimCommentStyle attribute)

INDENT_BEFORE_END (reuse.comment.CCommentStyle attribute) (reuse.comment.CommentStyle attribute) (reuse.comment.CppCommentStyle attribute) (reuse.comment.MlCommentStyle attribute) (reuse.comment.PlantUmlCommentStyle attribute) (reuse.comment.XQueryCommentStyle attribute) INDENT_BEFORE_MIDDLE (reuse.comment.CCommentStyle attribute) (reuse.comment.CommentStyle attribute) (reuse.comment.CppCommentStyle attribute) (reuse.comment.MlCommentStyle attribute) (reuse.comment.PlantUmlCommentStyle attribute) (reuse.comment.XQueryCommentStyle attribute) is_compliant (reuse.report.ProjectReport property) (reuse.report.ProjectReportSubsetProtocol property) (reuse.report.ProjectSubsetReport property) is_ignored() (reuse.vcs.VCSStrategy method) (reuse.vcs.VCSStrategyGit method) (reuse.vcs.VCSStrategyHg method) (reuse.vcs.VCSStrategyJujutsu method) (reuse.vcs.VCSStrategyNone method) (reuse.vcs.VCSStrategyPijul method) is_path_ignored() (in module reuse.covered_files) is_submodule() (reuse.vcs.VCSStrategy method) (reuse.vcs.VCSStrategyGit method) (reuse.vcs.VCSStrategyHg method) (reuse.vcs.VCSStrategyJujutsu method) (reuse.vcs.VCSStrategyNone method) (reuse.vcs.VCSStrategyPijul method) is_uncommentable() (in module reuse.comment) iter_files() (in module reuse.covered_files)

J

JinjaCommentStyle (class in reuse.comment)

JuliaCommentStyle (class in reuse.comment)

L

license_map (reuse.project.Project attribute) licenses (reuse.project.Project attribute)

licenses_without_extension (reuse.project.Project attribute) LispCommentStyle (class in reuse.comment)

M

M4CommentStyle (class in reuse.comment) make_copyright_line() (in module reuse.copyright) matches() (reuse.global_licensing.AnnotationsItem method) merge_copyright_lines() (in module reuse.copyright) middle (reuse.comment.MultiLineSegments attribute) missing_licenses (reuse.report.ProjectReportSubsetProtocol attribute) MissingReuseInfoError MlCommentStyle (class in reuse.comment) ModernFortranCommentStyle (class in reuse.comment) module reuse reuse.comment reuse.convert_dep5 reuse.copyright reuse.covered_files reuse.download reuse.exceptions reuse.extract reuse.global_licensing reuse.header reuse.i18n reuse.lint reuse.project reuse.report reuse.types reuse.vcs

MULTI_LINE (reuse.comment.AppleScriptCommentStyle attribute) (reuse.comment.AspxCommentStyle attribute) (reuse.comment.BibTexCommentStyle attribute) (reuse.comment.CCommentStyle attribute) (reuse.comment.CommentStyle attribute) (reuse.comment.CppCommentStyle attribute) (reuse.comment.FtlCommentStyle attribute) (reuse.comment.HandlebarsCommentStyle attribute) (reuse.comment.HtmlCommentStyle attribute) (reuse.comment.JinjaCommentStyle attribute) (reuse.comment.JuliaCommentStyle attribute) (reuse.comment.MlCommentStyle attribute) (reuse.comment.PlantUmlCommentStyle attribute) (reuse.comment.VelocityCommentStyle attribute) (reuse.comment.XQueryCommentStyle attribute) MultiLineSegments (class in reuse.comment)

N

NAME_STYLE_MAP (in module reuse.comment) NestedReuseTOML (class in reuse.global_licensing)

ngettext() (in module reuse.i18n) npgettext() (in module reuse.i18n)

O

OVERRIDE (reuse.global_licensing.PrecedenceType attribute)

P

parse_comment() (reuse.comment.CommentStyle class method) (reuse.comment.EmptyCommentStyle class method) path (reuse.project.GlobalLicensingFound attribute) (reuse.report.ProjectReportSubsetProtocol attribute) (reuse.ReuseInfo attribute) paths (reuse.global_licensing.AnnotationsItem attribute) pgettext() (in module reuse.i18n) PlantUmlCommentStyle (class in reuse.comment)

precedence (reuse.global_licensing.AnnotationsItem attribute) PrecedenceType (class in reuse.global_licensing) Project (class in reuse.project) ProjectReport (class in reuse.report) ProjectReportSubsetProtocol (class in reuse.report) ProjectSubsetReport (class in reuse.report) put_license_in_file() (in module reuse.download) PythonCommentStyle (class in reuse.comment)

R

read_errors (reuse.report.ProjectReportSubsetProtocol attribute) recommendations (reuse.report.ProjectReport property) relative_from_root() (reuse.project.Project method) ReStructedTextCommentStyle (class in reuse.comment) reuse module reuse.comment module reuse.convert_dep5 module reuse.copyright module reuse.covered_files module reuse.download module reuse.exceptions module reuse.extract module reuse.global_licensing module reuse.header module reuse.i18n module

reuse.lint module reuse.project module reuse.report module reuse.types module reuse.vcs module reuse_info_of() (reuse.global_licensing.GlobalLicensing method) (reuse.global_licensing.NestedReuseTOML method) (reuse.global_licensing.ReuseDep5 method) (reuse.global_licensing.ReuseTOML method) (reuse.project.Project method) reuse_info_of_file() (in module reuse.extract) REUSE_TOML (reuse.SourceType attribute) REUSE_TOML_VERSION (in module reuse.global_licensing) reuse_tomls (reuse.global_licensing.NestedReuseTOML attribute) ReuseDep5 (class in reuse.global_licensing) ReuseError ReuseInfo (class in reuse) ReuseTOML (class in reuse.global_licensing) root (reuse.project.Project attribute)

S

SemicolonCommentStyle (class in reuse.comment) SHEBANGS (reuse.comment.BibTexCommentStyle attribute) (reuse.comment.CommentStyle attribute) (reuse.comment.CppCommentStyle attribute) (reuse.comment.HaskellCommentStyle attribute) (reuse.comment.HtmlCommentStyle attribute) (reuse.comment.JuliaCommentStyle attribute) (reuse.comment.PythonCommentStyle attribute) (reuse.comment.TexCommentStyle attribute) SHORTHAND (reuse.comment.AppleScriptCommentStyle attribute) (reuse.comment.AspxCommentStyle attribute) (reuse.comment.BatchFileCommentStyle attribute) (reuse.comment.BibTexCommentStyle attribute) (reuse.comment.CCommentStyle attribute) (reuse.comment.CommentStyle attribute) (reuse.comment.CppCommentStyle attribute) (reuse.comment.CppSingleCommentStyle attribute) (reuse.comment.FortranCommentStyle attribute) (reuse.comment.FtlCommentStyle attribute) (reuse.comment.HandlebarsCommentStyle attribute) (reuse.comment.HaskellCommentStyle attribute) (reuse.comment.HtmlCommentStyle attribute) (reuse.comment.JinjaCommentStyle attribute) (reuse.comment.JuliaCommentStyle attribute) (reuse.comment.LispCommentStyle attribute) (reuse.comment.M4CommentStyle attribute) (reuse.comment.MlCommentStyle attribute) (reuse.comment.ModernFortranCommentStyle attribute) (reuse.comment.PlantUmlCommentStyle attribute) (reuse.comment.PythonCommentStyle attribute) (reuse.comment.ReStructedTextCommentStyle attribute) (reuse.comment.SemicolonCommentStyle attribute) (reuse.comment.TexCommentStyle attribute) (reuse.comment.UnixManCommentStyle attribute) (reuse.comment.VelocityCommentStyle attribute) (reuse.comment.VimCommentStyle attribute) (reuse.comment.XQueryCommentStyle attribute)

SINGLE_LINE (reuse.comment.AppleScriptCommentStyle attribute) (reuse.comment.BatchFileCommentStyle attribute) (reuse.comment.CommentStyle attribute) (reuse.comment.CppCommentStyle attribute) (reuse.comment.CppSingleCommentStyle attribute) (reuse.comment.FortranCommentStyle attribute) (reuse.comment.HaskellCommentStyle attribute) (reuse.comment.JuliaCommentStyle attribute) (reuse.comment.LispCommentStyle attribute) (reuse.comment.M4CommentStyle attribute) (reuse.comment.ModernFortranCommentStyle attribute) (reuse.comment.PlantUmlCommentStyle attribute) (reuse.comment.PythonCommentStyle attribute) (reuse.comment.ReStructedTextCommentStyle attribute) (reuse.comment.SemicolonCommentStyle attribute) (reuse.comment.TexCommentStyle attribute) (reuse.comment.UnixManCommentStyle attribute) (reuse.comment.VimCommentStyle attribute) SINGLE_LINE_REGEXP (reuse.comment.CommentStyle attribute) (reuse.comment.LispCommentStyle attribute) source (reuse.global_licensing.GlobalLicensing attribute) source_path (reuse.ReuseInfo attribute) source_type (reuse.ReuseInfo attribute) SourceType (class in reuse) spdx_expressions (reuse.global_licensing.AnnotationsItem attribute) (reuse.ReuseInfo attribute) SpdxIdentifierNotFoundError start (reuse.comment.MultiLineSegments attribute) StrPath (in module reuse.types) subset_files() (reuse.project.Project method)

T

TexCommentStyle (class in reuse.comment) to_dict_lint() (reuse.report.FileReport method) (reuse.report.ProjectReport method)

toml_from_dep5() (in module reuse.convert_dep5) TRANSLATIONS (in module reuse.i18n)

U

UncommentableCommentStyle (class in reuse.comment) union() (reuse.ReuseInfo method)

UnixManCommentStyle (class in reuse.comment) unused_licenses (reuse.report.ProjectReport property) used_licenses (reuse.report.ProjectReport property)

V

vcs_strategy (reuse.project.Project attribute) VCSStrategy (class in reuse.vcs) VCSStrategyGit (class in reuse.vcs) VCSStrategyHg (class in reuse.vcs) VCSStrategyJujutsu (class in reuse.vcs)

VCSStrategyNone (class in reuse.vcs) VCSStrategyPijul (class in reuse.vcs) VelocityCommentStyle (class in reuse.comment) version (reuse.global_licensing.ReuseTOML attribute) VimCommentStyle (class in reuse.comment)

X

XQueryCommentStyle (class in reuse.comment)