Pass arguments by reference with ref keyword to .NET Framework DLL in Python app

This article provides an introduction to cross-technology invocation of both static and instance methods which contains argument of type ref. Parameter modifier ref in C# (.NET) technology is used in a method signature to pass an argument by reference. It is described in details in this article.

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.

With Javonet you can interact with methods with ref parameter modifier from .NET Framework DLL like they were available in Python but invocation must be performed through Javonet SDK API. Javonet allows you to pass any Python value type as argument to method from .NET Framework DLL. For reference type arguments (instances of other classes) you can create such instance with Javonet and pass the Invocation Context variable referencing that object as argument of static method invocation.

Custom .NET Framework DLL with ref Python argument

With Javonet it is possible to reference any custom .NET Framework DLL and interact with its methods declared on types defined within that module almost the same as with any other Python library.

Snippet below represents the sample code from .NET Framework DLL which contains methods with ref parameter modifier. 

public static void RefSampleMethod(ref int x)
{
    x = x * 2;
}

public static void RefSampleMethod2(ref int x, ref double y, ref string z)
{
    x = x * 2;
    y = y / 2;
    z = "Done";
}

It is possible to invoke the declared methods from .NET Framework DLL using following Python code:

I code in:
# use activate only once in your app
Javonet.activate("your-license-key")

# create called runtime context
called_runtime = Javonet.in_memory().clr()

# set up variables
library_path = resources_directory + "/TestClass.dll"
class_name = "TestClass.TestClass"

# load custom library
called_runtime.load_library(library_path)

# get type from the runtime
called_runtime_type = called_runtime.get_type(class_name).execute()

# create values for ref

# first way - pass only value
ref_value1 = called_runtime.as_ref(10).execute()

# second way - pass value and type
# ref variable should have specific type to be able to invoke methods on it
# this way enables to cast value to specific type needed by called method
int_type = called_runtime.get_type("System.Int32").execute()
ref_value2 = called_runtime.as_ref(20.0, int_type).execute()

# invoke type's static method with ref values
called_runtime_type.invoke_static_method("RefSampleMethod", ref_value1).execute()
called_runtime_type.invoke_static_method("RefSampleMethod", ref_value2).execute()

# get ref values
result1 = ref_value1.get_ref_value().execute().get_value()
result2 = ref_value2.get_ref_value().execute().get_value()

# write result to console
print(result1)
print(result2)

This snippet uses in memory runtime bridging to load the .NET Framework DLL and next retrieves reference to specific type.

Next, two reference type arguments are created. An argument that is passed to a ref parameter must be initialized before it's passed to a method. Two ways of initialization are presented in create values for ref section of the snippet.
Fist argument (refValue1) is initialized using asRef() method with default type of passed value (int). This type matches the type of parameter in RefSampleMethod(ref int x) method.
Second argument (refValue2) is initialized using asRef() method with specifying the exact type which should be use. "System.Int32" is an alias for int.

Both values can be passed to RefSampleMethod(ref int x) method using invokeStaticMethod(...).execute() invocation.

Each reference type argument is get as regular Python value using getRefValue() and can be used for further processing.

Custom Python with ref keyword

It is possible to invoke the declared method which contains multiple ref arguments from .NET Framework DLL using following Python code:

I code in:
# use activate only once in your app
Javonet.activate("your-license-key")

# create called runtime context
called_runtime = Javonet.in_memory().clr()

# set up variables
library_path = resources_directory + "/TestClass.dll"
class_name = "TestClass.TestClass"

# load custom library
called_runtime.load_library(library_path)

# get type from the runtime
called_runtime_type = called_runtime.get_type(class_name).execute()
double_type = called_runtime.get_type("System.Double").execute()

# create values for ref
# ref variable should have specific type to be able to invoke methods on it
# This way enables to cast value to specific type needed by called method
ref_to_int = called_runtime.as_ref(10).execute()
ref_to_double = called_runtime.as_ref(5, double_type).execute()
ref_to_string = called_runtime.as_ref("Before execution").execute()

# invoke type's static method with ref values
called_runtime_type.invoke_static_method("RefSampleMethod2", ref_to_int, ref_to_double, ref_to_string).execute()

# get ref values
result1 = ref_to_int.get_ref_value().execute().get_value()
result2 = ref_to_double.get_ref_value().execute().get_value()
result3 = ref_to_string.get_ref_value().execute().get_value()

# write result to console
print(result1)
print(result2)
print(result3)

This snippet uses in memory runtime bridging to load the .NET Framework DLL and next retrieves reference to specific type.

Next, three reference type arguments are created. An argument that is passed to a ref parameter must be initialized before it's passed to a method. Two ways of initialization are presented in create values for ref section of the snippet.
Fist argument (refToInt) is initialized using asRef() method with default type of passed value (int). This type matches the type of first parameter in RefSampleMethod2 method.
Second value (refToDouble) is initialized using asRef() method with specifying the exact type which should be used. "System.Double" is an alias for double.
Third argument (refToString) is initialized using asRef() method with default type of passed value (string).

All three arguments are processed in RefSampleMethod2 and changed. Their values are obtained using getRefValue() method.

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 .NET Framework DLL 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.

Additional references