topic Re: Python Scrits in Alfresco Archive

Python Scrits

johnambrosiano — Tue, 25 Aug 2015 20:44:07 GMT

What's the trick for getting Python scripts enabled in script tasks. I set the scriptFormat value to "python" and it tells me "Can't find scripting engine for 'python'"

Re: Python Scrits

martin_grofcik — Wed, 26 Aug 2015 05:30:17 GMT

Hi John,

the problem could be:
http://activiti.org/userguide/index.html#bpmnScriptTask

The value of the scriptFormat attribute must be a name that is compatible with the JSR-223 (scripting for the Java platform). By default JavaScript is included in every JDK and as such doesn’t need any additional jars. If you want to use another (JSR-223 compatible) scripting engine, it is sufficient to add the corresponding jar to the classpath and use the appropriate name. For example, the Activiti unit tests often use Groovy because the syntax is pretty similar to that of Java.

Do note that the Groovy scripting engine is bundled with the groovy-all jar. Before version 2.0, the scripting engine was part of the regular Groovy jar. As such, one must now add following dependency:…

Regards
Martin

Re: Python Scrits

johnambrosiano — Wed, 26 Aug 2015 15:41:06 GMT

Thanks, Martin. I've seen this before. An example for Python would be helpful. Do you or anyone else know of such an example?

Re: Python Scrits

vasile_dirla — Wed, 26 Aug 2015 21:37:07 GMT

Hi John,
you could use Jython in order to call python scripts.
As of Jython 2.5.1 an implementation of JSR 223 is bundled in jython.jar. Simply add jython to your CLASSPATH and ask for the python script engine as you already mentioned above: "set the scriptFormat value to "python""
http://www.jython.org/

Re: Python Scrits

johnambrosiano — Wed, 26 Aug 2015 23:19:58 GMT

Thanks, Vasile. I'll try it.

Re: Python Scrits

johnambrosiano — Wed, 26 Aug 2015 23:32:25 GMT

Vasile,

Did as you suggested. (1) Using the Activiti Designer Eclipse plugin. (2) Have jython 2.7.0 in the POM for the project.

(3) Defining the following in the script task in the process:

<scriptTask id="scripttask1" name="Script Task"
   activiti:autoStoreVariables="false" scriptFormat="python">
   <script>
    print "Hello"
   </script>
</scriptTask>

(4) Invoking with:

public void startScript() {
ProcessEngine processEngine = ProcessEngineConfiguration
   .createStandaloneInMemProcessEngineConfiguration()
    .buildProcessEngine();
RuntimeService runtimeService = processEngine.getRuntimeService();
RepositoryService repositoryService = processEngine.getRepositoryService();
repositoryService.createDeployment()
   .addClasspathResource("diagrams/HelloScript.bpmn")
   .deploy();
ProcessInstance processInstance = runtimeService.startProcessInstanceByKey(
    "helloScript");
}

(5) Getting these errors:

org.activiti.engine.ActivitiException: Can't find scripting engine for 'python'
at org.activiti.engine.impl.scripting.ScriptingEngines.getEngineByName(ScriptingEngines.java:124)
at org.activiti.engine.impl.scripting.ScriptingEngines.evaluate(ScriptingEngines.java:85)
at org.activiti.engine.impl.scripting.ScriptingEngines.evaluate(ScriptingEngines.java:73)
…

What am I missing? Thanks.

Re: Python Scrits

vasile_dirla — Thu, 27 Aug 2015 07:20:13 GMT

Hi,
just create a unit test to demonstrate what's not working and upload it here (rename the zip extension to txt in order to upload it)

Re: Python Scrits

johnambrosiano — Thu, 27 Aug 2015 18:50:08 GMT

Thanks, Vasile,

Here's a diagram, a test, and the POM file to show the dependencies I've included.

Re: Python Scrits

vasile_dirla — Fri, 28 Aug 2015 15:18:58 GMT

Hi,
I don't have knowledge of python but during the debug I see that the engine cannot import the 'site' module so I decided to disable this (I have no idea what's the impact over the python engine so maybe if you know more about python you can add some more info here.)

https://docs.python.org/2/library/site.html

Anyway.. back to Jython JSR 223 support:
I did a few changes to your code and now it works:
<code>
@Test
@Deployment(resources = {"diagrams/HelloScript.bpmn"})
public void startScript() {

Properties props = new Properties();
props.put("python.import.site","false");
Properties preprops = System.getProperties();
PythonInterpreter.initialize(preprops, props, new String[0]);

ProcessInstance processInstance = activitiRule.getRuntimeService().startProcessInstanceByKey("helloScript");
assert(processInstance.getDeploymentId()!=null);
}
</code>

and also changed the script of your ScriptTask to:
<code>
<script>import sys; a = 42; print a; x = 2 + 2; print "x:",x</script>
</code>

and i can see this result:
<code>
INFO: Processing resource diagrams/HelloScript.bpmn
42
x: 4
</code>

so.. it's working.

There are a few issues as i can see with Jython, if the script contains new lines, it will fail when parsing.
Will be nice if we'll find a nice solution for python scripts in Activiti even that means we'll put some code into Jython or just change it with something else.

Re: Python Scrits

vasile_dirla — Fri, 28 Aug 2015 15:31:25 GMT

not really unsupported, (if you have the proper library which is able to interpret python it's supported)
scripting it's interpreted by an external library so it has nothing to do with Activiti.

Since you are interested by python support you said would like to see that written in the documentation.
but as you know there could be hundreds of script engines in the world what will be if we'll write about all of them ?

Imagine that you could develop your own scripting with support for JSR 233 and you'll be able to use it in java.

see this: https://www.jcp.org/en/jsr/detail?id=223

Re: Python Scrits

johnambrosiano — Fri, 28 Aug 2015 15:48:22 GMT

So it looks like Python is pretty much unsupported at this time. Should probably put that in the documentation somewhere.

I'm not dedicated to Jython, by the way. Just seemed like that was what JSR 223 led me to believe, i.e., it says the interpreter for Python is backed by Jython - if I read it right.

Do you know if there's a workaround, like getting Groovy to call Python or something?

Re: Python Scrits

johnambrosiano — Fri, 28 Aug 2015 15:49:00 GMT

Thanks for your example, by the way. I don't mean to seem ungrateful.

I get your point about scripting not necessarily being the responsibility of Activiti, but Groovy is transparently usable and has a clear example in the user guide. Python is the #1 scripting language in the world, as for instance suggested here http://www.drdobbs.com/jvm/the-rise-and-fall-of-languages-in-2013/240165192

Honestly, I'm not clear on how JSR 223 is supported generally. Perhaps it would help if I learned a bit about that. On Activiti's end, a section in the user guide on the general topic of getting interpreters for the top scripting languages to work with Activiti might be really helpful. For example, my understanding is that Javascript should work out of the box in Activiti like Groovy, but I couldn't get that one to work for me either. Same "cannot find interpreter" error.

Re: Python Scrits

vasile_dirla — Fri, 28 Aug 2015 15:54:51 GMT

this is how you could use a scripting engine form a java app.

<code>
ScriptEngine engine = new ScriptEngineManager().getEngineByName("python");
engine.put("a", "1234");
engine.eval("print a");
</code>

this will work if you have in the classpath the proper jar.

Re: Python Scrits

johnambrosiano — Fri, 28 Aug 2015 16:29:31 GMT

Excellent. Thanks.

Re: Python Scrits

allenhadden — Wed, 06 Apr 2016 13:47:34 GMT

Thank you for posting the code to initialize the Jython runtime! That was quite helpful.

There are a couple of additional pieces of information that might help others. First, it seems like the issue about the "python.import.site" property is discussed in this defect in the Jython project: http://bugs.jython.org/issue2355

Second, I was able to work around the indenting issue like this:

<blockcode>
<script>
<![CDATA[
import sys

a = 42

print a

x = 2 + 2

print "x: ", x
]]>
</script>
</blockcode>

The problem is that indenting is important to Python and what looks normal in XML will not run in Python because of the leading indentation.

Hope this helps.