Deprecate public RunString

vmuriart · vmuriart · commit 3225465c3929 · 2017-03-03T12:44:50.000-07:00
Had to remove defaults to disambiguate call on `internal RunString`. Can re-add after removing `public RunString` Closes pythonnet#401
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -38,6 +38,10 @@ This document follows the conventions laid out in [Keep a CHANGELOG][].
 -   Unfroze Mono version on Travis (#345)
 -   Changed `conda.recipe` build to only pull-requests (#345)
 
+### Deprecated
+
+-   Deprecated `RunString` (#401)
+
 ### Fixed
 
 -   Fixed crash during Initialization (#262)(#343)
@@ -52,7 +56,7 @@ This document follows the conventions laid out in [Keep a CHANGELOG][].
 -   Fixed `Py_Main` & `PySys_SetArgvEx` `no mem error` on `UCS4/PY3` (#399)
 -   Fixed `Python.Runtime.dll.config` on macOS (#120)
 -   Fixed crash on `PythonEngine.Version` (#413)
--   Fixed `PythonEngine.PythonPath` issues (#414)
+-   Fixed `PythonEngine.PythonPath` issues (#179)(#414)(#415)
 
 ### Removed
 
diff --git a/src/runtime/pythonengine.cs b/src/runtime/pythonengine.cs
@@ -469,16 +469,24 @@ public static void Exec(string code, IntPtr? globals = null, IntPtr? locals = nu
 
 
         /// <summary>
-        /// RunString Method
+        /// RunString Method. Function has been deprecated and will be removed.
+        /// Use Exec/Eval/RunSimpleString instead.
+        /// </summary>
+        [Obsolete("RunString is deprecated and will be removed. Use Exec/Eval/RunSimpleString instead.")]
+        public static PyObject RunString(string code, IntPtr? globals = null, IntPtr? locals = null)
+        {
+            return RunString(code, globals, locals, RunFlagType.File);
+        }
+
+        /// <summary>
+        /// Internal RunString Method.
         /// </summary>
         /// <remarks>
         /// Run a string containing Python code. Returns the result of
         /// executing the code string as a PyObject instance, or null if
         /// an exception was raised.
         /// </remarks>
-        public static PyObject RunString(
-            string code, IntPtr? globals = null, IntPtr? locals = null, RunFlagType _flag = RunFlagType.File
-        )
+        internal static PyObject RunString(string code, IntPtr? globals, IntPtr? locals, RunFlagType flag)
         {
             var borrowedGlobals = true;
             if (globals == null)
@@ -502,12 +510,10 @@ public static PyObject RunString(
                 borrowedLocals = false;
             }
 
-            var flag = (IntPtr)_flag;
-
             try
             {
                 IntPtr result = Runtime.PyRun_String(
-                    code, flag, globals.Value, locals.Value
+                    code, (IntPtr)flag, globals.Value, locals.Value
                 );
 
                 Runtime.CheckExceptionOccurred();
