pymanager/_msbuild.py at main · python/pymanager · GitHub

Repository navigation

History

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

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

import os

import sys

from pymsbuild import *

from pymsbuild.dllpack import *

DLL_NAME = "python{0.major}{0.minor}".format(sys.version_info)

VER_NUM = "{0.major}.{0.minor}.{0.micro}".format(sys.version_info)

if sys.version_info.releaselevel == "candidate":

VER_NUM_RC = f"rc{sys.version_info.serial}"

else:

VER_NUM_RC = ""

EMBED_URL = f"https://www.python.org/ftp/python/{VER_NUM}/python-{VER_NUM}{VER_NUM_RC}-embed-amd64.zip"

def can_embed(tag):

"""Return False if tag doesn't match DLL_NAME and EMBED_URL.

This is used for validation at build time, we don't currently handle

requesting a different build target."""

return tag == "cp{0.major}{0.minor}-cp{0.major}{0.minor}-win_amd64".format(

sys.version_info

)

METADATA = {

"Metadata-Version": "2.2",

"Name": "manage",

"Version": "0.1a0",

"Author": "Python Software Foundation",

"Author-email": "steve.dower@python.org",

"Project-url": [

"Homepage, https://www.python.org/",

"Sources, https://github.com/python/pymanager",

"Issues, https://github.com/python/pymanager",

"Summary": "The Python Install Manager app",

"Description": File("README.md"),

"Description-Content-Type": "text/markdown",

"Keywords": "python,install,manager",

}

# Define additional file type so we can specify .rc files

class ResourceFile(CSourceFile):

_ITEMNAME = "ResourceCompile"

# Default C++ compiler settings

CPP_SETTINGS = ItemDefinition('ClCompile', LanguageStandard='stdcpp20')

# AdditionalIncludes will be set during init_PACKAGE

INCLUDE_TMPDIR = ItemDefinition("ClCompile")

MANAGE_PYD = DllPackage(

'manage',

VersionInfo(FileDescription="Implementation of PyManager"),

PyFile('*.py'),

source='src/manage',

RootNamespace='manage',

)

NATIVE_PYD = DllPackage(

'_native',

VersionInfo(FileDescription="Native helper functions for PyManager"),

PyFile('__init__.py'),

CPP_SETTINGS,

ItemDefinition("Link",

AdditionalDependencies=Prepend("wintrust.lib;"),

IncludeFile('*.h'),

CSourceFile('*.cpp'),

CFunction('coinitialize'),

CFunction('bits_connect'),

CFunction('bits_begin'),

CFunction('bits_cancel'),

CFunction('bits_get_progress'),

CFunction('bits_retry_with_auth'),

CFunction('bits_find_job'),

CFunction('bits_serialize_job'),

CFunction('winhttp_urlopen'),

CFunction('winhttp_isconnected'),

CFunction('winhttp_urlsplit'),

CFunction('winhttp_urlunsplit'),

CFunction('file_url_to_path'),

CFunction('file_lock_for_delete'),

CFunction('file_unlock_for_delete'),

CFunction('file_locked_delete'),

CFunction('package_get_root'),

CFunction('shortcut_create'),

CFunction('shortcut_default_cwd'),

CFunction('shortcut_get_start_programs'),

CFunction('hide_file'),

CFunction('fd_supports_vt100'),

CFunction('date_as_str'),

CFunction('datetime_as_str'),

CFunction('reg_rename_key'),

CFunction('get_current_package'),

CFunction('read_alias_package'),

CFunction('broadcast_settings_change'),

CFunction('get_processor_architecture'),

CFunction('verify_trust'),

source='src/_native',

RootNamespace='_native',

)

def main_exe(name):

return CProject(name,

VersionInfo(FileDescription="Python Install Manager"),

CPP_SETTINGS,

ItemDefinition('ClCompile', PreprocessorDefinitions=Prepend(f'EXE_NAME=L"{name}";')),

ItemDefinition('Link',

SubSystem='CONSOLE',

DelayLoadDLLs=f'{DLL_NAME}.dll;ole32.dll;shell32.dll;advapi32.dll',

AdditionalOptions=Prepend('/IGNORE:4199 '),

INCLUDE_TMPDIR,

Manifest('default.manifest'),

ResourceFile('pyicon.rc'),

CSourceFile('main.cpp'),

CSourceFile('_launch.cpp'),

IncludeFile('*.h'),

CSourceFile('../_native/helpers.cpp'),

IncludeFile('../_native/helpers.h'),

source='src/pymanager',

ConfigurationType='Application',

)

def mainw_exe(name):

return CProject(name,

VersionInfo(FileDescription="Python Install Manager (windowed)"),

CPP_SETTINGS,

ItemDefinition('Link',

SubSystem='WINDOWS',

DelayLoadDLLs=f'{DLL_NAME}.dll;ole32.dll;shell32.dll;advapi32.dll',

AdditionalOptions=Prepend('/IGNORE:4199 '),

INCLUDE_TMPDIR,

ItemDefinition('ClCompile', PreprocessorDefinitions=Prepend(f'EXE_NAME=L"{name}";')),

ItemDefinition('ClCompile', PreprocessorDefinitions=Prepend("PY_WINDOWED=1;")),

Manifest('default.manifest'),

ResourceFile('pywicon.rc'),

CSourceFile('main.cpp'),

CSourceFile('_launch.cpp'),

IncludeFile('*.h'),

CSourceFile('../_native/helpers.cpp'),

IncludeFile('../_native/helpers.h'),

source='src/pymanager',

ConfigurationType='Application',

)

def launcher_exe(name, platform):

return CProject(name,

VersionInfo(

FileDescription="Python launcher",

OriginalFilename=f"{name}.exe"

CPP_SETTINGS,

Property('StaticLibcppLinkage', 'true'),

ItemDefinition('Link', SubSystem='CONSOLE'),

Manifest('default.manifest'),

ResourceFile('pyicon.rc'),

CSourceFile('launcher.cpp'),

CSourceFile('_launch.cpp'),

IncludeFile('*.h'),

source='src/pymanager',

ConfigurationType='Application',

Platform=platform,

)

def launcherw_exe(name, platform):

return CProject(name,

VersionInfo(

FileDescription="Python launcher (windowed)",

OriginalFilename=f"{name}.exe"

CPP_SETTINGS,

ItemDefinition('ClCompile', PreprocessorDefinitions=Prepend("PY_WINDOWED=1;")),

Property('StaticLibcppLinkage', 'true'),

ItemDefinition('Link', SubSystem='WINDOWS'),

Manifest('default.manifest'),

ResourceFile('pywicon.rc'),

CSourceFile('launcher.cpp'),

CSourceFile('_launch.cpp'),

IncludeFile('*.h'),

source='src/pymanager',

ConfigurationType='Application',

Platform=platform,

)

def pyshellext(ext='.exe', **props):

link_opts = ItemDefinition(

'Link',

AdditionalDependencies=Prepend('RuntimeObject.lib;pathcch.lib;'),

)

if ext != '.exe':

link_opts.options['ModuleDefinitionFile'] = '$(SourceRootDir)src\\pyshellext\\pyshellext.def'

return CProject(f"pyshellext{ext.rpartition('.')[0]}",

VersionInfo(

FileDescription='Python shell extension',

OriginalFilename=f'pyshellext{ext}',

ItemDefinition('ClCompile', LanguageStandard='stdcpp20'),

link_opts,

Manifest('default.manifest'),

CSourceFile('shellext.cpp'),

ResourceFile('pyshellext.rc'),

source='src/pyshellext',

StaticLibcppLinkage=True,

**props,

)

PACKAGE = Package('python-manager',

PyprojectTomlFile('pyproject.toml'),

# MSIX manifest

File('src/pymanager/appxmanifest.xml'),

File('src/pymanager/pymanager.appinstaller'),

Package(

'MSIX.AppInstaller.Data',

File('src/pymanager/MSIXAppInstallerData.xml'),

# Default settings

File('src/pymanager.json'),

# Default index feed, mainly for testing right now

Package(

'bundled',

File('src/index*.json', allow_none=True),

# Directory for template files

Package(

'templates',

File('src/pymanager/templates/template.py'),

launcher_exe("launcher-64", "x64"),

launcherw_exe("launcherw-64", "x64"),

launcher_exe("launcher-arm64", "ARM64"),

launcherw_exe("launcherw-arm64", "ARM64"),

launcher_exe("launcher-32", "Win32"),

launcherw_exe("launcherw-32", "Win32"),

# Directory for MSIX resources

Package(

'_resources',

File('src/pymanager/_resources/*.png'),

File('src/pymanager/_resources/*.ico'),

# Directory for bundled runtime and our modules

Package(

'runtime',

MANAGE_PYD,

NATIVE_PYD,

# Other files added during init_PACKAGE

# Main entry-point executables

main_exe("py-manager"),

mainw_exe("pyw-manager"),

main_exe("py"),

mainw_exe("pyw"),

main_exe("pymanager"),

mainw_exe("pywmanager"),

main_exe("python"),

mainw_exe("pythonw"),

main_exe("python3"),

mainw_exe("pythonw3"),

pyshellext(".exe", ConfigurationType="Application"),

pyshellext("-64.dll", Platform="x64"),

pyshellext("-arm64.dll", Platform="ARM64"),

)

def get_commands():

import ast

command_bases = {"BaseCommand"}

commands = []

with open("src/manage/commands.py", "r", encoding="utf-8") as f:

mod = ast.parse(f.read())

for cls in filter(lambda c: isinstance(c, ast.ClassDef), mod.body):

# Check if a subclass of BaseCommand

if not any(b.id in command_bases for b in cls.bases):

continue

# Ignore exec command - it gets handled separately.

if cls.name == "ExecCommand":

continue

command_bases.add(cls.name)

for a in filter(lambda s: isinstance(s, ast.Assign), cls.body):

if not any(t.id == "CMD" for t in a.targets):

continue

try:

commands.append(a.value.value)

except AttributeError:

commands.append(a.value.s)

break

return [c for c in commands if c[:1] != "_"]

def _make_xyzw_version(v, sep="."):

"""Calculate a suitable x.y.z.w version from our user-friendly version.

For MSIX in the Microsoft Store, the fourth field must be 0.

For MSI, the first field must be <256.

If the explicit version contains a non-zero field 3, it will override the

one that is calculated from prerelease markers.

"""

from packaging.version import parse

v = parse(v)

micro = 0xF0

if v.pre:

micro = {"a": 0xA0, "b": 0xB0, "rc": 0xC0}.get(v.pre[0].lower(), 0) | v.pre[1]

if v.micro:

print("[WARNING]Overriding calculated version field 3 with", v)

micro = v.micro

return sep.join(map(str, (v.major, v.minor, micro, 0)))

def _is_prerelease(v):

from packaging.version import parse

v = parse(v)

return bool(v.pre)

def _patch_appx_identity(source, dest, **new):

from xml.etree import ElementTree as ET

NS = {}

with open(source, "r", encoding="utf-8") as f:

NS = dict(e for _, e in ET.iterparse(f, events=("start-ns",)))

for k, v in NS.items():

ET.register_namespace(k, v)

with open(source, "r", encoding="utf-8") as f:

xml = ET.parse(f)

identity = xml.find(f"x:Identity", {"x": NS[""]})

for k, v in new.items():

if v:

identity.set(k, v)

with open(dest, "wb") as f:

xml.write(f, "utf-8")

def _patch_appinstaller(source, dest, **new):

with open(source, "r", encoding="utf-8") as f:

txt = f.read()

for k, v in new.items():

if v:

txt = txt.replace(f"${{{k}}}", v)

update_file(dest, txt)

def update_file(file, content):

if not file.is_file() or file.read_text("utf-8").strip() != content.strip():

file.parent.mkdir(parents=True, exist_ok=True)

with file.open("w", encoding="utf-8") as f:

print(content, file=f)

def init_METADATA():

import os, re

_, sep, version = os.getenv("BUILD_SOURCEBRANCH", os.getenv("GITHUB_REF", "")).rpartition("/")

if "." in version:

from packaging.version import parse

try:

# Looks like a version tag

METADATA["Version"] = parse(version).public

except Exception:

pass

PACKAGE.find("pyproject.toml").from_metadata(METADATA)

fileversion = _make_xyzw_version(METADATA["Version"], ",")

for vi in PACKAGE.findall("**/VersionInfo"):

vi.from_metadata(METADATA)

vi.options["FILEVERSION"] = fileversion

def init_PACKAGE(tag=None):

if not tag:

return

tmpdir = get_current_build_state().temp_dir

INCLUDE_TMPDIR.options["AdditionalIncludeDirectories"] = Prepend(f"{tmpdir};")

pre = _is_prerelease(METADATA["Version"])

# GENERATE _version MODULE

ver_py = tmpdir / "_version.py"

update_file(ver_py, f"__version__ = {METADATA['Version']!r}")

MANAGE_PYD.members.append(PyFile(ver_py))

# GENERATE version.txt

ver_txt = tmpdir / "version.txt"

update_file(ver_txt, str(METADATA['Version']))

PACKAGE.members.append(PyFile(ver_txt))

# PATCH appxmanifest.xml AND pymanager.appinstaller

appx_version = _make_xyzw_version(METADATA["Version"])

appx_publisher = os.getenv("PYMANAGER_APPX_PUBLISHER", "CN=00000000-0000-0000-0000-000000000000")

appx_url = os.getenv("PYMANAGER_PUBLISH_URL", "https://example.com").rstrip("/")

appx_filename = f"python-manager-{METADATA['Version']}.msix"

appx_xml = tmpdir / "appxmanifest.xml"

_patch_appx_identity(PACKAGE.find("appxmanifest.xml").source, appx_xml,

Version=appx_version,

Publisher=os.getenv("PYMANAGER_APPX_PUBLISHER"),

)

PACKAGE.find("appxmanifest.xml").source = appx_xml

appinstaller = tmpdir / "pymanager.appinstaller"

_patch_appinstaller(PACKAGE.find("pymanager.appinstaller").source, appinstaller,

# Prerelease builds use a separate online appinstaller file

# Release builds upload to both files, to move beta users onto final

AppInstallerName="pymanager-preview" if pre else "pymanager",

Version=appx_version,

Publisher=appx_publisher,

Url=appx_url,

Filename=appx_filename,

)

PACKAGE.find("pymanager.appinstaller").source = appinstaller

# GENERATE SUBCOMMAND LIST

cmds = get_commands()

cmds_h = tmpdir / "commands.g.h"

cmds_txt = ("static const wchar_t *subcommands[] = {"

+ ", ".join(f'L"{c}"' for c in cmds)

+ ", NULL};")

update_file(cmds_h, cmds_txt)

# BUNDLE EMBEDDABLE DISTRO

if not can_embed(tag):

print("[WARNING] Unable to bundle embeddable distro for this runtime.")

return

embed_files = [tmpdir / tag / n for n in [

f"{DLL_NAME}.dll",

f"{DLL_NAME}.zip",

f"{DLL_NAME}._pth",

]]

runtime_files = [tmpdir / tag / n for n in [

"vcruntime140.dll",

"vcruntime140_1.dll",

]]

if any(not f.is_file() for f in embed_files):

from urllib.request import urlretrieve

from zipfile import ZipFile

package = tmpdir / tag / "package.zip"

package.parent.mkdir(exist_ok=True, parents=True)

print("Downloading", EMBED_URL)

urlretrieve(EMBED_URL, package)

with ZipFile(package) as zf:

for f in [*embed_files, *runtime_files]:

f.write_bytes(zf.read(f.name))

PACKAGE.find("runtime").members.extend(File(f) for f in embed_files)

PACKAGE.members.extend(File(f) for f in runtime_files)

pymanager/_msbuild.py at main · python/pymanager · GitHub

Repository navigation

Expand file tree

Breadcrumbs

_msbuild.py

Latest commit

History

Breadcrumbs

_msbuild.py

File metadata and controls