__complex__

docs/reST/ref/math.rst

@@ -171,6 +171,9 @@ Multiple coordinates can be set using slices or swizzling
       Inherited methods of vector subclasses now correctly return an instance of the
       subclass instead of the superclass
 
+   .. versionchanged:: 2.5.3
+      It is now possible to convert a ``Vector2`` to a complex number using ``complex()``.
+
    .. method:: dot
 
       | :sl:`calculates the dot- or scalar-product with the other vector`

src_c/math.c

@@ -2200,6 +2200,19 @@ vector2_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
     return (PyObject *)vec;
 }
 
+static PyObject *
+vector2_complex(pgVector *self, PyObject *_null)
+{
+    PyObject *complex =
+        PyComplex_FromDoubles(self->coords[0], self->coords[1]);
+
+    if (complex == NULL) {
+        RAISE(PyExc_ValueError, "Couldn't build complex number from Vector2");
+    }
+
+    return complex;
+}
+
 static int
 _vector2_set(pgVector *self, PyObject *xOrSequence, PyObject *y)
 {
@@ -2578,6 +2591,7 @@ static PyMethodDef vector2_methods[] = {
      NULL},
     {"__reduce__", (PyCFunction)vector2_reduce, METH_NOARGS, NULL},
     {"__round__", (PyCFunction)vector___round__, METH_VARARGS, NULL},
+    {"__complex__", (PyCFunction)vector2_complex, METH_NOARGS, NULL},
 
     {NULL} /* Sentinel */
 };

test/math_test.py

@@ -273,6 +273,22 @@ def assign_nonfloat():
 
         self.assertRaises(TypeError, assign_nonfloat)
 
+    def test__complex__(self):
+        vec1 = pygame.Vector2(23, 45)
+        vec2 = pygame.Vector2(-123, 4859358338)
+        vec3 = pygame.Vector3(-25720.733232, -9404993.45)
+
+        complex1 = complex(vec1)
+        complex2 = complex(vec2)
+        complex3 = complex(vec3)
+
+        self.assertEqual(vec1.x, complex1.real)
+        self.assertEqual(vec1.y, complex1.imag)
+        self.assertEqual(vec2.x, complex2.real)
+        self.assertEqual(vec2.y, complex2.imag)
+        self.assertAlmostEqual(vec3.x, complex3.real)
+        self.assertAlmostEqual(vec3.y, complex3.imag)
+
     def test___round___basic(self):
         self.assertEqual(round(pygame.Vector2(0.0, 0.0)), pygame.Vector2(0.0, 0.0))
         self.assertEqual(type(round(pygame.Vector2(0.0, 0.0))), pygame.Vector2)