scripts/update_version.py - develop - vshmidt/streamlit

scripts/update_version.py
146 строк5 KB
Lukas Masuch
Migrate to uv package manager (#13622)
30 янв 2026, 01:23
30 янв 2026, 01:234d386cc
#!/usr/bin/env python

# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2026)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Update version number across the entire repo.

If the current version is 0.15.2 and I wanted to create a release for
local development, ie make a wheel file and make either a conda or pex
package to test on OSX or linux.  What should I call the next version?

If its a patch change, then only the third number being edited. If
its a minor change then its the second number.  In this example, we're
doing a patch change.

The public released dev version would be
0.15.3-dev0

For local development it would be
0.15.3-dev0+USERNAME0

If you iterate your local dev version it would then be
0.15.3-dev0+USERNAME1

You then release it for testing.
0.15.3-dev0

Someone finds a bug so you release a new internal version for testing.
0.15.3-dev1+USERNAME0

Then we can go to alpha, rc1, rc2, etc. but eventually its
0.15.3
"""

from __future__ import annotations

import fileinput
import os
import re
import sys

import packaging.version
import semver

BASE_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))

# Warning: Advanced regex foo.
# If another file has a version number that needs updating, add it here.
# These regex's are super greedy in that it actually matches everything
# but the version number so we can throw any valid PEP440 version in
# there.
PYTHON = {"lib/pyproject.toml": r'(?P<pre>^version = ").*(?P<post>"$)'}

# This regex captures the "version": field in a JSON-like structure
# allowing for any amount of whitespace before the "version": field.
regex = r'(?P<pre>^ \s*"version": ").*(?P<post>",$)'
NODE_PACKAGES = [
    {"frontend/package.json": regex},
    {"frontend/app/package.json": regex},
    {"frontend/connection/package.json": regex},
    {"frontend/lib/package.json": regex},
    {"frontend/protobuf/package.json": regex},
    {"frontend/typescript-config/package.json": regex},
    {"frontend/utils/package.json": regex},
]


def verify_pep440(version: str) -> packaging.version.Version:
    """Verify if version is PEP440 compliant.

    https://github.com/pypa/packaging/blob/16.7/packaging/version.py#L191

    We might need pre, post, alpha, rc in the future so might as well
    use an object that does all that.  This verifies its a valid
    version.
    """
    return packaging.version.Version(version)


def verify_semver(version: str) -> str:
    """Verify if version is compliant with semantic versioning.

    https://semver.org/
    """
    return str(semver.Version.parse(version))


def update_files(data: dict[str, str], version: str) -> None:
    """Update files with new version number."""

    for filename, regex in data.items():
        file_path = os.path.join(BASE_DIR, filename)
        matched = False
        pattern = re.compile(regex)
        for line in fileinput.input(file_path, inplace=True):
            if pattern.match(line.rstrip()):
                matched = True
            updated_line = re.sub(regex, rf"\g<pre>{version}\g<post>", line.rstrip())
            print(updated_line)
        if not matched:
            msg = f'In file "{file_path}", did not find regex "{regex}"'
            raise Exception(msg)


def main() -> None:
    """Run main loop."""

    if len(sys.argv) != 2:
        e = Exception(
            f'Specify semvver version as an argument, e.g.: "{sys.argv[0]} 1.2.3"'
        )
        raise (e)

    # We need two flavors of the version - one that's semver-compliant for Node, one that's
    # PEP440-compliant for Python. We allow for the incoming version to be either semver-compliant
    # PEP440-compliant.
    # - `verify_pep440` automatically converts semver to PEP440-compliant
    pep440_version = verify_pep440(sys.argv[1])

    # - Attempt to convert to semver-compliant. If a failure occurs, manually attempt to convert.
    semver_version = None
    try:
        semver_version = verify_semver(sys.argv[1])
    except ValueError:
        semver_version = verify_semver(
            sys.argv[1].replace("rc", "-rc.").replace(".dev", "-dev")
        )

    update_files(PYTHON, str(pep440_version))
    for package in NODE_PACKAGES:
        update_files(package, str(semver_version))


if __name__ == "__main__":
    main()