Skip to content

Fix pygame.Vector{2,3} initialization from numpy arrays #3408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
damusss merged 3 commits into from
Apr 21, 2025
Merged

Fix pygame.Vector{2,3} initialization from numpy arrays #3408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec30d0b
swap checking order for numbers and sequences to handle cases where s…
Matiiss Apr 20, 2025
13c5887
add tests to prevent a regression
Matiiss Apr 20, 2025
92dd2d6
fix vector3 tests and also actually fix vector3 init cuz I forgot to …
Matiiss Apr 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 35 additions & 17 deletions src_c/math.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2280,19 +2280,23 @@ static int
_vector2_set(pgVector *self, PyObject *xOrSequence, PyObject *y)
{
if (xOrSequence) {
if (RealNumber_Check(xOrSequence)) {
self->coords[0] = PyFloat_AsDouble(xOrSequence);
/* scalar constructor. */
if (y == NULL) {
self->coords[1] = self->coords[0];
if (pgVectorCompatible_Check(xOrSequence, self->dim)) {
if (!PySequence_AsVectorCoords(xOrSequence, self->coords, 2)) {
return -1;
}
else {
return 0;
}
}
else if (pgVectorCompatible_Check(xOrSequence, self->dim)) {
if (!PySequence_AsVectorCoords(xOrSequence, self->coords, 2)) {
else if (RealNumber_Check(xOrSequence)) {
self->coords[0] = PyFloat_AsDouble(xOrSequence);
if (self->coords[0] == -1.0 && PyErr_Occurred()) {
return -1;
}
else {

/* scalar constructor. */
if (y == NULL) {
self->coords[1] = self->coords[0];
return 0;
}
}
Expand Down Expand Up @@ -2323,6 +2327,9 @@ _vector2_set(pgVector *self, PyObject *xOrSequence, PyObject *y)

if (RealNumber_Check(y)) {
self->coords[1] = PyFloat_AsDouble(y);
if (self->coords[1] == -1.0 && PyErr_Occurred()) {
return -1;
}
}
else {
goto error;
Expand Down Expand Up @@ -2718,20 +2725,24 @@ static int
_vector3_set(pgVector *self, PyObject *xOrSequence, PyObject *y, PyObject *z)
{
if (xOrSequence) {
if (RealNumber_Check(xOrSequence)) {
self->coords[0] = PyFloat_AsDouble(xOrSequence);
/* scalar constructor. */
if (y == NULL && z == NULL) {
self->coords[1] = self->coords[0];
self->coords[2] = self->coords[0];
if (pgVectorCompatible_Check(xOrSequence, self->dim)) {
if (!PySequence_AsVectorCoords(xOrSequence, self->coords, 3)) {
return -1;
}
else {
return 0;
}
}
else if (pgVectorCompatible_Check(xOrSequence, self->dim)) {
if (!PySequence_AsVectorCoords(xOrSequence, self->coords, 3)) {
else if (RealNumber_Check(xOrSequence)) {
self->coords[0] = PyFloat_AsDouble(xOrSequence);
if (self->coords[0] == -1.0 && PyErr_Occurred()) {
return -1;
}
else {

/* scalar constructor. */
if (y == NULL && z == NULL) {
self->coords[1] = self->coords[0];
self->coords[2] = self->coords[0];
return 0;
}
}
Expand Down Expand Up @@ -2764,7 +2775,14 @@ _vector3_set(pgVector *self, PyObject *xOrSequence, PyObject *y, PyObject *z)
else if (y && z) {
if (RealNumber_Check(y) && RealNumber_Check(z)) {
self->coords[1] = PyFloat_AsDouble(y);
if (self->coords[1] == -1.0 && PyErr_Occurred()) {
return -1;
}

self->coords[2] = PyFloat_AsDouble(z);
if (self->coords[2] == -1.0 && PyErr_Occurred()) {
return -1;
}
}
else {
goto error;
Expand Down
94 changes: 94 additions & 0 deletions test/math_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@
import pygame.math
from pygame.math import Vector2, Vector3

try:
import numpy
except ModuleNotFoundError:
numpy = None

IS_PYPY = "PyPy" == platform.python_implementation()


Expand Down Expand Up @@ -255,6 +260,48 @@ def testConstructionVector2(self):
self.assertEqual(v.x, 1.2)
self.assertEqual(v.y, 3.4)

def testConstructionNumericSequence(self):
class NumericSequence:
# PyFloat_AsDouble will use this to convert to a float
# so this is testing the implementation a bit
def __float__(self):
raise TypeError("Cannot convert to float")

def __getitem__(self, index):
return [1, 0][index]

def __len__(self):
return 2

v = Vector2(NumericSequence())
self.assertEqual(v.x, 1.0)
self.assertEqual(v.y, 0.0)

def testConstructionNumericNonFloat(self):
class NumericNonFloat:
# PyFloat_AsDouble will use this to convert to a float
# so this is testing the implementation a bit
def __float__(self):
raise TypeError("Cannot convert to float")

with self.assertRaises(TypeError):
Vector2(NumericNonFloat())

with self.assertRaises(TypeError):
Vector2(NumericNonFloat(), NumericNonFloat())

with self.assertRaises(TypeError):
Vector2(1.0, NumericNonFloat())

@unittest.skipIf(numpy is None, "numpy not available")
def testConstructionNumpyArray(self):
assert numpy is not None

arr = numpy.array([1.2, 3.4])
v = Vector2(arr)
self.assertEqual(v.x, 1.2)
self.assertEqual(v.y, 3.4)

def testAttributeAccess(self):
tmp = self.v1.x
self.assertEqual(tmp, self.v1.x)
Expand Down Expand Up @@ -1431,6 +1478,53 @@ def testConstructionMissing(self):
self.assertRaises(ValueError, Vector3, 1, 2)
self.assertRaises(ValueError, Vector3, x=1, y=2)

def testConstructionNumericSequence(self):
class NumericSequence:
# PyFloat_AsDouble will use this to convert to a float
# so this is testing the implementation a bit
def __float__(self):
raise TypeError("Cannot convert to float")

def __getitem__(self, index):
return [1, 0, 5][index]

def __len__(self):
return 3

v = Vector3(NumericSequence())
self.assertEqual(v.x, 1.0)
self.assertEqual(v.y, 0.0)
self.assertEqual(v.z, 5.0)

def testConstructionNumericNonFloat(self):
class NumericNonFloat:
# PyFloat_AsDouble will use this to convert to a float
# so this is testing the implementation a bit
def __float__(self):
raise TypeError("Cannot convert to float")

with self.assertRaises(TypeError):
Vector3(NumericNonFloat())

with self.assertRaises(TypeError):
Vector3(NumericNonFloat(), NumericNonFloat(), NumericNonFloat())

with self.assertRaises(TypeError):
Vector3(1.0, NumericNonFloat(), 5.0)

with self.assertRaises(TypeError):
Vector3(1.0, 0.0, NumericNonFloat())

@unittest.skipIf(numpy is None, "numpy not available")
def testConstructionNumpyArray(self):
assert numpy is not None

arr = numpy.array([1.2, 3.4, 5.6], dtype=float)
v = Vector3(arr)
self.assertEqual(v.x, 1.2)
self.assertEqual(v.y, 3.4)
self.assertEqual(v.z, 5.6)

def testAttributeAccess(self):
tmp = self.v1.x
self.assertEqual(tmp, self.v1.x)
Expand Down
Loading