base.py

DEFAULT_TAG_VERSION = "0"


class SCM(object):
    """
    SCMs are wrappers around a particular form of version control.
    """
    RELEASE_BRANCH_REGEX = None

    REQUIRED_PARAMS = [
        "tag_version",
        "commit_count",
        "scm_change_id",
        "branch"
    ]

    def __init__(self, path):
        self._path = path

    @classmethod
    def get_name(cls):
        return str(cls.__name__.lower())

    @staticmethod
    def is_repo(path):
        """
        should return True if it is a valid
        repo of the provided scm type.
        """
        return False

    def get_properties(self):
        """
        return back a dictionary containing
        all properties exposed by this scm.
        """
        return {}


def extract_tag_version(tag):
    """
    extract a version string from a tag, or None if
    it is not a valid numerical version.
    """
    if tag.startswith("v"):
        return tag[1:]
    return None