Initial MSI implementation, based on Briefcase #1084
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| """ | ||
| Logic to build installers using Briefcase. | ||
| """ | ||
|
|
||
| import logging | ||
| import re | ||
| import shutil | ||
| import sysconfig | ||
| import tempfile | ||
| from pathlib import Path | ||
| from subprocess import run | ||
|
|
||
| import tomli_w | ||
|
|
||
| from . import preconda | ||
| from .utils import DEFAULT_REVERSE_DOMAIN_ID, copy_conda_exe, filename_dist | ||
|
|
||
| BRIEFCASE_DIR = Path(__file__).parent / "briefcase" | ||
| EXTERNAL_PACKAGE_PATH = "external" | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| def get_name_version(info): | ||
| name = info["name"] | ||
| if not name: | ||
| raise ValueError("Name is empty") | ||
|
|
||
| # Briefcase requires version numbers to be in the canonical Python format, and some | ||
|
Contributor
There was a problem hiding this comment. Python is not fully compatible with SemVer, so that could be a pretty significant limitation. It will at least require a few version changes in our integration test examples:
Author
There was a problem hiding this comment. As far as MSI is concerned, the version number is only used for 2 purposes:
Notice the current code only uses the last valid Python package version number it finds. This is to accommodate the Miniconda construct.yaml file, which sets
Author
There was a problem hiding this comment. For versions with no numbers in them at all, we could either reject them as the PR currently does, or display a warning and fall back to a default like 0.0.1 or 1.0.0. That's probably a good idea, since it would allow all existing construct.yaml files to at least build, and the integration tests wouldn't need to change so much.
Author
There was a problem hiding this comment. I've made it use a default of 0.0.1, so that if a valid version is added in the future, it'll be treated as an upgrade. |
||
| # installer types use the version to distinguish between upgrades, downgrades and | ||
| # reinstalls. So try to produce a consistent ordering by extracting the last valid | ||
| # version from the Constructor version string. | ||
| # | ||
| # Hyphens aren't allowed in this format, but for compatibility with Miniconda's | ||
| # version format, we treat them as dots. | ||
| matches = list( | ||
| re.finditer( | ||
| r"(\d+!)?\d+(\.\d+)*((a|b|rc)\d+)?(\.post\d+)?(\.dev\d+)?", | ||
| info["version"].lower().replace("-", "."), | ||
| ) | ||
| ) | ||
| if not matches: | ||
| raise ValueError( | ||
| f"Version {info['version']!r} contains no valid version numbers: see " | ||
| f"https://packaging.python.org/en/latest/specifications/version-specifiers/" | ||
| ) | ||
| match = matches[-1] | ||
| version = match.group() | ||
|
|
||
| # Treat anything else in the version string as part of the name. | ||
| start, end = match.span() | ||
| strip_chars = " .-_" | ||
| before = info["version"][:start].strip(strip_chars) | ||
| after = info["version"][end:].strip(strip_chars) | ||
| name = " ".join(s for s in [name, before, after] if s) | ||
|
Contributor
There was a problem hiding this comment. So, for something like
Author
There was a problem hiding this comment. Yes, those would be the name and version from Briefcase's point of view, and that's how they'd be displayed in the Windows apps list. The current code can generate these values from a construct.yaml file where |
||
|
|
||
| return name, version | ||
|
|
||
|
|
||
| # Some installer types use the reverse domain ID to detect when the product is already | ||
| # installed, so it should be both unique between different products, and stable between | ||
| # different versions of a product. | ||
| def get_bundle_app_name(info, name): | ||
| # If reverse_domain_identifier is provided, use it as-is, but verify that the last | ||
| # component is a valid Python package name, as Briefcase requires. | ||
|
||
| if (rdi := info.get("reverse_domain_identifier")) is not None: | ||
| if "." not in rdi: | ||
| raise ValueError(f"reverse_domain_identifier {rdi!r} contains no dots") | ||
| bundle, app_name = rdi.rsplit(".", 1) | ||
|
|
||
| if not re.fullmatch( | ||
| r"[A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9]", app_name, flags=re.IGNORECASE | ||
| ): | ||
| raise ValueError( | ||
| f"reverse_domain_identifier {rdi!r} doesn't end with a valid package " | ||
| f"name: see " | ||
| f"https://packaging.python.org/en/latest/specifications/name-normalization/" | ||
| ) | ||
|
|
||
| # If reverse_domain_identifier isn't provided, generate it from the name. | ||
| else: | ||
| bundle = DEFAULT_REVERSE_DOMAIN_ID | ||
| app_name = re.sub(r"[^a-z0-9]+", "-", name.lower()).strip("-") | ||
| if not app_name: | ||
| raise ValueError(f"Name {name!r} contains no alphanumeric characters") | ||
|
|
||
| return bundle, app_name | ||
|
|
||
|
|
||
| # Create a Briefcase configuration file. Using a full TOML writer rather than a Jinja | ||
| # template allows us to avoid escaping strings everywhere. | ||
| def write_pyproject_toml(tmp_dir, info): | ||
| name, version = get_name_version(info) | ||
| bundle, app_name = get_bundle_app_name(info, name) | ||
|
|
||
| config = { | ||
| "project_name": name, | ||
| "bundle": bundle, | ||
| "version": version, | ||
| "license": ({"file": info["license_file"]} if "license_file" in info else {"text": ""}), | ||
| "app": { | ||
| app_name: { | ||
| "formal_name": f"{info['name']} {info['version']}", | ||
| "description": "", # Required, but not used in the installer. | ||
| "external_package_path": EXTERNAL_PACKAGE_PATH, | ||
| "use_full_install_path": False, | ||
| "install_launcher": False, | ||
| "post_install_script": str(BRIEFCASE_DIR / "run_installation.bat"), | ||
| } | ||
| }, | ||
| } | ||
|
|
||
| if "company" in info: | ||
| config["author"] = info["company"] | ||
|
|
||
| (tmp_dir / "pyproject.toml").write_text(tomli_w.dumps({"tool": {"briefcase": config}})) | ||
|
|
||
|
|
||
| def create(info, verbose=False): | ||
| tmp_dir = Path(tempfile.mkdtemp()) | ||
| write_pyproject_toml(tmp_dir, info) | ||
|
|
||
| external_dir = tmp_dir / EXTERNAL_PACKAGE_PATH | ||
| external_dir.mkdir() | ||
| preconda.write_files(info, external_dir) | ||
| preconda.copy_extra_files(info.get("extra_files", []), external_dir) | ||
|
|
||
| download_dir = Path(info["_download_dir"]) | ||
| pkgs_dir = external_dir / "pkgs" | ||
| for dist in info["_dists"]: | ||
| shutil.copy(download_dir / filename_dist(dist), pkgs_dir) | ||
|
|
||
| copy_conda_exe(external_dir, "_conda.exe", info["_conda_exe"]) | ||
|
|
||
| briefcase = Path(sysconfig.get_path("scripts")) / "briefcase.exe" | ||
| logger.info("Building installer") | ||
| run( | ||
| [briefcase, "package"] + (["-v"] if verbose else []), | ||
| cwd=tmp_dir, | ||
| check=True, | ||
| ) | ||
|
Comment on lines
148
to
159
Contributor
There was a problem hiding this comment. I have two questions here:
Either way, we should make sure that
Contributor
There was a problem hiding this comment. I added 2) in mhsmith#1, the check for
Author
There was a problem hiding this comment.
Author
There was a problem hiding this comment. I've copied the |
||
|
|
||
| dist_dir = tmp_dir / "dist" | ||
| msi_paths = list(dist_dir.glob("*.msi")) | ||
| if len(msi_paths) != 1: | ||
| raise RuntimeError(f"Found {len(msi_paths)} MSI files in {dist_dir}") | ||
|
|
||
| outpath = Path(info["_outpath"]) | ||
| outpath.unlink(missing_ok=True) | ||
| shutil.move(msi_paths[0], outpath) | ||
|
|
||
| if not info.get("_debug"): | ||
| shutil.rmtree(tmp_dir) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| _conda constructor --prefix . --extract-conda-pkgs | ||
|
||
|
|
||
| set CONDA_PROTECT_FROZEN_ENVS=0 | ||
| set CONDA_ROOT_PREFIX=%cd% | ||
| set CONDA_SAFETY_CHECKS=disabled | ||
| set CONDA_EXTRA_SAFETY_CHECKS=no | ||
| set CONDA_PKGS_DIRS=%cd%\pkgs | ||
|
|
||
| _conda install --offline --file conda-meta\initial-state.explicit.txt -yp . | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,3 +10,4 @@ dependencies: | |
| - jinja2 | ||
| - jsonschema >=4 | ||
| - pydantic 2.11.* | ||
| - tomli-w >=1.2.0 | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,7 +16,8 @@ dependencies = [ | |
| "ruamel.yaml >=0.11.14,<0.19", | ||
| "pillow >=3.1 ; platform_system=='Windows' or platform_system=='Darwin'", | ||
| "jinja2", | ||
| "jsonschema >=4", | ||
| "tomli-w >=1.2.0", | ||
|
||
| ] | ||
|
|
||
| [project.optional-dependencies] | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we are concerned about empty values, we should use
get, too.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I fixed it in mhsmith#1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've copied that fix to this PR.