datasets

1
# Copyright 2021 The HuggingFace Team. All rights reserved.
2
#
3
# Licensed under the Apache License, Version 2.0 (the "License");
4
# you may not use this file except in compliance with the License.
5
# You may obtain a copy of the License at
6
#
7
#     http://www.apache.org/licenses/LICENSE-2.0
8
#
9
# Unless required by applicable law or agreed to in writing, software
10
# distributed under the License is distributed on an "AS IS" BASIS,
11
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
# See the License for the specific language governing permissions and
13
# limitations under the License.
14

15
import argparse
16
import re
17

18
import packaging.version
19

20

21
REPLACE_PATTERNS = {
22
    "init": (re.compile(r'^__version__\s+=\s+"([^"]+)"\s*$', re.MULTILINE), '__version__ = "VERSION"\n'),
23
    "setup": (re.compile(r'^(\s*)version\s*=\s*"[^"]+",', re.MULTILINE), r'\1version="VERSION",'),
24
}
25
REPLACE_FILES = {
26
    "init": "src/datasets/__init__.py",
27
    "setup": "setup.py",
28
}
29

30

31
def update_version_in_file(fname, version, pattern):
32
    """Update the version in one file using a specific pattern."""
33
    with open(fname, "r", encoding="utf-8", newline="\n") as f:
34
        code = f.read()
35
    re_pattern, replace = REPLACE_PATTERNS[pattern]
36
    replace = replace.replace("VERSION", version)
37
    code = re_pattern.sub(replace, code)
38
    with open(fname, "w", encoding="utf-8", newline="\n") as f:
39
        f.write(code)
40

41

42
def global_version_update(version):
43
    """Update the version in all needed files."""
44
    for pattern, fname in REPLACE_FILES.items():
45
        update_version_in_file(fname, version, pattern)
46

47

48
def get_version():
49
    """Reads the current version in the __init__."""
50
    with open(REPLACE_FILES["init"], "r") as f:
51
        code = f.read()
52
    default_version = REPLACE_PATTERNS["init"][0].search(code).groups()[0]
53
    return packaging.version.parse(default_version)
54

55

56
def pre_release_work(patch=False):
57
    """Do all the necessary pre-release steps."""
58
    # First let's get the default version: base version if we are in dev, bump minor otherwise.
59
    default_version = get_version()
60
    if patch and default_version.is_devrelease:
61
        raise ValueError("Can't create a patch version from the dev branch, checkout a released version!")
62
    if default_version.is_devrelease:
63
        default_version = default_version.base_version
64
    elif patch:
65
        default_version = f"{default_version.major}.{default_version.minor}.{default_version.micro + 1}"
66
    else:
67
        default_version = f"{default_version.major}.{default_version.minor + 1}.0"
68

69
    # Now let's ask nicely if that's the right one.
70
    version = input(f"Which version are you releasing? [{default_version}]")
71
    if len(version) == 0:
72
        version = default_version
73

74
    print(f"Updating version to {version}.")
75
    global_version_update(version)
76

77

78
def post_release_work():
79
    """Do all the necesarry post-release steps."""
80
    # First let's get the current version
81
    current_version = get_version()
82
    dev_version = f"{current_version.major}.{current_version.minor + 1}.0.dev0"
83
    current_version = current_version.base_version
84

85
    # Check with the user we got that right.
86
    version = input(f"Which version are we developing now? [{dev_version}]")
87
    if len(version) == 0:
88
        version = dev_version
89

90
    print(f"Updating version to {version}.")
91
    global_version_update(version)
92

93

94
if __name__ == "__main__":
95
    parser = argparse.ArgumentParser()
96
    parser.add_argument("--post_release", action="store_true", help="Whether or not this is post release.")
97
    parser.add_argument("--patch", action="store_true", help="Whether or not this is a patch release.")
98
    args = parser.parse_args()
99
    if not args.post_release:
100
        pre_release_work(patch=args.patch)
101
    elif args.patch:
102
        print("Nothing to do after a patch :-)")
103
    else:
104
        post_release_work()
105