Add intern string and PyIdentifier (#1254) · pythonnet/pythonnet@d0c588b

18 files changed

lines changed

Original file line number	Diff line number	Diff line change
`@@ -203,13 +203,13 @@ def test_obj_call():`
`203`	`203`	`// Create a new module`
`204`	`204`	`IntPtr module = PyRuntime.PyModule_New(name);`
`205`	`205`	`Assert.That(module != IntPtr.Zero);`
`206`		`-IntPtr globals = PyRuntime.PyObject_GetAttrString(module, "__dict__");`
	`206`	`+IntPtr globals = PyRuntime.PyObject_GetAttr(module, PyIdentifier.__dict__);`
`207`	`207`	`Assert.That(globals != IntPtr.Zero);`
`208`	`208`	`try`
`209`	`209`	`{`
`210`	`210`	`// import builtins`
`211`	`211`	`// module.__dict__[__builtins__] = builtins`
`212`		`-int res = PyRuntime.PyDict_SetItemString(globals, "__builtins__",`
	`212`	`+int res = PyRuntime.PyDict_SetItem(globals, PyIdentifier.__builtins__,`
`213`	`213`	`PyRuntime.PyEval_GetBuiltins());`
`214`	`214`	`PythonException.ThrowIfIsNotZero(res);`
`215`	`215`

Original file line number	Diff line number	Diff line change
`@@ -143,6 +143,22 @@`
`143`	`143`	`<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />`
`144`	`144`	`</ItemGroup>`
`145`	`145`
	`146`	`+<ItemGroup>`
	`147`	`+<None Update="intern_.tt">`
	`148`	`+<Generator>TextTemplatingFileGenerator</Generator>`
	`149`	`+<LastGenOutput>intern_.cs</LastGenOutput>`
	`150`	`+</None>`
	`151`	`+</ItemGroup>`
	`152`	`+`
	`153`	`+`
	`154`	`+<ItemGroup>`
	`155`	`+<Compile Update="intern_.cs">`
	`156`	`+<DesignTime>True</DesignTime>`
	`157`	`+<AutoGen>True</AutoGen>`
	`158`	`+<DependentUpon>intern_.tt</DependentUpon>`
	`159`	`+</Compile>`
	`160`	`+</ItemGroup>`
	`161`	`+`
`146`	`162`	`<Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk" />`
`147`	`163`
`148`	`164`	`<PropertyGroup>`

Original file line number	Diff line number	Diff line change
`@@ -82,14 +82,16 @@`
`82`	`82`	`<Compile Include="Codecs\TupleCodecs.cs" />`
`83`	`83`	`<Compile Include="converterextensions.cs" />`
`84`	`84`	`<Compile Include="finalizer.cs" />`
	`85`	`+<Compile Include="intern.cs" />`
	`86`	`+<Compile Include="intern_.cs" />`
`85`	`87`	`<Compile Include="Properties\AssemblyInfo.cs" />`
`86`	`88`	`<Compile Include="..\SharedAssemblyInfo.cs">`
`87`	`89`	`<Link>Properties\SharedAssemblyInfo.cs</Link>`
`88`	`90`	`</Compile>`
`89`	`91`	`<Compile Include="arrayobject.cs" />`
`90`	`92`	`<Compile Include="assemblymanager.cs" />`
`91`	`93`	`<Compile Include="BorrowedReference.cs" />`
`92`		`-<Compile Include="bufferinterface.cs" />`
	`94`	`+<Compile Include="bufferinterface.cs" />`
`93`	`95`	`<Compile Include="classderived.cs" />`
`94`	`96`	`<Compile Include="classbase.cs" />`
`95`	`97`	`<Compile Include="classmanager.cs" />`
`@@ -131,7 +133,7 @@`
`131`	`133`	`<Compile Include="overload.cs" />`
`132`	`134`	`<Compile Include="propertyobject.cs" />`
`133`	`135`	`<Compile Include="pyansistring.cs" />`
`134`		`-<Compile Include="pybuffer.cs" />`
	`136`	`+<Compile Include="pybuffer.cs" />`
`135`	`137`	`<Compile Include="pydict.cs" />`
`136`	`138`	`<Compile Include="PyExportAttribute.cs" />`
`137`	`139`	`<Compile Include="pyfloat.cs" />`
`@@ -185,4 +187,4 @@`
`185`	`187`	`<Copy SourceFiles="$(TargetAssembly)" DestinationFolder="$(PythonBuildDir)" />`
`186`	`188`	`<!--Copy SourceFiles="$(TargetAssemblyPdb)" Condition="Exists('$(TargetAssemblyPdb)')" DestinationFolder="$(PythonBuildDir)" /-->`
`187`	`189`	`</Target>`
`188`		`-</Project>`
	`190`	`+</Project>`

Original file line number	Diff line number	Diff line change
`@@ -279,7 +279,7 @@ public static IntPtr tp_repr(IntPtr ob)`
`279`	`279`	`IntPtr args = Runtime.PyTuple_New(1);`
`280`	`280`	`Runtime.XIncref(ob);`
`281`	`281`	`Runtime.PyTuple_SetItem(args, 0, ob);`
`282`		`-IntPtr reprFunc = Runtime.PyObject_GetAttrString(Runtime.PyBaseObjectType, "__repr__");`
	`282`	`+IntPtr reprFunc = Runtime.PyObject_GetAttr(Runtime.PyBaseObjectType, PyIdentifier.__repr__);`
`283`	`283`	`var output = Runtime.PyObject_Call(reprFunc, args, IntPtr.Zero);`
`284`	`284`	`Runtime.XDecref(args);`
`285`	`285`	`Runtime.XDecref(reprFunc);`

Original file line number	Diff line number	Diff line change
`@@ -232,7 +232,7 @@ private static void InitClassBase(Type type, ClassBase impl)`
`232`	`232`	`var attr = (DocStringAttribute)attrs[0];`
`233`	`233`	`string docStr = attr.DocString;`
`234`	`234`	`doc = Runtime.PyString_FromString(docStr);`
`235`		`-Runtime.PyDict_SetItemString(dict, "__doc__", doc);`
	`235`	`+Runtime.PyDict_SetItem(dict, PyIdentifier.__doc__, doc);`
`236`	`236`	`Runtime.XDecref(doc);`
`237`	`237`	`}`
`238`	`238`
`@@ -249,16 +249,16 @@ private static void InitClassBase(Type type, ClassBase impl)`
`249`	`249`	`var ctors = new ConstructorBinding(type, tp, co.binder);`
`250`	`250`	`// ExtensionType types are untracked, so don't Incref() them.`
`251`	`251`	`// TODO: deprecate __overloads__ soon...`
`252`		`-Runtime.PyDict_SetItemString(dict, "__overloads__", ctors.pyHandle);`
`253`		`-Runtime.PyDict_SetItemString(dict, "Overloads", ctors.pyHandle);`
	`252`	`+Runtime.PyDict_SetItem(dict, PyIdentifier.__overloads__, ctors.pyHandle);`
	`253`	`+Runtime.PyDict_SetItem(dict, PyIdentifier.Overloads, ctors.pyHandle);`
`254`	`254`	`ctors.DecrRefCount();`
`255`	`255`	`}`
`256`	`256`
`257`	`257`	`// don't generate the docstring if one was already set from a DocStringAttribute.`
`258`	`258`	`if (!CLRModule._SuppressDocs && doc == IntPtr.Zero)`
`259`	`259`	`{`
`260`	`260`	`doc = co.GetDocString();`
`261`		`-Runtime.PyDict_SetItemString(dict, "__doc__", doc);`
	`261`	`+Runtime.PyDict_SetItem(dict, PyIdentifier.__doc__, doc);`
`262`	`262`	`Runtime.XDecref(doc);`
`263`	`263`	`}`
`264`	`264`	`}`

Original file line number	Diff line number	Diff line change
`@@ -284,7 +284,7 @@ public static void SetError(Exception e)`
`284`	`284`	`}`
`285`	`285`
`286`	`286`	`IntPtr op = CLRObject.GetInstHandle(e);`
`287`		`-IntPtr etype = Runtime.PyObject_GetAttrString(op, "__class__");`
	`287`	`+IntPtr etype = Runtime.PyObject_GetAttr(op, PyIdentifier.__class__);`
`288`	`288`	`Runtime.PyErr_SetObject(new BorrowedReference(etype), new BorrowedReference(op));`
`289`	`289`	`Runtime.XDecref(etype);`
`290`	`290`	`Runtime.XDecref(op);`

Original file line number	Diff line number	Diff line change
`@@ -43,11 +43,11 @@ static void InitImport()`
`43`	`43`	`// look in CLR modules, then if we don't find any call the default`
`44`	`44`	`// Python __import__.`
`45`	`45`	`IntPtr builtins = Runtime.GetBuiltins();`
`46`		`-py_import = Runtime.PyObject_GetAttrString(builtins, "__import__");`
	`46`	`+py_import = Runtime.PyObject_GetAttr(builtins, PyIdentifier.__import__);`
`47`	`47`	`PythonException.ThrowIfIsNull(py_import);`
`48`	`48`
`49`	`49`	`hook = new MethodWrapper(typeof(ImportHook), "__import__", "TernaryFunc");`
`50`		`-int res = Runtime.PyObject_SetAttrString(builtins, "__import__", hook.ptr);`
	`50`	`+int res = Runtime.PyObject_SetAttr(builtins, PyIdentifier.__import__, hook.ptr);`
`51`	`51`	`PythonException.ThrowIfIsNotZero(res);`
`52`	`52`
`53`	`53`	`Runtime.XDecref(builtins);`
`@@ -60,7 +60,7 @@ static void RestoreImport()`
`60`	`60`	`{`
`61`	`61`	`IntPtr builtins = Runtime.GetBuiltins();`
`62`	`62`
`63`		`-int res = Runtime.PyObject_SetAttrString(builtins, "__import__", py_import);`
	`63`	`+int res = Runtime.PyObject_SetAttr(builtins, PyIdentifier.__import__, py_import);`
`64`	`64`	`PythonException.ThrowIfIsNotZero(res);`
`65`	`65`	`Runtime.XDecref(py_import);`
`66`	`66`	`py_import = IntPtr.Zero;`

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,74 @@`
	`1`	`+using System;`
	`2`	`+using System.Collections.Generic;`
	`3`	`+using System.Linq;`
	`4`	`+`
	`5`	`+namespace Python.Runtime`
	`6`	`+{`
	`7`	`+static partial class InternString`
	`8`	`+{`
	`9`	`+private static Dictionary<string, IntPtr> _string2interns;`
	`10`	`+private static Dictionary<IntPtr, string> _intern2strings;`
	`11`	`+`
	`12`	`+static InternString()`
	`13`	`+{`
	`14`	`+var identifierNames = typeof(PyIdentifier).GetFields().Select(fi => fi.Name);`
	`15`	`+var validNames = new HashSet<string>(identifierNames);`
	`16`	`+if (validNames.Count != _builtinNames.Length)`
	`17`	`+{`
	`18`	`+throw new InvalidOperationException("Identifiers args not matching");`
	`19`	`+}`
	`20`	`+foreach (var name in _builtinNames)`
	`21`	`+{`
	`22`	`+if (!validNames.Contains(name))`
	`23`	`+{`
	`24`	`+throw new InvalidOperationException($"{name} is not declared");`
	`25`	`+}`
	`26`	`+}`
	`27`	`+}`
	`28`	`+`
	`29`	`+public static void Initialize()`
	`30`	`+{`
	`31`	`+_string2interns = new Dictionary<string, IntPtr>();`
	`32`	`+_intern2strings = new Dictionary<IntPtr, string>();`
	`33`	`+`
	`34`	`+Type type = typeof(PyIdentifier);`
	`35`	`+foreach (string name in _builtinNames)`
	`36`	`+{`
	`37`	`+IntPtr op = Runtime.PyUnicode_InternFromString(name);`
	`38`	`+SetIntern(name, op);`
	`39`	`+type.GetField(name).SetValue(null, op);`
	`40`	`+}`
	`41`	`+}`
	`42`	`+`
	`43`	`+public static void Shutdown()`
	`44`	`+{`
	`45`	`+foreach (var ptr in _intern2strings.Keys)`
	`46`	`+{`
	`47`	`+Runtime.XDecref(ptr);`
	`48`	`+}`
	`49`	`+_string2interns = null;`
	`50`	`+_intern2strings = null;`
	`51`	`+}`
	`52`	`+`
	`53`	`+public static string GetManagedString(IntPtr op)`
	`54`	`+{`
	`55`	`+string s;`
	`56`	`+if (TryGetInterned(op, out s))`
	`57`	`+{`
	`58`	`+return s;`
	`59`	`+}`
	`60`	`+return Runtime.GetManagedString(op);`
	`61`	`+}`
	`62`	`+`
	`63`	`+public static bool TryGetInterned(IntPtr op, out string s)`
	`64`	`+{`
	`65`	`+return _intern2strings.TryGetValue(op, out s);`
	`66`	`+}`
	`67`	`+`
	`68`	`+private static void SetIntern(string s, IntPtr op)`
	`69`	`+{`
	`70`	`+_string2interns.Add(s, op);`
	`71`	`+_intern2strings.Add(op, s);`
	`72`	`+}`
	`73`	`+}`
	`74`	`+}`

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,48 @@`
	`1`	`+using System;`
	`2`	`+`
	`3`	`+namespace Python.Runtime`
	`4`	`+{`
	`5`	`+static class PyIdentifier`
	`6`	`+{`
	`7`	`+public static IntPtr __name__;`
	`8`	`+public static IntPtr __dict__;`
	`9`	`+public static IntPtr __doc__;`
	`10`	`+public static IntPtr __class__;`
	`11`	`+public static IntPtr __module__;`
	`12`	`+public static IntPtr __file__;`
	`13`	`+public static IntPtr __slots__;`
	`14`	`+public static IntPtr __self__;`
	`15`	`+public static IntPtr __annotations__;`
	`16`	`+public static IntPtr __init__;`
	`17`	`+public static IntPtr __repr__;`
	`18`	`+public static IntPtr __import__;`
	`19`	`+public static IntPtr __builtins__;`
	`20`	`+public static IntPtr builtins;`
	`21`	`+public static IntPtr __overloads__;`
	`22`	`+public static IntPtr Overloads;`
	`23`	`+}`
	`24`	`+`
	`25`	`+`
	`26`	`+static partial class InternString`
	`27`	`+{`
	`28`	`+private static readonly string[] _builtinNames = new string[]`
	`29`	`+{`
	`30`	`+"__name__",`
	`31`	`+"__dict__",`
	`32`	`+"__doc__",`
	`33`	`+"__class__",`
	`34`	`+"__module__",`
	`35`	`+"__file__",`
	`36`	`+"__slots__",`
	`37`	`+"__self__",`
	`38`	`+"__annotations__",`
	`39`	`+"__init__",`
	`40`	`+"__repr__",`
	`41`	`+"__import__",`
	`42`	`+"__builtins__",`
	`43`	`+"builtins",`
	`44`	`+"__overloads__",`
	`45`	`+"Overloads",`
	`46`	`+};`
	`47`	`+}`
	`48`	`+}`

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,58 @@`
	`1`	`+<#@ template debug="true" hostSpecific="true" #>`
	`2`	`+<#@ output extension=".cs" #>`
	`3`	`+<#`
	`4`	`+ string[] internNames = new string[]`
	`5`	`+ {`
	`6`	`+"__name__",`
	`7`	`+"__dict__",`
	`8`	`+"__doc__",`
	`9`	`+"__class__",`
	`10`	`+"__module__",`
	`11`	`+"__file__",`
	`12`	`+"__slots__",`
	`13`	`+"__self__",`
	`14`	`+"__annotations__",`
	`15`	`+`
	`16`	`+"__init__",`
	`17`	`+"__repr__",`
	`18`	`+"__import__",`
	`19`	`+"__builtins__",`
	`20`	`+`
	`21`	`+"builtins",`
	`22`	`+`
	`23`	`+"__overloads__",`
	`24`	`+"Overloads",`
	`25`	`+ };`
	`26`	`+#>`
	`27`	`+using System;`
	`28`	`+`
	`29`	`+namespace Python.Runtime`
	`30`	`+{`
	`31`	`+ static class PyIdentifier`
	`32`	`+ {`
	`33`	`+<#`
	`34`	`+ foreach (var name in internNames)`
	`35`	`+ {`
	`36`	`+#>`
	`37`	`+ public static IntPtr <#= name #>;`
	`38`	`+<#`
	`39`	`+ }`
	`40`	`+#>`
	`41`	`+ }`
	`42`	`+`
	`43`	`+`
	`44`	`+ static partial class InternString`
	`45`	`+ {`
	`46`	`+ private static readonly string[] _builtinNames = new string[]`
	`47`	`+ {`
	`48`	`+<#`
	`49`	`+ foreach (var name in internNames)`
	`50`	`+ {`
	`51`	`+#>`
	`52`	`+"<#= name #>",`
	`53`	`+<#`
	`54`	`+ }`
	`55`	`+#>`
	`56`	`+ };`
	`57`	`+ }`
	`58`	`+}`