Removes new object.GetRawPythonProxy extension method in favor of existing PyObject.FromManagedObject (#1132)

lostmsu · web-flow · commit 2e0874ad3b96 · 2020-05-01T10:36:19.000+02:00
Reverts most of #1078
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,7 +13,6 @@ This document follows the conventions laid out in [Keep a CHANGELOG][].
 -   Added function that sets Py_NoSiteFlag to 1.
 -   Added support for Jetson Nano.
 -   Added support for __len__ for .NET classes that implement ICollection
--   Added `object.GetRawPythonProxy() -> PyObject` extension method, that bypasses any conversions
 -   Added PythonException.Format method to format exceptions the same as traceback.format_exception
 
 ### Changed
diff --git a/src/embed_tests/Codecs.cs b/src/embed_tests/Codecs.cs
@@ -91,7 +91,7 @@ static void TupleRoundtripGeneric<T, TTuple>() {
     class ObjectToEncoderInstanceEncoder<T> : IPyObjectEncoder
     {
         public bool CanEncode(Type type) => type == typeof(T);
-        public PyObject TryEncode(object value) => this.GetRawPythonProxy();
+        public PyObject TryEncode(object value) => PyObject.FromManagedObject(this);
     }
 
     /// <summary>
diff --git a/src/embed_tests/TestConverter.cs b/src/embed_tests/TestConverter.cs
@@ -51,7 +51,7 @@ public void TestConvertDoubleToManaged(
         public void RawListProxy()
         {
             var list = new List<string> {"hello", "world"};
-            var listProxy = list.GetRawPythonProxy();
+            var listProxy = PyObject.FromManagedObject(list);
             var clrObject = (CLRObject)ManagedType.GetManagedObject(listProxy.Handle);
             Assert.AreSame(list, clrObject.inst);
         }
@@ -60,7 +60,7 @@ public void RawListProxy()
         public void RawPyObjectProxy()
         {
             var pyObject = "hello world!".ToPython();
-            var pyObjectProxy = pyObject.GetRawPythonProxy();
+            var pyObjectProxy = PyObject.FromManagedObject(pyObject);
             var clrObject = (CLRObject)ManagedType.GetManagedObject(pyObjectProxy.Handle);
             Assert.AreSame(pyObject, clrObject.inst);
 
diff --git a/src/runtime/Codecs/RawProxyEncoder.cs b/src/runtime/Codecs/RawProxyEncoder.cs
@@ -13,7 +13,7 @@ public PyObject TryEncode(object value)
         {
             if (value is null) throw new ArgumentNullException(nameof(value));
 
-            return value.GetRawPythonProxy();
+            return PyObject.FromManagedObject(value);
         }
 
         public virtual bool CanEncode(Type type) => false;
diff --git a/src/runtime/clrobject.cs b/src/runtime/clrobject.cs
@@ -68,17 +68,5 @@ internal static IntPtr GetInstHandle(object ob)
             CLRObject co = GetInstance(ob);
             return co.pyHandle;
         }
-
-        /// <summary>
-        /// Creates <see cref="CLRObject"/> proxy for the given object,
-        /// and returns a <see cref="NewReference"/> to it.
-        /// </summary>
-        internal static NewReference MakeNewReference(object obj)
-        {
-            if (obj is null) throw new ArgumentNullException(nameof(obj));
-
-            // TODO: CLRObject currently does not have Dispose or finalizer which might change in the future
-            return NewReference.DangerousFromPointer(GetInstHandle(obj));
-        }
     }
 }
diff --git a/src/runtime/converter.cs b/src/runtime/converter.cs
@@ -967,16 +967,5 @@ public static PyObject ToPython(this object o)
         {
             return new PyObject(Converter.ToPython(o, o?.GetType()));
         }
-
-        /// <summary>
-        /// Gets raw Python proxy for this object (bypasses all conversions,
-        /// except <c>null</c> &lt;==&gt; <c>None</c>)
-        /// </summary>
-        public static PyObject GetRawPythonProxy(this object o)
-        {
-            if (o is null) return new PyObject(new BorrowedReference(Runtime.PyNone));
-
-            return CLRObject.MakeNewReference(o).MoveToPyObject();
-        }
     }
 }
diff --git a/src/runtime/pyobject.cs b/src/runtime/pyobject.cs
@@ -111,7 +111,8 @@ public IntPtr Handle
 
 
         /// <summary>
-        /// FromManagedObject Method
+        /// Gets raw Python proxy for this object (bypasses all conversions,
+        /// except <c>null</c> &lt;==&gt; <c>None</c>)
         /// </summary>
         /// <remarks>
         /// Given an arbitrary managed object, return a Python instance that

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ static void TupleRoundtripGeneric<T, TTuple>() {`
`91`	`91`	`class ObjectToEncoderInstanceEncoder<T> : IPyObjectEncoder`
`92`	`92`	`{`
`93`	`93`	`public bool CanEncode(Type type) => type == typeof(T);`
`94`		`- public PyObject TryEncode(object value) => this.GetRawPythonProxy();`
	`94`	`+ public PyObject TryEncode(object value) => PyObject.FromManagedObject(this);`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public void TestConvertDoubleToManaged(`
`51`	`51`	`public void RawListProxy()`
`52`	`52`	`{`
`53`	`53`	`var list = new List<string> {"hello", "world"};`
`54`		`- var listProxy = list.GetRawPythonProxy();`
	`54`	`+ var listProxy = PyObject.FromManagedObject(list);`
`55`	`55`	`var clrObject = (CLRObject)ManagedType.GetManagedObject(listProxy.Handle);`
`56`	`56`	`Assert.AreSame(list, clrObject.inst);`
`57`	`57`	`}`
`@@ -60,7 +60,7 @@ public void RawListProxy()`
`60`	`60`	`public void RawPyObjectProxy()`
`61`	`61`	`{`
`62`	`62`	`var pyObject = "hello world!".ToPython();`
`63`		`- var pyObjectProxy = pyObject.GetRawPythonProxy();`
	`63`	`+ var pyObjectProxy = PyObject.FromManagedObject(pyObject);`
`64`	`64`	`var clrObject = (CLRObject)ManagedType.GetManagedObject(pyObjectProxy.Handle);`
`65`	`65`	`Assert.AreSame(pyObject, clrObject.inst);`
`66`	`66`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public PyObject TryEncode(object value)`
`13`	`13`	`{`
`14`	`14`	`if (value is null) throw new ArgumentNullException(nameof(value));`
`15`	`15`
`16`		`- return value.GetRawPythonProxy();`
	`16`	`+ return PyObject.FromManagedObject(value);`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`public virtual bool CanEncode(Type type) => false;`
Original file line number	Diff line number	Diff line change
`@@ -68,17 +68,5 @@ internal static IntPtr GetInstHandle(object ob)`
`68`	`68`	`CLRObject co = GetInstance(ob);`
`69`	`69`	`return co.pyHandle;`
`70`	`70`	`}`
`71`		`-`
`72`		`- /// <summary>`
`73`		`- /// Creates <see cref="CLRObject"/> proxy for the given object,`
`74`		`- /// and returns a <see cref="NewReference"/> to it.`
`75`		`- /// </summary>`
`76`		`- internal static NewReference MakeNewReference(object obj)`
`77`		`- {`
`78`		`- if (obj is null) throw new ArgumentNullException(nameof(obj));`
`79`		`-`
`80`		`- // TODO: CLRObject currently does not have Dispose or finalizer which might change in the future`
`81`		`- return NewReference.DangerousFromPointer(GetInstHandle(obj));`
`82`		`- }`
`83`	`71`	`}`
`84`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -967,16 +967,5 @@ public static PyObject ToPython(this object o)`
`967`	`967`	`{`
`968`	`968`	`return new PyObject(Converter.ToPython(o, o?.GetType()));`
`969`	`969`	`}`
`970`		`-`
`971`		`- /// <summary>`
`972`		`- /// Gets raw Python proxy for this object (bypasses all conversions,`
`973`		`- /// except <c>null</c> <==> <c>None</c>)`
`974`		`- /// </summary>`
`975`		`- public static PyObject GetRawPythonProxy(this object o)`
`976`		`- {`
`977`		`- if (o is null) return new PyObject(new BorrowedReference(Runtime.PyNone));`
`978`		`-`
`979`		`- return CLRObject.MakeNewReference(o).MoveToPyObject();`
`980`		`- }`
`981`	`970`	`}`
`982`	`971`	`}`