vscode-offline 0.1.7__tar.gz → 0.1.9__tar.gz

{vscode_offline-0.1.7 → vscode_offline-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vscode-offline
-Version: 0.1.7
+Version: 0.1.9
 Summary: Download and install VS Code for offline environments
 Project-URL: Homepage, https://github.com/fanck0605/vscode-offline
 Author-email: Chuck Fan <fanck0605@qq.com>
@@ -51,7 +51,7 @@ pip install -U vscode-offline
 vscode-offline download-all --client-platform win32-x64 --server-platform linux-x64
 ```
 
-（3）复制 `./vscode-offline-installer` 到内网 Windows 机器，安装 `client-<version>` 下的 VS Code，然后执行如下命令安装所有插件
+（3）复制 `./vscode-offline-installer` 到内网 Windows 机器，安装 `./vscode-offline-installer/<version>` 下的 VS Code，然后执行如下命令安装所有插件
 
 ```shell
 vscode-offline install-extensions --installer ./vscode-offline-installer

{vscode_offline-0.1.7 → vscode_offline-0.1.9}/README.md

@@ -28,7 +28,7 @@ pip install -U vscode-offline
 vscode-offline download-all --client-platform win32-x64 --server-platform linux-x64
 ```
 
-（3）复制 `./vscode-offline-installer` 到内网 Windows 机器，安装 `client-<version>` 下的 VS Code，然后执行如下命令安装所有插件
+（3）复制 `./vscode-offline-installer` 到内网 Windows 机器，安装 `./vscode-offline-installer/<version>` 下的 VS Code，然后执行如下命令安装所有插件
 
 ```shell
 vscode-offline install-extensions --installer ./vscode-offline-installer

{vscode_offline-0.1.7 → vscode_offline-0.1.9}/src/vscode_offline/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.1.7'
-__version_tuple__ = version_tuple = (0, 1, 7)
+__version__ = version = '0.1.9'
+__version_tuple__ = version_tuple = (0, 1, 9)
 
 __commit_id__ = commit_id = None

{vscode_offline-0.1.7 → vscode_offline-0.1.9}/src/vscode_offline/app.py

@@ -16,6 +16,9 @@ from vscode_offline.install import (
     install_vscode_server,
 )
 from vscode_offline.utils import (
+    CLIENT_PLATFORMS,
+    EXTENSION_PLATFORMS,
+    SERVER_PLATFORMS,
     get_client_platform,
     get_default_code_version,
     get_extension_platform,
@@ -23,7 +26,6 @@ from vscode_offline.utils import (
     get_server_platform,
     get_vscode_extensions_config,
     get_vscode_version_from_server_installer,
-    validate_platform,
 )
 
 
@@ -37,7 +39,7 @@ def cmd_download_server(args: Namespace) -> None:
 
     download_vscode_server(
         args.code_version,
-        output=args.installer / f"server-{args.code_version.replace(':', '-')}",
+        output=args.installer / args.code_version.replace(":", "-"),
         platform=get_server_platform(args.platform),
     )
     extensions_config = Path(args.extensions_config).expanduser()
@@ -63,7 +65,7 @@ def cmd_install_server(args: Namespace) -> None:
             ) from None
 
     vscode_server_home = install_vscode_server(
-        server_installer=args.installer / f"server-{args.code_version}",
+        server_installer=args.installer / args.code_version.replace(":", "-"),
         platform=get_server_platform(host_platform),
     )
     install_vscode_extensions(
@@ -104,7 +106,7 @@ def cmd_download_client(args: Namespace) -> None:
 
     download_vscode_client(
         args.code_version,
-        output=args.installer / f"client-{args.code_version.replace(':', '-')}",
+        output=args.installer / args.code_version.replace(":", "-"),
         platform=get_client_platform(args.platform),
     )
     extensions_config = Path(args.extensions_config).expanduser()
@@ -127,12 +129,12 @@ def cmd_download_all(args: Namespace) -> None:
 
     download_vscode_server(
         args.code_version,
-        output=args.installer / f"server-{args.code_version.replace(':', '-')}",
+        output=args.installer / args.code_version.replace(":", "-"),
         platform=get_server_platform(args.server_platform),
     )
     download_vscode_client(
         args.code_version,
-        output=args.installer / f"client-{args.code_version.replace(':', '-')}",
+        output=args.installer / args.code_version.replace(":", "-"),
         platform=get_client_platform(args.client_platform),
     )
     extensions_config = Path(args.extensions_config).expanduser()
@@ -153,29 +155,28 @@ def cmd_version(args: Namespace) -> None:
 
 def make_argparser() -> ArgumentParser:
     parent_parser = ArgumentParser(add_help=False)
-
     parent_parser.add_argument(
         "--installer",
         type=Path,
         default="./vscode-offline-installer",
-        help="The output directory for downloaded files. Also used as the installer directory.",
+        help="The output directory for downloaded files, also used as the installer directory.",
     )
 
-    parser = ArgumentParser()
-    subparsers = parser.add_subparsers(required=True)
+    main_parser = ArgumentParser(description="VS Code downloader and installer")
+    subparsers = main_parser.add_subparsers(required=True)
 
     version_parser = subparsers.add_parser(
         "version",
         help="Show version information",
     )
-    version_parser.set_defaults(func=cmd_version)
+    version_parser.set_defaults(command=cmd_version)
 
     download_server_parser = subparsers.add_parser(
         "download-server",
-        help="Download VS Code Server and extensions",
+        help="Download VS Code Server and its extensions",
         parents=[parent_parser],
     )
-    download_server_parser.set_defaults(func=cmd_download_server)
+    download_server_parser.set_defaults(command=cmd_download_server)
     download_server_parser.add_argument(
         "--code-version",
         type=str,
@@ -183,7 +184,7 @@ def make_argparser() -> ArgumentParser:
     )
     download_server_parser.add_argument(
         "--platform",
-        type=validate_platform,
+        choices=SERVER_PLATFORMS,
         required=True,
         help="The target platform of the VS Code Server to download.",
     )
@@ -194,68 +195,43 @@ def make_argparser() -> ArgumentParser:
         help="Path to the extensions configuration file. Will search for extensions to download.",
     )
 
-    install_server_parser = subparsers.add_parser(
-        "install-server",
-        help="Install VS Code Server and extensions",
+    download_client_parser = subparsers.add_parser(
+        "download-client",
+        help="Download VS Code client and its extensions",
         parents=[parent_parser],
     )
-    install_server_parser.set_defaults(func=cmd_install_server)
-    install_server_parser.add_argument(
+    download_client_parser.set_defaults(command=cmd_download_client)
+    download_client_parser.add_argument(
         "--code-version",
         type=str,
-        help="The version of the VS Code Server to install.",
-    )
-
-    download_extensions_parser = subparsers.add_parser(
-        "download-extensions",
-        help="Download VS Code Server and extensions",
-        parents=[parent_parser],
+        help="The version of the VS Code to download, must match the version of the VS Code Client.",
     )
-    download_extensions_parser.set_defaults(func=cmd_download_extensions)
-    download_extensions_parser.add_argument(
+    download_client_parser.add_argument(
         "--platform",
-        type=validate_platform,
+        choices=CLIENT_PLATFORMS,
         required=True,
-        help="The target platform of the VS Code extensions to download.",
+        help="The target platform of the VS Code client to download.",
     )
-    download_extensions_parser.add_argument(
+    download_client_parser.add_argument(
         "--extensions-config",
         type=Path,
         default=get_vscode_extensions_config(),
         help="Path to the extensions configuration file. Will search for extensions to download.",
     )
 
-    install_extensions_parser = subparsers.add_parser(
-        "install-extensions",
-        help="Install VS Code extensions",
-        parents=[parent_parser],
-    )
-    install_extensions_parser.set_defaults(func=cmd_install_extensions)
-    install_extensions_parser.add_argument(
-        "--code",
-        type=str,
-        default="code",
-        help="Path to the `code` binary.",
-    )
-
-    download_client_parser = subparsers.add_parser(
-        "download-client",
-        help="Download VS Code and extensions",
+    download_extensions_parser = subparsers.add_parser(
+        "download-extensions",
+        help="Download VS Code extensions only",
         parents=[parent_parser],
     )
-    download_client_parser.set_defaults(func=cmd_download_client)
-    download_client_parser.add_argument(
-        "--code-version",
-        type=str,
-        help="The version of the VS Code to download, must match the version of the VS Code Client.",
-    )
-    download_client_parser.add_argument(
+    download_extensions_parser.set_defaults(command=cmd_download_extensions)
+    download_extensions_parser.add_argument(
         "--platform",
-        type=validate_platform,
+        choices=EXTENSION_PLATFORMS,
         required=True,
-        help="The target platform of the VS Code to download.",
+        help="The target platform of the VS Code extensions to download.",
     )
-    download_client_parser.add_argument(
+    download_extensions_parser.add_argument(
         "--extensions-config",
         type=Path,
         default=get_vscode_extensions_config(),
@@ -264,10 +240,10 @@ def make_argparser() -> ArgumentParser:
 
     download_all_parser = subparsers.add_parser(
         "download-all",
-        help="Download VS Code server, client and extensions, all in one command",
+        help="Download VS Code Server, Client and its extensions, all in one command",
         parents=[parent_parser],
     )
-    download_all_parser.set_defaults(func=cmd_download_all)
+    download_all_parser.set_defaults(command=cmd_download_all)
     download_all_parser.add_argument(
         "--code-version",
         type=str,
@@ -275,13 +251,13 @@ def make_argparser() -> ArgumentParser:
     )
     download_all_parser.add_argument(
         "--server-platform",
-        type=validate_platform,
+        choices=SERVER_PLATFORMS,
         required=True,
         help="The target platform of the VS Code Server to download, defaults to linux-x64.",
     )
     download_all_parser.add_argument(
         "--client-platform",
-        type=validate_platform,
+        choices=CLIENT_PLATFORMS,
         required=True,
         help="The target platform of the VS Code to download, defaults to win32-x64.",
     )
@@ -292,7 +268,32 @@ def make_argparser() -> ArgumentParser:
         help="Path to the extensions configuration file. Will search for extensions to download.",
     )
 
-    return parser
+    install_server_parser = subparsers.add_parser(
+        "install-server",
+        help="Install VS Code Server and its extensions",
+        parents=[parent_parser],
+    )
+    install_server_parser.set_defaults(command=cmd_install_server)
+    install_server_parser.add_argument(
+        "--code-version",
+        type=str,
+        help="The version of the VS Code Server to install.",
+    )
+
+    install_extensions_parser = subparsers.add_parser(
+        "install-extensions",
+        help="Install VS Code extensions only",
+        parents=[parent_parser],
+    )
+    install_extensions_parser.set_defaults(command=cmd_install_extensions)
+    install_extensions_parser.add_argument(
+        "--code",
+        type=str,
+        default="code",
+        help="Path to the `code` binary.",
+    )
+
+    return main_parser
 
 
 def main() -> None:

{vscode_offline-0.1.7 → vscode_offline-0.1.9}/src/vscode_offline/download.py

@@ -4,7 +4,6 @@ import json
 import os
 from collections.abc import Set as AbstractSet
 from gzip import GzipFile
-from io import DEFAULT_BUFFER_SIZE
 from pathlib import Path
 from urllib.error import HTTPError
 from urllib.request import urlopen
@@ -12,6 +11,8 @@ from urllib.request import urlopen
 from vscode_offline.loggers import logger
 from vscode_offline.utils import extract_filename_from_headers, get_cli_platform
 
+_DOWNLOAD_CHUNK_SIZE = 4 * 1024 * 1024  # 4 MiB
+
 
 def _download_file_once(
     url: str,
@@ -45,7 +46,7 @@ def _download_file_once(
         tmp_file_path = Path(directory).joinpath(f"{filename}.tmp")
         with reader, tmp_file_path.open("wb") as fp:
             while True:
-                chunk = reader.read(DEFAULT_BUFFER_SIZE)
+                chunk = reader.read(_DOWNLOAD_CHUNK_SIZE)
                 if not chunk:
                     break
                 fp.write(chunk)

{vscode_offline-0.1.7 → vscode_offline-0.1.9}/src/vscode_offline/utils.py

@@ -4,12 +4,11 @@ import os
 import shutil
 import subprocess
 import sys
-from argparse import ArgumentTypeError
 from collections.abc import Mapping
 from collections.abc import Set as AbstractSet
 from email.parser import HeaderParser
 from pathlib import Path
-from typing import Final
+from typing import Collection, Final
 
 from vscode_offline.loggers import logger
 
@@ -38,9 +37,7 @@ def get_vscode_extensions_config() -> os.PathLike[str]:
 def get_vscode_version_from_server_installer(
     installer: os.PathLike[str], platform: str
 ) -> str:
-    directories = list(
-        Path(installer).glob(f"server-*/vscode-server-{platform}.tar.gz")
-    )
+    directories = list(Path(installer).glob(f"*/vscode-server-{platform}.tar.gz"))
     if len(directories) > 1:
         raise ValueError(
             f"Multiple matching installers found in {installer} for platform {platform}"
@@ -50,9 +47,9 @@ def get_vscode_version_from_server_installer(
             f"No matching installer found in {installer} for platform {platform}"
         )
 
-    version = directories[0].parent.name[len("server-") :]
+    version = directories[0].parent.name
     logger.info(f"Getting version from {platform} installer: {version}")
-    return version
+    return version.replace("commit-", "commit:")
 
 
 def get_default_code_version() -> str | None:
@@ -86,11 +83,9 @@ def get_default_code_version() -> str | None:
 # Mapping from other platforms to VS Code client platform used in download URLs
 _client_platform_mapping: Final[Mapping[str, str]] = {
     "linux-x64": "linux-x64",
-    "alpine-x64": "linux-x64",
     "linux-deb-x64": "linux-deb-x64",
     "linux-rpm-x64": "linux-rpm-x64",
     "linux-arm64": "linux-arm64",
-    "alpine-arm64": "linux-arm64",
     "linux-deb-arm64": "linux-deb-arm64",
     "linux-rpm-arm64": "linux-rpm-arm64",
     "linux-armhf": "linux-armhf",
@@ -102,19 +97,17 @@ _client_platform_mapping: Final[Mapping[str, str]] = {
     "win32-arm64": "win32-arm64",
     "win32-arm64-user": "win32-arm64-user",
     "win32-arm64-archive": "win32-arm64-archive",
-    "darwin": "darwin",
     "darwin-x64": "darwin",
     "darwin-arm64": "darwin-arm64",
 }
 
-# Mapping from other platforms to VS Code server platform used in download URLs
+
+# Mapping from other platforms to VS Code Server platform used in download URLs
 _server_platform_mapping: Final[Mapping[str, str]] = {
     "linux-x64": "linux-x64",
-    "alpine-x64": "linux-x64",
     "linux-deb-x64": "linux-x64",
     "linux-rpm-x64": "linux-x64",
     "linux-arm64": "linux-arm64",
-    "alpine-arm64": "linux-arm64",
     "linux-deb-arm64": "linux-arm64",
     "linux-rpm-arm64": "linux-arm64",
     "linux-armhf": "linux-armhf",
@@ -126,7 +119,6 @@ _server_platform_mapping: Final[Mapping[str, str]] = {
     "win32-arm64": "win32-arm64",
     "win32-arm64-user": "win32-arm64",
     "win32-arm64-archive": "win32-arm64",
-    "darwin": "darwin",
     "darwin-x64": "darwin",
     "darwin-arm64": "darwin-arm64",
 }
@@ -135,11 +127,9 @@ _server_platform_mapping: Final[Mapping[str, str]] = {
 # Mapping from other platforms to VS Code CLI platform used in download URLs
 _cli_platform_mapping: Final[Mapping[str, str]] = {
     "linux-x64": "alpine-x64",
-    "alpine-x64": "alpine-x64",
     "linux-deb-x64": "alpine-x64",
     "linux-rpm-x64": "alpine-x64",
     "linux-arm64": "alpine-arm64",
-    "alpine-arm64": "alpine-arm64",
     "linux-deb-arm64": "alpine-arm64",
     "linux-rpm-arm64": "alpine-arm64",
     "linux-armhf": "linux-armhf",
@@ -151,7 +141,6 @@ _cli_platform_mapping: Final[Mapping[str, str]] = {
     "win32-arm64": "win32-arm64",
     "win32-arm64-user": "win32-arm64",
     "win32-arm64-archive": "win32-arm64",
-    "darwin": "darwin-x64",
     "darwin-x64": "darwin-x64",
     "darwin-arm64": "darwin-arm64",
 }
@@ -160,11 +149,9 @@ _cli_platform_mapping: Final[Mapping[str, str]] = {
 # Mapping from other platforms to extension target platform used in download URLs
 _extension_platform_mapping: Final[Mapping[str, str]] = {
     "linux-x64": "linux-x64",
-    "alpine-x64": "linux-x64",
     "linux-deb-x64": "linux-x64",
     "linux-rpm-x64": "linux-x64",
     "linux-arm64": "linux-arm64",
-    "alpine-arm64": "linux-arm64",
     "linux-deb-arm64": "linux-arm64",
     "linux-rpm-arm64": "linux-arm64",
     "linux-armhf": "linux-armhf",
@@ -176,44 +163,64 @@ _extension_platform_mapping: Final[Mapping[str, str]] = {
     "win32-arm64": "win32-arm64",
     "win32-arm64-user": "win32-arm64",
     "win32-arm64-archive": "win32-arm64",
-    "darwin": "darwin-x64",
     "darwin-x64": "darwin-x64",
     "darwin-arm64": "darwin-arm64",
 }
 
+CLIENT_PLATFORMS: Final[Collection[str]] = {
+    "linux-x64": None,
+    "linux-deb-x64": None,
+    "linux-rpm-x64": None,
+    "linux-arm64": None,
+    "linux-deb-arm64": None,
+    "linux-rpm-arm64": None,
+    "linux-armhf": None,
+    "linux-deb-armhf": None,
+    "linux-rpm-armhf": None,
+    "win32-x64": None,
+    "win32-x64-user": None,
+    "win32-x64-archive": None,
+    "win32-arm64": None,
+    "win32-arm64-user": None,
+    "win32-arm64-archive": None,
+    "darwin-x64": None,
+    "darwin-arm64": None,
+}
 
-def get_client_platform(platform: str) -> str:
-    """Get the VS Code platform for the given platform."""
-    return _client_platform_mapping.get(platform, platform)
-
-
-def get_server_platform(platform: str) -> str:
-    """Get the VS Code server platform for the given platform."""
-    return _server_platform_mapping.get(platform, platform)
-
-
-def get_cli_platform(platform: str) -> str:
-    """Get the VS Code CLI platform for the given platform."""
-    return _cli_platform_mapping.get(platform, platform)
 
+SERVER_PLATFORMS: Final[Collection[str]] = {
+    "linux-x64": None,
+    "linux-arm64": None,
+    "linux-armhf": None,
+    "win32-x64": None,
+    "win32-arm64": None,
+    "darwin-x64": None,
+    "darwin-arm64": None,
+}
 
-def get_extension_platform(platform: str) -> str:
-    """Get the VS Code extension target platform for the given platform."""
-    return _extension_platform_mapping.get(platform, platform)
 
+EXTENSION_PLATFORMS: Final[Collection[str]] = {
+    "linux-x64": None,
+    "linux-arm64": None,
+    "linux-armhf": None,
+    "win32-x64": None,
+    "win32-arm64": None,
+    "darwin-x64": None,
+    "darwin-arm64": None,
+}
 
 _all_platforms: Final[AbstractSet[str]] = {
-    *_client_platform_mapping.keys(),
-    *_client_platform_mapping.values(),
-    *_server_platform_mapping.keys(),
-    *_server_platform_mapping.values(),
-    *_cli_platform_mapping.keys(),
-    *_cli_platform_mapping.values(),
-    *_extension_platform_mapping.keys(),
-    *_extension_platform_mapping.values(),
+    *CLIENT_PLATFORMS,
+    *SERVER_PLATFORMS,
+    *EXTENSION_PLATFORMS,
 }
 
 
+assert set(SERVER_PLATFORMS).issubset(CLIENT_PLATFORMS)
+assert set(EXTENSION_PLATFORMS).issubset(CLIENT_PLATFORMS)
+assert SERVER_PLATFORMS == EXTENSION_PLATFORMS
+
+
 assert (
     _client_platform_mapping.keys()
     == _server_platform_mapping.keys()
@@ -223,11 +230,24 @@ assert (
 )
 
 
-def validate_platform(platform: str) -> str:
-    """Check if the given platform is a valid VS Code platform."""
-    if platform in _all_platforms:
-        return platform
-    raise ArgumentTypeError(f"Unsupported platform: {platform!r}")
+def get_client_platform(platform: str) -> str:
+    """Get the VS Code platform for the given platform."""
+    return _client_platform_mapping.get(platform, platform)
+
+
+def get_server_platform(platform: str) -> str:
+    """Get the VS Code Server platform for the given platform."""
+    return _server_platform_mapping.get(platform, platform)
+
+
+def get_cli_platform(platform: str) -> str:
+    """Get the VS Code CLI platform for the given platform."""
+    return _cli_platform_mapping.get(platform, platform)
+
+
+def get_extension_platform(platform: str) -> str:
+    """Get the VS Code extension target platform for the given platform."""
+    return _extension_platform_mapping.get(platform, platform)
 
 
 def get_host_platform() -> str:

{vscode_offline-0.1.7 → vscode_offline-0.1.9}/tests/test_utils.py

@@ -1,4 +1,12 @@
-from vscode_offline.utils import extract_filename_from_headers
+import tempfile
+from pathlib import Path
+
+import pytest
+
+from vscode_offline.utils import (
+    extract_filename_from_headers,
+    get_vscode_version_from_server_installer,
+)
 
 
 def test_extract_filename_from_headers() -> None:
@@ -46,3 +54,36 @@ def test_get_filename_from_vsix_download_response() -> None:
         extract_filename_from_headers(headers)
         == "yzhang.markdown-all-in-one-3.6.3.vsix"
     )
+
+
+def test_get_vscode_version_from_server_installer_success() -> None:
+    with tempfile.TemporaryDirectory() as tmpdir:
+        base = Path(tmpdir)
+        version_dir = base / "commit-1234567890abcdef"
+        version_dir.mkdir()
+        (version_dir / "vscode-server-linux-x64.tar.gz").touch()
+        result = get_vscode_version_from_server_installer(base, "linux-x64")
+        assert result == "commit:1234567890abcdef"
+
+
+def test_get_vscode_version_from_server_installer_multiple_found() -> None:
+    with tempfile.TemporaryDirectory() as tmpdir:
+        base = Path(tmpdir)
+        v1 = base / "commit-1111111111111111"
+        v2 = base / "commit-2222222222222222"
+        v1.mkdir()
+        v2.mkdir()
+        (v1 / "vscode-server-linux-x64.tar.gz").touch()
+        (v2 / "vscode-server-linux-x64.tar.gz").touch()
+        with pytest.raises(ValueError, match="Multiple matching installers found"):
+            get_vscode_version_from_server_installer(base, "linux-x64")
+
+
+def test_get_vscode_version_from_server_installer_none_found() -> None:
+    with tempfile.TemporaryDirectory() as tmpdir:
+        base = Path(tmpdir)
+        version_dir = base / "commit-1234567890abcdef"
+        version_dir.mkdir()
+        (version_dir / "vscode-server-linux-arm64.tar.gz").touch()
+        with pytest.raises(ValueError, match="No matching installer found"):
+            get_vscode_version_from_server_installer(base, "linux-x64")