-
Notifications
You must be signed in to change notification settings - Fork 761
Use the BinaryFormatter only on .NET FW and Mono #2470
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.
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,9 +33,13 @@ | |
{ | ||
using var buf = new MemoryStream(); | ||
var formatter = RuntimeData.CreateFormatter(); | ||
|
||
if (formatter == null) | ||
Assert.Inconclusive("Failed to create formatter for state serialization"); | ||
|
||
formatter.Serialize(buf, item); | ||
Check warning on line 40 in src/embed_tests/StateSerialization/MethodSerialization.cs
|
||
buf.Position = 0; | ||
return (T)formatter.Deserialize(buf); | ||
Check warning on line 42 in src/embed_tests/StateSerialization/MethodSerialization.cs
|
||
} | ||
} | ||
|
||
|
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,21 +16,23 @@ namespace Python.Runtime | |
public static class RuntimeData | ||
{ | ||
|
||
public readonly static Func<IFormatter> DefaultFormatterFactory = () => | ||
public readonly static Func<IFormatter?> DefaultFormatterFactory = () => | ||
{ | ||
try | ||
{ | ||
return new BinaryFormatter(); | ||
} | ||
catch | ||
{ | ||
return new NoopFormatter(); | ||
var fw = RuntimeInformation.FrameworkDescription; | ||
if (fw.StartsWith(".NET Framework") || fw.StartsWith("Mono")) | ||
{ | ||
return new BinaryFormatter(); | ||
} | ||
} | ||
catch {} | ||
return null; | ||
}; | ||
|
||
private static Func<IFormatter> _formatterFactory { get; set; } = DefaultFormatterFactory; | ||
private static Func<IFormatter?> _formatterFactory { get; set; } = DefaultFormatterFactory; | ||
|
||
public static Func<IFormatter> FormatterFactory | ||
public static Func<IFormatter?> FormatterFactory | ||
{ | ||
get => _formatterFactory; | ||
set | ||
|
@@ -82,6 +84,14 @@ static void ClearCLRData () | |
|
||
internal static void Stash() | ||
{ | ||
ClearCLRData(); | ||
|
||
IFormatter? formatter = CreateFormatter(); | ||
|
||
if (formatter == null) | ||
// No formatter defined, exit early | ||
return; | ||
|
||
var runtimeStorage = new PythonNetState | ||
{ | ||
Metatype = MetaType.SaveRuntimeData(), | ||
|
@@ -91,7 +101,6 @@ internal static void Stash() | |
SharedObjects = SaveRuntimeDataObjects(), | ||
}; | ||
|
||
IFormatter formatter = CreateFormatter(); | ||
var ms = new MemoryStream(); | ||
formatter.Serialize(ms, runtimeStorage); | ||
|
||
|
@@ -102,11 +111,10 @@ internal static void Stash() | |
Marshal.WriteIntPtr(mem, (IntPtr)ms.Length); | ||
Marshal.Copy(data, 0, mem + IntPtr.Size, (int)ms.Length); | ||
|
||
ClearCLRData(); | ||
|
||
using NewReference capsule = PyCapsule_New(mem, IntPtr.Zero, IntPtr.Zero); | ||
int res = PySys_SetObject("clr_data", capsule.BorrowOrThrow()); | ||
PythonException.ThrowIfIsNotZero(res); | ||
|
||
PostStashHook?.Invoke(); | ||
} | ||
|
||
|
@@ -124,6 +132,12 @@ internal static void RestoreRuntimeData() | |
|
||
private static void RestoreRuntimeDataImpl() | ||
{ | ||
IFormatter? formatter = CreateFormatter(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think coming here should be an error. |
||
|
||
if (formatter == null) | ||
// No formatter defined, exit early | ||
return; | ||
|
||
PreRestoreHook?.Invoke(); | ||
BorrowedReference capsule = PySys_GetObject("clr_data"); | ||
if (capsule.IsNull) | ||
|
@@ -135,7 +149,6 @@ private static void RestoreRuntimeDataImpl() | |
byte[] data = new byte[length]; | ||
Marshal.Copy(mem + IntPtr.Size, data, 0, length); | ||
var ms = new MemoryStream(data); | ||
var formatter = CreateFormatter(); | ||
var storage = (PythonNetState)formatter.Deserialize(ms); | ||
|
||
PyCLRMetaType = MetaType.RestoreRuntimeData(storage.Metatype); | ||
|
@@ -373,9 +386,8 @@ public static MemoryStream GetSerializationData(string key) | |
return new MemoryStream(buffer, writable:false); | ||
} | ||
|
||
internal static IFormatter CreateFormatter() | ||
internal static IFormatter? CreateFormatter() | ||
{ | ||
|
||
if (FormatterType != null) | ||
{ | ||
return (IFormatter)Activator.CreateInstance(FormatterType); | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be a good idea to make the whole test class
[Obsolete]
to prevent warningsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, for the time being, we still by default support this functionality on .NET FW and Mono. Which warning are you referring to?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Obsolete code warning that comes from using
BinaryFormatter
. You can see it on GitHub review page.