Merge branch 'master' of https://github.com/intersystems-ru/PythonAdapter

# Conflicts:
#	sc-list.txt

Author: lukyanchikov

.gitignore

@@ -0,0 +1,52 @@
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 InterSystems
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,47 @@
+# PythonAdapter
+Python adapter via callout for InterSystems Data Platforms.
+
+# Installation
+
+1. Load ObjectScript code.
+2. Place callout DLL in `bin` folder.
+3. Check that your `PYTHONHOME` environment variable points to Python 3.6. 
+4. Check that your SYSTEM `PATH` environment variable has `PYTHONHOME` variable (or directory it points to).
+
+# Use
+
+1. Call: `do ##class(isc.py.Callout).Setup()` once per systems start (add to ZSTART!)
+2. Call: `do ##class(isc.py.Callout).Initialize()` once per process
+3. Call main method (can be called many times, context persists): `write ##class(isc.py.Callout).SimpleString(code, data)`
+4. Call: `do ##class(isc.py.Callout).Finalize()` to free Python context
+5. Call: `write ##class(isc.py.Callout).Unload()` to free callout library
+
+```
+do ##class(isc.py.Callout).Setup() 
+do ##class(isc.py.Callout).Initialize()
+write ##class(isc.py.Callout).SimpleString("x='ПРИВЕТ'","x")
+write ##class(isc.py.Callout).SimpleString("x=repr('ПРИВЕТ')","x")
+write ##class(isc.py.Callout).SimpleString("x=123","x")
+do ##class(isc.py.Callout).Finalize()
+write ##class(isc.py.Callout).Unload()
+```
+
+# Test Business Process
+
+Along with callout code and Interoperability adapter there's also a test Interoperability Production and test Business Process. To use them:
+
+1. In OS bash execute `python -m pip install  pyodbc pandas matplotlib seaborn`. 
+2. Execute: `do ##class(isc.py.test.CannibalizationData).Import()` to populate test data.
+3. Create ODBC connection to the namespace with data
+4. In test Business Process `isc.py.test.Process` edit annotation for `Correlation Matrix: Tabular` call, specifying correct ODBC DSN in line 3
+5. Edit annotation for `Correlation Matrix: Graph` call, specifying valid filepath for `f.savefig` function.
+6. Save and compile business process.
+7. Start `isc.py.test.Production` production.
+8. Send empty `Ens.Request` mesage to the `isc.py.test.Process`.
+
+
+
+# Development
+
+Development of ObjectScript is done via [cache-tort-git](https://github.com/MakarovS96/cache-tort-git) in UDL mode. 
+Development of C code is done in Eclipse.

c/Makefile

@@ -0,0 +1,58 @@
+CC := gcc
+RM := rm
+CD := cd
+MAKE := make
+
+CFLAGS += -Wall -Wextra -fpic -O2 -fno-strict-aliasing -Wno-unused-parameter
+
+
+SYS := $(shell gcc -dumpmachine)
+
+ifeq ($(SYS), x86_64-w64-mingw32)
+	BUILDSYS := $(SYS)
+else
+	BUILDSYS := $(shell bash $(LIBFFI_PATH)/config.guess)
+endif
+
+ifneq (, $(findstring linux, $(SYS)))
+	SUFFIX := so
+	LDFLAGS := -shared
+	LIBS += -ldl
+else ifneq (, $(findstring mingw, $(SYS)))
+	SUFFIX := dll
+	LDFLAGS := -shared
+else 
+	$(error Unsupported build platform)
+endif
+
+
+
+
+ifndef GLOBALS_HOME
+    $(error Couldn't find GLOBALS_HOME)
+endif
+
+ifndef PYTHONHOME
+    $(error Couldn't find PYTHONHOME)
+endif
+
+PYTHONVER := $(shell ${PYTHONHOME}python -c "import sys; print(sys.version_info[0],sys.version_info[1],sep='')")
+LIBS  = -lpython${PYTHONVER}
+
+LDFLAGS += -L${PYTHONHOME}/Libs
+
+INCLUDES += -I${GLOBALS_HOME}/dev/cpp/include
+INCLUDES += -I${PYTHONHOME}/include
+CFLAGS += $(INCLUDES)
+
+.PHONY: all clean
+
+all: iscpython.$(SUFFIX)
+
+iscpython.o: iscpython.c
+
+iscpython.$(SUFFIX): iscpython.o
+	$(CC) $(LDFLAGS) -o $@ $^ $(LIBS)
+
+clean:
+	$(RM) *.$(SUFFIX) *.o

c/iscpython.c

@@ -0,0 +1,148 @@
+/*
+ ============================================================================
+ Name        : iscpython.c
+ Author      : 
+ Version     :
+ Copyright   : MIT
+ Description : Python callout library for InterSystems Platforms
+ ============================================================================
+ */
+
+#define ZF_DLL  /* Required only for dynamically linked libraries. */
+
+#include <cdzf.h>
+#include <Python.h>
+
+#undef ERROR
+/*
+ *
+ #include <stdio.h>
+ #include <stdlib.h>
+ */
+
+
+// Reference to scope in which top-level code executes.
+PyObject *mainModule;
+
+// Initializes Python environment
+// and obtains reference to the main module, to be used by
+int Initialize() {
+	Py_Initialize();
+	mainModule = PyImport_AddModule("__main__");
+	return ZF_SUCCESS;
+}
+
+int Finalize() {
+	Py_DECREF(mainModule);
+	Py_Finalize();
+	return ZF_SUCCESS;
+}
+
+
+// Test method, returns random double
+int GetRandom(double* random) {
+
+	Py_Initialize();
+	// https://stackoverflow.com/questions/3286448/calling-a-python-method-from-c-c-and-extracting-its-return-value
+	// First, import your module :
+	PyObject* myModuleString = PyUnicode_FromString((char*) "random");
+	PyObject* myModule = PyImport_Import(myModuleString);
+
+	// Then getting a reference to your function :
+	PyObject* myFunction = PyObject_GetAttrString(myModule, (char*) "random");
+	//PyObject* args = PyTuple_Pack(1,PyFloat_FromDouble(2.0));
+	PyObject* args = PyTuple_Pack(0);
+
+	//Then getting your result :
+	PyObject* myResult = PyObject_CallObject(myFunction, args);
+
+	//And getting back to a double :
+	double result = PyFloat_AsDouble(myResult);
+
+	//Py_Main(argc, argv);
+	Py_Finalize();
+	*random = result;
+	// set value to be returned by the $ZF function call
+	return ZF_SUCCESS;   // set the exit status code
+}
+
+// Test method, returns random double
+int GetRandomSimple(double* random) {
+
+	Py_Initialize();
+	PyRun_SimpleString("import random;");
+	PyRun_SimpleString("x=random.random();");
+
+	PyObject *mainModule = PyImport_AddModule("__main__");
+	PyObject *var = PyObject_GetAttrString(mainModule, "x");
+
+	*random = PyFloat_AsDouble(var);
+	Py_Finalize();
+
+	return ZF_SUCCESS;
+}
+
+// Does complete initialization, executes code and finalizes environment
+int SimpleStringFull(char *command, double* result) {
+
+	Py_Initialize();
+	PyRun_SimpleString(command);
+
+	PyObject *mainModule = PyImport_AddModule("__main__");
+	PyObject *var = PyObject_GetAttrString(mainModule, "x");
+
+	*result = PyFloat_AsDouble(var);
+	Py_Finalize();
+
+	return ZF_SUCCESS;
+}
+
+// Assumes initialized environment
+int SimpleString(char *command, char *resultVar, char* result) {
+	PyRun_SimpleString(command);
+
+	int exists = PyObject_HasAttrString(mainModule, resultVar);
+
+	if (exists == 1) {
+		PyObject *var = PyObject_GetAttrString(mainModule, resultVar);
+
+		//PyObject* varStr = PyObject_Repr(var);
+		PyObject* varStr = PyObject_Str(var);
+		char* str  = PyUnicode_AsUTF8(varStr);
+
+		sprintf(result, "%s", str);
+
+		Py_DECREF(varStr);
+		Py_DECREF(var);
+	}
+
+	return ZF_SUCCESS;
+}
+
+// Code for testing and debugging as an executable
+int main(int argc, char **argv) {
+	printf("X: ");
+
+	//double random = 0;
+	//GetRandom(&random);
+	//GetRandomSimple(&random);
+	//printf("%lf", random);
+
+	char* result = malloc(sizeof(char) * 1024);
+
+	Initialize();
+	SimpleString("x=2", "y", result);
+	Finalize();
+
+	printf(result);
+	return EXIT_SUCCESS;
+}
+
+ZFBEGIN
+ZFENTRY("Initialize","",Initialize)
+ZFENTRY("Finalize","",Finalize)
+ZFENTRY("GetRandom","D",GetRandom)
+ZFENTRY("GetRandomSimple","D",GetRandomSimple)
+ZFENTRY("SimpleStringFull","cD",SimpleStringFull)
+ZFENTRY("SimpleString","ccC",SimpleString)
+ZFEND