Skip to content

gh-94808:Improve coverage of PyObject_Print #98749

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
encukou merged 10 commits into from
Apr 1, 2024
Merged

gh-94808:Improve coverage of PyObject_Print #98749

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7055a43
Improve coverage of PyObject_Print
MonadChains Oct 26, 2022
562b9d2
Merge branch 'main' into gh-94808/improve-coverage-pyobject-print
MonadChains Oct 27, 2022
25c24e4
Close file when error is returned
MonadChains Oct 28, 2022
64d8d19
Merge branch 'main' into gh-94808/improve-coverage-pyobject-print
MonadChains Nov 1, 2022
2202e4a
Rework negative reference test
MonadChains Nov 1, 2022
2bbb608
Merge in the main branch
encukou Mar 25, 2024
abf998e
Move the new tests
encukou Mar 25, 2024
d8e2e0e
Nitpicks
encukou Mar 25, 2024
355e8e4
Use Py_SET_REFCNT rather than ob_refcnt
encukou Mar 25, 2024
c14d4dd
Merge in the main branch
encukou Apr 1, 2024
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
Prev Previous commit
Next Next commit
Nitpicks 
- Use test helpers
- Use PyOS_snprintf
- Touch up formatting (PEP 7)
  • Loading branch information
@encukou
encukou committed Mar 25, 2024
commit d8e2e0ee53b5950e683bf74ea687db727cb653ac
33 changes: 10 additions & 23 deletions Lib/test/test_capi/test_object.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import enum
import unittest
from test.support import import_helper
from test.support import os_helper

_testlimitedcapi = import_helper.import_module('_testlimitedcapi')
_testcapi = import_helper.import_module('_testcapi')
Expand Down Expand Up @@ -53,9 +54,6 @@ def test_get_constant_borrowed(self):

class PrintTest(unittest.TestCase):
def testPyObjectPrintObject(self):
import os
import test.support.os_helper as os_helper
from test.support import import_helper

class PrintableObject:

Expand All @@ -67,54 +65,43 @@ def __str__(self):

obj = PrintableObject()
output_filename = os_helper.TESTFN
self.addCleanup(os_helper.unlink, output_filename)

# Test repr printing
_testcapi.call_pyobject_print(obj, output_filename, False)
with open(output_filename, 'r') as output_file:
self.assertEqual(output_file.read(), repr(obj))

# Test str printing
_testcapi.call_pyobject_print(obj, output_filename, True)
with open(output_filename, 'r') as output_file:
self.assertEqual(output_file.read(), str(obj))

os.remove(output_filename)

def testPyObjectPrintNULL(self):
import os
import test.support.os_helper as os_helper
from test.support import import_helper

output_filename = os_helper.TESTFN
self.addCleanup(os_helper.unlink, output_filename)

# Test repr printing
_testcapi.pyobject_print_null(output_filename)
with open(output_filename, 'r') as output_file:
self.assertEqual(output_file.read(), '<nil>')

os.remove(output_filename)

def testPyObjectPrintNoRefObject(self):
import os
import test.support.os_helper as os_helper
from test.support import import_helper

output_filename = os_helper.TESTFN
self.addCleanup(os_helper.unlink, output_filename)

# Test repr printing
correct_output = _testcapi.pyobject_print_noref_object(output_filename)
with open(output_filename, 'r') as output_file:
self.assertEqual(output_file.read(), correct_output)

os.remove(output_filename)

def testPyObjectPrintOSError(self):
import os
import test.support.os_helper as os_helper
from test.support import import_helper

output_filename = os_helper.TESTFN
self.addCleanup(os_helper.unlink, output_filename)

open(output_filename, "w+").close()
with self.assertRaises(OSError):
_testcapi.pyobject_print_os_error(output_filename)

os.remove(output_filename)

if __name__ == "__main__":
unittest.main()
10 changes: 6 additions & 4 deletions Modules/_testcapi/object.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ call_pyobject_print(PyObject *self, PyObject * args)
FILE *fp;
int flags = 0;

if (!PyArg_UnpackTuple(args, "call_pyobject_print", 3, 3, &object, &filename, &print_raw)) {
if (!PyArg_UnpackTuple(args, "call_pyobject_print", 3, 3,
&object, &filename, &print_raw)) {
return NULL;
}

Expand Down Expand Up @@ -62,9 +63,10 @@ pyobject_print_noref_object(PyObject *self, PyObject *args)

test_string = PyUnicode_FromString("Spam spam spam");

test_string -> ob_refcnt = 0;
test_string->ob_refcnt = 0;

snprintf(correct_string, 100, "<refcnt %zd at %p>", Py_REFCNT(test_string), (void *)test_string);
PyOS_snprintf(correct_string, 100, "<refcnt %zd at %p>",
Py_REFCNT(test_string), (void *)test_string);

if (!PyArg_UnpackTuple(args, "call_pyobject_print", 1, 1, &filename)) {
return NULL;
Expand All @@ -79,7 +81,7 @@ pyobject_print_noref_object(PyObject *self, PyObject *args)

fclose(fp);

test_string -> ob_refcnt = 1;
test_string->ob_refcnt = 1;
Py_DECREF(test_string);

return PyUnicode_FromString(correct_string);
Expand Down