marked the new codecs API as unstable

lostmsu · lostmsu · commit 39b2347e10b1 · 2020-01-31T20:35:05.000-08:00
diff --git a/src/runtime/Codecs/TupleCodecs.cs b/src/runtime/Codecs/TupleCodecs.cs
@@ -5,6 +5,7 @@ namespace Python.Runtime.Codecs
     using System.Linq;
     using System.Reflection;
 
+    [Obsolete(Util.UnstableApiMessage)]
     public sealed class TupleCodec<TTuple> : IPyObjectEncoder, IPyObjectDecoder
     {
         TupleCodec() { }
diff --git a/src/runtime/Util.cs b/src/runtime/Util.cs
@@ -5,6 +5,9 @@ namespace Python.Runtime
 {
     internal class Util
     {
+        internal const string UnstableApiMessage =
+            "This API is unstable, and might be changed or removed in the next minor release";
+
         internal static Int64 ReadCLong(IntPtr tp, int offset)
         {
             // On Windows, a C long is always 32 bits.
@@ -30,4 +33,4 @@ internal static void WriteCLong(IntPtr type, int offset, Int64 flags)
             }
         }
     }
-}
+}
diff --git a/src/runtime/converterextensions.cs b/src/runtime/converterextensions.cs
@@ -9,6 +9,7 @@ namespace Python.Runtime
     /// <summary>
     /// Defines <see cref="PyObject"/> conversion to CLR types (unmarshalling)
     /// </summary>
+    [Obsolete(Util.UnstableApiMessage)]
     public interface IPyObjectDecoder
     {
         /// <summary>
@@ -28,6 +29,7 @@ public interface IPyObjectDecoder
     /// <summary>
     /// Defines conversion from CLR objects into Python objects (e.g. <see cref="PyObject"/>) (marshalling)
     /// </summary>
+    [Obsolete(Util.UnstableApiMessage)]
     public interface IPyObjectEncoder
     {
         /// <summary>
@@ -44,6 +46,7 @@ public interface IPyObjectEncoder
     /// This class allows to register additional marshalling codecs.
     /// <para>Python.NET will pick suitable encoder/decoder registered first</para>
     /// </summary>
+    [Obsolete(Util.UnstableApiMessage)]
     public static class PyObjectConversions
     {
         static readonly List<IPyObjectDecoder> decoders = new List<IPyObjectDecoder>();

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ namespace Python.Runtime.Codecs`
`5`	`5`	`using System.Linq;`
`6`	`6`	`using System.Reflection;`
`7`	`7`
	`8`	`+ [Obsolete(Util.UnstableApiMessage)]`
`8`	`9`	`public sealed class TupleCodec<TTuple> : IPyObjectEncoder, IPyObjectDecoder`
`9`	`10`	`{`
`10`	`11`	`TupleCodec() { }`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@ namespace Python.Runtime`
`5`	`5`	`{`
`6`	`6`	`internal class Util`
`7`	`7`	`{`
	`8`	`+ internal const string UnstableApiMessage =`
	`9`	`+ "This API is unstable, and might be changed or removed in the next minor release";`
	`10`	`+`
`8`	`11`	`internal static Int64 ReadCLong(IntPtr tp, int offset)`
`9`	`12`	`{`
`10`	`13`	`// On Windows, a C long is always 32 bits.`
`@@ -30,4 +33,4 @@ internal static void WriteCLong(IntPtr type, int offset, Int64 flags)`
`30`	`33`	`}`
`31`	`34`	`}`
`32`	`35`	`}`
`33`		`-}`
	`36`	`+}`