pythonnet/src/runtime/Codecs/PyObjectConversions.cs at just · pythonnet/pythonnet · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

namespace Python.Runtime

{

using System;

using System.Collections.Concurrent;

using System.Collections.Generic;

using System.Diagnostics;

using System.Linq;

using System.Reflection;

using Python.Runtime.Codecs;

/// <summary>

/// This class allows to register additional marshalling codecs.

/// <para>Python.NET will pick suitable encoder/decoder registered first</para>

/// </summary>

public static class PyObjectConversions

{

static readonly DecoderGroup decoders = new();

static readonly EncoderGroup encoders = new();

/// <summary>

/// Registers specified encoder (marshaller)

/// <para>Python.NET will pick suitable encoder/decoder registered first</para>

/// </summary>

public static void RegisterEncoder(IPyObjectEncoder encoder)

{

if (encoder == null) throw new ArgumentNullException(nameof(encoder));

lock (encoders)

{

encoders.Add(encoder);

}

/// <summary>

/// Registers specified decoder (unmarshaller)

/// <para>Python.NET will pick suitable encoder/decoder registered first</para>

/// </summary>

public static void RegisterDecoder(IPyObjectDecoder decoder)

{

if (decoder == null) throw new ArgumentNullException(nameof(decoder));

lock (decoders)

{

decoders.Add(decoder);

}

#region Encoding

internal static PyObject? TryEncode(object obj, Type type)

{

if (obj == null) throw new ArgumentNullException(nameof(obj));

if (type == null) throw new ArgumentNullException(nameof(type));

foreach (var encoder in clrToPython.GetOrAdd(type, GetEncoders))

{

var result = encoder.TryEncode(obj);

if (result != null) return result;

}

return null;

}

static readonly ConcurrentDictionary<Type, IPyObjectEncoder[]>

clrToPython = new();

static IPyObjectEncoder[] GetEncoders(Type type)

{

lock (encoders)

{

return encoders.GetEncoders(type).ToArray();

}

#endregion

#region Decoding

static readonly ConcurrentDictionary<TypePair, (PyType, Converter.TryConvertFromPythonDelegate?)> pythonToClr = new();

internal static bool TryDecode(BorrowedReference pyHandle, BorrowedReference pyType, Type targetType, out object? result)

{

if (pyHandle == null) throw new ArgumentNullException(nameof(pyHandle));

if (pyType == null) throw new ArgumentNullException(nameof(pyType));

if (targetType == null) throw new ArgumentNullException(nameof(targetType));

var key = new TypePair(pyType.DangerousGetAddress(), targetType);

var (_, decoder) = pythonToClr.GetOrAdd(key, pair => GetDecoder(pair.PyType, pair.ClrType));

result = null;

if (decoder == null) return false;

return decoder.Invoke(pyHandle, out result);

}

static (PyType, Converter.TryConvertFromPythonDelegate?) GetDecoder(IntPtr sourceType, Type targetType)

{

var sourceTypeRef = new BorrowedReference(sourceType);

Debug.Assert(PyType.IsType(sourceTypeRef));

var pyType = new PyType(sourceTypeRef, prevalidated: true);

IPyObjectDecoder? decoder;

lock (decoders)

{

decoder = decoders.GetDecoder(pyType, targetType);

if (decoder == null) return default;

}

var decode = genericDecode.MakeGenericMethod(targetType)!;

bool TryDecode(BorrowedReference pyHandle, out object? result)

{

var pyObj = new PyObject(pyHandle);

var @params = new object?[] { pyObj, null };

bool success = (bool)decode.Invoke(decoder, @params);

if (!success)

{

pyObj.Dispose();

}

result = @params[1];

return success;

}

// returning PyType here establishes strong reference to the object,

// that ensures the PyType we use as the converter cache key is not deallocated

return (pyType, TryDecode);

}

static readonly MethodInfo genericDecode = typeof(IPyObjectDecoder).GetMethod(nameof(IPyObjectDecoder.TryDecode));

#endregion

internal static void Reset()

{

lock (encoders)

lock (decoders)

{

clrToPython.Clear();

pythonToClr.Clear();

encoders.Dispose();

decoders.Dispose();

}

struct TypePair : IEquatable<TypePair>

{

internal readonly IntPtr PyType;

internal readonly Type ClrType;

public TypePair(IntPtr pyType, Type clrType)

{

this.PyType = pyType;

this.ClrType = clrType;

}

public override int GetHashCode()

=> this.ClrType.GetHashCode() ^ this.PyType.GetHashCode();

public bool Equals(TypePair other)

=> this.PyType == other.PyType && this.ClrType == other.ClrType;

public override bool Equals(object obj) => obj is TypePair other && this.Equals(other);

}

pythonnet/src/runtime/Codecs/PyObjectConversions.cs at just · pythonnet/pythonnet · GitHub

Repository navigation

Expand file tree

Breadcrumbs

PyObjectConversions.cs

Latest commit

History

Breadcrumbs

PyObjectConversions.cs

File metadata and controls