vscode-offline 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

vscode_offline/app.py

@@ -6,6 +6,7 @@ from argparse import ArgumentParser, Namespace
 from pathlib import Path
 
 from vscode_offline.download import (
+    download_vscode_client,
     download_vscode_extensions,
     download_vscode_server,
 )
@@ -59,7 +60,7 @@ def cmd_install_server(args: Namespace) -> None:
 
     install_vscode_server(
         args.commit,
-        cli_installer=args.installer / f"server-{args.commit}",
+        server_installer=args.installer / f"server-{args.commit}",
         vscode_cli_bin=get_vscode_cli_bin(args.commit),
         platform=host_platform,
     )
@@ -88,6 +89,26 @@ def cmd_install_extensions(args: Namespace) -> None:
     )
 
 
+def cmd_download_client(args: Namespace) -> None:
+    if args.commit is None:
+        args.commit = get_vscode_commit_from_code_version()
+        if args.commit is None:
+            logger.info(
+                "Cannot determine commit from `code --version`, please specify --commit manually."
+            )
+            raise ValueError("Please specify --commit when installing.")
+
+    download_vscode_client(
+        args.commit,
+        output=args.installer / f"client-{args.commit}",
+        target_platform=args.target_platform,
+    )
+    extensions_config = Path(args.extensions_config).expanduser()
+    download_vscode_extensions(
+        extensions_config, args.target_platform, args.installer / "extensions"
+    )
+
+
 def make_argparser() -> ArgumentParser:
     parent_parser = ArgumentParser(add_help=False)
 
@@ -169,6 +190,30 @@ def make_argparser() -> ArgumentParser:
         help="Path to the `code` binary.",
     )
 
+    download_client_parser = subparsers.add_parser(
+        "download-client",
+        help="Download VS Code and extensions",
+        parents=[parent_parser],
+    )
+    download_client_parser.set_defaults(func=cmd_download_client)
+    download_client_parser.add_argument(
+        "--commit",
+        type=str,
+        help="The commit hash of the VS Code to download, must match the version of the VSCode client.",
+    )
+    download_client_parser.add_argument(
+        "--target-platform",
+        type=str,
+        required=True,
+        help="The target platform of the VS Code to download.",
+    )
+    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.",
+    )
+
     return parser
 
 

vscode_offline/download.py

@@ -3,16 +3,20 @@ from __future__ import annotations
 import json
 import os
 from gzip import GzipFile
+from io import DEFAULT_BUFFER_SIZE
+from pathlib import Path
 from urllib.error import HTTPError
 from urllib.request import urlopen
 
 from vscode_offline.loggers import logger
-from vscode_offline.utils import get_cli_os_arch
+from vscode_offline.utils import get_cli_platform, get_filename_from_headers
 
-_CHUCK_SIZE = 4 * 1024 * 1024  # 4MiB
 
-
-def _download_file(url: str, filename: str) -> None:
+def _download_file(
+    url: str,
+    directory: str | os.PathLike[str],
+    filename: str | None = None,
+) -> os.PathLike[str]:
     with urlopen(url) as resp:
         content_encoding = resp.headers.get("Content-Encoding")
         if content_encoding in {"gzip", "deflate"}:
@@ -23,39 +27,56 @@ def _download_file(url: str, filename: str) -> None:
         else:
             raise ValueError(f"Unsupported Content-Encoding: {content_encoding}")
 
-        with reader, open(filename, "wb") as fp:
+        if filename:
+            file_path = Path(directory).joinpath(filename)
+        else:
+            filename = get_filename_from_headers(resp.headers)
+            if not filename:
+                raise ValueError(
+                    "Cannot get filename from HTTP headers, please specify argument `filename`."
+                )
+            logger.info(f"Get filename `{filename}` from HTTP headers.")
+            file_path = Path(directory).joinpath(filename)
+            if file_path.exists():
+                logger.info(f"File {file_path} already exists, skipping download.")
+                return file_path
+
+        tmp_file_path = Path(directory).joinpath(f"{filename}.tmp")
+        with reader, tmp_file_path.open("wb") as fp:
             while True:
-                chunk = reader.read(_CHUCK_SIZE)
+                chunk = reader.read(DEFAULT_BUFFER_SIZE)
                 if not chunk:
                     break
                 fp.write(chunk)
 
+        if os.path.exists(file_path):
+            os.remove(file_path)
+        os.rename(tmp_file_path, file_path)
+
+        logger.info(f"Saved to {file_path} .")
+        return file_path
+
 
 def download_file(
     url: str,
-    filename: str,
+    directory: str | os.PathLike[str],
+    filename: str | None = None,
 ) -> None:
-    if os.path.exists(filename):
-        logger.info(f"File {filename} already exists, skipping download.")
-        return
-
-    logger.info(f"Downloading {url}")
-    tmp_filename = f"{filename}.tmp"
+    if filename:
+        file_path = Path(directory).joinpath(filename)
+        if file_path.exists():
+            logger.info(f"File {file_path} already exists, skipping download.")
+            return
 
+    logger.info(f"Downloading {url} ...")
     for i in range(3):
         try:
-            _download_file(url, tmp_filename)
+            _download_file(url, directory, filename)
             break
         except Exception as e:
             if isinstance(e, HTTPError) and e.code == 404:
                 raise
-            logger.info(f"Attempt {i + 1} failed: {e}")
-
-    if os.path.exists(filename):
-        os.remove(filename)
-    os.rename(tmp_filename, filename)
-
-    logger.info(f"Saved to {filename}")
+            logger.info(f"Attempt {i + 1} times failed: {e}")
 
 
 def download_extension(
@@ -68,11 +89,8 @@ def download_extension(
     url = f"https://marketplace.visualstudio.com/_apis/public/gallery/publishers/{publisher}/vsextensions/{name}/{version}/vspackage"
     if platform:
         url = f"{url}?targetPlatform={platform}"
-    filename = f"{publisher}.{name}-{version}"
-    if platform:
-        filename = f"{filename}@{platform}"
-    filename = f"{filename}.vsix"
-    download_file(url, f"{output}/{filename}")
+    filename = f"{publisher}.{name}-{version}{f'@{platform}' if platform else ''}.vsix"
+    download_file(url, output, filename)
 
 
 def download_vscode_extensions(
@@ -109,11 +127,27 @@ def download_vscode_server(
     os.makedirs(output, exist_ok=True)
     download_file(
         f"https://update.code.visualstudio.com/commit:{commit}/server-{target_platform}/stable",
-        f"{output}/vscode-server-{target_platform}.tar.gz",
+        output,
+        f"vscode-server-{target_platform}.tar.gz",
     )
-    target_os_arch = get_cli_os_arch(target_platform)
-    target_os_arch_ = target_os_arch.replace("-", "_")
+    cli_target_platform = get_cli_platform(target_platform)
+    cli_target_platform_ = cli_target_platform.replace("-", "_")
+    download_file(
+        f"https://update.code.visualstudio.com/commit:{commit}/cli-{cli_target_platform}/stable",
+        output,
+        f"vscode_cli_{cli_target_platform_}_cli.tar.gz",
+    )
+
+
+def download_vscode_client(
+    commit: str,
+    output: str,
+    target_platform: str,
+) -> None:
+    """Download VS Code for the given commit and target platform."""
+    os.makedirs(output, exist_ok=True)
     download_file(
-        f"https://update.code.visualstudio.com/commit:{commit}/cli-{target_os_arch}/stable",
-        f"{output}/vscode_cli_{target_os_arch_}_cli.tar.gz",
+        f"https://update.code.visualstudio.com/commit:{commit}/{target_platform}/stable",
+        output,
+        # filename is like "VSCodeSetup-x64-1.104.3.exe" for windows
     )

vscode_offline/install.py

@@ -7,7 +7,7 @@ from pathlib import Path
 from tempfile import TemporaryDirectory
 
 from vscode_offline.loggers import logger
-from vscode_offline.utils import get_cli_os_arch, get_vscode_server_home
+from vscode_offline.utils import get_cli_platform, get_vscode_server_home
 
 # These extensions are excluded because they are not needed in a VS Code Server.
 SERVER_EXCLUDE_EXTENSIONS = frozenset(
@@ -66,14 +66,16 @@ def install_vscode_extensions(
 
 def install_vscode_server(
     commit: str,
-    cli_installer: str,
+    server_installer: str,
     vscode_cli_bin: os.PathLike[str],
     platform: str,
 ) -> None:
-    cli_os = get_cli_os_arch(platform)
-    cli_os_ = cli_os.replace("-", "_")
+    cli_platform = get_cli_platform(platform)
+    cli_platform_ = cli_platform.replace("-", "_")
 
-    vscode_cli_tarball = Path(cli_installer) / f"vscode_cli_{cli_os_}_cli.tar.gz"
+    vscode_cli_tarball = (
+        Path(server_installer) / f"vscode_cli_{cli_platform_}_cli.tar.gz"
+    )
     with TemporaryDirectory() as tmpdir:
         subprocess.check_call(["tar", "-xzf", vscode_cli_tarball, "-C", tmpdir])
         tmpfile = Path(tmpdir) / "code"
@@ -81,9 +83,9 @@ def install_vscode_server(
             os.remove(vscode_cli_bin)
         os.makedirs(os.path.dirname(vscode_cli_bin), exist_ok=True)
         os.rename(tmpfile, vscode_cli_bin)
-    logger.info(f"Extracted vscode_cli_{cli_os_}_cli.tar.gz to {vscode_cli_bin}")
+    logger.info(f"Extracted vscode_cli_{cli_platform_}_cli.tar.gz to {vscode_cli_bin}")
 
-    vscode_server_tarball = Path(cli_installer) / f"vscode-server-{platform}.tar.gz"
+    vscode_server_tarball = Path(server_installer) / f"vscode-server-{platform}.tar.gz"
     vscode_server_home = get_vscode_server_home(commit)
     os.makedirs(vscode_server_home, exist_ok=True)
     subprocess.check_call(

vscode_offline/utils.py

@@ -4,6 +4,8 @@ import os
 import shutil
 import subprocess
 import sys
+from collections.abc import Mapping
+from email.parser import HeaderParser
 from pathlib import Path
 
 from vscode_offline.loggers import logger
@@ -72,32 +74,27 @@ def get_vscode_commit_from_code_version() -> str | None:
     commit = lines[1].strip().decode("utf-8")
     logger.info(f"Getting commit from `code --version`: {commit}")
 
-    return lines[1].strip().decode("utf-8")
-
-
-def get_target_platform_from_installer(cli_installer: str) -> str | None:
-    directories = list(Path(cli_installer).glob("vscode-server-*.tar.gz"))
-    if len(directories) == 1:
-        return directories[0].name[len("vscode-server-") : -len(".tar.gz")]
-    return None
+    return commit
 
 
 # Mapping from target platform to CLI OS and architecture used in download URLs
-_cli_os_arch_mapping = {
+_cli_platform_mapping = {
     "linux-x64": "alpine-x64",
     "linux-arm64": "alpine-arm64",
+    "linux-armhf": "linux-arm64",
+    "win32-x64": "win32-x64",
 }
 
 
-def get_cli_os_arch(platform: str) -> str:
+def get_cli_platform(platform: str) -> str:
     """Get the CLI OS and architecture for the given target platform."""
-    if platform not in _cli_os_arch_mapping:
+    if platform not in _cli_platform_mapping:
         raise ValueError(f"Unsupported target platform: {platform}")
-    return _cli_os_arch_mapping[platform]
+    return _cli_platform_mapping[platform]
 
 
 def get_host_platform() -> str:
-    """Get the host platform in the format used by VS Code Server install."""
+    """Get the host platform in the format used by VS Code install."""
     if os.name == "nt":
         if "amd64" in sys.version.lower():
             return "win32-x64"
@@ -111,3 +108,21 @@ def get_host_platform() -> str:
         elif machine in ("aarch64", "arm64"):
             return "linux-arm64"
     raise ValueError(f"Unsupported host platform: {osname}-{machine}")
+
+
+def get_filename_from_headers(headers: Mapping[str, str]) -> str | None:
+    """Get the filename from HTTP headers.
+
+    Args:
+        headers: The HTTP headers.
+    """
+    content_disposition = headers.get("Content-Disposition")
+    header_str = ""
+    if content_type := headers.get("Content-Type"):
+        header_str += f"Content-Type: {content_type}\n"
+    if content_disposition := headers.get("Content-Disposition"):
+        header_str += f"Content-Disposition: {content_disposition}\n"
+    if not header_str:
+        return None
+    header = HeaderParser().parsestr(header_str)
+    return header.get_filename()

{vscode_offline-0.1.3.dist-info → vscode_offline-0.1.4.dist-info}/METADATA

@@ -1,25 +1,24 @@
 Metadata-Version: 2.4
 Name: vscode-offline
-Version: 0.1.3
+Version: 0.1.4
 Summary: Download and install VS Code Server for offline environments
-Author: Chuck Fan
+Project-URL: Homepage, https://github.com/fanck0605/vscode-offline
 Author-email: Chuck Fan <fanck0605@qq.com>
 License-Expression: MIT
 License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Operating System :: Microsoft :: Windows
 Classifier: Topic :: Utilities
 Requires-Python: >=3.9
-Project-URL: Homepage, https://github.com/fanck0605/vscode-offline
 Description-Content-Type: text/markdown
 
 # vscode-offline

vscode_offline-0.1.4.dist-info/RECORD

@@ -0,0 +1,11 @@
+vscode_offline/__init__.py,sha256=dr6Jtj0XT9eQEC4fzNigEYsAIEfCsaom3HDbUsS-2O4,57
+vscode_offline/app.py,sha256=uO7netdS6U-CxN77zcXwzH301dBDlwvds1GUVVMYGok,7290
+vscode_offline/download.py,sha256=-6vFRoY5QKEQgIqSbx3XgzoZJz6TzLpSS8mCUygiogE,5136
+vscode_offline/install.py,sha256=pIibDCbCmbidXeGUYIS6H1aAE6d1bWwZyIFJecmAASw,3545
+vscode_offline/loggers.py,sha256=vX91NMtNo1xfxq5y4BCtm_uhCTKtCODqBJHNvcT7JdQ,104
+vscode_offline/utils.py,sha256=Pp5W7yeT883sVkoAn5snZ2Obdqdu7wqa0vGGhLYGYmc,4000
+vscode_offline-0.1.4.dist-info/METADATA,sha256=oD4uE9hkprb961ZjY6WZj0s-QMfVaOUyvbIzRA0tvp4,2474
+vscode_offline-0.1.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+vscode_offline-0.1.4.dist-info/entry_points.txt,sha256=XyuZLe7bgm2RmZp9oh9qCxcrAwHypD8XrTnm4G0_CzM,55
+vscode_offline-0.1.4.dist-info/licenses/LICENSE,sha256=pUIXFkLeTS986b7dopOVLyuw72fJsUxhl8H3rEMIycA,1053
+vscode_offline-0.1.4.dist-info/RECORD,,

vscode_offline-0.1.4.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

{vscode_offline-0.1.3.dist-info → vscode_offline-0.1.4.dist-info}/entry_points.txt

@@ -1,3 +1,2 @@
 [console_scripts]
 vscode-offline = vscode_offline:main
-

vscode_offline-0.1.3.dist-info/RECORD

@@ -1,11 +0,0 @@
-vscode_offline/__init__.py,sha256=dr6Jtj0XT9eQEC4fzNigEYsAIEfCsaom3HDbUsS-2O4,57
-vscode_offline/app.py,sha256=MLYg_2q3pudTL0zBAWTRSjVM_8zDccLIZt0s00xvT7Q,5686
-vscode_offline/download.py,sha256=hImUW23npX0hgNMcJ2E3nRLbW8fvzeIFEovg0mWzm9U,3763
-vscode_offline/install.py,sha256=UNgLnMAAZEOtX4s8v6QlmuIHPf3aeuXrCWfC6_TEM-0,3488
-vscode_offline/loggers.py,sha256=vX91NMtNo1xfxq5y4BCtm_uhCTKtCODqBJHNvcT7JdQ,104
-vscode_offline/utils.py,sha256=XknMz1aBMyyTvWG-szE_0eMG3KOdpl9aAeX3E5BrDAI,3542
-vscode_offline-0.1.3.dist-info/licenses/LICENSE,sha256=pUIXFkLeTS986b7dopOVLyuw72fJsUxhl8H3rEMIycA,1053
-vscode_offline-0.1.3.dist-info/WHEEL,sha256=-neZj6nU9KAMg2CnCY6T3w8J53nx1kFGw_9HfoSzM60,79
-vscode_offline-0.1.3.dist-info/entry_points.txt,sha256=zIMeh_ENKKzlt9lDao8icofSI0TeCQxH8eCwxIRI2G8,56
-vscode_offline-0.1.3.dist-info/METADATA,sha256=hjeP62mRkggLHpIypE8RgSNXUceC9PYGYBWCrhvabak,2492
-vscode_offline-0.1.3.dist-info/RECORD,,

vscode_offline-0.1.3.dist-info/WHEEL

@@ -1,4 +0,0 @@
-Wheel-Version: 1.0
-Generator: uv 0.8.22
-Root-Is-Purelib: true
-Tag: py3-none-any