qmsk/irclogs/version.py
author Tero Marttila <terom@fixme.fi>
Sun, 13 Sep 2009 01:15:56 +0300
changeset 140 6db2527b67cf
parent 138 version.py@7dbe0ee1a27b
permissions -rw-r--r--
restructure into package format - the qmsk.* stuff doesn't work so well though, requires a symlink for qmsk.web to work...
119
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     1
"""
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     2
    Figuring out the project version
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     3
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     4
    Currently this only supports mercurial
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     5
"""
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     6
132
0e857c4a67de cache version across calls to version_mercurial, so as to avoid opening the repo every time
Tero Marttila <terom@fixme.fi>
parents: 119
diff changeset
     7
# only load this once
0e857c4a67de cache version across calls to version_mercurial, so as to avoid opening the repo every time
Tero Marttila <terom@fixme.fi>
parents: 119
diff changeset
     8
_VERSION = None
0e857c4a67de cache version across calls to version_mercurial, so as to avoid opening the repo every time
Tero Marttila <terom@fixme.fi>
parents: 119
diff changeset
     9
119
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    10
def version_mercurial (path) :
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    11
    """
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    12
        Returns a (branch, tags, parents, modified) tuple for the given repo's working copy
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    13
    """
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    14
132
0e857c4a67de cache version across calls to version_mercurial, so as to avoid opening the repo every time
Tero Marttila <terom@fixme.fi>
parents: 119
diff changeset
    15
    global _VERSION
0e857c4a67de cache version across calls to version_mercurial, so as to avoid opening the repo every time
Tero Marttila <terom@fixme.fi>
parents: 119
diff changeset
    16
0e857c4a67de cache version across calls to version_mercurial, so as to avoid opening the repo every time
Tero Marttila <terom@fixme.fi>
parents: 119
diff changeset
    17
    # cached?
0e857c4a67de cache version across calls to version_mercurial, so as to avoid opening the repo every time
Tero Marttila <terom@fixme.fi>
parents: 119
diff changeset
    18
    if _VERSION :
0e857c4a67de cache version across calls to version_mercurial, so as to avoid opening the repo every time
Tero Marttila <terom@fixme.fi>
parents: 119
diff changeset
    19
        return _VERSION
0e857c4a67de cache version across calls to version_mercurial, so as to avoid opening the repo every time
Tero Marttila <terom@fixme.fi>
parents: 119
diff changeset
    20
119
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    21
    # code adapted from mercurial.commands.identify
138
7dbe0ee1a27b fix use of mercurial API to be compatible with 1.3.1 - this breaks backwards-compability, though...
Tero Marttila <terom@fixme.fi>
parents: 132
diff changeset
    22
    from mercurial import ui, hg, encoding
119
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    23
    from mercurial.node import short
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    24
    
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    25
    # open the repo
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    26
    repo = hg.repository(ui.ui(), path)
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    27
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    28
    # the working copy change context
138
7dbe0ee1a27b fix use of mercurial API to be compatible with 1.3.1 - this breaks backwards-compability, though...
Tero Marttila <terom@fixme.fi>
parents: 132
diff changeset
    29
    ctx = repo[None]
119
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    30
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    31
    # branch
138
7dbe0ee1a27b fix use of mercurial API to be compatible with 1.3.1 - this breaks backwards-compability, though...
Tero Marttila <terom@fixme.fi>
parents: 132
diff changeset
    32
    branch = encoding.tolocal(ctx.branch())
119
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    33
    
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    34
    # map default -> None
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    35
    if branch == 'default' :
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    36
        branch = None
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    37
    
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    38
    # list of tags, without 'tip' tag
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    39
    tags = [tag for tag in ctx.tags() if tag != 'tip']
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    40
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    41
    # ctx's parents
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    42
    parents = [short(p.node()) for p in ctx.parents()]
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    43
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    44
    # local modifications?
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    45
    modified = bool(ctx.files() + ctx.deleted())
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    46
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    47
    # done
132
0e857c4a67de cache version across calls to version_mercurial, so as to avoid opening the repo every time
Tero Marttila <terom@fixme.fi>
parents: 119
diff changeset
    48
    _VERSION = (branch, tags, parents, modified)
0e857c4a67de cache version across calls to version_mercurial, so as to avoid opening the repo every time
Tero Marttila <terom@fixme.fi>
parents: 119
diff changeset
    49
    return _VERSION
119
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    50
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    51
def version_string (path='.') :
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    52
    """
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    53
        Return a version string representing the version of the software at the given path.
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    54
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    55
        Currently, this assumes that the given path points to a local Mercurial repo.
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    56
    """
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    57
    
138
7dbe0ee1a27b fix use of mercurial API to be compatible with 1.3.1 - this breaks backwards-compability, though...
Tero Marttila <terom@fixme.fi>
parents: 132
diff changeset
    58
    try :
7dbe0ee1a27b fix use of mercurial API to be compatible with 1.3.1 - this breaks backwards-compability, though...
Tero Marttila <terom@fixme.fi>
parents: 132
diff changeset
    59
        # get info
7dbe0ee1a27b fix use of mercurial API to be compatible with 1.3.1 - this breaks backwards-compability, though...
Tero Marttila <terom@fixme.fi>
parents: 132
diff changeset
    60
        branch, tags, parents, modified = version_mercurial(path)
7dbe0ee1a27b fix use of mercurial API to be compatible with 1.3.1 - this breaks backwards-compability, though...
Tero Marttila <terom@fixme.fi>
parents: 132
diff changeset
    61
7dbe0ee1a27b fix use of mercurial API to be compatible with 1.3.1 - this breaks backwards-compability, though...
Tero Marttila <terom@fixme.fi>
parents: 132
diff changeset
    62
    except :
7dbe0ee1a27b fix use of mercurial API to be compatible with 1.3.1 - this breaks backwards-compability, though...
Tero Marttila <terom@fixme.fi>
parents: 132
diff changeset
    63
        # XXX: ignore
7dbe0ee1a27b fix use of mercurial API to be compatible with 1.3.1 - this breaks backwards-compability, though...
Tero Marttila <terom@fixme.fi>
parents: 132
diff changeset
    64
        raise
119
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    65
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    66
    # tags: <tag> [ "-" <tag> [ ... ]]
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    67
    if tags :
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    68
        return '-'.join(tags)
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    69
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    70
    # revision: <parent> [ "+" <parent> [ ... ]] [ "+" ]
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    71
    revision = '+'.join(p for p in parents) + ('+' if modified else '')
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    72
    
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    73
    if branch :
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    74
        # branch: "(" <branch> ")" <revision>
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    75
        return '(%s)%s' % (branch, revision)
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    76
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    77
    else :
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    78
        # plain: <revision>
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    79
        return revision
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    80
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    81
def version_link_hg (hgweb_url, path='.') :
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    82
    """
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    83
        Returns a link to a hgweb page for this version
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    84
    """
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    85
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    86
    # URL for revision ID
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    87
    rev_url = lambda rev: '<a href="%(url)s/rev/%(rev)s">%(rev)s</a>' % dict(url=hgweb_url, rev=rev)
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    88
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    89
     # get info
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    90
    branch, tags, parents, modified = version_mercurial(path)
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    91
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    92
    # tags: <tag> [ "-" <tag> [ ... ]] [ "+" ]
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    93
    if tags :
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    94
        return '-'.join(rev_url(tag) for tag in tags) + ('+' if modified else '')
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    95
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    96
    # revision: <parent> [ "+" <parent> [ ... ]] [ "+" ]
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    97
    revision = '+'.join(rev_url(p) for p in parents) + ('+' if modified else '')
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    98
    
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    99
    if branch :
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   100
        # branch: "(" <branch> ")" <revision> [ "+" ]
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   101
        return '(%s)%s' % (rev_url(branch), revision) + ('+' if modified else '')
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   102
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   103
    else :
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   104
        # plain: <revision>
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   105
        return revision
df859bfdd3be add version string
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   106