Проверить, существует ли исполняемый файл в Python?
Есть ли в Python портативный и простой способ проверить, существует ли исполняемая программа?
Под простым я имею в виду что-то вроде which
команда, которая была бы просто идеальной. Я не хочу искать PATH вручную или что-то, связанное с попытками выполнить его с Popen
и все и посмотрим, не получится ли (это то, что я делаю сейчас, но представьте, что это launchmissiles
)
21 ответ
Самый простой способ, которым я могу придумать:
def which(program):
import os
def is_exe(fpath):
return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
fpath, fname = os.path.split(program)
if fpath:
if is_exe(program):
return program
else:
for path in os.environ["PATH"].split(os.pathsep):
exe_file = os.path.join(path, program)
if is_exe(exe_file):
return exe_file
return None
Редактировать: Обновлен пример кода, чтобы включить логику для обработки случая, когда предоставленный аргумент уже является полным путем к исполняемому файлу, то есть "which /bin/ls". Это имитирует поведение UNIX команды "which".
Изменить: Обновлено для использования os.path.isfile() вместо os.path.exists() для комментариев.
Редактировать: path.strip('"')
кажется, что здесь делать не так. Ни Windows, ни POSIX, похоже, не поддерживают цитируемые элементы PATH.
Я знаю, что это древний вопрос, но вы можете использовать distutils.spawn.find_executable
, Это было задокументировано с python 2.4 и существует с python 1.6.
import distutils.spawn
distutils.spawn.find_executable("notepad.exe")
Кроме того, Python 3.3 теперь предлагает shutil.which()
,
Для Python 3.2 и более ранних версий:
my_command = 'ls'
any(os.access(os.path.join(path, my_command), os.X_OK) for path in os.environ["PATH"].split(os.pathsep))
Это одна строка ответа Джея, также здесь как лямбда-функция:
cmd_exists = lambda x: any(os.access(os.path.join(path, x), os.X_OK) for path in os.environ["PATH"].split(os.pathsep))
cmd_exists('ls')
Или, наконец, с отступом в виде функции:
def cmd_exists(cmd):
return any(
os.access(os.path.join(path, cmd), os.X_OK)
for path in os.environ["PATH"].split(os.pathsep)
)
Для Python 3.3 и более поздних версий:
import shutil
command = 'ls'
shutil.which(command) is not None
Как один из вкладышей Ян-Филип Gehrcke Ответ:
cmd_exists = lambda x: shutil.which(x) is not None
Как определение:
def cmd_exists(cmd):
return shutil.which(cmd) is not None
Просто не забудьте указать расширение файла в Windows. В противном случае вы должны написать гораздо сложнее is_exe
для окон, использующих PATHEXT
переменная окружения. Вы можете просто использовать FindPath.
OTOH, почему вы вообще пытаетесь найти исполняемый файл? Операционная система сделает это за вас как часть popen
Вызов & вызовет исключение, если исполняемый файл не найден. Все, что вам нужно сделать, это перехватить правильное исключение для данной ОС. Обратите внимание, что в Windows subprocess.Popen(exe, shell=True)
молча провалится, если exe
не найден.
Включение PATHEXT
в вышеупомянутой реализации which
(в ответе Джея):
def which(program):
def is_exe(fpath):
return os.path.exists(fpath) and os.access(fpath, os.X_OK) and os.path.isfile(fpath)
def ext_candidates(fpath):
yield fpath
for ext in os.environ.get("PATHEXT", "").split(os.pathsep):
yield fpath + ext
fpath, fname = os.path.split(program)
if fpath:
if is_exe(program):
return program
else:
for path in os.environ["PATH"].split(os.pathsep):
exe_file = os.path.join(path, program)
for candidate in ext_candidates(exe_file):
if is_exe(candidate):
return candidate
return None
Для платформ *nix (Linux и OS X)
Кажется, это работает для меня:
Отредактирован для работы на Linux, благодаря MestreLion
def cmd_exists(cmd):
return subprocess.call("type " + cmd, shell=True,
stdout=subprocess.PIPE, stderr=subprocess.PIPE) == 0
Здесь мы используем встроенную команду type
и проверка кода выхода. Если такой команды нет, type
выйдет с 1 (или ненулевым кодом состояния в любом случае).
Немного о stdout и stderr - просто заставить замолчать вывод type
команда, так как нас интересует только код состояния выхода.
Пример использования:
>>> cmd_exists("jsmin")
True
>>> cmd_exists("cssmin")
False
>>> cmd_exists("ls")
True
>>> cmd_exists("dir")
False
>>> cmd_exists("node")
True
>>> cmd_exists("steam")
False
Исходя из того, что проще просить прощения, чем разрешения, я бы просто попытался использовать его и поймать ошибку (в данном случае OSError - я проверил, что файл не существует, а файл не является исполняемым, и они оба дают OSError).
Это помогает, если исполняемый файл имеет что-то вроде --version
флаг, который быстро не активен.
import subprocess
myexec = "python2.8"
try:
subprocess.call([myexec, '--version']
except OSError:
print "%s not found on path" % myexec
Это не общее решение, но оно будет самым простым способом для многих случаев использования - тех, где код должен искать один хорошо известный исполняемый файл.
Смотрите модуль os.path для некоторых полезных функций на путевых именах. Чтобы проверить, является ли существующий файл исполняемым, используйте os.access (путь, режим) в режиме os.X_OK.
os.X_OK
Значение, которое нужно включить в параметр mode access(), чтобы определить, может ли быть выполнен путь.
РЕДАКТИРОВАТЬ: предлагаемыйwhich()
реализации отсутствуют один ключ - использованиеos.path.join()
построить полные имена файлов.
Я знаю, что я немного некромант здесь, но я наткнулся на этот вопрос, и принятое решение не сработало для меня во всех случаях. Думаю, что в любом случае это может быть полезно. В частности, обнаружение "исполняемого" режима и требование предоставления расширения файла. Кроме того, оба Python3.3 shutil.which
(использование PATHEXT
) и python2.4+ х distutils.spawn.find_executable
(просто пытается добавить '.exe'
) работать только в подмножестве случаев.
Поэтому я написал "супер" версию (на основе принятого ответа, и PATHEXT
предложение от Сураджа). Эта версия which
выполняет задачу более тщательно, сначала пробует серию "широкофазных" методик в ширину, и в конечном итоге пробует более детальный поиск по PATH
пространство:
import os
import sys
import stat
import tempfile
def is_case_sensitive_filesystem():
tmphandle, tmppath = tempfile.mkstemp()
is_insensitive = os.path.exists(tmppath.upper())
os.close(tmphandle)
os.remove(tmppath)
return not is_insensitive
_IS_CASE_SENSITIVE_FILESYSTEM = is_case_sensitive_filesystem()
def which(program, case_sensitive=_IS_CASE_SENSITIVE_FILESYSTEM):
""" Simulates unix `which` command. Returns absolute path if program found """
def is_exe(fpath):
""" Return true if fpath is a file we have access to that is executable """
accessmode = os.F_OK | os.X_OK
if os.path.exists(fpath) and os.access(fpath, accessmode) and not os.path.isdir(fpath):
filemode = os.stat(fpath).st_mode
ret = bool(filemode & stat.S_IXUSR or filemode & stat.S_IXGRP or filemode & stat.S_IXOTH)
return ret
def list_file_exts(directory, search_filename=None, ignore_case=True):
""" Return list of (filename, extension) tuples which match the search_filename"""
if ignore_case:
search_filename = search_filename.lower()
for root, dirs, files in os.walk(path):
for f in files:
filename, extension = os.path.splitext(f)
if ignore_case:
filename = filename.lower()
if not search_filename or filename == search_filename:
yield (filename, extension)
break
fpath, fname = os.path.split(program)
# is a path: try direct program path
if fpath:
if is_exe(program):
return program
elif "win" in sys.platform:
# isnt a path: try fname in current directory on windows
if is_exe(fname):
return program
paths = [path.strip('"') for path in os.environ.get("PATH", "").split(os.pathsep)]
exe_exts = [ext for ext in os.environ.get("PATHEXT", "").split(os.pathsep)]
if not case_sensitive:
exe_exts = map(str.lower, exe_exts)
# try append program path per directory
for path in paths:
exe_file = os.path.join(path, program)
if is_exe(exe_file):
return exe_file
# try with known executable extensions per program path per directory
for path in paths:
filepath = os.path.join(path, program)
for extension in exe_exts:
exe_file = filepath+extension
if is_exe(exe_file):
return exe_file
# try search program name with "soft" extension search
if len(os.path.splitext(fname)[1]) == 0:
for path in paths:
file_exts = list_file_exts(path, fname, not case_sensitive)
for file_ext in file_exts:
filename = "".join(file_ext)
exe_file = os.path.join(path, filename)
if is_exe(exe_file):
return exe_file
return None
Использование выглядит так:
>>> which.which("meld")
'C:\\Program Files (x86)\\Meld\\meld\\meld.exe'
Принятое решение у меня не сработало в этом случае, так как были такие файлы, как meld.1
, meld.ico
, meld.doap
и т. д. также в каталоге, один из которых был возвращен (предположительно, начиная с лексикографически первого), потому что выполняемый тест в принятом ответе был неполным и дал ложные срабатывания.
Лучшим примером должен быть встроенный модуль Python shutil.which() в Python 3. Ссылка: https://hg.python.org/cpython/file/default/Lib/shutil.py
Добавлена поддержка Windows
def which(program):
path_ext = [""];
ext_list = None
if sys.platform == "win32":
ext_list = [ext.lower() for ext in os.environ["PATHEXT"].split(";")]
def is_exe(fpath):
exe = os.path.isfile(fpath) and os.access(fpath, os.X_OK)
# search for executable under windows
if not exe:
if ext_list:
for ext in ext_list:
exe_path = "%s%s" % (fpath,ext)
if os.path.isfile(exe_path) and os.access(exe_path, os.X_OK):
path_ext[0] = ext
return True
return False
return exe
fpath, fname = os.path.split(program)
if fpath:
if is_exe(program):
return "%s%s" % (program, path_ext[0])
else:
for path in os.environ["PATH"].split(os.pathsep):
path = path.strip('"')
exe_file = os.path.join(path, program)
if is_exe(exe_file):
return "%s%s" % (exe_file, path_ext[0])
return None
Я нашел что-то в Stackru, которое решило проблему для меня. Это работает при условии, что исполняемый файл имеет параметр (например, --help или --version), который выводит что-либо и возвращает нулевой статус выхода. См. Подавление вывода в вызовах Python для исполняемых файлов - "результат" в конце фрагмента кода в этом ответе будет нулевым, если исполняемый файл находится в пути, иначе скорее всего он будет равен 1.
Это кажется достаточно простым и работает как в Python 2 и 3
try: subprocess.check_output('which executable',shell=True)
except: sys.exit('ERROR: executable not found')
Вы можете попробовать внешнюю библиотеку под названием "sh" ( http://amoffat.github.io/sh/).
import sh
print sh.which('ls') # prints '/bin/ls' depending on your setup
print sh.which('xxx') # prints None
Важный вопрос: " Зачем вам проверять, существует ли исполняемый файл?" Может, нет?;-)
Недавно мне понадобился этот функционал, чтобы запустить просмотрщик для файла PNG. Я хотел перебрать несколько предопределенных зрителей и запустить первое из существующих. К счастью я наткнулся os.startfile
, Это намного лучше! Простой, переносимый и использует средство просмотра по умолчанию в системе:
>>> os.startfile('yourfile.png')
Обновление: я был неправ os.startfile
быть портативным... это только Windows. На Mac вы должны запустить open
команда. А также xdg_open
на Unix. Существует проблема с Python при добавлении поддержки Mac и Unix для os.startfile
,
Если у вас есть bash
и функция sh
(subprocess.Popen( ... ).communicate()
),
использовать bash
встроенная type
:
type -p ls => /bin/ls
type -p nonesuch => ""
Ни один из предыдущих примеров не работает на всех платформах. Обычно они не работают в Windows, потому что вы можете выполнить без расширения файла и что вы можете зарегистрировать новое расширение. Например, в Windows, если python хорошо установлен, достаточно запустить file.py, и он будет работать.
Единственное верное и переносимое решение, которое у меня было, - выполнить команду и увидеть код ошибки. Любой приличный исполняемый файл должен иметь набор параметров вызова, который ничего не будет делать.
Вы можете сказать, существует ли файл с модулем os. в частности, исполняемый файл выглядит довольно непереносимым, учитывая, что на nix исполняется множество вещей, которых нет на windows, и наоборот.
Казалось бы, очевидным выбором является "который", анализируя результаты с помощью popen, но вы можете смоделировать его в противном случае, используя класс os. В псевдопионе это будет выглядеть так:
for each element r in path:
for each file f in directory p:
if f is executable:
return True
Поэтому в основном вы хотите найти файл в смонтированной файловой системе (не обязательно только в каталогах PATH) и проверить, является ли он исполняемым. Это переводит на следующий план:
- перечислить все файлы в локально смонтированных файловых системах
- результаты поиска по шаблону имени
- для каждого найденного файла проверьте, является ли он исполняемым
Я бы сказал, что это портативное решение потребует больших вычислительных ресурсов и времени. Это действительно то, что вам нужно?
Использование библиотеки тканей Python:
from fabric.api import *
def test_cli_exists():
"""
Make sure executable exists on the system path.
"""
with settings(warn_only=True):
which = local('which command', capture=True)
if not which:
print "command does not exist"
assert which