Skip to content

gh-66143: Allow copying of CodecInfo object #109235

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.

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 24 commits into from
Sep 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
e2b6a32
implement __getnewargs__ for codecs to use copy module
furkanonder Dec 22, 2022
e71ea50
test duplicated codec with the original codec
furkanonder Sep 10, 2023
c722e52
Merge branch 'main' into issue-66143
furkanonder Sep 10, 2023
089d89c
📜🤖 Added by blurb_it.
blurb-it[bot] Sep 10, 2023
dbe168b
add test for deepcopy
furkanonder Sep 10, 2023
93070e8
Merge branch 'issue-66143' of github.com:furkanonder/cpython into iss…
furkanonder Sep 10, 2023
271de81
add pickle test for CodecInfo
furkanonder Sep 10, 2023
dff8e3c
add tests for a CodecInfo with _is_text_encoding equal to False
furkanonder Sep 10, 2023
6de32a6
Merge branch 'main' into issue-66143
furkanonder Sep 10, 2023
8c015be
remove white spaces
furkanonder Sep 10, 2023
bddde11
Merge branch 'issue-66143' of github.com:furkanonder/cpython into iss…
furkanonder Sep 10, 2023
f887190
add tests for a CodecInfo with _is_text_encoding equal to False
furkanonder Sep 10, 2023
cfc691c
remove white spaces
furkanonder Sep 10, 2023
73fec7d
update function name as test_deepcopy
furkanonder Sep 11, 2023
d8300cf
add equality test to test_copy
furkanonder Sep 11, 2023
bb6f4ba
add equality check to test methods
furkanonder Sep 11, 2023
f3d87eb
use base64 instead of rot13
furkanonder Sep 11, 2023
afea5b9
check name, incrementalencoder and _is_text_encoding in pickle test c…
furkanonder Sep 11, 2023
807dfd4
add assertIsNot check to pickle tests
furkanonder Sep 11, 2023
e3c6ce3
use base64 instead of rot13
furkanonder Sep 11, 2023
ef0df6a
add equality check to test methods
furkanonder Sep 11, 2023
026d1e2
add equality check to test methods
furkanonder Sep 11, 2023
9c12be6
Update 2023-09-10-20-23-20.gh-issue-66143.71xvgL.rst
serhiy-storchaka Sep 12, 2023
f0ea5c7
fix typo in news entry
furkanonder Sep 12, 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
3 changes: 3 additions & 0 deletions Lib/codecs.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,9 @@ def __repr__(self):
(self.__class__.__module__, self.__class__.__qualname__,
self.name, id(self))

def __getnewargs__(self):
return tuple(self)

class Codec:

""" Defines the interface for stateless encoders/decoders.
Expand Down
70 changes: 70 additions & 0 deletions Lib/test/test_codecs.py
Original file line number Diff line number Diff line change
Expand Up @@ -1762,6 +1762,76 @@ def test_file_closes_if_lookup_error_raised(self):

file().close.assert_called()

def test_copy(self):
orig = codecs.lookup('utf-8')
dup = copy.copy(orig)
self.assertIsNot(dup, orig)
self.assertEqual(dup, orig)
self.assertTrue(orig._is_text_encoding)
self.assertEqual(dup.encode, orig.encode)
self.assertEqual(dup.name, orig.name)
self.assertEqual(dup.incrementalencoder, orig.incrementalencoder)

# Test a CodecInfo with _is_text_encoding equal to false.
orig = codecs.lookup("base64")
dup = copy.copy(orig)
self.assertIsNot(dup, orig)
self.assertEqual(dup, orig)
self.assertFalse(orig._is_text_encoding)
self.assertEqual(dup.encode, orig.encode)
self.assertEqual(dup.name, orig.name)
self.assertEqual(dup.incrementalencoder, orig.incrementalencoder)

def test_deepcopy(self):
orig = codecs.lookup('utf-8')
dup = copy.deepcopy(orig)
self.assertIsNot(dup, orig)
self.assertEqual(dup, orig)
self.assertTrue(orig._is_text_encoding)
self.assertEqual(dup.encode, orig.encode)
self.assertEqual(dup.name, orig.name)
self.assertEqual(dup.incrementalencoder, orig.incrementalencoder)

# Test a CodecInfo with _is_text_encoding equal to false.
orig = codecs.lookup("base64")
dup = copy.deepcopy(orig)
self.assertIsNot(dup, orig)
self.assertEqual(dup, orig)
self.assertFalse(orig._is_text_encoding)
self.assertEqual(dup.encode, orig.encode)
self.assertEqual(dup.name, orig.name)
self.assertEqual(dup.incrementalencoder, orig.incrementalencoder)

def test_pickle(self):
codec_info = codecs.lookup('utf-8')
for proto in range(pickle.HIGHEST_PROTOCOL + 1):
with self.subTest(protocol=proto):
pickled_codec_info = pickle.dumps(codec_info)
unpickled_codec_info = pickle.loads(pickled_codec_info)
self.assertIsNot(codec_info, unpickled_codec_info)
self.assertEqual(codec_info, unpickled_codec_info)
self.assertEqual(codec_info.name, unpickled_codec_info.name)
self.assertEqual(
codec_info.incrementalencoder,
unpickled_codec_info.incrementalencoder
)
self.assertTrue(unpickled_codec_info._is_text_encoding)

# Test a CodecInfo with _is_text_encoding equal to false.
codec_info = codecs.lookup('base64')
for proto in range(pickle.HIGHEST_PROTOCOL + 1):
with self.subTest(protocol=proto):
pickled_codec_info = pickle.dumps(codec_info)
unpickled_codec_info = pickle.loads(pickled_codec_info)
self.assertIsNot(codec_info, unpickled_codec_info)
self.assertEqual(codec_info, unpickled_codec_info)
self.assertEqual(codec_info.name, unpickled_codec_info.name)
self.assertEqual(
codec_info.incrementalencoder,
unpickled_codec_info.incrementalencoder
)
self.assertFalse(unpickled_codec_info._is_text_encoding)


class StreamReaderTest(unittest.TestCase):

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The :class:`codecs.CodecInfo` object has been made copyable and pickleable.
Patched by Robert Lehmann and Furkan Onder.
Loading