conanfile.py 29 KB

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