conanfile.py 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502
  1. import os
  2. from pathlib import Path
  3. from jinja2 import Template
  4. from conan import ConanFile
  5. from conan.tools.files import copy, rmdir, save, mkdir
  6. from conan.tools.microsoft import unix_path
  7. from conan.tools.env import VirtualRunEnv, Environment, VirtualBuildEnv
  8. from conan.tools.scm import Version
  9. from conan.errors import ConanInvalidConfiguration, ConanException
  10. required_conan_version = "<=1.56.0"
  11. class CuraConan(ConanFile):
  12. name = "cura"
  13. license = "LGPL-3.0"
  14. author = "UltiMaker"
  15. url = "https://github.com/Ultimaker/cura"
  16. description = "3D printer / slicing GUI built on top of the Uranium framework"
  17. topics = ("conan", "python", "pyqt6", "qt", "qml", "3d-printing", "slicer")
  18. build_policy = "missing"
  19. exports = "LICENSE*", "UltiMaker-Cura.spec.jinja", "CuraVersion.py.jinja"
  20. settings = "os", "compiler", "build_type", "arch"
  21. no_copy_source = True # We won't build so no need to copy sources to the build folder
  22. # FIXME: Remove specific branch once merged to main
  23. # Extending the conanfile with the UMBaseConanfile https://github.com/Ultimaker/conan-ultimaker-index/tree/CURA-9177_Fix_CI_CD/recipes/umbase
  24. python_requires = "umbase/[>=0.1.7]@ultimaker/stable"
  25. python_requires_extend = "umbase.UMBaseConanfile"
  26. options = {
  27. "enterprise": ["True", "False", "true", "false"], # Workaround for GH Action passing boolean as lowercase string
  28. "staging": ["True", "False", "true", "false"], # Workaround for GH Action passing boolean as lowercase string
  29. "devtools": [True, False], # FIXME: Split this up in testing and (development / build (pyinstaller) / system installer) tools
  30. "cloud_api_version": "ANY",
  31. "display_name": "ANY", # TODO: should this be an option??
  32. "cura_debug_mode": [True, False], # FIXME: Use profiles
  33. "internal": [True, False]
  34. }
  35. default_options = {
  36. "enterprise": "False",
  37. "staging": "False",
  38. "devtools": False,
  39. "cloud_api_version": "1",
  40. "display_name": "UltiMaker Cura",
  41. "cura_debug_mode": False, # Not yet implemented
  42. "internal": False,
  43. }
  44. @property
  45. def _pycharm_targets(self):
  46. return self.conan_data["pycharm_targets"]
  47. # FIXME: These env vars should be defined in the runenv.
  48. _cura_env = None
  49. @property
  50. def _cura_run_env(self):
  51. if self._cura_env:
  52. return self._cura_env
  53. self._cura_env = Environment()
  54. self._cura_env.define("QML2_IMPORT_PATH", str(self._site_packages.joinpath("PyQt6", "Qt6", "qml")))
  55. self._cura_env.define("QT_PLUGIN_PATH", str(self._site_packages.joinpath("PyQt6", "Qt6", "plugins")))
  56. if self.settings.os == "Linux":
  57. self._cura_env.define("QT_QPA_FONTDIR", "/usr/share/fonts")
  58. self._cura_env.define("QT_QPA_PLATFORMTHEME", "xdgdesktopportal")
  59. self._cura_env.define("QT_XKB_CONFIG_ROOT", "/usr/share/X11/xkb")
  60. return self._cura_env
  61. @property
  62. def _staging(self):
  63. return self.options.staging in ["True", 'true']
  64. @property
  65. def _enterprise(self):
  66. return self.options.enterprise in ["True", 'true']
  67. @property
  68. def _app_name(self):
  69. if self._enterprise:
  70. return str(self.options.display_name) + " Enterprise"
  71. return str(self.options.display_name)
  72. @property
  73. def _cloud_api_root(self):
  74. return "https://api-staging.ultimaker.com" if self._staging else "https://api.ultimaker.com"
  75. @property
  76. def _cloud_account_api_root(self):
  77. return "https://account-staging.ultimaker.com" if self._staging else "https://account.ultimaker.com"
  78. @property
  79. def _marketplace_root(self):
  80. return "https://marketplace-staging.ultimaker.com" if self._staging else "https://marketplace.ultimaker.com"
  81. @property
  82. def _digital_factory_url(self):
  83. return "https://digitalfactory-staging.ultimaker.com" if self._staging else "https://digitalfactory.ultimaker.com"
  84. @property
  85. def _cura_latest_url(self):
  86. return "https://software.ultimaker.com/latest.json"
  87. @property
  88. def requirements_txts(self):
  89. if self.options.devtools:
  90. return ["requirements.txt", "requirements-ultimaker.txt", "requirements-dev.txt"]
  91. return ["requirements.txt", "requirements-ultimaker.txt"]
  92. @property
  93. def _base_dir(self):
  94. if self.install_folder is None:
  95. if self.build_folder is not None:
  96. return Path(self.build_folder)
  97. return Path(os.getcwd(), "venv")
  98. if self.in_local_cache:
  99. return Path(self.install_folder)
  100. else:
  101. return Path(self.source_folder, "venv")
  102. @property
  103. def _share_dir(self):
  104. return self._base_dir.joinpath("share")
  105. @property
  106. def _script_dir(self):
  107. if self.settings.os == "Windows":
  108. return self._base_dir.joinpath("Scripts")
  109. return self._base_dir.joinpath("bin")
  110. @property
  111. def _site_packages(self):
  112. if self.settings.os == "Windows":
  113. return self._base_dir.joinpath("Lib", "site-packages")
  114. py_version = Version(self.deps_cpp_info["cpython"].version)
  115. return self._base_dir.joinpath("lib", f"python{py_version.major}.{py_version.minor}", "site-packages")
  116. @property
  117. def _py_interp(self):
  118. py_interp = self._script_dir.joinpath(Path(self.deps_user_info["cpython"].python).name)
  119. if self.settings.os == "Windows":
  120. py_interp = Path(*[f'"{p}"' if " " in p else p for p in py_interp.parts])
  121. return py_interp
  122. def _generate_cura_version(self, location):
  123. with open(os.path.join(self.recipe_folder, "CuraVersion.py.jinja"), "r") as f:
  124. cura_version_py = Template(f.read())
  125. # If you want a specific Cura version to show up on the splash screen add the user configuration `user.cura:version=VERSION`
  126. # the global.conf, profile, package_info (of dependency) or via the cmd line `-c user.cura:version=VERSION`
  127. cura_version = Version(self.conf.get("user.cura:version", default = self.version, check_type = str))
  128. pre_tag = f"-{cura_version.pre}" if cura_version.pre else ""
  129. build_tag = f"+{cura_version.build}" if cura_version.build else ""
  130. internal_tag = f"+internal" if self.options.internal else ""
  131. cura_version = f"{cura_version.major}.{cura_version.minor}.{cura_version.patch}{pre_tag}{build_tag}{internal_tag}"
  132. with open(os.path.join(location, "CuraVersion.py"), "w") as f:
  133. f.write(cura_version_py.render(
  134. cura_app_name = self.name,
  135. cura_app_display_name = self._app_name,
  136. cura_version = cura_version,
  137. cura_build_type = "Enterprise" if self._enterprise else "",
  138. cura_debug_mode = self.options.cura_debug_mode,
  139. cura_cloud_api_root = self._cloud_api_root,
  140. cura_cloud_api_version = self.options.cloud_api_version,
  141. cura_cloud_account_api_root = self._cloud_account_api_root,
  142. cura_marketplace_root = self._marketplace_root,
  143. cura_digital_factory_url = self._digital_factory_url,
  144. cura_latest_url = self._cura_latest_url))
  145. def _generate_pyinstaller_spec(self, location, entrypoint_location, icon_path, entitlements_file):
  146. pyinstaller_metadata = self.conan_data["pyinstaller"]
  147. datas = [(str(self._base_dir.joinpath("conan_install_info.json")), ".")]
  148. for data in pyinstaller_metadata["datas"].values():
  149. if not self.options.internal and data.get("internal", False):
  150. continue
  151. if "package" in data: # get the paths from conan package
  152. if data["package"] == self.name:
  153. if self.in_local_cache:
  154. src_path = os.path.join(self.package_folder, data["src"])
  155. else:
  156. src_path = os.path.join(self.source_folder, data["src"])
  157. else:
  158. src_path = os.path.join(self.deps_cpp_info[data["package"]].rootpath, data["src"])
  159. elif "root" in data: # get the paths relative from the sourcefolder
  160. src_path = os.path.join(self.source_folder, data["root"], data["src"])
  161. else:
  162. continue
  163. if Path(src_path).exists():
  164. datas.append((str(src_path), data["dst"]))
  165. binaries = []
  166. for binary in pyinstaller_metadata["binaries"].values():
  167. if "package" in binary: # get the paths from conan package
  168. src_path = os.path.join(self.deps_cpp_info[binary["package"]].rootpath, binary["src"])
  169. elif "root" in binary: # get the paths relative from the sourcefolder
  170. src_path = os.path.join(self.source_folder, binary["root"], binary["src"])
  171. else:
  172. continue
  173. if not Path(src_path).exists():
  174. self.output.warning(f"Source path for binary {binary['binary']} does not exist")
  175. continue
  176. for bin in Path(src_path).glob(binary["binary"] + "*[.exe|.dll|.so|.dylib|.so.]*"):
  177. binaries.append((str(bin), binary["dst"]))
  178. for bin in Path(src_path).glob(binary["binary"]):
  179. binaries.append((str(bin), binary["dst"]))
  180. # Make sure all Conan dependencies which are shared are added to the binary list for pyinstaller
  181. for _, dependency in self.dependencies.host.items():
  182. for bin_paths in dependency.cpp_info.bindirs:
  183. binaries.extend([(f"{p}", ".") for p in Path(bin_paths).glob("**/*.dll")])
  184. for lib_paths in dependency.cpp_info.libdirs:
  185. binaries.extend([(f"{p}", ".") for p in Path(lib_paths).glob("**/*.so*")])
  186. binaries.extend([(f"{p}", ".") for p in Path(lib_paths).glob("**/*.dylib*")])
  187. # Copy dynamic libs from lib path
  188. binaries.extend([(f"{p}", ".") for p in Path(self._base_dir.joinpath("lib")).glob("**/*.dylib*")])
  189. binaries.extend([(f"{p}", ".") for p in Path(self._base_dir.joinpath("lib")).glob("**/*.so*")])
  190. # Collect all dll's from PyQt6 and place them in the root
  191. binaries.extend([(f"{p}", ".") for p in Path(self._site_packages, "PyQt6", "Qt6").glob("**/*.dll")])
  192. with open(os.path.join(self.recipe_folder, "UltiMaker-Cura.spec.jinja"), "r") as f:
  193. pyinstaller = Template(f.read())
  194. version = self.conf_info.get("user.cura:version", default = self.version, check_type = str)
  195. cura_version = Version(version)
  196. with open(os.path.join(location, "UltiMaker-Cura.spec"), "w") as f:
  197. f.write(pyinstaller.render(
  198. name = str(self.options.display_name).replace(" ", "-"),
  199. display_name = self._app_name,
  200. entrypoint = entrypoint_location,
  201. datas = datas,
  202. binaries = binaries,
  203. venv_script_path = str(self._script_dir),
  204. hiddenimports = pyinstaller_metadata["hiddenimports"],
  205. collect_all = pyinstaller_metadata["collect_all"],
  206. icon = icon_path,
  207. entitlements_file = entitlements_file,
  208. osx_bundle_identifier = "'nl.ultimaker.cura'" if self.settings.os == "Macos" else "None",
  209. upx = str(self.settings.os == "Windows"),
  210. strip = False, # This should be possible on Linux and MacOS but, it can also cause issues on some distributions. Safest is to disable it for now
  211. target_arch = "'x86_64'" if self.settings.os == "Macos" else "None", # FIXME: Make this dependent on the settings.arch_target
  212. macos = self.settings.os == "Macos",
  213. version = f"'{version}'",
  214. short_version = f"'{cura_version.major}.{cura_version.minor}.{cura_version.patch}'",
  215. ))
  216. def export_sources(self):
  217. copy(self, "*", os.path.join(self.recipe_folder, "plugins"), os.path.join(self.export_sources_folder, "plugins"))
  218. copy(self, "*", os.path.join(self.recipe_folder, "resources"), os.path.join(self.export_sources_folder, "resources"), excludes = "*.mo")
  219. copy(self, "*", os.path.join(self.recipe_folder, "tests"), os.path.join(self.export_sources_folder, "tests"))
  220. copy(self, "*", os.path.join(self.recipe_folder, "cura"), os.path.join(self.export_sources_folder, "cura"), excludes="CuraVersion.py")
  221. copy(self, "*", os.path.join(self.recipe_folder, "packaging"), os.path.join(self.export_sources_folder, "packaging"))
  222. copy(self, "*", os.path.join(self.recipe_folder, ".run_templates"), os.path.join(self.export_sources_folder, ".run_templates"))
  223. copy(self, "requirements.txt", self.recipe_folder, self.export_sources_folder)
  224. copy(self, "requirements-dev.txt", self.recipe_folder, self.export_sources_folder)
  225. copy(self, "requirements-ultimaker.txt", self.recipe_folder, self.export_sources_folder)
  226. copy(self, "UltiMaker-Cura.spec.jinja", self.recipe_folder, self.export_sources_folder)
  227. copy(self, "CuraVersion.py.jinja", self.recipe_folder, self.export_sources_folder)
  228. copy(self, "cura_app.py", self.recipe_folder, self.export_sources_folder)
  229. def set_version(self):
  230. if self.version is None:
  231. self.version = self._umdefault_version()
  232. def configure(self):
  233. self.options["pyarcus"].shared = True
  234. self.options["pysavitar"].shared = True
  235. self.options["pynest2d"].shared = True
  236. self.options["cpython"].shared = True
  237. def validate(self):
  238. version = self.conf_info.get("user.cura:version", default = self.version, check_type = str)
  239. if version and Version(version) <= Version("4"):
  240. raise ConanInvalidConfiguration("Only versions 5+ are support")
  241. def requirements(self):
  242. self.requires("pyarcus/5.2.2")
  243. self.requires("curaengine/(latest)@ultimaker/stable")
  244. self.requires("pysavitar/5.2.2")
  245. self.requires("pynest2d/5.2.2")
  246. self.requires("uranium/(latest)@ultimaker/stable")
  247. self.requires("fdm_materials/(latest)@ultimaker/stable")
  248. self.requires("cura_binary_data/5.3.0-beta")
  249. self.requires("cpython/3.10.4")
  250. if self.options.internal:
  251. self.requires("cura_private_data/(latest)@ultimaker/testing")
  252. def build_requirements(self):
  253. if self.options.devtools:
  254. if self.settings.os != "Windows" or self.conf.get("tools.microsoft.bash:path", check_type = str):
  255. # FIXME: once m4, autoconf, automake are Conan V2 ready use self.win_bash and add gettext as base tool_requirement
  256. self.tool_requires("gettext/0.21", force_host_context=True)
  257. def layout(self):
  258. self.folders.source = "."
  259. self.folders.build = "venv"
  260. self.folders.generators = os.path.join(self.folders.build, "conan")
  261. self.cpp.package.libdirs = [os.path.join("site-packages", "cura")]
  262. self.cpp.package.bindirs = ["bin"]
  263. self.cpp.package.resdirs = ["resources", "plugins", "packaging", "pip_requirements"] # pip_requirements should be the last item in the list
  264. def generate(self):
  265. copy(self, "cura_app.py", self.source_folder, str(self._script_dir))
  266. cura_run_envvars = self._cura_run_env.vars(self, scope = "run")
  267. ext = ".ps1" if self.settings.os == "Windows" else ".sh"
  268. cura_run_envvars.save_script(os.path.join(self.folders.generators, f"cura_run_environment{ext}"))
  269. vr = VirtualRunEnv(self)
  270. vr.generate()
  271. self._generate_cura_version(os.path.join(self.source_folder, "cura"))
  272. if self.options.devtools:
  273. entitlements_file = "'{}'".format(os.path.join(self.source_folder, "packaging", "MacOS", "cura.entitlements"))
  274. self._generate_pyinstaller_spec(location = self.generators_folder,
  275. entrypoint_location = "'{}'".format(os.path.join(self.source_folder, self.conan_data["pyinstaller"]["runinfo"]["entrypoint"])).replace("\\", "\\\\"),
  276. icon_path = "'{}'".format(os.path.join(self.source_folder, "packaging", self.conan_data["pyinstaller"]["icon"][str(self.settings.os)])).replace("\\", "\\\\"),
  277. entitlements_file = entitlements_file if self.settings.os == "Macos" else "None")
  278. # Update the po files
  279. if self.settings.os != "Windows" or self.conf.get("tools.microsoft.bash:path", check_type=str):
  280. vb = VirtualBuildEnv(self)
  281. vb.generate()
  282. # FIXME: once m4, autoconf, automake are Conan V2 ready use self.win_bash and add gettext as base tool_requirement
  283. cpp_info = self.dependencies["gettext"].cpp_info
  284. for po_file in self.source_path.joinpath("resources", "i18n").glob("**/*.po"):
  285. pot_file = self.source_path.joinpath("resources", "i18n", po_file.with_suffix('.pot').name)
  286. mkdir(self, str(unix_path(self, pot_file.parent)))
  287. self.run(
  288. f"{cpp_info.bindirs[0]}/msgmerge --no-wrap --no-fuzzy-matching -width=140 -o {po_file} {po_file} {pot_file}",
  289. env="conanbuild", ignore_errors=True)
  290. def build(self):
  291. if self.options.devtools:
  292. if self.settings.os != "Windows" or self.conf.get("tools.microsoft.bash:path", check_type = str):
  293. # FIXME: once m4, autoconf, automake are Conan V2 ready use self.win_bash and add gettext as base tool_requirement
  294. for po_file in self.source_path.joinpath("resources", "i18n").glob("**/*.po"):
  295. mo_file = Path(self.build_folder, po_file.with_suffix('.mo').relative_to(self.source_path))
  296. mo_file = mo_file.parent.joinpath("LC_MESSAGES", mo_file.name)
  297. mkdir(self, str(unix_path(self, Path(mo_file).parent)))
  298. cpp_info = self.dependencies["gettext"].cpp_info
  299. self.run(f"{cpp_info.bindirs[0]}/msgfmt {po_file} -o {mo_file} -f", env="conanbuild", ignore_errors=True)
  300. def imports(self):
  301. self.copy("CuraEngine.exe", root_package = "curaengine", src = "@bindirs", dst = "", keep_path = False)
  302. self.copy("CuraEngine", root_package = "curaengine", src = "@bindirs", dst = "", keep_path = False)
  303. rmdir(self, os.path.join(self.source_folder, "resources", "materials"))
  304. self.copy("*.fdm_material", root_package = "fdm_materials", src = "@resdirs", dst = "resources/materials", keep_path = False)
  305. self.copy("*.sig", root_package = "fdm_materials", src = "@resdirs", dst = "resources/materials", keep_path = False)
  306. if self.options.internal:
  307. self.copy("*", root_package = "cura_private_data", src = self.deps_cpp_info["cura_private_data"].resdirs[0],
  308. dst = self._share_dir.joinpath("cura", "resources"), keep_path = True)
  309. # Copy resources of cura_binary_data
  310. self.copy("*", root_package = "cura_binary_data", src = self.deps_cpp_info["cura_binary_data"].resdirs[0],
  311. dst = self._share_dir.joinpath("cura", "resources"), keep_path = True)
  312. self.copy("*", root_package = "cura_binary_data", src = self.deps_cpp_info["cura_binary_data"].resdirs[1],
  313. dst =self._share_dir.joinpath("uranium", "resources"), keep_path = True)
  314. self.copy("*.dll", src = "@bindirs", dst = self._site_packages)
  315. self.copy("*.pyd", src = "@libdirs", dst = self._site_packages)
  316. self.copy("*.pyi", src = "@libdirs", dst = self._site_packages)
  317. self.copy("*.dylib", src = "@libdirs", dst = self._script_dir)
  318. def deploy(self):
  319. # Copy CuraEngine.exe to bindirs of Virtual Python Environment
  320. # TODO: Fix source such that it will get the curaengine relative from the executable (Python bindir in this case)
  321. self.copy_deps("CuraEngine.exe", root_package = "curaengine", src = self.deps_cpp_info["curaengine"].bindirs[0],
  322. dst = self._base_dir,
  323. keep_path = False)
  324. self.copy_deps("CuraEngine", root_package = "curaengine", src = self.deps_cpp_info["curaengine"].bindirs[0], dst = self._base_dir,
  325. keep_path = False)
  326. # Copy resources of Cura (keep folder structure)
  327. self.copy("*", src = self.cpp_info.bindirs[0], dst = self._base_dir, keep_path = False)
  328. self.copy("*", src = self.cpp_info.libdirs[0], dst = self._site_packages.joinpath("cura"), keep_path = True)
  329. self.copy("*", src = self.cpp_info.resdirs[0], dst = self._share_dir.joinpath("cura", "resources"), keep_path = True)
  330. self.copy("*", src = self.cpp_info.resdirs[1], dst = self._share_dir.joinpath("cura", "plugins"), keep_path = True)
  331. # Copy materials (flat)
  332. self.copy_deps("*.fdm_material", root_package = "fdm_materials", src = self.deps_cpp_info["fdm_materials"].resdirs[0],
  333. dst = self._share_dir.joinpath("cura", "resources", "materials"), keep_path = False)
  334. self.copy_deps("*.sig", root_package = "fdm_materials", src = self.deps_cpp_info["fdm_materials"].resdirs[0],
  335. dst = self._share_dir.joinpath("cura", "resources", "materials"), keep_path = False)
  336. # Copy internal resources
  337. if self.options.internal:
  338. self.copy_deps("*", root_package = "cura_private_data", src = self.deps_cpp_info["cura_private_data"].resdirs[0],
  339. dst = self._share_dir.joinpath("cura", "resources"), keep_path = True)
  340. self.copy_deps("*", root_package = "cura_private_data", src = self.deps_cpp_info["cura_private_data"].resdirs[1],
  341. dst = self._share_dir.joinpath("cura", "plugins"), keep_path = True)
  342. # Copy resources of Uranium (keep folder structure)
  343. self.copy_deps("*", root_package = "uranium", src = self.deps_cpp_info["uranium"].resdirs[0],
  344. dst = self._share_dir.joinpath("uranium", "resources"), keep_path = True)
  345. self.copy_deps("*", root_package = "uranium", src = self.deps_cpp_info["uranium"].resdirs[1],
  346. dst = self._share_dir.joinpath("uranium", "plugins"), keep_path = True)
  347. self.copy_deps("*", root_package = "uranium", src = self.deps_cpp_info["uranium"].libdirs[0],
  348. dst = self._site_packages.joinpath("UM"),
  349. keep_path = True)
  350. self.copy_deps("*", root_package = "uranium", src = str(os.path.join(self.deps_cpp_info["uranium"].libdirs[0], "Qt", "qml", "UM")),
  351. dst = self._site_packages.joinpath("PyQt6", "Qt6", "qml", "UM"),
  352. keep_path = True)
  353. # Copy resources of cura_binary_data
  354. self.copy_deps("*", root_package = "cura_binary_data", src = self.deps_cpp_info["cura_binary_data"].resdirs[0],
  355. dst = self._share_dir.joinpath("cura"), keep_path = True)
  356. self.copy_deps("*", root_package = "cura_binary_data", src = self.deps_cpp_info["cura_binary_data"].resdirs[1],
  357. dst = self._share_dir.joinpath("uranium"), keep_path = True)
  358. if self.settings.os == "Windows":
  359. self.copy_deps("*", root_package = "cura_binary_data", src = self.deps_cpp_info["cura_binary_data"].resdirs[2],
  360. dst = self._share_dir.joinpath("windows"), keep_path = True)
  361. self.copy_deps("*.dll", src = "@bindirs", dst = self._site_packages)
  362. self.copy_deps("*.pyd", src = "@libdirs", dst = self._site_packages)
  363. self.copy_deps("*.pyi", src = "@libdirs", dst = self._site_packages)
  364. self.copy_deps("*.dylib", src = "@libdirs", dst = self._base_dir.joinpath("lib"))
  365. # Copy packaging scripts
  366. self.copy("*", src = self.cpp_info.resdirs[2], dst = self._base_dir.joinpath("packaging"))
  367. # Copy requirements.txt's
  368. self.copy("*.txt", src = self.cpp_info.resdirs[-1], dst = self._base_dir.joinpath("pip_requirements"))
  369. # Generate the GitHub Action version info Environment
  370. version = self.conf_info.get("user.cura:version", default = self.version, check_type = str)
  371. cura_version = Version(version)
  372. env_prefix = "Env:" if self.settings.os == "Windows" else ""
  373. activate_github_actions_version_env = Template(r"""echo "CURA_VERSION_MAJOR={{ cura_version_major }}" >> ${{ env_prefix }}GITHUB_ENV
  374. echo "CURA_VERSION_MINOR={{ cura_version_minor }}" >> ${{ env_prefix }}GITHUB_ENV
  375. echo "CURA_VERSION_PATCH={{ cura_version_patch }}" >> ${{ env_prefix }}GITHUB_ENV
  376. echo "CURA_VERSION_BUILD={{ cura_version_build }}" >> ${{ env_prefix }}GITHUB_ENV
  377. echo "CURA_VERSION_FULL={{ cura_version_full }}" >> ${{ env_prefix }}GITHUB_ENV
  378. echo "CURA_APP_NAME={{ cura_app_name }}" >> ${{ env_prefix }}GITHUB_ENV
  379. """).render(cura_version_major = cura_version.major,
  380. cura_version_minor = cura_version.minor,
  381. cura_version_patch = cura_version.patch,
  382. cura_version_build = cura_version.build if cura_version.build != "" else "0",
  383. cura_version_full = self.version,
  384. cura_app_name = self._app_name,
  385. env_prefix = env_prefix)
  386. ext = ".sh" if self.settings.os != "Windows" else ".ps1"
  387. save(self, os.path.join(self._script_dir, f"activate_github_actions_version_env{ext}"), activate_github_actions_version_env)
  388. self._generate_cura_version(os.path.join(self._site_packages, "cura"))
  389. entitlements_file = "'{}'".format(Path(self.cpp_info.res_paths[2], "MacOS", "cura.entitlements"))
  390. self._generate_pyinstaller_spec(location = self._base_dir,
  391. entrypoint_location = "'{}'".format(os.path.join(self.package_folder, self.cpp_info.bindirs[0], self.conan_data["pyinstaller"]["runinfo"]["entrypoint"])).replace("\\", "\\\\"),
  392. icon_path = "'{}'".format(os.path.join(self.package_folder, self.cpp_info.resdirs[2], self.conan_data["pyinstaller"]["icon"][str(self.settings.os)])).replace("\\", "\\\\"),
  393. entitlements_file = entitlements_file if self.settings.os == "Macos" else "None")
  394. def package(self):
  395. copy(self, "cura_app.py", src = self.source_folder, dst = os.path.join(self.package_folder, self.cpp.package.bindirs[0]))
  396. copy(self, "*", src = os.path.join(self.source_folder, "cura"), dst = os.path.join(self.package_folder, self.cpp.package.libdirs[0]))
  397. copy(self, "*", src = os.path.join(self.source_folder, "resources"), dst = os.path.join(self.package_folder, self.cpp.package.resdirs[0]))
  398. copy(self, "*.mo", os.path.join(self.build_folder, "resources"), os.path.join(self.package_folder, "resources"))
  399. copy(self, "*", src = os.path.join(self.source_folder, "plugins"), dst = os.path.join(self.package_folder, self.cpp.package.resdirs[1]))
  400. copy(self, "requirement*.txt", src = self.source_folder, dst = os.path.join(self.package_folder, self.cpp.package.resdirs[-1]))
  401. copy(self, "*", src = os.path.join(self.source_folder, "packaging"), dst = os.path.join(self.package_folder, self.cpp.package.resdirs[2]))
  402. def package_info(self):
  403. self.user_info.pip_requirements = "requirements.txt"
  404. self.user_info.pip_requirements_git = "requirements-ultimaker.txt"
  405. self.user_info.pip_requirements_build = "requirements-dev.txt"
  406. if self.in_local_cache:
  407. self.runenv_info.append_path("PYTHONPATH", os.path.join(self.package_folder, "site-packages"))
  408. self.runenv_info.append_path("PYTHONPATH", os.path.join(self.package_folder, "plugins"))
  409. else:
  410. self.runenv_info.append_path("PYTHONPATH", self.source_folder)
  411. self.runenv_info.append_path("PYTHONPATH", os.path.join(self.source_folder, "plugins"))
  412. def package_id(self):
  413. self.info.clear()
  414. # The following options shouldn't be used to determine the hash, since these are only used to set the CuraVersion.py
  415. # which will als be generated by the deploy method during the `conan install cura/5.1.0@_/_`
  416. del self.info.options.enterprise
  417. del self.info.options.staging
  418. del self.info.options.devtools
  419. del self.info.options.cloud_api_version
  420. del self.info.options.display_name
  421. del self.info.options.cura_debug_mode
  422. # TODO: Use the hash of requirements.txt and requirements-ultimaker.txt, Because changing these will actually result in a different
  423. # Cura. This is needed because the requirements.txt aren't managed by Conan and therefor not resolved in the package_id. This isn't
  424. # ideal but an acceptable solution for now.