Skip to content
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

gh-94808: add tests covering PySequence_[InPlace]Concat #99319

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+215 −0
Open

gh-94808: add tests covering PySequence_[InPlace]Concat #99319

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3556649
gh-94808: add tests covering `PySequence_[InPlace]Concat`
sobolevn Nov 10, 2022
359b007
Typo
sobolevn Nov 10, 2022
6cee271
Typo
sobolevn Nov 10, 2022
5893ba7
Address review
sobolevn Nov 25, 2022
3f46389
Merge branch 'main' into cover-sequence-concat
sobolevn Mar 24, 2023
db068d7
Address review
sobolevn Mar 24, 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
145 changes: 145 additions & 0 deletions Lib/test/test_operator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,151 @@ def __getitem__(self, other): return 5 # so that C is a sequence
self.assertEqual(operator.ixor (c, 5), "ixor")
self.assertEqual(operator.iconcat (c, c), "iadd")

def test_concat(self):
operator = self.module

# Simple cases:
data1 = [1, 2]
data2 = ['a', 'b']
self.assertEqual(operator.concat(data1, data2), [1, 2, 'a', 'b'])
self.assertEqual(operator.concat(data1, data2), data1 + data2)
self.assertEqual(data1, [1, 2]) # must not change
self.assertEqual(data2, ['a', 'b']) # must not change

data1 = (1, 2)
data2 = ('a', 'b')
self.assertEqual(operator.concat(data1, data2), (1, 2, 'a', 'b'))
self.assertEqual(operator.concat(data1, data2), data1 + data2)
self.assertEqual(data1, (1, 2)) # must not change
self.assertEqual(data2, ('a', 'b')) # must not change

data1 = '12'
data2 = 'ab'
self.assertEqual(operator.concat(data1, data2), '12ab')
self.assertEqual(operator.concat(data1, data2), data1 + data2)
self.assertEqual(data1, '12') # must not change
self.assertEqual(data2, 'ab') # must not change

# Subclasses:
class ListSubclass(list): ...

data1 = ListSubclass([1, 2])
data2 = ListSubclass(['a', 'b'])
self.assertEqual(operator.concat(data1, data2),
ListSubclass([1, 2, 'a', 'b']))
self.assertEqual(operator.concat(data1, data2), data1 + data2)
self.assertEqual(data1, ListSubclass([1, 2])) # must not change
self.assertEqual(data2, ListSubclass(['a', 'b'])) # must not change
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't prove much. The results are in all cases list instances, not ListSubclass instances, because of the way list operator overloading works -- data1+data2 is a plain list, and __eq__ considers a plain list equal to a list subclass with the same elements. The test makes it appear differently.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch, thanks! I've totally missed that. I've added several assertIsInstance checks and updated the expected values.


# Custom type with `__add__`:
class TupleSubclass(tuple):
def __add__(self, other):
return other + self

data1 = TupleSubclass([1, 2])
data2 = ('a', 'b')
self.assertEqual(operator.concat(data1, data2),
TupleSubclass(['a', 'b', 1, 2]))
self.assertEqual(operator.concat(data1, data2), data1 + data2)
self.assertEqual(data1, TupleSubclass([1, 2])) # must not change
self.assertEqual(data2, ('a', 'b')) # must not change

# Corner cases:
self.assertEqual(operator.concat([1, 2], []), [1, 2])
self.assertEqual(operator.concat([], [1, 2]), [1, 2])
self.assertEqual(operator.concat([], []), [])

# Type errors:
self.assertRaises(TypeError, operator.concat, [], 1)
self.assertRaises(TypeError, operator.concat, 1, [])
self.assertRaises(TypeError, operator.concat, 1, 1)
self.assertRaises(TypeError, operator.concat, (), [])
self.assertRaises(TypeError, operator.concat, [], ())

# Returns `NotImplemented`:
class BrokenSeq(tuple):
def __add__(self, other):
return NotImplemented

self.assertRaises(TypeError, operator.concat, BrokenSeq(), BrokenSeq())

def test_iconcat(self):
operator = self.module

# Simple cases:
data1 = [1, 2, 3]
data2 = ['a', 'b']
res = operator.iconcat(data1, data2)
self.assertEqual(res, [1, 2, 3, 'a', 'b'])
self.assertEqual(data1, [1, 2, 3, 'a', 'b']) # must change
self.assertEqual(data2, ['a', 'b']) # must not change

data1 = (1, 2)
data2 = ('a', 'b')
self.assertEqual(operator.iconcat(data1, data2), (1, 2, 'a', 'b'))
self.assertEqual(operator.iconcat(data1, data2), data1 + data2)
self.assertEqual(data1, (1, 2)) # must not change
self.assertEqual(data2, ('a', 'b')) # must not change

data1 = '12'
data2 = 'ab'
self.assertEqual(operator.iconcat(data1, data2), '12ab')
self.assertEqual(operator.iconcat(data1, data2), data1 + data2)
self.assertEqual(data1, '12') # must not change
self.assertEqual(data2, 'ab') # must not change

# Subclasses:
class ListSubclass(list): ...

data1 = ListSubclass([1, 2])
data2 = ListSubclass(['a', 'b'])
res = operator.iconcat(data1, data2)
self.assertEqual(res, ListSubclass([1, 2, 'a', 'b']))
self.assertEqual(data1, ListSubclass([1, 2, 'a', 'b'])) # must change
self.assertEqual(data2, ListSubclass(['a', 'b'])) # must not change

# Custom type with `__add__`:
class TupleSubclass(tuple):
def __add__(self, other):
return other + self

data1 = TupleSubclass([1, 2])
data2 = ('a', 'b')
self.assertEqual(operator.iconcat(data1, data2),
TupleSubclass(['a', 'b', 1, 2]))
self.assertEqual(operator.iconcat(data1, data2), data1 + data2)
self.assertEqual(data1, TupleSubclass([1, 2])) # must not change
self.assertEqual(data2, ('a', 'b')) # must not change

# Corner cases:
self.assertEqual(operator.iconcat([1, 2], []), [1, 2])
self.assertEqual(operator.iconcat([], [1, 2]), [1, 2])
self.assertEqual(operator.iconcat([], []), [])
self.assertEqual(operator.iconcat([], ()), [])

# Type errors:
self.assertRaises(TypeError, operator.iconcat, [], 1)
self.assertRaises(TypeError, operator.iconcat, 1, [])
self.assertRaises(TypeError, operator.iconcat, 1, 1)
self.assertRaises(TypeError, operator.iconcat, (), [])

# Returns `NotImplemented`:
class BrokenSeq1(list):
def __add__(self, other):
return NotImplemented
def __iadd__(self, other):
return NotImplemented

self.assertRaises(TypeError,
operator.iconcat, BrokenSeq1(), BrokenSeq1())

class BrokenSeq2(tuple):
def __add__(self, other):
return NotImplemented

self.assertRaises(TypeError,
operator.iconcat, BrokenSeq2(), BrokenSeq2())

def test_length_hint(self):
operator = self.module
class X(object):
Expand Down