Function _add_alias_mapping

explainshell/manager.py:327–371

Insert or upgrade a mapping from an alias command name to the canonical source. Used for both symlinks and content-identical files (e.g. cross-compiler variants). If a mapping already exists with a lower score (e.g. lexgrog alias at score 1), upgrades it to score 10 since the alias nam

(
    s: store.Store,
    gz_path: str,
    alias_source: str,
    canonical_source: str,
)

def _add_alias_mapping(
    s: store.Store,
    gz_path: str,
    alias_source: str,
    canonical_source: str,
) -> bool:
    """Insert or upgrade a mapping from an alias command name to the canonical source.

    Used for both symlinks and content-identical files (e.g. cross-compiler
    variants).  If a mapping already exists with a lower score (e.g. lexgrog
    alias at score 1), upgrades it to score 10 since the alias name is the
    primary command name.

    Returns True if a mapping was inserted or upgraded, False if unchanged.
    """
    from explainshell import manpage

    alias_name = manpage.extract_name(gz_path)
    existing_score = s.mapping_score(alias_name, canonical_source)
    if existing_score is not None and existing_score >= 10:
        logger.debug(
            "alias mapping %s -> %s already exists (score %d)",
            alias_name,
            canonical_source,
            existing_score,
        )
        return False
    if existing_score is not None:
        # Upgrade score from lower value (e.g. lexgrog alias at score 1).
        s.update_mapping_score(alias_name, canonical_source, score=10)
        logger.info(
            "upgraded alias mapping %s -> %s score %d -> 10",
            alias_source,
            canonical_source,
            existing_score,
        )
    else:
        s.add_mapping(alias_name, canonical_source, score=10)
        logger.info(
            "mapped alias %s -> %s (name: %s)",
            alias_source,
            canonical_source,
            alias_name,
        )
    return True


# ---------------------------------------------------------------------------