forked from AVSLab/basilisk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconanfile.py
More file actions
699 lines (607 loc) · 31.5 KB
/
Copy pathconanfile.py
File metadata and controls
699 lines (607 loc) · 31.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
import argparse
import os
import json
import shutil
import shlex
import subprocess
import sys
from datetime import datetime
from glob import glob
from pathlib import Path
from typing import Callable, Optional
import importlib.metadata
from packaging.requirements import Requirement
from conan import ConanFile
from conan.tools.cmake import CMakeToolchain, CMake, cmake_layout, CMakeDeps
from conan.tools.microsoft import is_msvc
from conan.tools.files import copy
sys.path.insert(1, './src/utilities/')
import makeDraftModule
# XXX: this statement is needed to enable Windows to print ANSI codes in the Terminal
# see https://stackoverflow.com/questions/287871/how-to-print-colored-text-in-terminal-in-python/3332860#3332860
os.system("")
# define the print color codes
statusColor = '\033[92m'
failColor = '\033[91m'
warningColor = '\033[93m'
endColor = '\033[0m'
# # define BSK module option list (option name and default value)
bskModuleOptionsBool = {
"opNav": [[True, False], False],
"vizInterface": [[True, False], True],
"mujoco": [[True, False], False],
# Experimental: build Rust modules under src/ (see
# src/cmake/bskFindRustModules.cmake and
# docs/source/Learn/makingModules/rustModules.rst).
# Requires a Rust/Cargo toolchain on PATH; off by default so most builds/CI
# jobs never need one.
"rustModules": [[True, False], False],
"examples": [[True, False], True],
"buildProject": [[True, False], True],
"pyPkgCanary": [[True, False], False],
"recorderPropertyRollback": [[True, False], False],
# XXX: Set managePipEnvironment to True to keep the old behaviour of
# managing the `pip` environment directly (upgrading, installing Python
# packages, etc.). This behaviour is deprecated using the new pip-based
# installation, and should only be required for users who are still calling
# this file with `python conanfile.py ...`.
# TODO: Remove all managePipEnvironment behaviour!
"managePipEnvironment": [[True, False], True],
}
bskModuleOptionsString = {
"autoKey": [["", "u", "s","c"], ""], # TODO: Remove, used only for managePipEnvironment.
"pathToExternalModules": [["ANY"], ""],
"pyLimitedAPI": [["ANY"], ""],
}
bskModuleOptionsFlag = {
"clean": [[True, False], False],
"allOptPkg": [[True, False], False] # TODO: Remove, used only for managePipEnvironment.
}
def is_running_virtual_env():
return sys.prefix != sys.base_prefix
required_conan_version = ">=2.0.5"
PY_LIMITED_API_PY39 = "0x03090000" # cp39-abi3
NUMBA_CACHE_SEARCH_DIRS = ("src", "docs/source", "examples")
NUMBA_CACHE_DIR_NAME = "__pycache__"
NUMBA_CACHE_FILE_PATTERNS = ("*.nbc", "*.nbi")
def get_basilisk_numba_model_cache_dir() -> Optional[Path]:
"""Return Basilisk's generated Numba model cache directory."""
try:
from platformdirs import user_cache_dir
except ImportError:
return None
return Path(user_cache_dir("basilisk")) / "numba_model"
def clean_numba_cache_artifacts(root: Optional[Path] = None,
user_cache_dir: Optional[Path] = None,
print_fn: Optional[Callable[[str], None]] = print) -> tuple[int, bool]:
"""Remove Numba disk-cache artifacts that can outlive a clean build."""
root_path = Path.cwd() if root is None else Path(root)
removed_cache_files = 0
for search_dir in NUMBA_CACHE_SEARCH_DIRS:
search_path = root_path / search_dir
if not search_path.exists():
continue
for cache_dir in search_path.rglob(NUMBA_CACHE_DIR_NAME):
if not cache_dir.is_dir():
continue
for pattern in NUMBA_CACHE_FILE_PATTERNS:
for cache_file in cache_dir.glob(pattern):
try:
cache_file.unlink()
removed_cache_files += 1
except FileNotFoundError:
continue
cache_dir = (
get_basilisk_numba_model_cache_dir()
if user_cache_dir is None
else Path(user_cache_dir)
)
cache_dir_existed = False
removed_user_cache = False
if cache_dir is not None and cache_dir.exists():
cache_dir_existed = True
shutil.rmtree(cache_dir, ignore_errors=True)
removed_user_cache = not cache_dir.exists()
if print_fn is not None:
print_fn(f"Removed {removed_cache_files} in-repo Numba cache file(s).")
if cache_dir is None:
print_fn("Basilisk Numba model cache path unavailable; platformdirs is not installed.")
elif removed_user_cache:
print_fn(f"Removed Basilisk Numba model cache: {cache_dir}")
elif cache_dir_existed:
print_fn(f"Unable to fully remove Basilisk Numba model cache: {cache_dir}")
else:
print_fn(f"No Basilisk Numba model cache found at: {cache_dir}")
return removed_cache_files, removed_user_cache
def clean_rust_target_artifacts(root: Optional[Path] = None,
print_fn: Optional[Callable[[str], None]] = print) -> int:
"""Remove Cargo ``target`` directories belonging to crates under ``src``."""
root_path = Path.cwd() if root is None else Path(root)
source_path = root_path / "src"
if not source_path.exists():
return 0
manifests = [
manifest
for manifest in source_path.rglob("Cargo.toml")
if "target" not in manifest.relative_to(source_path).parts
]
target_directories = sorted({manifest.parent / "target" for manifest in manifests})
removed_target_directories = 0
for target_directory in target_directories:
if not target_directory.is_dir() or target_directory.is_symlink():
continue
shutil.rmtree(target_directory, ignore_errors=True)
if not target_directory.exists():
removed_target_directories += 1
if print_fn is not None:
directory_label = "directory" if removed_target_directories == 1 else "directories"
print_fn(f"Removed {removed_target_directories} Cargo target {directory_label}.")
return removed_target_directories
def should_scan_windows_dll_directory(root: str, build_folder: str) -> bool:
"""Return whether a build directory can contain runtime DLLs.
Cargo's target tree contains build-time procedural-macro DLLs. They are
loaded only by ``rustc`` and must not be copied into the Basilisk wheel.
"""
normalized_root = os.path.normcase(os.path.abspath(root))
excluded_roots = (
os.path.normcase(os.path.abspath(os.path.join(build_folder, "Basilisk"))),
os.path.normcase(os.path.abspath(os.path.join(build_folder, "cargo"))),
)
for excluded_root in excluded_roots:
try:
if os.path.commonpath([normalized_root, excluded_root]) == excluded_root:
return False
except ValueError:
continue
return True
def resolve_py_limited_api(opt_value: Optional[str]) -> str:
"""Use explicit --pyLimitedAPI if provided, else cp39."""
if opt_value:
return opt_value
return PY_LIMITED_API_PY39
class BasiliskConan(ConanFile):
name = "Basilisk"
homepage = "https://avslab.github.io/basilisk/"
f = open('docs/source/bskVersion.txt', 'r')
version = f.read()
f.close()
# generators = "CMakeDeps"
settings = "os", "compiler", "build_type", "arch"
build_policy = "missing"
license = "ISC"
# Requirements
requires = [
"eigen/3.4.0",
"cspice/0067",
"cfitsio/4.6.3",
]
package_type = "shared-library"
options = {
# define BSK module option list
"sourceFolder": ["ANY"],
"buildFolder": ["ANY"],
"generator": ["ANY"],
}
default_options = {
"sourceFolder": "src",
"buildFolder": "dist3",
"generator": "",
}
# Sources are located in the same place as this recipe, copy them to the recipe
exports_sources = "setup.py", "CMakeLists.txt", "src/*", "include/*"
for opt, value in bskModuleOptionsBool.items():
options.update({opt: value[0]})
default_options.update({opt: value[1]})
for opt, value in bskModuleOptionsString.items():
options.update({opt: value[0]})
default_options.update({opt: value[1]})
for opt, value in bskModuleOptionsFlag.items():
options.update({opt: value[0]})
default_options.update({opt: value[1]})
def system_requirements(self):
if not self.options.get_safe("managePipEnvironment"):
return # Don't need to manage any pip requirements
# TODO: Remove everything here, which only runs if we have set
# managePipEnvironment (i.e. conanfile.py-based build).
# ensure latest pip is installed
cmakeCmd = [sys.executable, "-m", "pip", "install", "--upgrade", "pip"]
print(statusColor + "Updating pip:" + endColor)
print(shlex.join(cmakeCmd))
try:
subprocess.check_call(cmakeCmd)
except subprocess.CalledProcessError:
print(warningColor + "Was not able to upgrade pip; continuing with the existing pip installation." + endColor)
# TODO: Remove this: requirements and optional requirements are
# installed automatically by add_basilisk_to_sys_path(). Only build
# system requirements need to be installed here.
reqPath = '.github/workflows/' if self.options.get_safe("pyPkgCanary") else ''
reqFile = open(f'{reqPath}requirements.txt', 'r')
required = reqFile.read().replace("`", "").split('\n')
reqFile.close()
pkgList = [x.lower() for x in required]
reqFile = open(f'{reqPath}requirements_dev.txt', 'r')
required = reqFile.read().replace("`", "").split('\n')
reqFile.close()
pkgList += [x.lower() for x in required]
checkStr = "Required"
if self.options.get_safe("allOptPkg"):
optFile = open(f'{reqPath}requirements_doc.txt', 'r')
optionalPkgs = optFile.read().replace("`", "").split('\n')
optFile.close()
optionalPkgs = [x.lower() for x in optionalPkgs]
pkgList += optionalPkgs
checkStr += " and All Optional"
print("\nChecking " + checkStr + " Python packages:")
missing_packages = []
for elem in pkgList:
if not elem: # Skip empty or falsy elements
continue
try:
# Parse the requirement (e.g., "numpy<2")
req = Requirement(elem)
# Get the installed version of the package
installed_version = importlib.metadata.version(req.name)
# Check if the installed version satisfies the requirement
if req.specifier.contains(installed_version):
print("Found: " + statusColor + elem + endColor)
else:
raise Exception(
f"Version conflict for {req.name}: {installed_version} does not satisfy {req.specifier}")
except importlib.metadata.PackageNotFoundError:
missing_packages.append(elem)
except Exception as e:
print(f"Error: {e}")
missing_packages.append(elem)
for elem in missing_packages:
installCmd = [sys.executable, "-m", "pip", "install"]
if not is_running_virtual_env():
if self.options.get_safe("autoKey"):
choice = self.options.get_safe("autoKey")
else:
choice = input(warningColor + f"Required python package " + elem + " is missing" + endColor +
"\nInstall for user (u), system (s) or cancel(c)? ")
if choice == 'c':
print(warningColor + "Skipping installing " + elem + endColor)
continue
elif choice == 'u':
installCmd.append("--user")
installCmd.append(elem)
try:
subprocess.check_call(installCmd)
print(f"Installed: {statusColor}{elem}{endColor}")
except subprocess.CalledProcessError:
print(failColor + f"Was not able to install " + elem + endColor)
def build_requirements(self):
# Protobuf is also required as a tool (in order for CMake to find the
# Conan-installed `protoc` compiler).
# See https://github.com/conan-io/conan-center-index/issues/21737
# and https://github.com/conan-io/conan-center-index/pull/22244#issuecomment-1910770387
if self.options.get_safe("vizInterface") or self.options.get_safe("opNav"):
self.tool_requires("protobuf/<host_version>")
def requirements(self):
if self.options.get_safe("opNav"):
self.requires("opencv/4.13.0")
if self.options.get_safe("vizInterface") or self.options.get_safe("opNav"):
self.requires("protobuf/3.21.12") # For compatibility with openCV
self.requires("cppzmq/4.11.0")
if self.options.get_safe("mujoco"):
self.requires(f"mujoco/{get_mujoco_version()}")
def configure(self):
if self.options.get_safe("clean"):
# clean the distribution folder to start fresh
root = os.path.abspath(os.path.curdir)
distPath = os.path.join(root, "dist3")
if os.path.exists(distPath):
shutil.rmtree(distPath, ignore_errors=True)
clean_numba_cache_artifacts(Path(root))
clean_rust_target_artifacts(Path(root))
if self.settings.get_safe("build_type") == "Debug":
print(warningColor + "Build type is set to Debug. Performance will be significantly lower." + endColor)
# Install additional opencv methods
if self.options.get_safe("opNav"):
self.options['opencv'].contrib = True
self.options['opencv'].with_ffmpeg = False # video frame encoding lib
self.options['opencv'].gapi = False # graph manipulations framework
self.options['opencv'].with_tiff = False # generate image in TIFF format
self.options['opencv'].with_openexr = False # generate image in EXR format
self.options['opencv'].with_quirc = False # QR code lib
self.options['opencv'].with_webp = False # raster graphics file format for web
if self.settings.get_safe("os") == "Linux":
self.options['opencv'].with_wayland = False # desktop display protocol
# Other dependency options
if self.options.get_safe("vizInterface") or self.options.get_safe("opNav"):
if self.settings.get_safe("os") == "Macos":
# Avoid loading separate protobuf runtimes through OpenCV and vizInterface.
self.options["protobuf"].shared = True
self.options['zeromq'].encryption = False # Basilisk does not use data streaming encryption.
def package_id(self):
if self.info.settings.compiler == "Visual Studio":
if "MD" in self.settings.compiler.runtime:
self.info.settings.compiler.runtime = "MD/MDd"
else:
self.info.settings.compiler.runtime = "MT/MTd"
def layout(self):
cmake_layout(self,
src_folder=str(self.options.get_safe("sourceFolder")),
build_folder=str(self.options.get_safe("buildFolder"))
)
# XXX: Override the build folder again to keep it consistent between
# multi- (e.g. Visual Studio) and single-config (e.g. Make) generators.
# Otherwise, it's too difficult to extract the value of this into the
# setup.py file programmatically.
self.folders.build = str(self.options.get_safe("buildFolder"))
def generate(self):
if self.settings.os == "Windows":
# Ensure dependent DLLs are copied into the Basilisk package
# directory inside the build folder so they can be discovered by
# packaging tools (delvewheel) and included in wheels.
basilisk_dst = os.path.join(self.build_folder, "Basilisk")
for dep in self.dependencies.values():
for bindir in dep.cpp_info.bindirs:
copy(self, "*.dll", bindir, basilisk_dst)
if self.settings.os == "Windows":
for dep in self.dependencies.values():
for libdir in dep.cpp_info.bindirs:
copy(self, "*.dll", libdir, "../Basilisk")
if self.options.get_safe("pathToExternalModules"):
print(statusColor + "Including External Folder: " + endColor + str(self.options.pathToExternalModules))
if self.settings.build_type == "Debug":
self.output.warning("Build type is set to Debug. Performance will be significantly slower.")
# -------------------------------------------------------------
# Run the CMake configuration generators.
# -------------------------------------------------------------
deps = CMakeDeps(self)
deps.set_property("eigen", "cmake_target_name", "Eigen3::Eigen3") # XXX: Override, original is "Eigen3::Eigen"
deps.set_property("cppzmq", "cmake_target_name", "cppzmq::cppzmq") # XXX: Override, original is "cppzmq"
deps.generate()
tc = CMakeToolchain(self)
generatorString = str(self.options.get_safe("generator"))
if generatorString == "":
# Select default generator supplied to cmake based on os
if self.settings.os == "Macos" and not self.options.get_safe("buildProject"):
generatorString = "Xcode"
tc.generator = generatorString
elif self.settings.os == "Windows":
generatorString = "Visual Studio 17 2022"
tc.generator = generatorString
self.options["*"].shared = True
else:
print("Creating a make file for project. ")
print("Specify your own using the -o generator='Name' flag during conan install")
else:
tc.generator = generatorString
if self.settings.os == "Windows":
self.options["*"].shared = True
print("cmake generator set to: " + statusColor + generatorString + endColor)
tc.cache_variables["BUILD_OPNAV"] = bool(self.options.get_safe("opNav"))
tc.cache_variables["BUILD_VIZINTERFACE"] = bool(self.options.get_safe("vizInterface"))
tc.cache_variables["BUILD_MUJOCO"] = bool(self.options.get_safe("mujoco"))
tc.cache_variables["BUILD_RUST_MODULES"] = bool(self.options.get_safe("rustModules"))
tc.cache_variables["BSK_CONAN_BUILD_TYPE"] = str(self.settings.build_type)
tc.cache_variables["BSK_VERSION"] = str(self.version).strip()
tc.cache_variables["BSK_CONAN_VERSION"] = importlib.metadata.version("conan")
tc.cache_variables["BSK_CONAN_CXX_STANDARD"] = str(self.settings.get_safe("compiler.cppstd") or "")
tc.cache_variables["BSK_CONAN_CXX_STANDARD_LIBRARY"] = str(self.settings.get_safe("compiler.libcxx") or "")
tc.cache_variables["BSK_CONAN_COMPILER_RUNTIME"] = str(self.settings.get_safe("compiler.runtime") or "")
tc.cache_variables["BSK_CONAN_COMPILER_RUNTIME_TYPE"] = str(
self.settings.get_safe("compiler.runtime_type") or ""
)
tc.cache_variables["Python3_EXECUTABLE"] = Path(sys.executable).as_posix()
if self.options.get_safe("pathToExternalModules"):
tc.cache_variables["EXTERNAL_MODULES_PATH"] = Path(str(self.options.pathToExternalModules)).resolve().as_posix()
tc.cache_variables["PYTHON_VERSION"] = f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}"
tc.cache_variables["RECORDER_PROPERTY_ROLLBACK"] = "1" if self.options.get_safe("recorderPropertyRollback") else "0"
# get the header directory for numpy
import numpy
tc.cache_variables["NUMPY_INCLUDE_DIR"] = numpy.get_include()
# Set the build rpath, since we don't install the targets, so that the
# shared libraries can find each other using relative paths.
tc.cache_variables["CMAKE_BUILD_RPATH_USE_ORIGIN"] = True
# Set the minimum buildable MacOS version.
# tc.cache_variables["CMAKE_OSX_DEPLOYMENT_TARGET"] = "10.13"
tc.parallel = True
# Use sccache as a compiler launcher if available (e.g. in CI via CMAKE_C/CXX_COMPILER_LAUNCHER env vars)
if c_launcher := os.environ.get("CMAKE_C_COMPILER_LAUNCHER"):
tc.cache_variables["CMAKE_C_COMPILER_LAUNCHER"] = c_launcher
if cxx_launcher := os.environ.get("CMAKE_CXX_COMPILER_LAUNCHER"):
tc.cache_variables["CMAKE_CXX_COMPILER_LAUNCHER"] = cxx_launcher
py_limited = resolve_py_limited_api(self.options.get_safe("pyLimitedAPI"))
tc.cache_variables["PY_LIMITED_API"] = py_limited
print(f"{statusColor}PY_LIMITED_API={py_limited}{endColor}")
# Generate!
tc.generate()
def build(self):
cmake = CMake(self)
print(statusColor + "Configuring cmake..." + endColor)
cmake.configure()
if self.options.get_safe("managePipEnvironment"):
# TODO: it's only needed when conanfile.py is handling pip installations.
self.add_basilisk_to_sys_path()
if self.options.get_safe("buildProject"):
print(statusColor + "\nCompiling Basilisk..." + endColor)
start = datetime.now()
cmake.build()
print("Total Build Time: " + str(datetime.now() - start))
print(f"{statusColor}The Basilisk build is successful and the scripts are ready to run{endColor}")
# On Windows, copy project-built DLLs next to the Python extension modules
# so they are bundled in the wheel and resolvable at runtime without PATH tweaks.
if self.settings.os == "Windows":
basilisk_dst_root = os.path.join(self.build_folder, "Basilisk")
common_srcs = [
os.path.join(self.build_folder, "bin"),
os.path.join(self.build_folder, "Release"),
os.path.join(self.build_folder, "Debug"),
]
for src in common_srcs:
if os.path.isdir(src):
try:
copy(self, "*.dll", src, basilisk_dst_root)
except Exception as e:
self.output.warning(f"Failed to copy DLLs from {src}: {e}")
# As a fallback, scan the build tree for any remaining DLLs.
for root, dirs, files in os.walk(self.build_folder):
# Skip the destination and Cargo's build-only proc-macro DLLs.
if not should_scan_windows_dll_directory(root, self.build_folder):
dirs.clear()
continue
if any(f.lower().endswith(".dll") for f in files):
try:
copy(self, "*.dll", root, basilisk_dst_root)
except Exception as e:
self.output.warning(f"Failed to copy DLLs from {root}: {e}")
# Rename DLLs to lowercase
for path in glob(os.path.join(basilisk_dst_root, "*.dll")):
base = os.path.basename(path)
lower = base.lower()
if base != lower:
tmp = os.path.join(basilisk_dst_root, f".{lower}.tmp")
os.replace(path, tmp)
os.replace(tmp, os.path.join(basilisk_dst_root, lower))
else:
print(f"{statusColor}Finished configuring the Basilisk project.{endColor}")
if self.settings.os != "Linux":
print(f"{statusColor}Please open project file inside dist3 with IDE "
f"and build the project for {self.settings.build_type}{endColor}")
else:
print(f"{statusColor}Please go to dist3 folder and run command "
f"`make -j <number of threads to use>`{endColor}")
return
def add_basilisk_to_sys_path(self):
print(f"{statusColor}Adding Basilisk module to python{endColor}\n")
# NOTE: "--no-build-isolation" is used here only to force pip to use the
# packages installed directly by this Conanfile (using the
# "managePipEnvironment" option). Otherwise, it is not necessary.
add_basilisk_module_command = [sys.executable, "-m", "pip", "install", "--no-build-isolation", "-e", "../"]
if self.options.get_safe("examples"):
add_basilisk_module_command[-1] = "../[examples]"
if self.options.get_safe("allOptPkg"):
# Install the optional requirements as well
add_basilisk_module_command[-1] = "../[optional]"
if not is_running_virtual_env() and self.options.get_safe("autoKey") != 's':
add_basilisk_module_command.append("--user")
process = subprocess.Popen(add_basilisk_module_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
output, err = process.communicate()
if process.returncode:
print("Error %s while running %s" % (err.decode(), add_basilisk_module_command))
sys.exit(1)
else:
print("This resulted in the stdout: \n%s" % output.decode())
if err.decode() != "":
print("This resulted in the stderr: \n%s" % err.decode())
def get_mujoco_version():
with open("./libs/mujoco/version.txt") as f:
return f.read().strip()
def is_conan_package_available(ref: str):
"""
Run 'conan list' and return True if package exists in local or remote caches.
"""
try:
output = subprocess.check_output(
[sys.executable, "-m", "conans.conan", "list", ref, "-c", "-f", "json", "-verror"],
stderr=subprocess.STDOUT,
universal_newlines=True
)
parsed = json.loads(output)
return any( "error" not in v for v in parsed.values() )
except subprocess.CalledProcessError:
return False
def conan_create_mujoco(print_fn: Optional[Callable[[str], None]] = print):
"""
If the 'mujoco/VERSION' package is not found in any remote or the local cache,
then the mujoco project (as defined in '/libs/mujoco/conanfile.py') is created
into the local cache.
"""
ref = f"mujoco/{get_mujoco_version()}"
if not is_conan_package_available(ref):
if print_fn is not None:
print_fn(f"Package {ref} not found locally, creating it...")
# Run 'conan create' in the external recipe directory
subprocess.run([sys.executable, "-m", "conans.conan", "create", ".", "-s" ,"compiler.cppstd=17"], cwd="./libs/mujoco" )
else:
if print_fn is not None:
print_fn(f"Package {ref} already available, skipping creation.")
if __name__ == "__main__":
# make sure conan is configured to use the libstdc++11 by default
# XXX: This needs to be run before dispatching to Conan (i.e. outside of the
# ConanFile object), because it affects the configuration of the first run.
# (Running it here fixes https://github.com/AVSLab/basilisk/issues/525)
try:
subprocess.check_output([sys.executable, "-m", "conans.conan", "profile", "detect", "--exist-ok"])
except:
# if profile already exists the above command returns an error. Just ignore in this
# case. We don't want to overwrite an existing profile file
pass
print(statusColor + "Checking conan configuration:" + endColor + " Done")
parser = argparse.ArgumentParser(description="Configure the Basilisk framework.")
# define the optional arguments
parser.add_argument("--generator", help="cmake generator")
parser.add_argument("--buildType", help="build type", default="Release", choices=["Release", "Debug"])
# parser.add_argument("--clean", help="make a clean distribution folder", action="store_true")
for opt, value in bskModuleOptionsBool.items():
parser.add_argument("--" + opt, help="build modules for " + opt + " behavior", default=value[1],
type=lambda x: (str(x).lower() == 'true'))
for opt, value in bskModuleOptionsString.items():
parser.add_argument("--" + opt, help="using string option for " + opt, default=value[1])
for opt, value in bskModuleOptionsFlag.items():
if sys.version_info < (3, 9, 0):
parser.add_argument("--" + opt, help="using flag option for " + opt, default=value[1], action='store_true')
else:
parser.add_argument("--" + opt, help="using flag option for " + opt, default=value[1],
action=argparse.BooleanOptionalAction)
args = parser.parse_args()
# set the build destination folder
# buildFolderName = 'dist3/conan'
# run the auto-module generation script
# this ensures that this script is up-to-date with the latest BSK code base
# and that the associated unit test draft file runs
print(statusColor + "Auto-Generating Draft Modules... " + endColor, end=" ")
genMod = makeDraftModule.moduleGenerator()
genMod.cleanBuild = True
genMod.verbose = False
makeDraftModule.fillCppInfo(genMod)
genMod.createCppModule()
makeDraftModule.fillCInfo(genMod)
genMod.createCModule()
print("Done")
# If we're missing MuJoCo, create the conan package
if args.mujoco:
conan_create_mujoco()
# setup conan install command arguments
conanInstallArgs = [sys.executable, "-m", "conans.conan", "install", ".", "--build=missing"]
# setup arguments shared by conan install and conan build
conanBuildOptionsList = ["-s", "build_type=" + str(args.buildType)]
conanBuildOptionsList.extend(["-s", "compiler.cppstd=17"])
if os.name != "nt":
conanBuildOptionsList.extend(["-s", "compiler.cstd=gnu17"])
if args.generator:
conanBuildOptionsList.extend(["-o", "&:generator=" + str(args.generator)])
for opt, value in bskModuleOptionsBool.items():
conanBuildOptionsList.extend(["-o", "&:" + opt + "=" + str(vars(args)[opt])])
conanInstallArgs.extend(conanBuildOptionsList) # arguments get used in both install and build
# Most of these options go to both conan install and build commands
for opt, value in bskModuleOptionsString.items():
if str(vars(args)[opt]):
if opt == "pathToExternalModules":
externalPath = os.path.abspath(str(vars(args)[opt]).rstrip(os.path.sep))
if os.path.exists(externalPath):
conanInstallArgs.extend(["-o", "&:" + opt + "=" + externalPath])
conanBuildOptionsList.extend(["-o", "&:" + opt + "=" + externalPath])
else:
print(f"{failColor}Error: path {str(vars(args)[opt])} does not exist{endColor}")
sys.exit(1)
else:
if opt != "autoKey":
conanInstallArgs.extend(["-o", "&:" + opt + "=" + str(vars(args)[opt])])
conanBuildOptionsList.extend(["-o", "&:" + opt + "=" + str(vars(args)[opt])])
# only used for conan install arguments, not build
for opt, value in bskModuleOptionsFlag.items():
if vars(args)[opt]:
conanInstallArgs.extend(["-o", "&:" + opt + "=True"])
print(statusColor + "Running conan install:" + endColor)
print(shlex.join(conanInstallArgs))
completedProcess = subprocess.run(conanInstallArgs, check=True)
# run conan build
buildCmd = [sys.executable, "-m", "conans.conan", "build", "."] + conanBuildOptionsList
print(statusColor + "Running conan build:" + endColor)
print(shlex.join(buildCmd))
completedProcess = subprocess.run(buildCmd, check=True)