Function load_licenses

src/licensedcode/models.py:801–857

Return a mapping of {key: License} loaded from license data and text files found in ``licenses_data_dir``. Raise Exceptions if there are dangling or orphaned files. Optionally include deprecated license if ``with_deprecated`` is True. Optionally check for dangling orphaned files

(
    licenses_data_dir=licenses_data_dir,
    with_deprecated=False,
    check_consistency=True,
    is_builtin=True,
)

def load_licenses(
    licenses_data_dir=licenses_data_dir,
    with_deprecated=False,
    check_consistency=True,
    is_builtin=True,
):
    """
    Return a mapping of {key: License} loaded from license data and text files
    found in ``licenses_data_dir``. Raise Exceptions if there are dangling or
    orphaned files.
    Optionally include deprecated license if ``with_deprecated`` is True.
    Optionally check for dangling orphaned files if ``check_dangling`` is True.
    """

    all_files = list(resource_iter(
        location=licenses_data_dir,
        ignored=ignore_editor_tmp_files,
        with_dirs=False,
        follow_symlinks=True,
    ))

    licenses = {}

    for license_file in all_files:
        if license_file.endswith('.LICENSE'):
            if TRACE:
                logger_debug('load_licenses: license_file:', license_file)

            key = file_base_name(license_file)

            try:
                lic = License.from_dir(
                    key=key,
                    licenses_data_dir=licenses_data_dir,
                    check_consistency=check_consistency,
                    is_builtin=is_builtin,
                )
            except Exception as e:
                msg = (
                    f'Failed to load license: {key} from: '
                    f'file://{licenses_data_dir}/{key}.LICENSE with error: {e}'
                )
                raise InvalidLicense(msg) from e

            if not with_deprecated and lic.is_deprecated:
                continue

            licenses[key] = lic

    if not licenses:
        msg = (
            'No licenses were loaded. Check to see if the license data files '
            f'are available at "{licenses_data_dir}".'
        )
        raise InvalidLicense(msg)

    return licenses