10000 Best effort serialization by BadSingleton · Pull Request #1892 · pythonnet/pythonnet · GitHub
[go: up one dir, main page]
Skip to content

Best effort serialization #1892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

Best effort serialization #1892

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
61e1ede
Last line of defense, best effort serialization
BadSingleton Jun 23, 2022
fc1044a
Add nested class support
BadSingleton Jun 30, 2022
ff550c6
fixup! Add nested class support
BadSingleton Jun 30, 2022
2caa2e5
Workaround for mono attribute bug
BadSingleton Jul 6, 2022
0a81466
fixup! Workaround for mono attribute bug
BadSingleton Jul 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add nested class support 
plus guard rails for private classes

and review fixes
  • Loading branch information
@BadSingleton
BadSingleton committed Jul 29, 2022
commit fc1044a25ae7fb573e88e359b343108adb18e061
152 changes: 124 additions & 28 deletions src/runtime/StateSerialization/RuntimeData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Dynamic;
using System.IO;
using System.Linq;
using System.Reflection;
Expand Down Expand Up @@ -45,38 +42,140 @@ internal static class NonSerializedTypeBuilder
internal static HashSet<string> dontReimplementMethods = new(){"Finalize", "Dispose", "GetType", "ReferenceEquals", "GetHashCode", "Equals"};
const string notSerializedSuffix = "_NotSerialized";

public static object CreateNewObject(Type baseType)
private static Func<Type, TypeAttributes, bool> hasVisibility = (tp, attr) => (tp.Attributes & TypeAttributes.VisibilityMask) == attr;
private static Func<Type, bool> isNestedType = (tp) => hasVisibility(tp, TypeAttributes.NestedPrivate) || hasVisibility(tp, TypeAttributes.NestedPublic) || hasVisibility(tp, TypeAttributes.NestedFamily) || hasVisibility(tp, TypeAttributes.NestedAssembly);
private static Func<Type, bool> isPrivateType = (tp) => hasVisibility(tp, TypeAttributes.NotPublic) || hasVisibility(tp, TypeAttributes.NestedPrivate) || hasVisibility(tp, TypeAttributes.NestedFamily) || hasVisibility( tp, TypeAttributes.NestedAssembly);
private static Func<Type, bool> isPublicType = (tp) => hasVisibility(tp, TypeAttributes.Public) || hasVisibility(tp,TypeAttributes.NestedPublic);

public static object? CreateNewObject(Type baseType)
{
var myType = CreateType(baseType);
if (myType is null)
{
return null;
}
var myObject = Activator.CreateInstance(myType);
return myObject;
}

public static Type CreateType(Type tp)
static void FillTypeMethods(TypeBuilder tb)
{
Type existingType = assemblyForNonSerializedClasses.GetType(tp.Name + "_NotSerialized", throwOnError:false);
if (existingType is not null)
var constructors = tb.BaseType.GetConstructors();
if (constructors.Count() == 0)
{
return existingType;
// no constructors defined, at least declare a default
ConstructorBuilder constructor = tb.DefineDefaultConstructor(MethodAttributes.Public | MethodAttributes.SpecialName | MethodAttributes.RTSpecialName);
}
else
{
foreach (var ctor in constructors)
{
var ctorParams = (from param in ctor.GetParameters() select param.ParameterType).ToArray();
var ctorbuilder = tb.DefineConstructor(ctor.Attributes, ctor.CallingConvention, ctorParams);
ctorbuilder.GetILGenerator().Emit(OpCodes.Ret);

TypeBuilder tb = GetTypeBuilder(tp);
ConstructorBuilder constructor = tb.DefineDefaultConstructor(MethodAttributes.Public | MethodAttributes.SpecialName | MethodAttributes.RTSpecialName);
var properties = tp.GetProperties(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static);
}
var parameterless = tb.DefineConstructor(MethodAttributes.Public | MethodAttributes.SpecialName | MethodAttributes.RTSpecialName, CallingConventions.Standard | CallingConventions.HasThis, Type.EmptyTypes);
parameterless.GetILGenerator().Emit(OpCodes.Ret);
}

var properties = tb.BaseType.GetProperties(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static);
foreach (var prop in properties)
{
CreateProperty(tb, prop);
}

var methods = tp.GetMethods(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static);
var methods = tb.BaseType.GetMethods(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static);
foreach (var meth in methods)
{
CreateMethod(tb, meth);
}

ImplementEqualityAndHash(tb);
}

return tb.CreateType();
static string MakeName(Type tp)
{
const string suffix = "_NotSerialized";
string @out = tp.Name + suffix;
var parentType = tp.DeclaringType;
while (parentType is not null)
{
// If we have a nested class, we need the whole nester/nestee
// chain with the suffix for each.
@out = parentType.Name + suffix + "+" + @out;
parentType = parentType.DeclaringType;
}
return @out;
}

public static Type? CreateType(Type tp)
{
if (!isPublicType(tp))
{
return null;
}

Type existingType = assemblyForNonSerializedClasses.GetType(MakeName(tp), throwOnError:false);
if (existingType is not null)
{
return existingType;
}
var parentType = tp.DeclaringType;
if (parentType is not null)
{
// parent types for nested types must be created first. Climb up the
// declaring type chain until we find a "top-level" class.
while (parentType.DeclaringType is not null)
{
parentType = parentType.DeclaringType;
}
CreateTypeInternal(parentType);
Type nestedType = assemblyForNonSerializedClasses.GetType(MakeName(tp), throwOnError:true);
return nestedType;
}
return CreateTypeInternal(tp);
}

private static Type? CreateTypeInternal(Type baseType)
{
if (!isPublicType(baseType))
{
// we can't derive from non-public types.
return null;
}
Type existingType = assemblyForNonSerializedClasses.GetType(MakeName(baseType), throwOnError:false);
if (existingType is not null)
{
return existingType;
}

TypeBuilder tb = GetTypeBuilder(baseType);
SetNonSerialiedAttr(tb);
FillTypeMethods(tb);

var nestedtypes = baseType.GetNestedTypes(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static);
List<TypeBuilder> nestedBuilders = new();
foreach (var nested in nestedtypes)
{
if (isPrivateType(nested))
{
continue;
}
var nestedBuilder = tb.DefineNestedType(nested.Name + notSerializedSuffix,
TypeAttributes.NestedPublic,
nested
);
nestedBuilders.Add(nestedBuilder);
}
var outTp = tb.CreateType();
foreach(var builder in nestedBuilders)
{
FillTypeMethods(builder);
SetNonSerialiedAttr(builder);
builder.CreateType();
}
return outTp;
}

private static void ImplementEqualityAndHash(TypeBuilder tb)
Expand All @@ -91,7 +190,7 @@ private static void ImplementEqualityAndHash(TypeBuilder tb)
getHashIlGen.Emit(OpCodes.Ldarg_0);
getHashIlGen.EmitCall(OpCodes.Call, typeof(object).GetMethod("GetType"), Type.EmptyTypes);
getHashIlGen.EmitCall(OpCodes.Call, typeof(Type).GetProperty("Name").GetMethod, Type.EmptyTypes);
getHashIlGen.EmitCall(OpCodes.Call, typeof(string).GetMethod("GetHashCode"), Type.EmptyTypes);
getHashIlGen.EmitCall(OpCodes.Call, typeof(string).GetMethod("GetHashCode", Type.EmptyTypes), Type.EmptyTypes);
getHashIlGen.Emit(OpCodes.Ret);

Type[] equalsArgs = new Type[] {typeof(object), typeof(object)};
Expand All @@ -108,19 +207,20 @@ private static void ImplementEqualityAndHash(TypeBuilder tb)
equalsIlGen.Emit(OpCodes.Ret);
}

private static void SetNonSerialiedAttr(TypeBuilder tb)
{
ConstructorInfo attrCtorInfo = typeof(PyNet_NotSerializedAttribute).GetConstructor(new Type[]{});
CustomAttributeBuilder attrBuilder = new CustomAttributeBuilder(attrCtorInfo,new object[]{});
tb.SetCustomAttribute(attrBuilder);
}

private static TypeBuilder GetTypeBuilder(Type baseType)
{
string typeSignature = baseType.Name + notSerializedSuffix;

TypeBuilder tb = moduleBuilder.DefineType(typeSignature,
baseType.Attributes,
baseType,
baseType.GetInterfaces());

ConstructorInfo attrCtorInfo = typeof(PyNet_NotSerializedAttribute).GetConstructor(new Type[]{});
CustomAttributeBuilder attrBuilder = new CustomAttributeBuilder(attrCtorInfo,new object[]{});
tb.SetCustomAttribute(attrBuilder);

return tb;
}

Expand Down Expand Up @@ -188,7 +288,6 @@ private static void CreateProperty(TypeBuilder tb, PropertyInfo pinfo)

private static void CreateMethod(TypeBuilder tb, MethodInfo minfo)
{
Console.WriteLine($"overimplementing method for: {minfo} {minfo.IsVirtual} {minfo.IsFinal} ");
string methodName = minfo.Name;

if (dontReimplementMethods.Contains(methodName))
Expand Down Expand Up @@ -226,8 +325,7 @@ public void GetObjectData(object obj, SerializationInfo info, StreamingContext c

MaybeType type = obj.GetType();

var hasAttr = (from attr in obj.GetType().CustomAttributes select attr.AttributeType == typeof(PyNet_NotSerializedAttribute)).Count() != 0;
if (hasAttr)
if (type.Value.CustomAttributes.Any((attr) => attr.AttributeType == typeof(NonSerializedAttribute)))
{
// Don't serialize a _NotSerialized. Serialize the base type, and deserialize as a _NotSerialized
type = type.Value.BaseType;
Expand Down Expand Up @@ -257,7 +355,7 @@ public object SetObjectData(object obj, SerializationInfo info, StreamingContext
object nameObj = null!;
try
{
nameObj = info.GetValue($"notSerialized_tp", typeof(object));
nameObj = info.GetValue("notSerialized_tp", typeof(object));
}
catch
{
Expand All @@ -274,7 +372,7 @@ public object SetObjectData(object obj, SerializationInfo info, StreamingContext
return null!;
}

obj = NonSerializedTypeBuilder.CreateNewObject(name.Value);
obj = NonSerializedTypeBuilder.CreateNewObject(name.Value)!;
return obj;
}
}
Expand All @@ -287,14 +385,13 @@ class NonSerializableSelector : SurrogateSelector
{
throw new ArgumentNullException();
}
selector = this;
if (type.IsSerializable)
{
selector = this;
return null; // use whichever default
}
else
{
selector = this;
return new NotSerializableSerializer();
}
}
Expand Down Expand Up @@ -597,7 +694,6 @@ internal static IFormatter CreateFormatter()
: new BinaryFormatter()
{
SurrogateSelector = new NonSerializableSelector(),
// Binder = new CustomizedBinder()
};
}
}
Expand Down
0