version_handler.py

"""
version_manager
~~~~~~~~~~~~~
Taken from version manager of CFSession
"""

# Simply following the Python markdown's versioning format since it is good enough for me.
# __version_info__ format:
#     (major, minor, patch, dev/alpha/beta/rc/final, #)
#     (1, 1, 2, 'dev', 0) => "1.1.2.dev0"
#     (1, 1, 2, 'alpha', 1) => "1.1.2a1"
#     (1, 2, 0, 'beta', 2) => "1.2b2"
#     (1, 2, 0, 'rc', 4) => "1.2rc4"
#     (1, 2, 0, 'final', 0) => "1.2.0"

__version_info__ = (1, 2, 0, 'final', 0)

def _get_version(version_info):
    " Returns a PEP 440-compliant version number from version_info. "
    assert len(version_info) == 5
    assert version_info[3] in ('dev', 'alpha', 'beta', 'rc', 'final')

    parts = 2 if version_info[2] == 0 else 3
    #parts = 3 #I want explicit versioning
    v = '.'.join(map(str, version_info[:parts]))

    if version_info[3] == 'dev':
        v += '.dev' + str(version_info[4])
    elif version_info[3] != 'final':
        mapping = {'alpha': 'a', 'beta': 'b', 'rc': 'rc'}
        v += mapping[version_info[3]] + str(version_info[4])
    return v

def _get_semver_version(version_info):
    "Returns a SemVer-compliant version number from version_info."
    assert len(version_info) == 5
    assert version_info[3] in ('dev', 'alpha', 'beta', 'rc', 'final')

    major = version_info[0]  # Major version
    minor = version_info[1]  # Minor version
    patch = version_info[2]  # Patch version

    # Build the base version string
    version = f"{major}.{minor}.{patch}"

    # Add pre-release identifier if not final
    if version_info[3] == 'dev':
        version += f"-dev.{version_info[4]}"
    elif version_info[3] == 'alpha':
        version += f"-alpha.{version_info[4]}"
    elif version_info[3] == 'beta':
        version += f"-beta.{version_info[4]}"
    elif version_info[3] == 'rc':
        version += f"-rc.{version_info[4]}"
    return version

__version_semver__ = _get_semver_version(__version_info__)
__version__ = _get_version(__version_info__)