“Правильный” способ добавить сценарии Python к приложению не-Python

Одним из эффективных способов достижения этой цели является использование архитектуры передачи сообщений/обмена процессами, позволяющей достичь цели с помощью Python, но не ограничивающейся Python.

------------------------------------
| App  <--> Ext. API <--> Protocol | <--> (Socket) <--> API.py <--> Script
------------------------------------

Эта диаграмма пытается показать следующее: Ваше приложение взаимодействует с внешними процессами (например, Python), используя передачу сообщений. Это эффективно на локальной машине и может быть переносимым, поскольку вы определяете свой собственный протокол. Единственное, что вы должны предоставить своим пользователям, это библиотеку Python, которая реализует ваш пользовательский API и взаимодействует с помощью цикла передачи-получения сообщений между скриптом пользователя и вашим приложением.

Определите внешний API вашего приложения

Внешний API вашего приложения описывает все функции, с которыми должен иметь возможность взаимодействовать внешний процесс. Например, если вы хотите, чтобы ваш скрипт Python мог нарисовать красный круг в вашем приложении, ваш внешний API может включать Draw(Object, Color, Position).

Определите протокол связи

Это протокол, который внешние процессы используют для связи с вашим приложением через внешний API. Популярными вариантами для этого могут быть XML-RPC, SunRPC, JSON или ваш собственный протокол и формат данных. Выбор должен быть достаточным для вашего API. Например, если вы собираетесь передавать двоичные данные, то JSON может потребовать кодировки base64, в то время как SunRPC предполагает двоичную передачу данных.

Постройте систему обмена сообщениями вашего приложения

Это просто как бесконечный цикл, принимающий сообщения в вашем коммуникационном протоколе, обслуживающий запрос в вашем приложении и отвечающий на него через тот же сокет/канал. Например, если вы выбрали JSON, то вы получите сообщение, содержащее инструкции по выполнению Draw(Object, Color, Position). После выполнения запроса вы бы ответили на него.

Создание библиотеки обмена сообщениями для Python (или любой другой)

Это еще проще. Опять же, это цикл, посылающий и принимающий сообщения от имени пользователя библиотеки (т.е. ваших пользователей, пишущих скрипты на Python). Единственное, что должна делать эта библиотека, это предоставлять программный интерфейс к внешнему API вашего приложения и переводить запросы в ваш протокол связи, все это скрыто от ваших пользователей.

Использование Unix Sockets, например, будет чрезвычайно быстрым.

Plugin/Application Rendezvous

Обычная практика обнаружения подключаемых модулей приложения заключается в указании "хорошо известного" каталога, в котором должны быть размещены подключаемые модули. Это может быть, например, так:

~/.myapp/plugins

Следующим шагом будет поиск вашим приложением в этом каталоге существующих плагинов. Ваше приложение должно обладать некоторым умом, чтобы уметь различать скрипты Python, которые являются и не являются настоящими скриптами для вашего приложения.

Предположим, что ваш протокол взаимодействия определяет, что каждый скрипт будет взаимодействовать с помощью JSON через StdInput/StdOuput. Простой и эффективный подход заключается в том, чтобы указать в протоколе, что при первом запуске скрипта он посылает MAGIC_ID в стандартный выход. То есть, ваше приложение считывает первые, скажем, 8 байт и ищет определенное 64-битное значение, которое идентифицирует его как сценарий.

Дополнительно, вы должны включить в свой External API методы, позволяющие вашим скриптам идентифицировать себя. Например, сценарий должен иметь возможность сообщить приложению через External API такие вещи, как Name, Description, Capabilities, Expectations, по существу информируя приложение о том, что он собой представляет и что он будет делать.