refactor: Use package.json for version management (#5514)

DarhkVoyd · abidlabs · gradio-pr-bot · web-flow · commit 52f7831751b4 · 2023-09-15T16:23:52.000-07:00
* refactor: Use package.json for version management

- uses package.json file for version management.
- updated the regex pattern.
- removed the logic that creates or updates the version.txt file

* load version through package.json

* fix code duplication

* add changeset

* add changeset

* fixes

* fix

* package version

* fix

* typing

* typing

* changes

* add changeset

---------

Co-authored-by: Abubakar Abid &lt;abubakar@huggingface.co&gt;
Co-authored-by: gradio-pr-bot &lt;gradio-pr-bot@users.noreply.github.com&gt;
diff --git a/.changeset/fix_changelogs.cjs b/.changeset/fix_changelogs.cjs
@@ -82,7 +82,6 @@ ${current_changelog.replace(`# ${pkg_name}`, "").trim()}
 		});
 
 		if (python) {
-			writeFileSync(join(dirs[0], "version.txt"), version);
 			bump_local_dependents(pkg_name, version);
 		}
 	}
diff --git a/.changeset/smart-birds-drop.md b/.changeset/smart-birds-drop.md
@@ -0,0 +1,7 @@
+---
+"@gradio/app": patch
+"gradio": patch
+"gradio_client": patch
+---
+
+feat:refactor: Use package.json for version management
diff --git a/.config/basevite.config.ts b/.config/basevite.config.ts
@@ -11,7 +11,7 @@ import { join } from "path";
 import { fileURLToPath } from "url";
 
 const __dirname = fileURLToPath(new URL(".", import.meta.url));
-const version_path = join(__dirname, "..", "gradio", "version.txt");
+const version_path = join(__dirname, "..", "gradio", "package.json");
 const theme_token_path = join(
 	__dirname,
 	"..",
@@ -21,9 +21,7 @@ const theme_token_path = join(
 	"tokens.css"
 );
 
-const version = readFileSync(version_path, { encoding: "utf-8" })
-	.trim()
-	.replace(/\./g, "-");
+const version = JSON.parse(readFileSync(version_path, { encoding: 'utf-8' })).version.trim().replace(/\./g, '-');
 
 //@ts-ignore
 export default defineConfig(({ mode }) => {
diff --git a/.github/workflows/build-pr.yml b/.github/workflows/build-pr.yml
@@ -47,7 +47,6 @@ jobs:
         fi
     - name: Build pr package
       run: |
-        echo ${{ steps.get_pr_number.outputs.GRADIO_VERSION }} > gradio/version.txt
         pnpm i --frozen-lockfile --ignore-scripts
         pnpm build
         python3 -m build -w
diff --git a/build_pypi.sh b/build_pypi.sh
@@ -3,9 +3,10 @@ set -e
 
 cd "$(dirname ${0})"
 
-# You should update the version in version.txt before running this script
-new_version="$(cat gradio/version.txt)"
-GRADIO_VERSION=$new_version
+# You should update the version in package.json before running this script
+FILE="gradio/package.json"
+new_version=$(python -c "import json; f = open('$FILE', 'r'); data = json.load(f); print(data['version']); f.close();")
+GRADIO_VERSION = $new_version
 
 rm -rf gradio/templates/frontend
 rm -rf gradio/templates/cdn
diff --git a/client/python/gradio_client/utils.py b/client/python/gradio_client/utils.py
@@ -58,7 +58,20 @@
     SpaceStage.PAUSED,
 ]
 
-__version__ = (pkgutil.get_data(__name__, "version.txt") or b"").decode("ascii").strip()
+
+def get_package_version() -> str:
+    try:
+        package_json_data = (
+            pkgutil.get_data(__name__, "package.json").decode("utf-8").strip()  # type: ignore
+        )
+        package_data = json.loads(package_json_data)
+        version = package_data.get("version", "")
+        return version
+    except Exception:
+        return ""
+
+
+__version__ = get_package_version()
 
 
 class TooManyRequestsError(Exception):
diff --git a/client/python/gradio_client/version.txt b/client/python/gradio_client/version.txt
diff --git a/client/python/pyproject.toml b/client/python/pyproject.toml
@@ -38,8 +38,8 @@ classifiers = [
 Homepage = "https://github.com/gradio-app/gradio"
 
 [tool.hatch.version]
-path = "gradio_client/version.txt"
-pattern = "(?P<version>.+)"
+path = "gradio_client/package.json"
+pattern = ".*\"version\":\\s*\"(?P<version>[^\"]+)\""
 
 [tool.hatch.metadata.hooks.requirements_txt]
 filename = "requirements.txt"
diff --git a/client/python/scripts/check_pypi.py b/client/python/scripts/check_pypi.py
@@ -3,8 +3,9 @@
 import urllib.request
 from pathlib import Path
 
-version_file = Path(__file__).parent.parent / "gradio_client" / "version.txt"
-version = version_file.read_text(encoding="utf8").strip()
+version_file = Path(__file__).parent.parent / "gradio_client" / "package.json"
+with version_file.open() as f:
+    version = json.load(f)["version"]
 
 with urllib.request.urlopen("https://pypi.org/pypi/gradio_client/json") as url:
     releases = json.load(url)["releases"]
diff --git a/gradio/__init__.py b/gradio/__init__.py
@@ -1,4 +1,4 @@
-import pkgutil
+import json
 
 import gradio.components as components
 import gradio.inputs as inputs
@@ -103,8 +103,6 @@
     Webcam,
 )
 from gradio.themes import Base as Theme
+from gradio.utils import get_package_version
 
-current_pkg_version = (
-    (pkgutil.get_data(__name__, "version.txt") or b"").decode("ascii").strip()
-)
-__version__ = current_pkg_version
+__version__ = get_package_version()
diff --git a/gradio/analytics.py b/gradio/analytics.py
@@ -16,7 +16,7 @@
 import gradio
 from gradio import wasm_utils
 from gradio.context import Context
-from gradio.utils import GRADIO_VERSION
+from gradio.utils import get_package_version
 
 # For testability, we import the pyfetch function into this module scope and define a fallback coroutine object to be patched in tests.
 try:
@@ -87,10 +87,7 @@ async def _do_wasm_analytics_request(url: str, data: dict[str, Any]) -> None:
 
 def version_check():
     try:
-        version_data = pkgutil.get_data(__name__, "version.txt")
-        if not version_data:
-            raise FileNotFoundError
-        current_pkg_version = version_data.decode("ascii").strip()
+        current_pkg_version = get_package_version()
         latest_pkg_version = requests.get(url=PKG_VERSION_URL, timeout=3).json()[
             "version"
         ]
@@ -197,7 +194,7 @@ def launched_analytics(blocks: gradio.Blocks, data: dict[str, Any]) -> None:
             str(blocks.blocks[y]) for y in x["outputs"] if y in blocks.blocks
         ]
     additional_data = {
-        "version": GRADIO_VERSION,
+        "version": get_package_version(),
         "is_kaggle": blocks.is_kaggle,
         "is_sagemaker": blocks.is_sagemaker,
         "using_auth": blocks.auth is not None,
diff --git a/gradio/blocks.py b/gradio/blocks.py
@@ -55,14 +55,14 @@
     CURRENT_TUNNELS,
 )
 from gradio.utils import (
-    GRADIO_VERSION,
     TupleNoPrint,
     check_function_inputs_match,
     component_or_layout_class,
     concurrency_count_warning,
     delete_none,
     get_cancel_function,
     get_continuous_fn,
+    get_package_version,
 )
 
 try:
@@ -771,7 +771,7 @@ def __init__(
                 "custom_css": self.css is not None,
                 "theme": self.theme.name,
                 "is_custom_theme": is_custom_theme,
-                "version": GRADIO_VERSION,
+                "version": get_package_version(),
             }
             analytics.initiated_analytics(data)
 
diff --git a/gradio/routes.py b/gradio/routes.py
@@ -54,14 +54,19 @@
 from gradio.oauth import attach_oauth
 from gradio.queueing import Estimation, Event
 from gradio.route_utils import Request  # noqa: F401
-from gradio.utils import cancel_tasks, run_coro_in_background, set_task_name
+from gradio.utils import (
+    cancel_tasks,
+    get_package_version,
+    run_coro_in_background,
+    set_task_name,
+)
 
 mimetypes.init()
 
 STATIC_TEMPLATE_LIB = files("gradio").joinpath("templates").as_posix()  # type: ignore
 STATIC_PATH_LIB = files("gradio").joinpath("templates", "frontend", "static").as_posix()  # type: ignore
 BUILD_PATH_LIB = files("gradio").joinpath("templates", "frontend", "assets").as_posix()  # type: ignore
-VERSION = files("gradio").joinpath("version.txt").read_text()
+VERSION = get_package_version()
 
 
 class ORJSONResponse(JSONResponse):
diff --git a/gradio/utils.py b/gradio/utils.py
@@ -50,14 +50,23 @@
     from gradio.routes import App
 
 JSON_PATH = os.path.join(os.path.dirname(gradio.__file__), "launches.json")
-GRADIO_VERSION = (
-    (pkgutil.get_data(__name__, "version.txt") or b"").decode("ascii").strip()
-)
 
 P = ParamSpec("P")
 T = TypeVar("T")
 
 
+def get_package_version() -> str:
+    try:
+        package_json_data = (
+            pkgutil.get_data(__name__, "package.json").decode("utf-8").strip()  # type: ignore
+        )
+        package_data = json.loads(package_json_data)
+        version = package_data.get("version", "")
+        return version
+    except Exception:
+        return ""
+
+
 def safe_get_lock() -> asyncio.Lock:
     """Get asyncio.Lock() without fear of getting an Exception.
 
diff --git a/gradio/version.txt b/gradio/version.txt
diff --git a/js/app/vite.config.ts b/js/app/vite.config.ts
@@ -9,19 +9,16 @@ import prefixer from "postcss-prefix-selector";
 import { readFileSync } from "fs";
 import { resolve } from "path";
 
-const version_path = resolve(__dirname, "../../gradio/version.txt");
+const version_path = resolve(__dirname, "../../gradio/package.json");
 const theme_token_path = resolve(__dirname, "../theme/src/tokens.css");
-const version_raw = readFileSync(version_path, { encoding: "utf-8" }).trim();
+const version_raw = JSON.parse(readFileSync(version_path, { encoding: "utf-8" })).version.trim();
 const version = version_raw.replace(/\./g, "-");
 
 const client_version_path = resolve(
 	__dirname,
-	"../../client/python/gradio_client/version.txt"
+	"../../client/python/gradio_client/package.json"
 );
-const client_version_raw = readFileSync(client_version_path, {
-	encoding: "utf-8"
-}).trim();
-const client_version = client_version_raw.replace(/\./g, "-");
+const client_version_raw = JSON.parse(readFileSync(client_version_path, { encoding: "utf-8" })).version.trim();
 
 import {
 	inject_ejs,
diff --git a/pyproject.toml b/pyproject.toml
@@ -42,8 +42,8 @@ upload_theme = "gradio.themes.upload_theme:main"
 Homepage = "https://github.com/gradio-app/gradio"
 
 [tool.hatch.version]
-path = "gradio/version.txt"
-pattern = "(?P<version>.+)"
+path = "gradio/package.json"
+pattern = ".*\"version\":\\s*\"(?P<version>[^\"]+)\""
 
 [tool.hatch.metadata.hooks.requirements_txt]
 filename = "requirements.txt"
diff --git a/scripts/check_pypi.py b/scripts/check_pypi.py
@@ -3,9 +3,9 @@
 import urllib.request
 from pathlib import Path
 
-root_directory = Path(__file__).parent.parent
-version = (root_directory /  "gradio" / "version.txt").read_text(
-    encoding='utf8').strip()
+version_file = Path(__file__).parent.parent / "gradio" / "package.json"
+with version_file.open() as f:
+    version = json.load(f)["version"]
 
 with urllib.request.urlopen("https://pypi.org/pypi/gradio/json") as url:
     releases = json.load(url)["releases"]
diff --git a/scripts/upload_website_demos.py b/scripts/upload_website_demos.py
@@ -1,23 +1,22 @@
 from __future__ import annotations
 
 import argparse
+import json
 import os
 import pathlib
 import shutil
 import tempfile
 import textwrap
-import requests
 
 import huggingface_hub
 
 ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
-VERSION_TXT = os.path.abspath(os.path.join(ROOT, "gradio", "version.txt"))
+VERSION_FILE = os.path.abspath(os.path.join(ROOT, "gradio", "package.json"))
 DIR = os.path.dirname(__file__)
 GRADIO_DEMO_DIR = os.path.abspath(os.path.join(ROOT, "demo"))
 
-with open(VERSION_TXT) as f:
-    gradio_version=f.read()
-gradio_version = gradio_version.strip()
+with open(VERSION_FILE) as f:
+    version = json.load(f)["version"]
 
 # Reasoning:
 # 1. all_demos includes all demos and is for testing PRs

Original file line number	Diff line number	Diff line change
@@ -82,7 +82,6 @@ ${current_changelog.replace(`# ${pkg_name}`, "").trim()}
`82`	`82`	`});`
`83`	`83`
`84`	`84`	`if (python) {`
`85`		`- writeFileSync(join(dirs[0], "version.txt"), version);`
`86`	`85`	`bump_local_dependents(pkg_name, version);`
`87`	`86`	`}`
`88`	`87`	`}`