File: update_version.py

package info (click to toggle)
reentry 1.3.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, trixie
  • size: 280 kB
  • sloc: python: 749; makefile: 19; sh: 4
file content (120 lines) | stat: -rw-r--r-- 4,120 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
"""Update version numbers everywhere based on git tags."""
from __future__ import print_function
import os
import re
import json
import fileinput
import contextlib
import subprocess
try:
    # prefer the backport for Python <3.5
    from pathlib2 import Path
except ImportError:
    from pathlib import Path
import collections

from packaging import version


def subpath(*args):
    return os.path.realpath(os.path.join(os.path.dirname(os.path.realpath(__file__)), '..', *args))


@contextlib.contextmanager
def file_input(*args, **kwargs):
    """Context manager for a FileInput object."""
    input_fo = fileinput.FileInput(*args, **kwargs)
    try:
        yield input_fo
    finally:
        input_fo.close()


class VersionUpdater(object):
    """
    Version number synchronisation interface.

    Updates the version information in

    * setup.json
    * aiida_vasp/__init__.py

    to the current version number.

    The current version number is either parsed from the output of ``git describe --tags --match v*.*.*``, or if the command fails for
    any reason, from setup.json. The current version number is decided on init, syncronization can be executed by calling ``.sync()``.
    """

    version_pat = re.compile(r'\d+.\d+.\d+(-(alpha|beta|rc)(.\d+){0,3}){0,1}')
    init_version_pat = re.compile(r'(__version__ = )([\'"])(.*?)([\'"])', re.DOTALL | re.MULTILINE)
    replace_tmpl = r'\1\g<2>{}\4'

    def __init__(self):
        """Initialize with documents that should be kept up to date and actual version."""
        self.top_level_init = Path(subpath('reentry', '__init__.py'))
        self.setup_json = Path(subpath('setup.json'))
        self.version = self.get_version()

    def write_to_init(self):
        init_content = self.top_level_init.read_text()
        self.top_level_init.write_text(re.sub(self.init_version_pat, self.new_version_str, init_content, re.DOTALL | re.MULTILINE))

    def write_to_setup(self):
        """Write the updated version number to setup.json."""
        with open(str(self.setup_json), 'r') as setup_fo:
            # preserve order
            setup = json.load(setup_fo, object_pairs_hook=collections.OrderedDict)

        setup['version'] = str(self.version)
        with open(str(self.setup_json), 'w') as setup_fo:
            json.dump(setup, setup_fo, indent=4, separators=(',', ': '))

    @property
    def new_version_str(self):
        return self.replace_tmpl.format(str(self.version))

    @property
    def setup_version(self):
        """Grab the parsed version from setup.json."""
        with open(str(self.setup_json), 'r') as setup_fo:
            setup = json.load(setup_fo)

        try:
            version_string = setup['version']
        except KeyError:
            raise AttributeError('No version found in setup.json')

        return version.parse(version_string)

    @property
    def init_version(self):
        """Grab the parsed version from the init file."""
        match = re.search(self.init_version_pat, self.top_level_init.read_text())
        if not match:
            raise AttributeError('No __version__ found in top-level __init__.py')
        return version.parse(match.groups()[2])

    @property
    def tag_version(self):
        """Get the current version number from ``git describe``, fall back to setup.json."""
        try:
            describe_byte_string = subprocess.check_output(['git', 'describe', '--tags', '--match', 'v*.*.*'])
            match = re.search(self.version_pat, describe_byte_string.decode(encoding='UTF-8'))
            version_string = match.string[match.pos:match.end()]
            return version.parse(version_string)
        except subprocess.CalledProcessError:
            return self.setup_version

    def get_version(self):
        return max(self.setup_version, self.init_version, self.tag_version)

    def sync(self):
        if self.version > self.init_version:
            self.write_to_init()
        if self.version > self.setup_version:
            self.write_to_setup()


if __name__ == '__main__':
    VERSION_UPDATER = VersionUpdater()
    VERSION_UPDATER.sync()