8000 gh-110235: Raise `TypeError` for duplicate/unknown fields in PyStructSequence constructor by XuehaiPan · Pull Request #110258 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-110235: Raise TypeError for duplicate/unknown fields in PyStructSequence constructor #110258

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
merged 19 commits into from
Oct 4, 2023
Merged

gh-110235: Raise TypeError for duplicate/unknown fields in PyStructSequence constructor #110258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
da93f2f
Raise `TypeError` for duplicate/unknown fields in PyStructSequence co…
XuehaiPan Oct 3, 2023
9632370
📜🤖 Added by blurb_it.
blurb-it[bot] Oct 3, 2023
464cbaf
Add test for duplicate/unknown fields in PyStructSequence constructor
XuehaiPan Oct 3, 2023
11a8435
Add test for duplicate/unknown fields in PyStructSequence constructor
XuehaiPan Oct 3, 2023
9fc1501
Handle case for PyStructSequence with unnamed fields
XuehaiPan Oct 3, 2023
981e403
Handle case for PyStructSequence with unnamed fields
XuehaiPan Oct 3, 2023
67954db
Add more test cases
XuehaiPan Oct 3, 2023
06c5d44
Merge branch 'main' into structseq-new
XuehaiPan Oct 3, 2023
9c3f7d2
Add more test cases
XuehaiPan Oct 3, 2023
c927e1e
Move tests to better places
XuehaiPan Oct 3, 2023
c173451
Revert test changes for structseq.__reduce__
XuehaiPan Oct 3, 2023
704ccaa
Refactor and simplify error handling
XuehaiPan Oct 3, 2023
8f216b8
Refactor and simplify error handling
XuehaiPan Oct 3, 2023
04a19cc
Also check the input dict size
XuehaiPan Oct 3, 2023
782fa4a
Merge branch 'main' into structseq-new
XuehaiPan Oct 3, 2023
297459e
Merge branch 'main' into structseq-new
XuehaiPan Oct 4, 2023
bd2782c
Split for-loop for better code readability
XuehaiPan Oct 4, 2023
04a554d
Remove unnecessary error checking
XuehaiPan Oct 4, 2023
41e4d0b
Merge branch 'main' into structseq-new
XuehaiPan Oct 4, 2023
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
60 changes: 60 additions & 0 deletions Lib/test/test_structseq.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import copy
import os
import pickle
import re
import time
import unittest

Expand Down Expand Up @@ -91,10 +92,69 @@ def test_constructor(self):
self.assertRaises(TypeError, t, "123")
self.assertRaises(TypeError, t, "123", dict={})
self.assertRaises(TypeError, t, "123456789", dict=None)
self.assertRaises(TypeError, t, seq="123456789", dict={})

self.assertEqual(t("123456789"), tuple("123456789"))
self.assertEqual(t("123456789", {}), tuple("123456789"))
self.assertEqual(t("123456789", dict={}), tuple("123456789"))
self.assertEqual(t(sequence="123456789", dict={}), tuple("123456789"))

self.assertEqual(t("1234567890"), tuple("123456789"))
self.assertEqual(t("1234567890").tm_zone, "0")
self.assertEqual(t("123456789", {"tm_zone": "some zone"}), tuple("123456789"))
self.assertEqual(t("123456789", {"tm_zone": "some zone"}).tm_zone, "some zone")

s = "123456789"
self.assertEqual("".join(t(s)), s)

def test_constructor_with_duplicate_fields(self):
t = time.struct_time

error_message = re.escape("got duplicate or unexpected field name(s)")
with self.assertRaisesRegex(TypeError, error_message):
t("1234567890", dict={"tm_zone": "some zone"})
with self.assertRaisesRegex(TypeError, error_message):
t("1234567890", dict={"tm_zone": "some zone", "tm_mon": 1})
with self.assertRaisesRegex(TypeError, error_message):
t("1234567890", dict={"error": 0, "tm_zone": "some zone"})
with self.assertRaisesRegex(TypeError, error_message):
t("1234567890", dict={"error": 0, "tm_zone": "some zone", "tm_mon": 1})

def test_constructor_with_duplicate_unnamed_fields(self):
assert os.stat_result.n_unnamed_fields > 0
n_visible_fields = os.stat_result.n_sequence_fields

r = os.stat_result(range(n_visible_fields), {'st_atime': -1.0})
self.assertEqual(r.st_atime, -1.0)
self.assertEqual(r, tuple(range(n_visible_fields)))

r = os.stat_result((*range(n_visible_fields), -1.0))
self.assertEqual(r.st_atime, -1.0)
self.assertEqual(r, tuple(range(n_visible_fields)))

with self.assertRaisesRegex(TypeError,
re.escape("got duplicate or unexpected field name(s)")):
os.stat_result((*range(n_visible_fields), -1.0), {'st_atime': -1.0})

def test_constructor_with_unknown_fields(self):
t = time.struct_time

error_message = re.escape("got duplicate or unexpected field name(s)")
with self.assertRaisesRegex(TypeError, error_message):
t("123456789", dict={"tm_year": 0})
with self.assertRaisesRegex(TypeError, error_message):
t("123456789", dict={"tm_year": 0, "tm_mon": 1})
with self.assertRaisesRegex(TypeError, error_message):
t("123456789", dict={"tm_zone": "some zone", "tm_mon": 1})
with self.assertRaisesRegex(TypeError, error_message):
t("123456789", dict={"tm_zone": "some zone", "error": 0})
with self.assertRaisesRegex(TypeError, error_message):
t("123456789", dict={"error": 0, "tm_zone": "some zone", "tm_mon": 1})
with self.assertRaisesRegex(TypeError, error_message):
t("123456789", dict={"error": 0})
with self.assertRaisesRegex(TypeError, error_message):
t("123456789", dict={"tm_zone": "some zone", "error": 0})

def test_eviltuple(self):
class Exc(Exception):
pass
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/C API/2023-10-03-06-19-10.gh-issue-110235.uec5AG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Raise :exc:`TypeError` for duplicate/unknown fields in ``PyStructSequence`` constructor.
Patched by Xuehai Pan.
29 changes: 22 additions & 7 deletions Objects/structseq.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,19 +216,34 @@ structseq_new_impl(PyTypeObject *type, PyObject *arg, PyObject *dict)
res->ob_item[i] = Py_NewRef(v);
}
Py_DECREF(arg);
for (; i < max_len; ++i) {
PyObject *ob = NULL;
if (dict != NULL) {
const char *name = type->tp_members[i-n_unnamed_fields].name;
if (dict != NULL && PyDict_GET_SIZE(dict) > 0) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I add this guard check before the for-loop to avoid unnecessary dictionary lookup for empty dict.

Py_ssize_t n_found_keys = 0;
for (i = len; i < max_len; ++i) {
PyObject *ob = NULL;
const char *name = type->tp_members[i - n_unnamed_fields].name;
if (PyDict_GetItemStringRef(dict, name, &ob) < 0) {
Py_DECREF(res);
return NULL;
}
if (ob == NULL) {
ob = Py_NewRef(Py_None);
}
else {
++n_found_keys;
}
res->ob_item[i] = ob;
}
if (PyDict_GET_SIZE(dict) > n_found_keys) {
PyErr_Format(PyExc_TypeError,
"%.500s() got duplicate or unexpected field name(s)",
type->tp_name);
Py_DECREF(res);
return NULL;
}
if (ob == NULL) {
ob = Py_NewRef(Py_None);
} else {
for (i = len; i < max_len; ++i) {
res->ob_item[i] = Py_NewRef(Py_None);
}
res->ob_item[i] = ob;
}

_PyObject_GC_TRACK(res);
Expand Down
0