autoincrement version

Author: vgvoleg

.github/scripts/increment_version.py

@@ -0,0 +1,170 @@
+#!/bin/env python
+import argparse
+from dataclasses import dataclass
+
+from packaging.version import Version
+
+PYPROJECT_PATH = "pyproject.toml"
+DEFAULT_CHANGELOG_PATH = "CHANGELOG.md"
+DEFAULT_YDB_VERSION_FILE = "ydb_dbapi/version.py"
+MARKER = "# AUTOVERSION"
+
+
+@dataclass(init=False)
+class VersionLine:
+    old_line: str
+    major: int
+    minor: int
+    patch: int
+    pre: int
+
+    def __init__(self, old_line: str, version_str: str):
+        self.old_line = old_line
+
+        version = Version(version_str)
+        self.major = version.major
+        self.minor = version.minor
+        self.micro = version.micro
+
+        if version.pre is None:
+            self.pre = 0
+        else:
+            self.pre = version.pre[1]
+
+    def increment(self, part_name: str, with_beta: bool):
+        if part_name == "minor":
+            self.increment_minor(with_beta)
+        elif part_name == "patch" or part_name == "micro":
+            self.increment_micro(with_beta)
+        else:
+            raise Exception("unexpected increment type: '%s'" % part_name)
+
+    def increment_minor(self, with_beta: bool):
+        if with_beta:
+            if self.pre == 0 or self.micro != 0:
+                self.increment_minor(False)
+            self.pre += 1
+            return
+
+        if self.micro == 0 and self.pre > 0:
+            self.pre = 0
+            return
+
+        self.minor += 1
+        self.micro = 0
+        self.pre = 0
+
+    def increment_micro(self, with_beta: bool):
+        if with_beta:
+            if self.pre == 0:
+                self.increment_micro(False)
+            self.pre += 1
+            return
+
+        if self.pre > 0:
+            self.pre = 0
+            return
+
+        self.micro += 1
+
+    def __str__(self):
+        if self.pre > 0:
+            pre = "b%s" % self.pre
+        else:
+            pre = ""
+
+        return "%s.%s.%s%s" % (self.major, self.minor, self.micro, pre)
+
+    def version_line_with_mark(self):
+        return 'version = "%s"  %s' % (str(self), MARKER)
+
+
+def extract_version(pyproject_content: str):
+    version_line = ""
+    for line in pyproject_content.splitlines():
+        if MARKER in line:
+            version_line = line
+            break
+
+    if version_line == "":
+        raise Exception("Not found version line")
+
+    version_line = version_line.strip()
+
+    parts = version_line.split('"')
+    version_part = parts[1]
+
+    return VersionLine(old_line=version_line, version_str=version_part)
+
+
+def increment_version_at_pyproject(
+    pyproject_path: str, inc_type: str, with_beta: bool
+) -> str:
+    with open(pyproject_path, "rt") as f:
+        setup_content = f.read()
+
+    version = extract_version(setup_content)
+    version.increment(inc_type, with_beta)
+    setup_content = setup_content.replace(
+        version.old_line, version.version_line_with_mark()
+    )
+
+    with open(pyproject_path, "w") as f:
+        f.write(setup_content)
+
+    return str(version)
+
+
+def add_changelog_version(changelog_path, version: str):
+    with open(changelog_path, "rt") as f:
+        content = f.read()
+        content = content.strip()
+
+    if content.startswith("##"):
+        return
+
+    content = """## %s ##
+%s
+""" % (version, content)
+    with open(changelog_path, "w") as f:
+        f.write(content)
+
+
+def set_version_in_version_file(file_path: str, version: str):
+    with open(file_path, "w") as f:
+        f.write('VERSION = "%s"\n' % version)
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--inc-type",
+        default="minor",
+        help="increment version type: patch or minor",
+        choices=["minor", "patch"],
+    )
+    parser.add_argument(
+        "--beta", choices=["true", "false"], help="is beta version"
+    )
+    parser.add_argument(
+        "--changelog-path",
+        default=DEFAULT_CHANGELOG_PATH,
+        help="path to changelog",
+        type=str,
+    )
+    parser.add_argument("--pyproject-path", default=PYPROJECT_PATH)
+
+    args = parser.parse_args()
+
+    is_beta = args.beta == "true"
+
+    new_version = increment_version_at_pyproject(
+        args.pyproject_path, args.inc_type, is_beta
+    )
+    add_changelog_version(args.changelog_path, new_version)
+    set_version_in_version_file(DEFAULT_YDB_VERSION_FILE, new_version)
+    print(new_version)
+
+
+if __name__ == "__main__":
+    main()

.github/scripts/increment_version_test.py

@@ -0,0 +1,28 @@
+import pytest
+
+from .increment_version import VersionLine
+
+
+@pytest.mark.parametrize(
+    "source,inc_type,with_beta,result",
+    [
+        ("0.0.0", "patch", False, "0.0.1"),
+        ("0.0.1", "patch", False, "0.0.2"),
+        ("0.0.1b1", "patch", False, "0.0.1"),
+        ("0.0.0", "patch", True, "0.0.1b1"),
+        ("0.0.1", "patch", True, "0.0.2b1"),
+        ("0.0.2b1", "patch", True, "0.0.2b2"),
+        ("0.0.1", "minor", False, "0.1.0"),
+        ("0.0.1b1", "minor", False, "0.1.0"),
+        ("0.1.0b1", "minor", False, "0.1.0"),
+        ("0.1.0", "minor", True, "0.2.0b1"),
+        ("0.1.0b1", "minor", True, "0.1.0b2"),
+        ("0.1.1b1", "minor", True, "0.2.0b1"),
+        ("3.0.0b1", "patch", True, "3.0.0b2"),
+    ],
+)
+def test_increment_version(source, inc_type, with_beta, result):
+    version = VersionLine("", source)
+    version.increment(inc_type, with_beta)
+    incremented = str(version)
+    assert incremented == result

.pre-commit-config.yaml

@@ -23,3 +23,5 @@ repos:
     hooks:
       - id: mypy
         name: mypy
+
+exclude: '.github/'

CHANGELOG.md

@@ -0,0 +1 @@
+* YDB DBAPI based on QueryService

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ydb-dbapi"
-version = "0.0.1"
+version = "0.0.0" # AUTOVERSION
 description = "YDB Python DBAPI which complies with PEP 249"
 authors = ["Yandex LLC <[email protected]>"]
 readme = "README.md"
@@ -33,7 +33,7 @@ format = "ruff format"
 tests = "pytest"
 
 [tool.ruff]
-exclude = [".venv", ".git", "__pycache__", "build", "dist", "venv"]
+exclude = [".venv", ".git", ".github/scripts", "__pycache__", "build", "dist", "venv"]
 line-length = 79
 target-version = "py39"
 src = ["ydb_dbapi", "tests"]

pyproject.toml

@@ -6,9 +6,9 @@
 from .cursors import AsyncCursor
 from .cursors import Cursor
 from .errors import *
-from .version import version
+from .version import VERSION
 
-__version__ = version
+__version__ = VERSION
 
 apilevel = "2.0"
 threadsafety = 0

ydb_dbapi/__init__.py

@@ -1 +1 @@
-version = "0.0.1"
+VERSION = "0.0.1"