-
Notifications
You must be signed in to change notification settings - Fork 747
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
Open
filmor
wants to merge
1
commit into
master
Choose a base branch
from
fix-binaryformatter-usage
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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); | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.