Add formatting and linting for C# files

pythonnet · filmor · Mar 31, 2024 · Mar 31, 2024 · Mar 31, 2024 · Mar 31, 2024
commit 76857c01cd05042a0205eba593e4e0a90a01a1c9
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,30 @@
+name: Linting
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  lint-dotnet:
+    name: Lint .NET
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '7.0.x'
+
+      - name: Lint
+        run: dotnet format -v diag --verify-no-changes --report=format.json
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: format-report
+          path: format.json
diff --git a/src/console/pythonconsole.cs b/src/console/pythonconsole.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Reflection;
+
 using Python.Runtime;
 
 namespace Python.Runtime

diff --git a/src/embed_tests/CodecGroups.cs b/src/embed_tests/CodecGroups.cs
@@ -2,7 +2,9 @@ namespace Python.EmbeddingTest
 {
     using System;
     using System.Linq;
+
     using NUnit.Framework;
+
     using Python.Runtime;
     using Python.Runtime.Codecs;
 
@@ -20,7 +22,7 @@ public void GetEncodersByType()
             };
 
             var got = group.GetEncoders(typeof(Uri)).ToArray();
-            CollectionAssert.AreEqual(new[]{encoder1, encoder2}, got);
+            CollectionAssert.AreEqual(new[] { encoder1, encoder2 }, got);
         }
 
         [Test]

diff --git a/src/embed_tests/Codecs.cs b/src/embed_tests/Codecs.cs
@@ -1,8 +1,11 @@
-namespace Python.EmbeddingTest {
+namespace Python.EmbeddingTest
+{
     using System;
     using System.Collections.Generic;
     using System.Linq;
+
     using NUnit.Framework;
+
     using Python.Runtime;
     using Python.Runtime.Codecs;
 
@@ -169,7 +172,8 @@ public void SequenceDecoderTest()
             ICollection<string> stringCollection = null;
             Assert.DoesNotThrow(() => { codec.TryDecode(pyList, out stringCollection); });
             Assert.AreEqual(3, stringCollection.Count());
-            Assert.Throws(typeof(InvalidCastException), () => {
+            Assert.Throws(typeof(InvalidCastException), () =>
+            {
                 string[] array = new string[3];
                 stringCollection.CopyTo(array, 0);
             });
@@ -206,7 +210,8 @@ public void SequenceDecoderTest()
             ICollection<string> stringCollection2 = null;
             Assert.DoesNotThrow(() => { codec.TryDecode(pyTuple, out stringCollection2); });
             Assert.AreEqual(3, stringCollection2.Count());
-            Assert.Throws(typeof(InvalidCastException), () => {
+            Assert.Throws(typeof(InvalidCastException), () =>
+            {
                 string[] array = new string[3];
                 stringCollection2.CopyTo(array, 0);
             });
@@ -255,13 +260,15 @@ public void IterableDecoderTest()
             IEnumerable<string> stringEnumerable = null;
             Assert.DoesNotThrow(() => { codec.TryDecode(pyList, out stringEnumerable); });
 
-            Assert.Throws(typeof(InvalidCastException), () => {
+            Assert.Throws(typeof(InvalidCastException), () =>
+            {
                 foreach (string item in stringEnumerable)
                 {
                     var x = item;
                 }
             });
-            Assert.Throws(typeof(InvalidCastException), () => {
+            Assert.Throws(typeof(InvalidCastException), () =>
+            {
                 stringEnumerable.Count();
             });
 
@@ -390,7 +397,7 @@ public void ExceptionDecodedNoInstance()
             }
         }
 
-        public static void AcceptsDateTime(DateTime v) {}
+        public static void AcceptsDateTime(DateTime v) { }
 
         [Test]
         public void As_Object_AffectedByDecoders()

diff --git a/src/embed_tests/GlobalTestsSetup.cs b/src/embed_tests/GlobalTestsSetup.cs
@@ -1,4 +1,5 @@
 using NUnit.Framework;
+
 using Python.Runtime;
 
 namespace Python.EmbeddingTest

diff --git a/src/embed_tests/Inheritance.cs b/src/embed_tests/Inheritance.cs
@@ -206,9 +206,9 @@ public class PropertyAccessorBase
         public virtual string VirtualProp { get; set; }
     }
 
-    public class PropertyAccessorIntermediate: PropertyAccessorBase { }
+    public class PropertyAccessorIntermediate : PropertyAccessorBase { }
 
-    public class PropertyAccessorDerived: PropertyAccessorIntermediate
+    public class PropertyAccessorDerived : PropertyAccessorIntermediate
     {
         public override string VirtualProp { set => base.VirtualProp = value.ToUpperInvariant(); }
     }
@@ -217,7 +217,7 @@ public class ContainerClass
     {
         public void BaseMethod() { }
 
-        public class InnerClass: ContainerClass
+        public class InnerClass : ContainerClass
         {
 
         }

diff --git a/src/embed_tests/Modules.cs b/src/embed_tests/Modules.cs
@@ -1,6 +1,8 @@
 using System;
 using System.Threading;
+
 using NUnit.Framework;
+
 using Python.Runtime;
 
 namespace Python.EmbeddingTest
@@ -385,8 +387,8 @@ public void TestThread()
                     //add function to the scope
                     //can be call many times, more efficient than ast
                     ps.Exec(
-                        "import threading\n"+
-                        "lock = threading.Lock()\n"+
+                        "import threading\n" +
+                        "lock = threading.Lock()\n" +
                         "def update():\n" +
                         "  global res, th_cnt\n" +
                         "  with lock:\n" +

diff --git a/src/embed_tests/NumPyTests.cs b/src/embed_tests/NumPyTests.cs
@@ -68,7 +68,7 @@ public void VarArg()
         {
             dynamic zX = np.array(new[,] { { 1, 2, 3 }, { 4, 5, 6 }, { 8, 9, 0 } });
             dynamic grad = np.gradient(zX, 4.0, 5.0);
-            dynamic grad2 = np.InvokeMethod("gradient", new PyObject[] {zX, new PyFloat(4.0), new PyFloat(5.0)});
+            dynamic grad2 = np.InvokeMethod("gradient", new PyObject[] { zX, new PyFloat(4.0), new PyFloat(5.0) });
 
             Assert.AreEqual(4.125, grad[0].sum().__float__().As<double>(), 0.001);
             Assert.AreEqual(-1.2, grad[1].sum().__float__().As<double>(), 0.001);

diff --git a/src/embed_tests/References.cs b/src/embed_tests/References.cs
@@ -1,6 +1,7 @@
 namespace Python.EmbeddingTest
 {
     using NUnit.Framework;
+
     using Python.Runtime;
 
     public class References

diff --git a/src/embed_tests/TestCallbacks.cs b/src/embed_tests/TestCallbacks.cs
@@ -1,28 +1,35 @@
 using System;
 
 using NUnit.Framework;
+
 using Python.Runtime;
 
-namespace Python.EmbeddingTest {
-    public class TestCallbacks {
+namespace Python.EmbeddingTest
+{
+    public class TestCallbacks
+    {
         [OneTimeSetUp]
-        public void SetUp() {
+        public void SetUp()
+        {
             PythonEngine.Initialize();
         }
 
         [OneTimeTearDown]
-        public void Dispose() {
+        public void Dispose()
+        {
             PythonEngine.Shutdown();
         }
 
         [Test]
-        public void TestNoOverloadException() {
+        public void TestNoOverloadException()
+        {
             int passed = 0;
             var aFunctionThatCallsIntoPython = new Action<int>(value => passed = value);
-            using (Py.GIL()) {
+            using (Py.GIL())
+            {
                 using dynamic callWith42 = PythonEngine.Eval("lambda f: f([42])");
                 using var pyFunc = aFunctionThatCallsIntoPython.ToPython();
-                var error =  Assert.Throws<PythonException>(() => callWith42(pyFunc));
+                var error = Assert.Throws<PythonException>(() => callWith42(pyFunc));
                 Assert.AreEqual("TypeError", error.Type.Name);
                 string expectedArgTypes = "(<class 'list'>)";
                 StringAssert.EndsWith(expectedArgTypes, error.Message);

diff --git a/src/embed_tests/TestConverter.cs b/src/embed_tests/TestConverter.cs
@@ -46,7 +46,7 @@ public void TestConvertSingleToManaged(
             var converted = Converter.ToManaged(pyFloat, typeof(float), out convertedValue, false);
 
             Assert.IsTrue(converted);
-            Assert.IsTrue(((float) convertedValue).Equals(testValue));
+            Assert.IsTrue(((float)convertedValue).Equals(testValue));
         }
 
         [Test]
@@ -60,7 +60,7 @@ public void TestConvertDoubleToManaged(
             var converted = Converter.ToManaged(pyFloat, typeof(double), out convertedValue, false);
 
             Assert.IsTrue(converted);
-            Assert.IsTrue(((double) convertedValue).Equals(testValue));
+            Assert.IsTrue(((double)convertedValue).Equals(testValue));
         }
 
         [Test]
@@ -164,7 +164,7 @@ public void ToPyList()
         [Test]
         public void RawListProxy()
         {
-            var list = new List<string> {"hello", "world"};
+            var list = new List<string> { "hello", "world" };
             var listProxy = PyObject.FromManagedObject(list);
             var clrObject = (CLRObject)ManagedType.GetManagedObject(listProxy);
             Assert.AreSame(list, clrObject.inst);

diff --git a/src/embed_tests/TestCustomMarshal.cs b/src/embed_tests/TestCustomMarshal.cs
@@ -1,5 +1,7 @@
 using System;
+
 using NUnit.Framework;
+
 using Python.Runtime;
 
 namespace Python.EmbeddingTest

diff --git a/src/embed_tests/TestDomainReload.cs b/src/embed_tests/TestDomainReload.cs
@@ -3,7 +3,9 @@
 using System.Diagnostics;
 using System.Reflection;
 using System.Runtime.InteropServices;
+
 using NUnit.Framework;
+
 using Python.Runtime;
 
 using PyRuntime = Python.Runtime.Runtime;

diff --git a/src/embed_tests/TestFinalizer.cs b/src/embed_tests/TestFinalizer.cs
@@ -1,12 +1,14 @@
-using NUnit.Framework;
-using Python.Runtime;
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
 using System.Runtime.CompilerServices;
 using System.Threading;
 
+using NUnit.Framework;
+
+using Python.Runtime;
+
 namespace Python.EmbeddingTest
 {
     public class TestFinalizer
@@ -237,7 +239,7 @@ private static IntPtr CreateStringGarbage()
             PyString s1 = new PyString("test_string");
             // s2 steal a reference from s1
             IntPtr address = s1.Reference.DangerousGetAddress();
-            PyString s2 = new (StolenReference.DangerousFromPointer(address));
+            PyString s2 = new(StolenReference.DangerousFromPointer(address));
             return address;
         }
     }

diff --git a/src/embed_tests/TestGILState.cs b/src/embed_tests/TestGILState.cs
@@ -1,6 +1,7 @@
 namespace Python.EmbeddingTest
 {
     using NUnit.Framework;
+
     using Python.Runtime;
 
     public class TestGILState
@@ -13,7 +14,7 @@ public void CanDisposeMultipleTimes()
         {
             using (var gilState = Py.GIL())
             {
-                for(int i = 0; i < 50; i++)
+                for (int i = 0; i < 50; i++)
                     gilState.Dispose();
             }
         }

diff --git a/src/embed_tests/TestInstanceWrapping.cs b/src/embed_tests/TestInstanceWrapping.cs
@@ -1,6 +1,8 @@
 using System;
 using System.Globalization;
+
 using NUnit.Framework;
+
 using Python.Runtime;
 
 namespace Python.EmbeddingTest
@@ -44,10 +46,10 @@ public void WeakRefIsNone_AfterObjectIsGone()
             Assert.IsTrue(weakref.Invoke().IsNone());
         }
 
-        class Base {}
-        class Derived: Base { }
+        class Base { }
+        class Derived : Base { }
 
-        class Overloaded: Derived
+        class Overloaded : Derived
         {
             public int Value { get; set; }
             public void IntOrStr(int arg) => this.Value = arg;

diff --git a/src/embed_tests/TestNamedArguments.cs b/src/embed_tests/TestNamedArguments.cs
@@ -1,5 +1,7 @@
 using System;
+
 using NUnit.Framework;
+
 using Python.Runtime;
 
 namespace Python.EmbeddingTest

diff --git a/src/embed_tests/TestOperator.cs b/src/embed_tests/TestOperator.cs
@@ -1,12 +1,12 @@
+using System;
+using System.Linq;
+using System.Reflection;
+
 using NUnit.Framework;
 
 using Python.Runtime;
 using Python.Runtime.Codecs;
 
-using System;
-using System.Linq;
-using System.Reflection;
-
 namespace Python.EmbeddingTest
 {
     public class TestOperator
@@ -541,12 +541,12 @@ public void ForwardOperatorOverloads()
         [Test]
         public void TupleComparisonOperatorOverloads()
         {
-                TupleCodec<ValueTuple>.Register();
-                string name = string.Format("{0}.{1}",
-                typeof(OperableObject).DeclaringType.Name,
-                typeof(OperableObject).Name);
+            TupleCodec<ValueTuple>.Register();
+            string name = string.Format("{0}.{1}",
+            typeof(OperableObject).DeclaringType.Name,
+            typeof(OperableObject).Name);
             string module = MethodBase.GetCurrentMethod().DeclaringType.Namespace;
-                PythonEngine.Exec($@"
+            PythonEngine.Exec($@"
 from {module} import *
 cls = {name}
 a = cls(2)