Simplifying some of the install criterion (#306)

* better compiler support

* trying to clean up some stuff

* closer to master

* closer to master

* build but dont activate at install time

* print license key warning

Author: machinaut

mujoco_py/__init__.py

@@ -1,3 +1,5 @@
+#!/usr/bin/env python
+import os
 from mujoco_py.builder import cymj, ignore_mujoco_warnings, functions, MujocoException
 from mujoco_py.generated import const
 from mujoco_py.mjrenderpool import MjRenderPool
@@ -27,4 +29,10 @@
            'ignore_mujoco_warnings', 'const', "functions",
            "__version__", "get_version"]
 
-mujoco_py.builder.activate()
+
+# Print out a warning if we can't find the key.
+# this is nicer than failing activation, which we can not do in python.
+# The mujoco library exits the process forcibly, in a way we can't try/catch.
+mujoco_py.builder.find_key()
+if not os.environ.get('MUJOCO_PY_SKIP_ACTIVATE'):
+    mujoco_py.builder.activate()

mujoco_py/builder.py

@@ -88,6 +88,14 @@ def load_cython_ext(mjpro_path):
 
     with LockFile(lockpath):
         mod = None
+        force_rebuild = os.environ.get('MUJOCO_PY_FORCE_REBUILD')
+        if force_rebuild:
+            # Try to remove the old file, ignore errors if it doesn't exist
+            print("Removing old mujoco_py cext", cext_so_path)
+            try:
+                os.remove(cext_so_path)
+            except OSError:
+                pass
         if exists(cext_so_path):
             try:
                 mod = load_dynamic_ext('cymj', cext_so_path)
@@ -98,6 +106,7 @@ def load_cython_ext(mjpro_path):
             mod = load_dynamic_ext('cymj', cext_so_path)
     return mod
 
+
 def _ensure_set_env_var(var_name, lib_path):
     paths = os.environ.get(var_name, "").split(":")
     paths = [os.path.abspath(path) for path in paths]
@@ -108,6 +117,7 @@ def _ensure_set_env_var(var_name, lib_path):
                         "export %s=$%s:%s" % (var_name, os.environ.get(var_name, ""),
                                               var_name, var_name, lib_path))
 
+
 def load_dynamic_ext(name, path):
     ''' Load compiled shared object and return as python module. '''
     loader = ExtensionFileLoader(name, path)
@@ -236,9 +246,8 @@ def _build_impl(self):
 
     def get_so_file_path(self):
         dir_path = abspath(dirname(__file__))
-
         python_version = str(sys.version_info.major) + str(sys.version_info.minor)
-        return join(dir_path, "generated", "cymj_%s.so" % self.version)
+        return join(dir_path, "generated", "cymj_{}_{}.so".format(self.version, python_version))
 
 
 class WindowsExtensionBuilder(MujocoExtensionBuilder):
@@ -259,7 +268,6 @@ def __init__(self, mjpro_path):
         self.extension.libraries.extend(['glewosmesa', 'OSMesa', 'GL'])
         self.extension.runtime_library_dirs = [join(mjpro_path, 'bin')]
 
-
     def _build_impl(self):
         so_file_path = super()._build_impl()
         # Removes absolute paths to libraries. Allows for dynamic loading.
@@ -298,22 +306,27 @@ def __init__(self, mjpro_path):
         self.extension.runtime_library_dirs = [join(mjpro_path, 'bin')]
 
     def _build_impl(self):
-        # Prefer GCC 6 for now since GCC 7 may behave differently.
-        c_compilers = ['/usr/local/bin/gcc-6', '/usr/local/bin/gcc-7']
-        available_c_compiler = None
-        for c_compiler in c_compilers:
-            if distutils.spawn.find_executable(c_compiler) is not None:
-                available_c_compiler = c_compiler
-                break
-        if available_c_compiler is None:
-            raise RuntimeError(
-                'Could not find GCC 6 or GCC 7 executable.\n\n'
-                'HINT: On OS X, install GCC 6 with '
-                '`brew install gcc --without-multilib`.')
-        os.environ['CC'] = available_c_compiler
-
-        so_file_path = super()._build_impl()
-        del os.environ['CC']
+        if not os.environ.get('CC'):
+            # Known-working versions of GCC on mac
+            c_compilers = ['/usr/local/bin/gcc-6',
+                           '/usr/local/bin/gcc-7',
+                           '/usr/local/bin/gcc-8']
+            available_c_compiler = None
+            for c_compiler in c_compilers:
+                if distutils.spawn.find_executable(c_compiler) is not None:
+                    available_c_compiler = c_compiler
+                    break
+            if available_c_compiler is None:
+                raise RuntimeError(
+                    'Could not find GCC executable.\n\n'
+                    'HINT: On OS X, install GCC with '
+                    '`brew install gcc`.')
+            os.environ['CC'] = available_c_compiler
+
+            so_file_path = super()._build_impl()
+            del os.environ['CC']
+        else:  # User-directed c compiler
+            so_file_path = super()._build_impl()
         return manually_link_libraries(self.mjpro_path, so_file_path)
 
 
@@ -469,9 +482,30 @@ def build_callback_fn(function_string, userdata_names=[]):
     build_fn_cleanup(name)
     return module.lib.__fun
 
+
+MISSING_KEY_MESSAGE = '''
+You appear to be missing a License Key for mujoco.  We expected to find the
+file here: {}
+
+You can get licenses at this page:
+
+    https://www.roboti.us/license.html
+
+If python tries to activate an invalid license, the process will exit.
+'''
+
+
+def find_key():
+    ''' Try to find the key file, if missing, print out a big message '''
+    if exists(key_path):
+        return
+    print(MISSING_KEY_MESSAGE.format(key_path), file=sys.stderr)
+
+
 def activate():
     functions.mj_activate(key_path)
 
+
 mjpro_path, key_path = discover_mujoco()
 cymj = load_cython_ext(mjpro_path)
 

mujoco_py/version.py

@@ -1,6 +1,6 @@
 __all__ = ['__version__', 'get_version']
 
-version_info = (1, 50, 1, 59)
+version_info = (1, 50, 1, 61)
 # format:
 # ('mujoco_major', 'mujoco_minor', 'mujoco_py_major', 'mujoco_py_minor')
 

setup.py

@@ -1,8 +1,9 @@
 #!/usr/bin/env python3
-import importlib
-from distutils.command.build import build as DistutilsBuild
-from os.path import abspath, join, dirname, realpath
+import os
+from os.path import join, dirname, realpath
 from setuptools import find_packages, setup
+from distutils.command.build import build as DistutilsBuild
+
 
 with open(join("mujoco_py", "version.py")) as version_file:
     exec(version_file.read())
@@ -19,6 +20,15 @@ def read_requirements_file(filename):
 for p in packages:
     assert p == 'mujoco_py' or p.startswith('mujoco_py.')
 
+
+class Build(DistutilsBuild):
+    def run(self):
+        os.environ['MUJOCO_PY_FORCE_REBUILD'] = 'True'
+        os.environ['MUJOCO_PY_SKIP_ACTIVATE'] = 'True'
+        import mujoco_py  # noqa: force build
+        DistutilsBuild.run(self)
+
+
 setup(
     name='mujoco-py',
     version=__version__,  # noqa
@@ -27,6 +37,7 @@ def read_requirements_file(filename):
     url='https://github.com/openai/mujoco-py',
     packages=packages,
     include_package_data=True,
+    cmdclass={'build': Build},
     package_dir={'mujoco_py': 'mujoco_py'},
     package_data={'mujoco_py': ['generated/*.so']},
     install_requires=read_requirements_file('requirements.txt'),