Skip to content

gh-114894: add array.array.clear() method #114919

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 14 commits into from
Feb 10, 2024
+71 −1
Merged

gh-114894: add array.array.clear() method #114919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
be9733a
pythongh-114894: add array.array.clear() method
mikeziminio Feb 2, 2024
9c2c360
📜🤖 Added by blurb_it.
blurb-it[bot] Feb 2, 2024
8adac42
added test and documentation
mikeziminio Feb 2, 2024
e04c2fa
fixed - trim trailing whitespace
mikeziminio Feb 2, 2024
7630069
Update Modules/arraymodule.c
mikeziminio Feb 6, 2024
556bf1a
Update Misc/NEWS.d/next/Library/2024-02-02-15-50-13.gh-issue-114894.D…
mikeziminio Feb 6, 2024
b5b9e63
add memoryview test, update other tests
mikeziminio Feb 6, 2024
83422b0
add MutableSequence test
mikeziminio Feb 6, 2024
4d5fcfb
resolve clinic conflicts
mikeziminio Feb 6, 2024
519ad21
add whatsnew doc
mikeziminio Feb 6, 2024
6242242
change issue reference
mikeziminio Feb 6, 2024
fc76d73
move so that it matches the alphabetical order.
mikeziminio Feb 6, 2024
7b46716
Update Doc/whatsnew/3.13.rst
mikeziminio Feb 7, 2024
a399ac6
Update Doc/library/array.rst
mikeziminio Feb 7, 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
7 changes: 7 additions & 0 deletions Doc/library/array.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,13 @@ The module defines the following type:
Remove the first occurrence of *x* from the array.


.. method:: clear()

Remove all elements from the array.

.. versionadded:: 3.13


.. method:: reverse()

Reverse the order of the items in the array.
Expand Down
3 changes: 3 additions & 0 deletions Doc/whatsnew/3.13.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,9 @@ array
It can be used instead of ``'u'`` type code, which is deprecated.
(Contributed by Inada Naoki in :gh:`80480`.)

* Add ``clear()`` method in order to implement ``MutableSequence``.
(Contributed by Mike Zimin in :gh:`114894`.)

ast
---

Expand Down
23 changes: 23 additions & 0 deletions Lib/test/test_array.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1014,6 +1014,29 @@ def test_pop(self):
array.array(self.typecode, self.example[3:]+self.example[:-1])
)

def test_clear(self):
a = array.array(self.typecode, self.example)
with self.assertRaises(TypeError):
a.clear(42)
a.clear()
self.assertEqual(len(a), 0)
self.assertEqual(a.typecode, self.typecode)

a = array.array(self.typecode)
a.clear()
self.assertEqual(len(a), 0)
self.assertEqual(a.typecode, self.typecode)

a = array.array(self.typecode, self.example)
a.clear()
a.append(self.example[2])
a.append(self.example[3])
self.assertEqual(a, array.array(self.typecode, self.example[2:4]))

Copy link
Member

Choose a reason for hiding this comment

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

Add a test that an array with exported buffers cannot be cleared, something like this (untested):

with memoryview(a):
    with self.assertRaises(BufferError):
        a.clear()

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

with memoryview(a):
with self.assertRaises(BufferError):
a.clear()

def test_reverse(self):
a = array.array(self.typecode, self.example)
self.assertRaises(TypeError, a.reverse, 42)
Expand Down
2 changes: 2 additions & 0 deletions Lib/test/test_collections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
"""Unit tests for collections.py."""

import array
import collections
import copy
import doctest
Expand Down Expand Up @@ -1972,6 +1973,7 @@ def test_MutableSequence(self):
for sample in [list, bytearray, deque]:
self.assertIsInstance(sample(), MutableSequence)
self.assertTrue(issubclass(sample, MutableSequence))
self.assertTrue(issubclass(array.array, MutableSequence))
self.assertFalse(issubclass(str, MutableSequence))
self.validate_abstract_methods(MutableSequence, '__contains__', '__iter__',
'__len__', '__getitem__', '__setitem__', '__delitem__', 'insert')
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2024-02-02-15-50-13.gh-issue-114894.DF-dSd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add :meth:`array.array.clear`.
16 changes: 16 additions & 0 deletions Modules/arraymodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -868,6 +868,21 @@ array_slice(arrayobject *a, Py_ssize_t ilow, Py_ssize_t ihigh)
return (PyObject *)np;
}

/*[clinic input]
Copy link
Member

Choose a reason for hiding this comment

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

This will also need new unit tests (probably in test_array.py but I haven't checked) and a documentation entry (in array.rst)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This will also need new unit tests (probably in test_array.py but I haven't checked) and a documentation entry (in array.rst)

Thanks for the comment. I'll try to do it now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

array.array.clear

Remove all items from the array.
[clinic start generated code]*/

static PyObject *
array_array_clear_impl(arrayobject *self)
/*[clinic end generated code: output=5efe0417062210a9 input=5dffa30e94e717a4]*/
{
if (array_resize(self, 0) == -1) {
return NULL;
}
Py_RETURN_NONE;
}

/*[clinic input]
array.array.__copy__
Expand Down Expand Up @@ -2342,6 +2357,7 @@ static PyMethodDef array_methods[] = {
ARRAY_ARRAY_APPEND_METHODDEF
ARRAY_ARRAY_BUFFER_INFO_METHODDEF
ARRAY_ARRAY_BYTESWAP_METHODDEF
ARRAY_ARRAY_CLEAR_METHODDEF
ARRAY_ARRAY___COPY___METHODDEF
ARRAY_ARRAY_COUNT_METHODDEF
ARRAY_ARRAY___DEEPCOPY___METHODDEF
Expand Down
20 changes: 19 additions & 1 deletion Modules/clinic/arraymodule.c.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.