http://jenyay.net/Programming/PyPlugins
Делаем плагины на Python
Введение
Многие программы поддерживают так называемые плагины (дополнение, расширения и т.п.), с помощью которых можно расширять функциональность программы. На Python делать программы, поддерживающие плагины особенно легко и приятно. Потому что с одной стороны с качестве плагина могут выступать полноценные классы, а с другой стороны благодаря кроссплатформенности языка Python плагины так же остаются кроссплатформенными. Давайте посмотрим что нужно сделать, чтобы ваша программа тоже поддерживала плагины. Заодно убедимся как это легко.
Первый пример. Основные функции
Вначале давайте договоримся о структуре тестовых примеров. Модуль основной программы будет называться main.py, а плагины будут лежать в папке
plugins, располагающейся рядом с этим файлом. Чтобы Python принял plugins за пакет, в нем должен находиться файл с именем
__init__.py (в нашем случае он будет пустым).
Сначала представим, что динамически во время выполнения программы нам не нужно узнавать имя плагина и мы его знаем на этапе программирования. Пусть плагин имеет имя
my_plugin.py и располагается в папке
plugins. И пусть внутри файла
my_plugin.py находится класс
pluginClass, который содержит всю функциональность плагина. Вот его код:
PHP код:
class pluginClass (object):
def __init__(self):
pass
def run (self):
print "Hello, Plug-in!"
В конечном итоге нам необходимо во время выполнения программы добраться до этого класса, создать его экземпляр и выполнить метод run. Для простоты на первое время договоримся, что в этом модуле нет других классов кроме
pluginClass. Как бы мы поступили, если бы все имена (и модуля, и класса) были бы доступны во время программирования? Скорее всего вот так:
PHP код:
import plugins.my_plugin
cls = plugins.my_plugin.pluginClass ()
cls.run()
И в результате получили бы сообщение
"Hello, Plug-in!". А теперь вернемся к нашей задаче. Нам нужно сделать то же самое, но при этом имя модуля
my_plugin и имя класса
pluginClass хранится в соответствующих строковых переменных.
Импорт модуля плагина
Аналогом встроенной директивы import является функция
__import__ , она позволяет импортировать модули, имена которых на этапе написания программы неизвестны. У функции
__import__ пять параметров, но обязательным является только первый. Необязательные параметры в данной статье мы использовать не будем, поэтому про них умолчим. Итак, единственный обязательный параметр - это имя пакета или модуля, который мы хотим импортировать. Если импорт пройдет удачно, функция возвратит экземпляр класса, который хранит все импортированные элементы.
Начнем с импортирования модуля. Директива
import нам не поможет. Зато мы можем воспользоваться функцией
__import__ . Аналогом первой строки из записанного выше примера будет следующий код:
PHP код:
package_obj = __import__("plugins.my_plugin")
После этого переменная
package_obj станет экземпляром класса загруженного модуля (пакета)
plugins. Чтобы убедиться в этом выполним команду
При этом мы получим что-то вроде (путь, разумеется, может быть другой):
Код:
<module 'plugins' from 'H:\Projects\Tests\PyPlugins\test1\plugins\__init__.pyc'>
Это сообщение мало информативно, поэтому применим к переменной package_obj встроенную функцию dir, которая возвращает имеющиеся в package_obj атрибуты. Итак, выполним следующий код:
В результате на экран выведется такой список:
Код:
['__builtins__', '__doc__', '__file__', '__name__', '__path__', 'my_plugin']
Обратите внимание на последний элемент списка - это и есть наш плагин. Итак, пакет мы загрузили, но как нам добраться до модуля нашего плагина? Для этого сначала воспользуемся встроенной функцией getattr, которая позволяет получить из модуля или пакета (в нашем случае package_obj) экземпляр класса атрибута (а нашем случае my_plugin). Эта функция принимает два параметра: соответственно экземпляр объекта, атрибут которого надо получить и строковую переменную, которая содержит имя атрибута. Применяя функцию getattr на пакет, в случае успеха мы получим экземпляр загруженного модуля. Выполним следующий код:
PHP код:
module_obj = getattr (package_obj, "my_plugin")
print module_obj
Если все прошло удачно, на экране мы увидим примерно такой результат:
Код:
<module 'plugins.my_plugin' from 'H:\Projects\Tests\PyPlugins\test1\plugins\my_plugin.pyc'>
Но скорее всего в программе придется загружать не один плагин, а несколько. Как в этом случае поведет себя функция __import__ ? Рассмотрим пример, в котором загружаются два плагина (все они должны находиться в папке plugins.
PHP код:
#-*- coding: utf-8 -*-
modulename1 = "my_plugin_1"
modulename2 = "my_plugin_2"
classname = "pluginClass1"
package_obj = __import__("plugins." + modulename1 )
package_obj = __import__("plugins." + modulename2 )
print dir(package_obj)
В результате на экране вы увидите следующий результат:
Код:
['__builtins__', '__doc__', '__file__', '__name__', '__path__', 'my_plugin_1', 'my_plugin_2']
В этом примере результат импорта мы каждый раз присваиваем одной и той же переменной. Но в результате после каждой операции импорта в нее добавляется новый импортированный модуль. Скачать этот пример можно по адресу -
http://jenyay.net/uploads/Programming/PyPlugins/test1_1.zip
Получаем доступ к классу
Итак, модуль my_plugin мы загрузили. Осталось добраться до класса, который содержится внутри. Для этого воспользуемся уже знакомой нам функцией dir и убедимся, внутри действительно хранится наш класс:
В результате выполнения этого кода получим:
Код:
['__builtins__', '__doc__', '__file__', '__name__', 'pluginClass']
Как видим, класс pluginClass действительно содержится внутри module_obj. Снова воспользуемся функцией getattr:
PHP код:
obj = getattr (module_obj, "pluginClass")
В принципе, уже после этого мы можем сделать экземпляр класса pluginClass, но для начала сделаем небольшую проверку того, что мы получили. Убедимся, что полученный объект действительно является классом, причем классом, вроизводным от object. Для этого воспользуемся встроенной функцией issubclass. Как ее использовать ясно из следующего кода:
PHP код:
if issubclass (obj, object):
a = obj()
a.run()
else:
print "Not class"
Если все сделано правильно, то в результате мы увидим сообщение "Hello, Plug-in!"
И все вместе
Теперь для наглядности сведем вместе весь код, что мы раньше написали. В комментариях после операторов print приведено то, что они выведут на экран.
PHP код:
#-*- coding: utf-8 -*-
modulename = "my_plugin"
classname = "pluginClass"
package_obj = __import__("plugins." + modulename )
print package_obj
# <module 'plugins' from 'H:\Projects\Tests\PyPlugins\test1\plugins\__init__.pyc'>
print dir(package_obj)
# ['__builtins__', '__doc__', '__file__', '__name__', '__path__', 'my_plugin']
module_obj = getattr (package_obj, modulename)
print module_obj
# <module 'plugins.my_plugin' from 'H:\Projects\Tests\PyPlugins\test1\plugins\my_plugin.pyc'>
print dir (module_obj)
# ['__builtins__', '__doc__', '__file__', '__name__', 'pluginClass']
obj = getattr (module_obj, classname)
if issubclass (obj, object):
print obj
# <class 'plugins.my_plugin.pluginClass'>
a = obj()
print a
# <plugins.my_plugin.pluginClass object at 0x00AF9750>
a.run()
else:
print "Not class"
Скачать этот пример можно по ссылке -
http://jenyay.net/uploads/Programming/PyPlugins/test1.zip
Делаем плагины на Python
Похожие темы
Древовидный вид