Function get_version_scheme

commitizen/version_schemes.py:397–437

Get the version scheme as defined in the configuration or from an overridden `name`. :raises VersionSchemeUnknown: if the version scheme is not found.

(settings: Settings, name: str | None = None)

def get_version_scheme(settings: Settings, name: str | None = None) -> VersionScheme:
    """
    Get the version scheme as defined in the configuration
    or from an overridden `name`.



    :raises VersionSchemeUnknown: if the version scheme is not found.
    """
    # TODO: Remove the deprecated `version_type` handling
    deprecated_setting: str | None = settings.get("version_type")
    if deprecated_setting:
        warnings.warn(
            DeprecationWarning(
                "`version_type` setting is deprecated and will be removed in v5. "
                "Please use `version_scheme` instead"
            )
        )
    name = name or settings.get("version_scheme") or deprecated_setting
    if not name:
        return DEFAULT_SCHEME

    try:
        (ep,) = metadata.entry_points(name=name, group=SCHEMES_ENTRYPOINT)
    except ValueError:
        raise VersionSchemeUnknown(f'Version scheme "{name}" unknown.')
    scheme = cast("VersionScheme", ep.load())

    # `VersionProtocol` is a `@runtime_checkable` Protocol, but `issubclass()` is not
    # supported for Protocols with non-method members. We check an instance instead by
    # verifying the loaded object is a class with the expected interface.
    if isinstance(scheme, type):
        # Check for a key method/attribute that VersionProtocol requires
        if not hasattr(scheme, "bump"):
            warnings.warn(
                f"Version scheme {name} does not implement the VersionProtocol"
            )
    else:
        warnings.warn(f"Version scheme {name} does not implement the VersionProtocol")

    return scheme