Merge pull request #42 from QuantConnect/feature-dictionary-object

Implements KeyValuePairEnumerableObject

Author: Martin-Molinero

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.5.29
+current_version = 1.0.5.30
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+)(?P<dev>\d+))?
 serialize = 
 	{major}.{minor}.{patch}.{release}{dev}

conda.recipe/meta.yaml

@@ -1,6 +1,6 @@
 package:
   name: pythonnet
-  version: "1.0.5.29"
+  version: "1.0.5.30"
 
 build:
   skip: True  # [not win]

setup.py

@@ -485,7 +485,7 @@ def run(self):
 
 setup(
     name="pythonnet",
-    version="1.0.5.29",
+    version="1.0.5.30",
     description=".Net and Mono integration for Python",
     url='https://pythonnet.github.io/',
     license='MIT',

src/SharedAssemblyInfo.cs

@@ -25,4 +25,4 @@
 // Version Information. Keeping it simple. May need to revisit for Nuget
 // See: https://codingforsmarties.wordpress.com/2016/01/21/how-to-version-assemblies-destined-for-nuget/
 // AssemblyVersion can only be numeric
-[assembly: AssemblyVersion("1.0.5.29")]
+[assembly: AssemblyVersion("1.0.5.30")]

src/clrmodule/ClrModule.cs

@@ -53,7 +53,7 @@ public static void initclr()
         {
 #if USE_PYTHON_RUNTIME_VERSION
             // Has no effect until SNK works. Keep updated anyways.
-            Version = new Version("1.0.5.29"),
+            Version = new Version("1.0.5.30"),
 #endif
             CultureInfo = CultureInfo.InvariantCulture
         };

src/runtime/Python.Runtime.csproj

@@ -76,6 +76,7 @@
     <Reference Include="System" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="keyvaluepairenumerableobject.cs" />
     <Compile Include="finalizer.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="..\SharedAssemblyInfo.cs">

src/runtime/classmanager.cs

@@ -87,6 +87,11 @@ private static ClassBase CreateClass(Type type)
                 impl = new ArrayObject(type);
             }
 
+            else if (type.IsKeyValuePairEnumerable())
+            {
+                impl = new KeyValuePairEnumerableObject(type);
+            }
+
             else if (type.IsInterface)
             {
                 impl = new InterfaceObject(type);

src/runtime/keyvaluepairenumerableobject.cs

@@ -0,0 +1,112 @@
+using System;
+using System.Collections.Generic;
+using System.Reflection;
+
+namespace Python.Runtime
+{
+    /// <summary>
+    /// Implements a Python type for managed KeyValuePairEnumerable (dictionaries).
+    /// This type is essentially the same as a ClassObject, except that it provides
+    /// sequence semantics to support natural dictionary usage (__contains__ and __len__)
+    /// from Python.
+    /// </summary>
+    internal class KeyValuePairEnumerableObject : ClassObject
+    {
+        private static Dictionary<Tuple<Type, string>, MethodInfo> methodsByType = new Dictionary<Tuple<Type, string>, MethodInfo>();
+        private static List<string> requiredMethods = new List<string> { "Count", "ContainsKey" };
+
+        internal static bool VerifyMethodRequirements(Type type)
+        {
+            foreach (var requiredMethod in requiredMethods)
+            {
+                var method = type.GetMethod(requiredMethod);
+                if (method == null)
+                {
+                    method = type.GetMethod($"get_{requiredMethod}");
+                    if (method == null)
+                    {
+                        return false;
+                    }
+                }
+
+                var key = Tuple.Create(type, requiredMethod);
+                methodsByType.Add(key, method);
+            }
+
+            return true;
+        }
+
+        internal KeyValuePairEnumerableObject(Type tp) : base(tp)
+        {
+
+        }
+
+        internal override bool CanSubclass() => false;
+
+        /// <summary>
+        /// Implements __len__ for dictionary types.
+        /// </summary>
+        public static int mp_length(IntPtr ob)
+        {
+            var obj = (CLRObject)GetManagedObject(ob);
+            var self = obj.inst;
+
+            var key = Tuple.Create(self.GetType(), "Count");
+            var methodInfo = methodsByType[key];
+
+            return (int)methodInfo.Invoke(self, null);
+        }
+
+        /// <summary>
+        /// Implements __contains__ for dictionary types.
+        /// </summary>
+        public static int sq_contains(IntPtr ob, IntPtr v)
+        {
+            var obj = (CLRObject)GetManagedObject(ob);
+            var self = obj.inst;
+
+            var key = Tuple.Create(self.GetType(), "ContainsKey");
+            var methodInfo = methodsByType[key];
+
+            var parameters = methodInfo.GetParameters();
+            object arg;
+            if (!Converter.ToManaged(v, parameters[0].ParameterType, out arg, false))
+            {
+                Exceptions.SetError(Exceptions.TypeError,
+                    $"invalid parameter type for sq_contains: should be {Converter.GetTypeByAlias(v)}, found {parameters[0].ParameterType}");
+            }
+
+            return (bool)methodInfo.Invoke(self, new[] { arg }) ? 1 : 0;
+        }
+    }
+
+    public static class KeyValuePairEnumerableObjectExtension
+    {
+        public static bool IsKeyValuePairEnumerable(this Type type)
+        {
+            var iEnumerableType = typeof(IEnumerable<>);
+            var keyValuePairType = typeof(KeyValuePair<,>);
+
+            var interfaces = type.GetInterfaces();
+            foreach (var i in interfaces)
+            {
+                if (i.IsGenericType &&
+                    i.GetGenericTypeDefinition() == iEnumerableType)
+                {
+                    var arguments = i.GetGenericArguments();
+                    if (arguments.Length != 1) continue;
+
+                    var a = arguments[0];
+                    if (a.IsGenericType &&
+                        a.GetGenericTypeDefinition() == keyValuePairType &&
+                        a.GetGenericArguments().Length == 2)
+                    {
+                        return KeyValuePairEnumerableObject.VerifyMethodRequirements(type);
+                    }
+                }
+            }
+
+            return false;
+        }
+    }
+}

src/runtime/resources/clr.py

@@ -2,7 +2,7 @@
 Code in this module gets loaded into the main clr module.
 """
 
-__version__ = "1.0.5.29"
+__version__ = "1.0.5.30"
 
 
 class clrproperty(object):

src/testing/Python.Test.csproj

@@ -70,6 +70,7 @@
     <DebugType>pdbonly</DebugType>
   </PropertyGroup>
   <ItemGroup>
+    <Compile Include="dictionarytest.cs" />
     <Compile Include="arraytest.cs" />
     <Compile Include="callbacktest.cs" />
     <Compile Include="classtest.cs" />