2
0

makewheel.py 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938
  1. """
  2. Generates a wheel (.whl) file from the output of makepanda.
  3. """
  4. import json
  5. import sys
  6. import os
  7. from os.path import join
  8. import zipfile
  9. import hashlib
  10. import tempfile
  11. import subprocess
  12. import time
  13. import struct
  14. from optparse import OptionParser
  15. from base64 import urlsafe_b64encode
  16. from makepandacore import LocateBinary, GetExtensionSuffix, SetVerbose, GetVerbose, GetMetadataValue, CrossCompiling, GetThirdpartyDir, SDK, GetStrip
  17. from locations import get_config_var
  18. from sysconfig import get_platform
  19. def get_abi_tag():
  20. ver = 'cp%d%d' % sys.version_info[:2]
  21. if hasattr(sys, 'abiflags'):
  22. return ver + sys.abiflags
  23. gil_disabled = get_config_var("Py_GIL_DISABLED")
  24. if gil_disabled and int(gil_disabled):
  25. return ver + 't'
  26. return ver
  27. def is_exe_file(path):
  28. return os.path.isfile(path) and path.lower().endswith('.exe')
  29. def is_elf_file(path):
  30. base = os.path.basename(path)
  31. return os.path.isfile(path) and '.' not in base and \
  32. open(path, 'rb').read(4) == b'\x7FELF'
  33. def is_macho_or_fat_file(path):
  34. base = os.path.basename(path)
  35. return os.path.isfile(path) and '.' not in base and \
  36. open(path, 'rb').read(4) in (b'\xFE\xED\xFA\xCE', b'\xCE\xFA\xED\xFE',
  37. b'\xFE\xED\xFA\xCF', b'\xCF\xFA\xED\xFE',
  38. b'\xCA\xFE\xBA\xBE', b'\xBE\xBA\xFE\xCA',
  39. b'\xCA\xFE\xBA\xBF', b'\xBF\xBA\xFE\xCA')
  40. def is_fat_file(path):
  41. return os.path.isfile(path) and \
  42. open(path, 'rb').read(4) in (b'\xCA\xFE\xBA\xBE', b'\xBE\xBA\xFE\xCA',
  43. b'\xCA\xFE\xBA\xBF', b'\xBF\xBA\xFE\xCA')
  44. def get_python_ext_module_dir():
  45. if CrossCompiling():
  46. return os.path.join(GetThirdpartyDir(), "python", "lib", SDK["PYTHONVERSION"], "lib-dynload")
  47. else:
  48. import _ctypes
  49. return os.path.dirname(_ctypes.__file__)
  50. if sys.platform in ('win32', 'cygwin'):
  51. is_executable = is_exe_file
  52. elif sys.platform == 'darwin':
  53. is_executable = is_macho_or_fat_file
  54. else:
  55. is_executable = is_elf_file
  56. # Other global parameters
  57. PY_VERSION = "cp{0}{1}".format(*sys.version_info)
  58. ABI_TAG = get_abi_tag()
  59. EXCLUDE_EXT = [".pyc", ".pyo", ".N", ".prebuilt", ".xcf", ".plist", ".vcproj", ".sln"]
  60. # Plug-ins to install.
  61. PLUGIN_LIBS = ["pandagl", "pandagles", "pandagles2", "pandadx9", "p3tinydisplay", "p3ptloader", "p3assimp", "p3ffmpeg", "p3openal_audio", "p3fmod_audio", "p3headlessgl"]
  62. # Libraries included in manylinux ABI that should be ignored. See PEP 513/571/599.
  63. MANYLINUX_LIBS = [
  64. "libgcc_s.so.1", "libstdc++.so.6", "libm.so.6", "libdl.so.2", "librt.so.1",
  65. "libcrypt.so.1", "libc.so.6", "libnsl.so.1", "libutil.so.1",
  66. "libpthread.so.0", "libresolv.so.2", "libX11.so.6", "libXext.so.6",
  67. "libXrender.so.1", "libICE.so.6", "libSM.so.6", "libGL.so.1",
  68. "libgobject-2.0.so.0", "libgthread-2.0.so.0", "libglib-2.0.so.0",
  69. # These are not mentioned in manylinux1 spec but should nonetheless always
  70. # be excluded.
  71. "linux-vdso.so.1", "linux-gate.so.1", "ld-linux.so.2", "libdrm.so.2",
  72. "libEGL.so.1", "libOpenGL.so.0", "libGLX.so.0", "libGLdispatch.so.0",
  73. ]
  74. # Binaries to never scan for dependencies on non-Windows systems.
  75. IGNORE_UNIX_DEPS_OF = [
  76. "panda3d_tools/pstats",
  77. ]
  78. # Tools to exclude from the wheel.
  79. EXCLUDE_BINARIES = [
  80. 'eggcacher',
  81. 'packpanda',
  82. 'interrogate',
  83. 'interrogate_module',
  84. 'test_interrogate',
  85. 'parse_file',
  86. 'run_tests',
  87. ]
  88. WHEEL_DATA = """Wheel-Version: 1.0
  89. Generator: makepanda
  90. Root-Is-Purelib: false
  91. Tag: {0}-{1}-{2}
  92. """
  93. PROJECT_URLS = dict([line.split('=', 1) for line in GetMetadataValue('project_urls').strip().splitlines()])
  94. METADATA = {
  95. "license": GetMetadataValue('license'),
  96. "name": GetMetadataValue('name'),
  97. "metadata_version": "2.1",
  98. "generator": "makepanda",
  99. "summary": GetMetadataValue('description'),
  100. "extensions": {
  101. "python.details": {
  102. "project_urls": dict(PROJECT_URLS, Home=GetMetadataValue('url')),
  103. "document_names": {
  104. "license": "LICENSE.txt"
  105. },
  106. "contacts": [
  107. {
  108. "role": "author",
  109. "name": GetMetadataValue('author'),
  110. "email": GetMetadataValue('author_email'),
  111. }
  112. ]
  113. }
  114. },
  115. "classifiers": GetMetadataValue('classifiers'),
  116. }
  117. DESCRIPTION = """
  118. The Panda3D free 3D game engine
  119. ===============================
  120. Panda3D is a powerful 3D engine written in C++, with a complete set of Python
  121. bindings. Unlike other engines, these bindings are automatically generated,
  122. meaning that they are always up-to-date and complete: all functions of the
  123. engine can be controlled from Python. All major Panda3D applications have been
  124. written in Python, this is the intended way of using the engine.
  125. Panda3D now supports automatic shader generation, which now means you can use
  126. normal maps, gloss maps, glow maps, HDR, cartoon shading, and the like without
  127. having to write any shaders.
  128. Panda3D is a modern engine supporting advanced features such as shaders,
  129. stencil, and render-to-texture. Panda3D is unusual in that it emphasizes a
  130. short learning curve, rapid development, and extreme stability and robustness.
  131. Panda3D is free software that runs under Windows, Linux, or macOS.
  132. The Panda3D team is very concerned with making the engine accessible to new
  133. users. We provide a detailed manual, a complete API reference, and a large
  134. collection of sample programs to help you get started. We have active forums,
  135. with many helpful users, and the developers are regularly online to answer
  136. questions.
  137. """
  138. PANDA3D_TOOLS_INIT = """import os, sys
  139. import panda3d
  140. dir = os.path.dirname(panda3d.__file__)
  141. del panda3d
  142. if sys.platform in ('win32', 'cygwin'):
  143. path_var = 'PATH'
  144. if hasattr(os, 'add_dll_directory'):
  145. os.add_dll_directory(dir)
  146. elif sys.platform == 'darwin':
  147. path_var = 'DYLD_LIBRARY_PATH'
  148. else:
  149. path_var = 'LD_LIBRARY_PATH'
  150. if not os.environ.get(path_var):
  151. os.environ[path_var] = dir
  152. else:
  153. os.environ[path_var] = dir + os.pathsep + os.environ[path_var]
  154. del os, sys, path_var, dir
  155. def _exec_tool(tool):
  156. import os, sys
  157. from subprocess import Popen
  158. tools_dir = os.path.dirname(__file__)
  159. handle = Popen(sys.argv, executable=os.path.join(tools_dir, tool))
  160. try:
  161. try:
  162. return handle.wait()
  163. except KeyboardInterrupt:
  164. # Give the program a chance to handle the signal gracefully.
  165. return handle.wait()
  166. except:
  167. handle.kill()
  168. handle.wait()
  169. raise
  170. # Register all the executables in this directory as global functions.
  171. {0}
  172. """
  173. def parse_dependencies_windows(data):
  174. """ Parses the given output from dumpbin /dependents to determine the list
  175. of dll's this executable file depends on. """
  176. lines = data.splitlines()
  177. li = 0
  178. while li < len(lines):
  179. line = lines[li]
  180. li += 1
  181. if line.find(' has the following dependencies') != -1:
  182. break
  183. if li < len(lines):
  184. line = lines[li]
  185. if line.strip() == '':
  186. # Skip a blank line.
  187. li += 1
  188. # Now we're finding filenames, until the next blank line.
  189. filenames = []
  190. while li < len(lines):
  191. line = lines[li]
  192. li += 1
  193. line = line.strip()
  194. if line == '':
  195. # We're done.
  196. return filenames
  197. filenames.append(line)
  198. # At least we got some data.
  199. return filenames
  200. def parse_dependencies_unix(data):
  201. """ Parses the given output from otool -XL or ldd to determine the list of
  202. libraries this executable file depends on. """
  203. lines = data.splitlines()
  204. filenames = []
  205. for l in lines:
  206. l = l.strip()
  207. if l != "statically linked":
  208. filenames.append(l.split(' ', 1)[0])
  209. return filenames
  210. def _scan_dependencies_elf(elf):
  211. deps = []
  212. ident = elf.read(12)
  213. # Make sure we read in the correct endianness and integer size
  214. byte_order = "<>"[ord(ident[1:2]) - 1]
  215. elf_class = ord(ident[0:1]) - 1 # 0 = 32-bits, 1 = 64-bits
  216. header_struct = byte_order + ("HHIIIIIHHHHHH", "HHIQQQIHHHHHH")[elf_class]
  217. section_struct = byte_order + ("4xI8xIII8xI", "4xI16xQQI12xQ")[elf_class]
  218. dynamic_struct = byte_order + ("iI", "qQ")[elf_class]
  219. type, machine, version, entry, phoff, shoff, flags, ehsize, phentsize, phnum, shentsize, shnum, shstrndx \
  220. = struct.unpack(header_struct, elf.read(struct.calcsize(header_struct)))
  221. dynamic_sections = []
  222. string_tables = {}
  223. # Seek to the section header table and find the .dynamic section.
  224. elf.seek(shoff)
  225. for i in range(shnum):
  226. type, offset, size, link, entsize = struct.unpack_from(section_struct, elf.read(shentsize))
  227. if type == 6 and link != 0: # DYNAMIC type, links to string table
  228. dynamic_sections.append((offset, size, link, entsize))
  229. string_tables[link] = None
  230. # Read the relevant string tables.
  231. for idx in string_tables.keys():
  232. elf.seek(shoff + idx * shentsize)
  233. type, offset, size, link, entsize = struct.unpack_from(section_struct, elf.read(shentsize))
  234. if type != 3: continue
  235. elf.seek(offset)
  236. string_tables[idx] = elf.read(size)
  237. # Loop through the dynamic sections to get the NEEDED entries.
  238. needed = []
  239. for offset, size, link, entsize in dynamic_sections:
  240. elf.seek(offset)
  241. data = elf.read(entsize)
  242. tag, val = struct.unpack_from(dynamic_struct, data)
  243. # Read tags until we find a NULL tag.
  244. while tag != 0:
  245. if tag == 1: # A NEEDED entry. Read it from the string table.
  246. string = string_tables[link][val : string_tables[link].find(b'\0', val)]
  247. needed.append(string.decode('utf-8'))
  248. data = elf.read(entsize)
  249. tag, val = struct.unpack_from(dynamic_struct, data)
  250. elf.close()
  251. return needed
  252. def scan_dependencies(pathname):
  253. """ Checks the named file for DLL dependencies, and adds any appropriate
  254. dependencies found into pluginDependencies and dependentFiles. """
  255. with open(pathname, 'rb') as fh:
  256. if fh.read(4) == b'\x7FELF':
  257. return _scan_dependencies_elf(fh)
  258. if sys.platform == "darwin":
  259. command = ['otool', '-XL', pathname]
  260. elif sys.platform in ("win32", "cygwin"):
  261. command = ['dumpbin', '/dependents', pathname]
  262. else:
  263. sys.exit("Don't know how to determine dependencies from %s" % (pathname))
  264. process = subprocess.Popen(command, stdout=subprocess.PIPE, universal_newlines=True)
  265. output, unused_err = process.communicate()
  266. retcode = process.poll()
  267. if retcode:
  268. raise subprocess.CalledProcessError(retcode, command[0], output=output)
  269. filenames = None
  270. if sys.platform in ("win32", "cygwin"):
  271. filenames = parse_dependencies_windows(output)
  272. else:
  273. filenames = parse_dependencies_unix(output)
  274. if filenames is None:
  275. sys.exit("Unable to determine dependencies from %s" % (pathname))
  276. if sys.platform == "darwin" and len(filenames) > 0:
  277. # Filter out the library ID.
  278. if os.path.basename(filenames[0]).split('.', 1)[0] == os.path.basename(pathname).split('.', 1)[0]:
  279. del filenames[0]
  280. return filenames
  281. class WheelFile(object):
  282. def __init__(self, name, version, platform):
  283. self.name = name
  284. self.version = version
  285. self.platform = platform
  286. wheel_name = "{0}-{1}-{2}-{3}-{4}.whl".format(
  287. name, version, PY_VERSION, ABI_TAG, platform)
  288. print("Writing %s" % (wheel_name))
  289. self.zip_file = zipfile.ZipFile(wheel_name, 'w', zipfile.ZIP_DEFLATED)
  290. self.records = []
  291. # Used to locate dependency libraries.
  292. self.lib_path = []
  293. self.dep_paths = {}
  294. self.ignore_deps = set()
  295. # This can be set if a reproducible (deterministic) build is desired, in
  296. # which case we have to clamp all dates to the given SOURCE_DATE_EPOCH.
  297. epoch = os.environ.get('SOURCE_DATE_EPOCH')
  298. self.max_date_time = time.localtime(int(epoch) if epoch else time.time())[:6]
  299. if self.max_date_time < (1980, 1, 1, 0, 0, 0):
  300. # Earliest representable time in zip archives.
  301. self.max_date_time = (1980, 1, 1, 0, 0, 0)
  302. def consider_add_dependency(self, target_path, dep, search_path=None):
  303. """Considers adding a dependency library.
  304. Returns the target_path if it was added, which may be different from
  305. target_path if it was already added earlier, or None if it wasn't."""
  306. if dep in self.dep_paths:
  307. # Already considered this.
  308. return self.dep_paths[dep]
  309. self.dep_paths[dep] = None
  310. if dep in self.ignore_deps:
  311. if GetVerbose():
  312. print("Ignoring {0} (explicitly ignored)".format(dep))
  313. return
  314. if not self.platform.startswith("android"):
  315. if dep.lower().startswith("python") or os.path.basename(dep).startswith("libpython"):
  316. if GetVerbose():
  317. print("Ignoring {0} (explicitly ignored)".format(dep))
  318. return
  319. if self.platform.startswith("macosx"):
  320. if dep.endswith(".so"):
  321. # Temporary hack for 1.9, which had link deps on modules.
  322. return
  323. if dep.startswith("/System/"):
  324. return
  325. if dep.startswith('/'):
  326. source_path = dep
  327. else:
  328. source_path = None
  329. if search_path is None:
  330. search_path = self.lib_path
  331. for lib_dir in search_path:
  332. # Ignore static stuff.
  333. path = os.path.join(lib_dir, dep)
  334. if os.path.isfile(path):
  335. source_path = os.path.normpath(path)
  336. break
  337. if not source_path:
  338. # Couldn't find library in the panda3d lib dir.
  339. if GetVerbose():
  340. print("Ignoring {0} (not in search path)".format(dep))
  341. return
  342. self.dep_paths[dep] = target_path
  343. self.write_file(target_path, source_path)
  344. return target_path
  345. def write_file(self, target_path, source_path):
  346. """Adds the given file to the .whl file."""
  347. orig_source_path = source_path
  348. # If this is a .so file, we should set the rpath appropriately.
  349. temp = None
  350. basename, ext = os.path.splitext(source_path)
  351. if ext in ('.so', '.dylib') or '.so.' in os.path.basename(source_path) or \
  352. (not ext and is_executable(source_path)):
  353. # Scan Unix dependencies.
  354. if target_path not in IGNORE_UNIX_DEPS_OF:
  355. deps = scan_dependencies(source_path)
  356. else:
  357. deps = []
  358. suffix = ''
  359. if '.so' in os.path.basename(source_path):
  360. suffix = '.so'
  361. elif ext == '.dylib':
  362. suffix = '.dylib'
  363. temp = tempfile.NamedTemporaryFile(suffix=suffix, prefix='whl', delete=False)
  364. # On macOS, if no fat wheel was requested, extract the right architecture.
  365. if self.platform.startswith("macosx") and is_fat_file(source_path) \
  366. and not self.platform.endswith("_intel") \
  367. and "_fat" not in self.platform \
  368. and "_universal" not in self.platform:
  369. if self.platform.endswith("_x86_64"):
  370. arch = 'x86_64'
  371. else:
  372. arch = self.platform.split('_')[-1]
  373. subprocess.call(['lipo', source_path, '-extract', arch, '-output', temp.name])
  374. else:
  375. # Otherwise, just copy it over.
  376. temp.write(open(source_path, 'rb').read())
  377. temp.close()
  378. os.chmod(temp.name, os.stat(temp.name).st_mode | 0o711)
  379. # Now add dependencies. On macOS, fix @loader_path references.
  380. if self.platform.startswith("macosx"):
  381. if source_path.endswith('deploy-stubw'):
  382. deps_path = '@executable_path/../Frameworks'
  383. else:
  384. deps_path = '@loader_path'
  385. loader_path = [os.path.dirname(source_path)]
  386. for dep in deps:
  387. if dep.endswith('/Python'):
  388. # If this references the Python framework, change it
  389. # to reference libpython instead.
  390. new_dep = deps_path + '/libpython{0}.{1}.dylib'.format(*sys.version_info)
  391. elif '@loader_path' in dep:
  392. dep_path = dep.replace('@loader_path', '.')
  393. target_dep = os.path.dirname(target_path) + '/' + os.path.basename(dep)
  394. target_dep = self.consider_add_dependency(target_dep, dep_path, loader_path)
  395. if not target_dep:
  396. # It won't be included, so no use adjusting the path.
  397. continue
  398. new_dep = os.path.join(deps_path, os.path.relpath(target_dep, os.path.dirname(target_path)))
  399. elif '@rpath' in dep:
  400. # Unlike makepanda, CMake uses @rpath instead of
  401. # @loader_path. This means we can just search for the
  402. # dependencies like normal.
  403. dep_path = dep.replace('@rpath', '.')
  404. target_dep = os.path.dirname(target_path) + '/' + os.path.basename(dep)
  405. self.consider_add_dependency(target_dep, dep_path)
  406. continue
  407. elif dep.startswith('/Library/Frameworks/Python.framework/') or \
  408. dep.startswith('/Library/Frameworks/PythonT.framework/'):
  409. # Add this dependency if it's in the Python directory.
  410. target_dep = os.path.dirname(target_path) + '/' + os.path.basename(dep)
  411. target_dep = self.consider_add_dependency(target_dep, dep, loader_path)
  412. if not target_dep:
  413. # It won't be included, so no use adjusting the path.
  414. continue
  415. new_dep = os.path.join(deps_path, os.path.relpath(target_dep, os.path.dirname(target_path)))
  416. else:
  417. if '/' in dep:
  418. if GetVerbose():
  419. print("Ignoring dependency %s" % (dep))
  420. continue
  421. subprocess.call(["install_name_tool", "-change", dep, new_dep, temp.name])
  422. # Make sure it has an ad-hoc code signature.
  423. subprocess.call(["codesign", "-f", "-s", "-", temp.name])
  424. else:
  425. # On other unixes, we just add dependencies normally.
  426. for dep in deps:
  427. # Only include dependencies with relative path, for now.
  428. if '/' in dep:
  429. continue
  430. if self.platform.startswith('android') and '.so.' in dep:
  431. # Change .so.1.2 suffix to .so, to allow loading in .apk
  432. new_dep = dep.rpartition('.so.')[0] + '.so'
  433. subprocess.call(["patchelf", "--replace-needed", dep, new_dep, temp.name])
  434. target_dep = os.path.dirname(target_path) + '/' + new_dep
  435. else:
  436. target_dep = os.path.dirname(target_path) + '/' + dep
  437. self.consider_add_dependency(target_dep, dep)
  438. subprocess.call([GetStrip(), "-s", temp.name])
  439. if self.platform.startswith('android'):
  440. # We must link explicitly with Python, because the usual
  441. # -rdynamic trick doesn't work from a shared library loaded
  442. # through ANativeActivity.
  443. if suffix == '.so' and not os.path.basename(source_path).startswith('lib'):
  444. pylib_name = "libpython" + get_config_var('LDVERSION') + ".so"
  445. subprocess.call(["patchelf", "--add-needed", pylib_name, temp.name])
  446. else:
  447. # On other systems, we use the rpath to force it to locate
  448. # dependencies in the same directory.
  449. subprocess.call(["patchelf", "--force-rpath", "--set-rpath", "$ORIGIN", temp.name])
  450. source_path = temp.name
  451. ext = ext.lower()
  452. if ext in ('.dll', '.pyd', '.exe'):
  453. # Scan and add Win32 dependencies.
  454. for dep in scan_dependencies(source_path):
  455. target_dep = os.path.dirname(target_path) + '/' + dep
  456. self.consider_add_dependency(target_dep, dep)
  457. if GetVerbose():
  458. print("Adding {0} from {1}".format(target_path, orig_source_path))
  459. zinfo = zipfile.ZipInfo.from_file(source_path, target_path)
  460. zinfo.compress_type = self.zip_file.compression
  461. if zinfo.date_time > self.max_date_time:
  462. zinfo.date_time = self.max_date_time
  463. # Copy the data to the zip file, while also calculating the SHA-256.
  464. size = 0
  465. sha = hashlib.sha256()
  466. with open(source_path, 'rb') as source_fp, self.zip_file.open(zinfo, 'w') as target_fp:
  467. data = source_fp.read(1024 * 1024)
  468. while data:
  469. size += len(data)
  470. target_fp.write(data)
  471. sha.update(data)
  472. data = source_fp.read(1024 * 1024)
  473. # Save it in PEP-0376 format for writing out later.
  474. digest = urlsafe_b64encode(sha.digest()).decode('ascii')
  475. digest = digest.rstrip('=')
  476. self.records.append("{0},sha256={1},{2}\n".format(target_path, digest, size))
  477. #if temp:
  478. # os.unlink(temp.name)
  479. def write_file_data(self, target_path, source_data):
  480. """Adds the given file from a string."""
  481. sha = hashlib.sha256()
  482. sha.update(source_data.encode())
  483. digest = urlsafe_b64encode(sha.digest()).decode('ascii')
  484. digest = digest.rstrip('=')
  485. self.records.append("{0},sha256={1},{2}\n".format(target_path, digest, len(source_data)))
  486. if GetVerbose():
  487. print("Adding %s from data" % target_path)
  488. zinfo = zipfile.ZipInfo(filename=target_path,
  489. date_time=self.max_date_time)
  490. zinfo.compress_type = self.zip_file.compression
  491. zinfo.external_attr = 0o600 << 16
  492. self.zip_file.writestr(zinfo, source_data)
  493. def write_directory(self, target_dir, source_dir):
  494. """Adds the given directory recursively to the .whl file."""
  495. for root, dirs, files in os.walk(source_dir):
  496. dirs.sort()
  497. for file in sorted(files):
  498. if os.path.splitext(file)[1] in EXCLUDE_EXT:
  499. continue
  500. source_path = os.path.join(root, file)
  501. target_path = os.path.join(target_dir, os.path.relpath(source_path, source_dir))
  502. target_path = target_path.replace('\\', '/')
  503. self.write_file(target_path, source_path)
  504. def close(self):
  505. # Write the RECORD file.
  506. record_file = "{0}-{1}.dist-info/RECORD".format(self.name, self.version)
  507. self.records.append(record_file + ",,\n")
  508. zinfo = zipfile.ZipInfo(filename=record_file,
  509. date_time=self.max_date_time)
  510. zinfo.compress_type = self.zip_file.compression
  511. zinfo.external_attr = 0o600 << 16
  512. self.zip_file.writestr(zinfo, "".join(self.records))
  513. self.zip_file.close()
  514. def makewheel(version, output_dir, platform=None):
  515. if sys.platform not in ("win32", "darwin") and not sys.platform.startswith("cygwin"):
  516. if not LocateBinary("patchelf"):
  517. raise Exception("patchelf is required when building a Linux wheel.")
  518. if sys.version_info < (3, 8):
  519. raise Exception("Python 3.8 or higher is required to produce a wheel.")
  520. if platform is None:
  521. # Determine the platform from the build.
  522. platform_dat = os.path.join(output_dir, 'tmp', 'platform.dat')
  523. cmake_cache = os.path.join(output_dir, 'CMakeCache.txt')
  524. if os.path.isfile(platform_dat):
  525. # This is written by makepanda.
  526. platform = open(platform_dat, 'r').read().strip()
  527. elif os.path.isfile(cmake_cache):
  528. # This variable is written to the CMake cache by Package.cmake.
  529. for line in open(cmake_cache, 'r').readlines():
  530. if line.startswith('PYTHON_PLATFORM_TAG:STRING='):
  531. platform = line[27:].strip()
  532. break
  533. if not platform:
  534. raise Exception("Could not find PYTHON_PLATFORM_TAG in CMakeCache.txt, specify --platform manually.")
  535. else:
  536. print("Could not find platform.dat or CMakeCache.txt in build directory")
  537. platform = get_platform()
  538. if platform.startswith("linux-") and os.path.isdir("/opt/python"):
  539. # Is this manylinux?
  540. if os.path.isfile("/lib/libc-2.5.so") or os.path.isfile("/lib64/libc-2.5.so"):
  541. platform = platform.replace("linux", "manylinux1")
  542. elif os.path.isfile("/lib/libc-2.12.so") or os.path.isfile("/lib64/libc-2.12.so"):
  543. platform = platform.replace("linux", "manylinux2010")
  544. elif os.path.isfile("/lib/libc-2.17.so") or os.path.isfile("/lib64/libc-2.17.so"):
  545. platform = platform.replace("linux", "manylinux2014")
  546. elif os.path.isfile("/lib/i386-linux-gnu/libc-2.24.so") or os.path.isfile("/lib/x86_64-linux-gnu/libc-2.24.so"):
  547. platform = platform.replace("linux", "manylinux_2_24")
  548. elif os.path.isfile("/lib64/libc-2.28.so") and os.path.isfile('/etc/almalinux-release'):
  549. platform = platform.replace("linux", "manylinux_2_28")
  550. platform = platform.replace('-', '_').replace('.', '_')
  551. is_windows = platform == 'win32' \
  552. or platform.startswith('win_') \
  553. or platform.startswith('cygwin_')
  554. is_macosx = platform.startswith('macosx_')
  555. # Global filepaths
  556. panda3d_dir = join(output_dir, "panda3d")
  557. pandac_dir = join(output_dir, "pandac")
  558. direct_dir = join(output_dir, "direct")
  559. models_dir = join(output_dir, "models")
  560. etc_dir = join(output_dir, "etc")
  561. bin_dir = join(output_dir, "bin")
  562. if is_windows:
  563. libs_dir = join(output_dir, "bin")
  564. else:
  565. libs_dir = join(output_dir, "lib")
  566. ext_mod_dir = get_python_ext_module_dir()
  567. license_src = "LICENSE"
  568. readme_src = "README.md"
  569. # Update relevant METADATA entries
  570. METADATA['version'] = version
  571. # Build out the metadata
  572. details = METADATA["extensions"]["python.details"]
  573. homepage = details["project_urls"]["Home"]
  574. author = details["contacts"][0]["name"]
  575. email = details["contacts"][0]["email"]
  576. metadata = ''.join([
  577. "Metadata-Version: {metadata_version}\n" \
  578. "Name: {name}\n" \
  579. "Version: {version}\n" \
  580. "Summary: {summary}\n" \
  581. "License: {license}\n".format(**METADATA),
  582. "Home-page: {0}\n".format(homepage),
  583. ] + ["Project-URL: {0}, {1}\n".format(*url) for url in PROJECT_URLS.items()] + [
  584. "Author: {0}\n".format(author),
  585. "Author-email: {0}\n".format(email),
  586. "Platform: {0}\n".format(platform),
  587. ] + ["Classifier: {0}\n".format(c) for c in METADATA['classifiers']])
  588. metadata += '\n' + DESCRIPTION.strip() + '\n'
  589. # Zip it up and name it the right thing
  590. whl = WheelFile('panda3d', version, platform)
  591. whl.lib_path = [libs_dir]
  592. if is_windows:
  593. whl.lib_path.append(ext_mod_dir)
  594. if platform.startswith("manylinux"):
  595. # On manylinux1, we pick up all libraries except for the ones specified
  596. # by the manylinux1 ABI.
  597. whl.lib_path.append("/usr/local/lib")
  598. if platform.endswith("_x86_64"):
  599. whl.lib_path += ["/lib64", "/usr/lib64"]
  600. else:
  601. whl.lib_path += ["/lib", "/usr/lib"]
  602. whl.ignore_deps.update(MANYLINUX_LIBS)
  603. # Add libpython for deployment.
  604. suffix = ''
  605. gil_disabled = get_config_var("Py_GIL_DISABLED")
  606. if gil_disabled and int(gil_disabled):
  607. suffix = 't'
  608. if is_windows:
  609. pylib_name = 'python{0}{1}{2}.dll'.format(sys.version_info[0], sys.version_info[1], suffix)
  610. pylib_path = os.path.join(get_config_var('BINDIR'), pylib_name)
  611. elif is_macosx:
  612. pylib_name = 'libpython{0}.{1}{2}.dylib'.format(sys.version_info[0], sys.version_info[1], suffix)
  613. pylib_path = os.path.join(get_config_var('LIBDIR'), pylib_name)
  614. else:
  615. pylib_name = get_config_var('LDLIBRARY')
  616. pylib_arch = get_config_var('MULTIARCH')
  617. libdir = get_config_var('LIBDIR')
  618. if pylib_arch and os.path.exists(os.path.join(libdir, pylib_arch, pylib_name)):
  619. pylib_path = os.path.join(libdir, pylib_arch, pylib_name)
  620. else:
  621. pylib_path = os.path.join(libdir, pylib_name)
  622. # If Python was linked statically, we don't need to include this.
  623. if not pylib_name.endswith('.a'):
  624. whl.write_file('deploy_libs/' + pylib_name, pylib_path)
  625. # Add the trees with Python modules.
  626. whl.write_directory('direct', direct_dir)
  627. # Write the panda3d tree. We use a custom empty __init__ since the
  628. # default one adds the bin directory to the PATH, which we don't have.
  629. p3d_init = """"Python bindings for the Panda3D libraries"
  630. __version__ = '{0}'
  631. """.format(version)
  632. if '27' in ABI_TAG:
  633. p3d_init += """
  634. if __debug__:
  635. if 1 / 2 == 0:
  636. raise ImportError(\"Python 2 is not supported.\")
  637. """
  638. whl.write_file_data('panda3d/__init__.py', p3d_init)
  639. # Copy the extension modules from the panda3d directory.
  640. ext_suffix = GetExtensionSuffix()
  641. for file in sorted(os.listdir(panda3d_dir)):
  642. if file == '__init__.py':
  643. pass
  644. elif file.endswith('.py') or (file.endswith(ext_suffix) and '.' not in file[:-len(ext_suffix)]):
  645. source_path = os.path.join(panda3d_dir, file)
  646. if file.endswith('.pyd') and platform.startswith('cygwin'):
  647. # Rename it to .dll for cygwin Python to be able to load it.
  648. target_path = 'panda3d/' + os.path.splitext(file)[0] + '.dll'
  649. elif file.endswith(ext_suffix) and platform.startswith('android'):
  650. # Strip the extension suffix on Android.
  651. target_path = 'panda3d/' + file[:-len(ext_suffix)] + '.so'
  652. else:
  653. target_path = 'panda3d/' + file
  654. whl.write_file(target_path, source_path)
  655. # And copy the extension modules from the Python installation into the
  656. # deploy_libs directory, for use by deploy-ng.
  657. ext_suffix = '.pyd' if is_windows else '.so'
  658. for file in sorted(os.listdir(ext_mod_dir)):
  659. if file.endswith(ext_suffix):
  660. if file.startswith('_tkinter.'):
  661. # Tkinter is supplied in a separate wheel.
  662. continue
  663. source_path = os.path.join(ext_mod_dir, file)
  664. if file.endswith('.pyd') and platform.startswith('cygwin'):
  665. # Rename it to .dll for cygwin Python to be able to load it.
  666. target_path = 'deploy_libs/' + os.path.splitext(file)[0] + '.dll'
  667. else:
  668. target_path = 'deploy_libs/' + file
  669. whl.write_file(target_path, source_path)
  670. # Include the special sysconfigdata module.
  671. if os.name == 'posix':
  672. import sysconfig
  673. if hasattr(sysconfig, '_get_sysconfigdata_name'):
  674. modname = sysconfig._get_sysconfigdata_name() + '.py'
  675. else:
  676. modname = '_sysconfigdata.py'
  677. for entry in sys.path:
  678. source_path = os.path.join(entry, modname)
  679. if os.path.isfile(source_path):
  680. whl.write_file('deploy_libs/' + modname, source_path)
  681. break
  682. # Add plug-ins.
  683. for lib in PLUGIN_LIBS:
  684. plugin_name = 'lib' + lib
  685. if is_windows:
  686. plugin_name += '.dll'
  687. elif is_macosx:
  688. plugin_name += '.dylib'
  689. else:
  690. plugin_name += '.so'
  691. plugin_path = os.path.join(libs_dir, plugin_name)
  692. if os.path.isfile(plugin_path):
  693. whl.write_file('panda3d/' + plugin_name, plugin_path)
  694. if platform.startswith('android'):
  695. deploy_stub_path = os.path.join(libs_dir, 'libdeploy-stubw.so')
  696. if os.path.isfile(deploy_stub_path):
  697. whl.write_file('deploy_libs/libdeploy-stubw.so', deploy_stub_path)
  698. classes_dex_path = os.path.join(output_dir, 'classes.dex')
  699. if os.path.isfile(classes_dex_path):
  700. whl.write_file('deploy_libs/classes.dex', classes_dex_path)
  701. # Add the .data directory, containing additional files.
  702. data_dir = 'panda3d-{0}.data'.format(version)
  703. #whl.write_directory(data_dir + '/data/etc', etc_dir)
  704. #whl.write_directory(data_dir + '/data/models', models_dir)
  705. # Actually, let's not. That seems to install the files to the strangest
  706. # places in the user's filesystem. Let's instead put them in panda3d.
  707. whl.write_directory('panda3d/etc', etc_dir)
  708. whl.write_directory('panda3d/models', models_dir)
  709. # Add the pandac tree for backward compatibility.
  710. for file in sorted(os.listdir(pandac_dir)):
  711. if file.endswith('.py'):
  712. whl.write_file('pandac/' + file, os.path.join(pandac_dir, file))
  713. # Let's also add the interrogate databases.
  714. input_dir = os.path.join(pandac_dir, 'input')
  715. if os.path.isdir(input_dir):
  716. for file in sorted(os.listdir(input_dir)):
  717. if file.endswith('.in'):
  718. whl.write_file('pandac/input/' + file, os.path.join(input_dir, file))
  719. # Add a panda3d-tools directory containing the executables.
  720. entry_points = '[console_scripts]\n'
  721. entry_points += 'eggcacher = direct.directscripts.eggcacher:main\n'
  722. entry_points += 'pfreeze = direct.dist.pfreeze:main\n'
  723. tools_init = ''
  724. for file in sorted(os.listdir(bin_dir)):
  725. basename = os.path.splitext(file)[0]
  726. if basename in EXCLUDE_BINARIES:
  727. continue
  728. source_path = os.path.join(bin_dir, file)
  729. if is_executable(source_path):
  730. # Put the .exe files inside the panda3d-tools directory.
  731. whl.write_file('panda3d_tools/' + file, source_path)
  732. if basename.endswith('_bin'):
  733. # These tools won't be invoked by the user directly.
  734. continue
  735. # Tell pip to create a wrapper script.
  736. funcname = basename.replace('-', '_')
  737. entry_points += '{0} = panda3d_tools:{1}\n'.format(basename, funcname)
  738. tools_init += '{0} = lambda: _exec_tool({1!r})\n'.format(funcname, file)
  739. entry_points += '[distutils.commands]\n'
  740. entry_points += 'build_apps = direct.dist.commands:build_apps\n'
  741. entry_points += 'bdist_apps = direct.dist.commands:bdist_apps\n'
  742. entry_points += '[setuptools.finalize_distribution_options]\n'
  743. entry_points += 'build_apps = direct.dist._dist_hooks:finalize_distribution_options\n'
  744. whl.write_file_data('panda3d_tools/__init__.py', PANDA3D_TOOLS_INIT.format(tools_init))
  745. # Add the dist-info directory last.
  746. info_dir = 'panda3d-{0}.dist-info'.format(version)
  747. whl.write_file_data(info_dir + '/entry_points.txt', entry_points)
  748. whl.write_file_data(info_dir + '/metadata.json', json.dumps(METADATA, indent=4, separators=(',', ': ')))
  749. whl.write_file_data(info_dir + '/METADATA', metadata)
  750. whl.write_file_data(info_dir + '/WHEEL', WHEEL_DATA.format(PY_VERSION, ABI_TAG, platform))
  751. whl.write_file(info_dir + '/LICENSE.txt', license_src)
  752. whl.write_file(info_dir + '/README.md', readme_src)
  753. whl.write_file_data(info_dir + '/top_level.txt', 'direct\npanda3d\npandac\npanda3d_tools\n')
  754. whl.close()
  755. if __name__ == "__main__":
  756. version = GetMetadataValue('version')
  757. parser = OptionParser()
  758. parser.add_option('', '--version', dest = 'version', help = 'Panda3D version number (default: %s)' % (version), default = version)
  759. parser.add_option('', '--outputdir', dest = 'outputdir', help = 'Makepanda\'s output directory (default: built)', default = 'built')
  760. parser.add_option('', '--verbose', dest = 'verbose', help = 'Enable verbose output', action = 'store_true', default = False)
  761. parser.add_option('', '--platform', dest = 'platform', help = 'Override platform tag', default = None)
  762. (options, args) = parser.parse_args()
  763. SetVerbose(options.verbose)
  764. makewheel(options.version, options.outputdir, options.platform)