ABI.Initialize gives a helpful message when the TypeOffset interop class is not configured correctly (#1340)

tminka · web-flow · commit cac82a6fba69 · 2021-01-04T14:15:18.000-08:00
+ Added LoadNativeTypeOffsetClass test
* Remove reference to PythonInteropFile
diff --git a/src/embed_tests/Python.EmbeddingTest.csproj b/src/embed_tests/Python.EmbeddingTest.csproj
@@ -12,6 +12,10 @@
     <None Include="fixtures/**/*.py" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
+  <PropertyGroup>
+    <DefineConstants>$(DefineConstants);$(ConfiguredConstants)</DefineConstants>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="NUnit" Version="3.*" />
     <PackageReference Include="NUnit3TestAdapter" Version="3.*">
diff --git a/src/embed_tests/TestNativeTypeOffset.cs b/src/embed_tests/TestNativeTypeOffset.cs
@@ -0,0 +1,45 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+using System.Threading.Tasks;
+
+using NUnit.Framework;
+
+using Python.Runtime;
+
+namespace Python.EmbeddingPythonTest
+{
+    public class TestNativeTypeOffset
+    {
+        private Py.GILState _gs;
+
+        [SetUp]
+        public void SetUp()
+        {
+            _gs = Py.GIL();
+        }
+
+        [TearDown]
+        public void Dispose()
+        {
+            _gs.Dispose();
+        }
+
+        /// <summary>
+        /// Tests that installation has generated code for NativeTypeOffset and that it can be loaded.
+        /// </summary>        
+        [Test]
+        public void LoadNativeTypeOffsetClass()
+        {
+            PyObject sys = Py.Import("sys");
+            string attributeName = "abiflags";
+            if (sys.HasAttr(attributeName) && !string.IsNullOrEmpty(sys.GetAttr(attributeName).ToString()))
+            {
+                string typeName = "Python.Runtime.NativeTypeOffset, Python.Runtime";
+                Assert.NotNull(Type.GetType(typeName), $"{typeName} does not exist and sys.{attributeName} is not empty");
+            }
+        }
+    }
+}
diff --git a/src/runtime/Python.Runtime.csproj b/src/runtime/Python.Runtime.csproj
@@ -19,12 +19,6 @@
     <DefineConstants>$(DefineConstants);$(ConfiguredConstants)</DefineConstants>
   </PropertyGroup>
 
-  <ItemGroup Condition=" '$(PythonInteropFile)' != '' ">
-    <Compile Remove="interop*.cs" />
-    <Compile Include="interop.cs" />
-    <Compile Include="$(PythonInteropFile)" />
-  </ItemGroup>
-
   <ItemGroup>
     <None Remove="resources\clr.py" />
     <EmbeddedResource Include="resources\clr.py">
diff --git a/src/runtime/native/ABI.cs b/src/runtime/native/ABI.cs
@@ -22,7 +22,12 @@ internal static void Initialize(Version version, BorrowedReference pyType)
                 thisAssembly.GetType(nativeTypeOffsetClassName, throwOnError: false)
                 ?? thisAssembly.GetType(className, throwOnError: false);
             if (typeOffsetsClass is null)
-                throw new NotSupportedException($"Python ABI v{version} is not supported");
+            {
+                var types = thisAssembly.GetTypes().Select(type => type.Name).Where(name => name.StartsWith("TypeOffset"));
+                string message = $"Searching for {className}, found {string.Join(",", types)}. " +
+                    "If you are building Python.NET from source, make sure you have run 'python setup.py configure' to fill in configured.props";
+                throw new NotSupportedException($"Python ABI v{version} is not supported: {message}");
+            }
             var typeOffsets = (ITypeOffsets)Activator.CreateInstance(typeOffsetsClass);
             TypeOffset.Use(typeOffsets);
 
