Function fetch_newer_version

src/scancode/outdated.py:158–218

Return a version string if there is an updated version of scancode-toolkit newer than the installed version and available on PyPI. Return None otherwise. Limit the frequency of update checks to once per week. State is stored in the scancode_cache_dir. If `force` is True, red

(
    installed_version=scancode_version,
    new_version_url='https://pypi.org/pypi/scancode-toolkit/json',
    force=False,
)

def fetch_newer_version(
    installed_version=scancode_version,
    new_version_url='https://pypi.org/pypi/scancode-toolkit/json',
    force=False,
):
    """
    Return a version string if there is an updated version of scancode-toolkit
    newer than the installed version and available on PyPI. Return None
    otherwise.
    Limit the frequency of update checks to once per week.
    State is stored in the scancode_cache_dir.
    If `force` is True, redo a PyPI remote check.
    """
    # If installed version is from git describe, only use the first part of it
    # i.e. `v31.2.1-343-gd9d2e19e32` -> `v31.2.1`
    if "-" in installed_version:
        installed_version = installed_version.split("-")[0]

    try:
        installed_version = packaging_version.parse(installed_version)
        state = VersionCheckState()

        current_time = datetime.datetime.utcnow()
        # Determine if we need to refresh the state
        if ('last_check' in state.state and 'latest_version' in state.state):
            last_check = datetime.datetime.strptime(
                state.state['last_check'],
                SELFCHECK_DATE_FMT
            )
            seconds_since_last_check = total_seconds(current_time - last_check)
            one_week = 7 * 24 * 60 * 60
            if seconds_since_last_check < one_week:
                latest_version = state.state['latest_version']

        if force:
            latest_version = None

        # Refresh the version if we need to or just see if we need to warn
        if latest_version is None:
            try:
                latest_version = fetch_latest_version(new_version_url)
                state.save(latest_version, current_time)
            except Exception:
                # save an empty version to avoid checking more than once a week
                state.save(None, current_time)
                raise

        latest_version = packaging_version.parse(latest_version)

        if TRACE:
            logger_debug(f"installed_version: {installed_version}, latest version: {latest_version}")
            logger_debug(f"installed_version < latest_version: {installed_version < latest_version}")

        # Determine if our latest_version is older
        if (installed_version < latest_version
        and installed_version.base_version != latest_version.base_version):
            return str(latest_version)