conanfile.py 27 KB

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