/
hatch_build.py
140 lines (110 loc) 路 5.08 KB
/
hatch_build.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
import os
import pathlib
import platform
import re
import shutil
import sys
import sysconfig
from typing import Any, Dict, List
from hatchling.builders.hooks.plugin.interface import BuildHookInterface
# A small hack to allow importing build scripts from the source tree.
sys.path = [str(pathlib.Path(__file__).parent)] + sys.path
from apple_stats import hatch as hatch_apple_stats # noqa: I001 E402
from core import hatch as hatch_core # noqa: I001 E402
_WANDB_BUILD_UNIVERSAL = "WANDB_BUILD_UNIVERSAL"
_WANDB_BUILD_COVERAGE = "WANDB_BUILD_COVERAGE"
_WANDB_BUILD_SKIP_APPLE = "WANDB_BUILD_SKIP_APPLE"
_WANDB_RELEASE_COMMIT = "WANDB_RELEASE_COMMIT"
class CustomBuildHook(BuildHookInterface):
def initialize(self, version: str, build_data: Dict[str, Any]) -> None:
if self.target_name == "wheel":
self._prepare_wheel(build_data)
def _prepare_wheel(self, build_data: Dict[str, Any]) -> None:
artifacts: list[str] = build_data["artifacts"]
if self._include_wandb_core():
artifacts.extend(self._build_wandb_core())
if self._include_apple_stats():
artifacts.extend(self._build_apple_stats())
if self._is_platform_wheel():
build_data["tag"] = f"py3-none-{self._get_platform_tag()}"
def _get_platform_tag(self) -> str:
"""Returns the platform tag for the current platform."""
# Replace dots, spaces and dashes with underscores following
# https://packaging.python.org/en/latest/specifications/platform-compatibility-tags/#platform-tag
platform_tag = re.sub("[-. ]", "_", sysconfig.get_platform())
# On macOS versions >=11, pip expects the minor version to be 0:
# https://github.com/pypa/packaging/issues/435
#
# You can see the list of tags that pip would support on your machine
# using `pip debug --verbose`. On my macOS, get_platform() returns
# 14.1, but `pip debug --verbose` reports only these py3 tags with 14:
#
# * py3-none-macosx_14_0_arm64
# * py3-none-macosx_14_0_universal2
#
# We do this remapping here because otherwise, it's possible for `pip wheel`
# to successfully produce a wheel that you then cannot `pip install` on the
# same machine.
macos_match = re.fullmatch(r"macosx_(\d+_\d+)_(\w+)", platform_tag)
if macos_match:
major, _ = macos_match.group(1).split("_")
if int(major) >= 11:
arch = macos_match.group(2)
platform_tag = f"macosx_{major}_0_{arch}"
return platform_tag
def _must_build_universal(self) -> bool:
"""Returns whether we must build a universal wheel."""
return _get_env_bool(_WANDB_BUILD_UNIVERSAL, default=False)
def _include_wandb_core(self) -> bool:
"""Returns whether we should produce a wheel with wandb-core."""
return not self._must_build_universal()
def _include_apple_stats(self) -> bool:
"""Returns whether we should produce a wheel with apple_gpu_stats."""
return (
not self._must_build_universal()
and not _get_env_bool(_WANDB_BUILD_SKIP_APPLE, default=False)
and platform.system().lower() == "darwin"
)
def _is_platform_wheel(self) -> bool:
"""Returns whether we're producing a platform-specific wheel."""
return self._include_wandb_core() or self._include_apple_stats()
def _build_apple_stats(self) -> List[str]:
output = pathlib.Path("wandb", "bin", "apple_gpu_stats")
self.app.display_waiting("Building apple_gpu_stats...")
hatch_apple_stats.build_applestats(output_path=output)
return [output.as_posix()]
def _build_wandb_core(self) -> List[str]:
output = pathlib.Path("wandb", "bin", "wandb-core")
with_coverage = _get_env_bool(_WANDB_BUILD_COVERAGE, default=False)
self.app.display_waiting("Building wandb-core Go binary...")
hatch_core.build_wandb_core(
go_binary=self._get_and_require_go_binary(),
output_path=output,
with_code_coverage=with_coverage,
wandb_commit_sha=os.getenv(_WANDB_RELEASE_COMMIT),
)
# NOTE: as_posix() is used intentionally. Hatch expects forward slashes
# even on Windows.
return [output.as_posix()]
def _get_and_require_go_binary(self) -> pathlib.Path:
go = shutil.which("go")
if not go:
self.app.abort(
"Did not find the 'go' binary. You need Go to build wandb"
" from source. See https://go.dev/doc/install.",
)
return pathlib.Path(go)
def _get_env_bool(name: str, default: bool) -> bool:
"""Returns the value of a boolean environment variable."""
value = os.getenv(name)
if value is None:
return default
elif value.lower() in ("1", "true"):
return True
elif value.lower() in ("0", "false"):
return False
else:
raise ValueError(
f"Environment variable '{name}' has invalid value '{value}'"
" expected one of {1,true,0,false}."
)