Use array from C++ as method argument to Python package

This article shows how to pass array as an argument.

Javonet allows you to reference and use modules or packages written in (Java/Kotlin/Groovy/Clojure, C#/VB.NET, Ruby, Perl, Python, JavaScript/TypeScript) like they were created in your technology. If have not yet created your first project check Javonet overview and quick start guides for your technology.

Custom Python package with method accepting array

With Javonet it is possible to reference any custom Python package and interact with arrays declared on types defined within that module almost the same as with any other C++ library.

Snippet below represents the sample code from Python package that has methods which return or process the arrays:

class TestClass:
    def __init__(self, public_value, private_value):
        self.public_value = public_value
        self.private_value = private_value

    def get_1d_array(self):
        return ["one", "two", "three", "four", "five"]
    
    def get_2d_array(self):
        return [["S00", "S01"], ["S10", "S11"]]
    
    def add_array_elements_and_multiply(self, my_array, my_value):
        return sum(my_array) * my_value
def get_1d_array(self):
    return ["one", "two", "three", "four", "five"]

def get_2d_array(self):
    return [["S00", "S01"], ["S10", "S11"]]

def add_array_elements_and_multiply(self, my_array, my_value):
    return sum(my_array) * my_value

With Javonet SDK it is possible to pass array as an argument to one of this method.

Pass C++ array

#include "Javonet.h"
#include <iostream>
#include <vector>

using namespace JavonetNS::Cpp::Sdk;

std::string resourcesDirectory = ".";

int main(int argc, char* argv[]) {

    // use Activate only once in your app
    Javonet::Activate("your-license-key");
    
    // create called runtime context
    auto calledRuntime = Javonet::InMemory()->Python();
    
    // set up variables
    auto libraryPath = resourcesDirectory;
    auto className = "TestClass.TestClass";
    
    // load custom library
    calledRuntime->LoadLibrary(libraryPath);
    
    // get type from the runtime
    auto calledRuntimeType = calledRuntime->GetType(className)->Execute();
    
    // create type's instance
    auto instance = calledRuntimeType->CreateInstance({ 1,0 })->Execute();
    
    // invoke instance's method
    auto response = instance->InvokeInstanceMethod("add_array_elements_and_multiply", { std::vector<std::any>{12.22, 98.22, -10.44}, 9.99 })->Execute();
    
    // get value from response
    auto result = std::any_cast<double>(response->GetValue());
    
    // write result to console
    std::cout << result << std::endl;
}class TestClass:
    def __init__(self, public_value, private_value):
        self.public_value = public_value
        self.private_value = private_value

    def get_1d_array(self):
        return ["one", "two", "three", "four", "five"]
    
    def get_2d_array(self):
        return [["S00", "S01"], ["S10", "S11"]]
    
    def add_array_elements_and_multiply(self, my_array, my_value):
        return sum(my_array) * my_value
// use Activate only once in your app
Javonet::Activate("your-license-key");

// create called runtime context
auto calledRuntime = Javonet::InMemory()->Python();

// set up variables
auto libraryPath = resourcesDirectory;
auto className = "TestClass.TestClass";

// load custom library
calledRuntime->LoadLibrary(libraryPath);

// get type from the runtime
auto calledRuntimeType = calledRuntime->GetType(className)->Execute();

// create type's instance
auto instance = calledRuntimeType->CreateInstance({ 1,0 })->Execute();

// invoke instance's method
auto response = instance->InvokeInstanceMethod("add_array_elements_and_multiply", { std::vector<std::any>{12.22, 98.22, -10.44}, 9.99 })->Execute();

// get value from response
auto result = std::any_cast<double>(response->GetValue());

// write result to console
std::cout << result << std::endl;

In the snippet above, addArrayElementsAndMultiply method needs array to be the first argument. Depending on called technology, the array may need to have a specific type, f. e. array of doubles. In this case, proper cast is needed before passing the array from C++.

The same operation can be performed remotely by just changing the new Runtime Context invocation from in memory to tcp that will create and interact with your Python package objects on any remote node, container or service that hosts Javonet Code Gateway. This way you can preserve the same logic in your application and instantly switch between monolithic and microservices architecture without the need to implement the integration layer based on web services or other remote invocation methods.

Read more about use cases and software architecture scenarios where Javonet runtime bridging technology can support your development process.

Use array from C++ as method argument to Python package

Custom Python package with method accepting array

Pass C++ array

Additional references