General: Custom function for find executable #2822
Conversation
openpype/lib/vendor_bin_utils.py
Outdated
| def find_executable(executable): | ||
| """Find full path to executable. | ||
|
|
||
| Also tries additional extensions if passed executable does not contain one. | ||
|
|
||
| Paths where it is looked for executable is defined by 'PATH' environment | ||
| variable, 'os.confstr("CS_PATH")' or 'os.defpath'. | ||
|
|
||
| Args: | ||
| executable(str): Name of executable with or without extension. Can be | ||
| path to file. | ||
|
|
||
| Returns: | ||
| str: Full path to executable with extension (is file). | ||
| None: When the executable was not found. | ||
| """ | ||
| if os.path.isfile(executable): | ||
| return executable | ||
|
|
||
| low_platform = platform.system().lower() | ||
| _, ext = os.path.splitext(executable) | ||
| variants = [executable] | ||
| if not ext: | ||
| if low_platform == "windows": | ||
| exts = [".exe", ".ps1", ".bat"] | ||
| for ext in os.getenv("PATHEXT", "").split(os.pathsep): | ||
| ext = ext.lower() | ||
| if ext and ext not in exts: | ||
| exts.append(ext) | ||
| else: | ||
| exts = [".sh"] | ||
|
|
||
| for ext in exts: | ||
| variant = executable + ext | ||
| if os.path.isfile(variant): | ||
| return variant | ||
| variants.append(variant) | ||
|
|
||
| path_str = os.environ.get("PATH", None) | ||
| if path_str is None: | ||
| if hasattr(os, "confstr"): | ||
| path_str = os.confstr("CS_PATH") | ||
| elif hasattr(os, "defpath"): | ||
| path_str = os.defpath | ||
|
|
||
| if not path_str: | ||
| return None | ||
|
|
||
| paths = path_str.split(os.pathsep) | ||
| for path in paths: | ||
| for variant in variants: | ||
| filepath = os.path.abspath(os.path.join(path, executable)) | ||
| if os.path.isfile(filepath): | ||
| return filepath | ||
| return None |
There was a problem hiding this comment.
Out of curiosity. What is this logic based on? It looks like distutils.find_executable but does not look like recent code?
There was a problem hiding this comment.
Source was distutils, but slightly modified. In distutils find_executable always expect ".exe" on windows, this adds other options from PATHEXT and .sh for linux and mac.
There was a problem hiding this comment.
For reference sake this is what which does in Avalon core which looks somewhat similar
There was a problem hiding this comment.
Handle less cases. When passed executable is existing path it should just return it. If the passed executable is path but don't have extension then this function will just add extension and return it. Then will start to look into PATH for possible variants.
Adding the os.access(filepath, os.X_OK) seems like a good idea.
|
Just warning about And there is unfortunately one common scenario (and I am not saying we should handle it - just be aware of it) - with mixed windows/linux environments sometimes they have share permission set so |
@64qam could you find a time to test this on linux? |
Brief description
We're using
find_executablefrom distutils but it seems that they'll get deprecated soon and may not work as expected also some older hosts have issues with using distutils too.Description
Added custom
find_executablewhich should return full path to an executable file.Changes
find_executableinopenpype/libmaketxin extract look does not add".exe"Testing notes: