gh-66143: Allow copying and pickling of CodecInfo object (GH-109235)

Co-authored-by: Robert Lehmann <mail@robertlehmann.de>
This commit is contained in:
Furkan Onder 2023-09-29 20:07:09 +03:00 committed by GitHub
parent 7d57288f6d
commit 3439cb0049
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 75 additions and 0 deletions

View File

@ -111,6 +111,9 @@ class CodecInfo(tuple):
(self.__class__.__module__, self.__class__.__qualname__, (self.__class__.__module__, self.__class__.__qualname__,
self.name, id(self)) self.name, id(self))
def __getnewargs__(self):
return tuple(self)
class Codec: class Codec:
""" Defines the interface for stateless encoders/decoders. """ Defines the interface for stateless encoders/decoders.

View File

@ -1762,6 +1762,76 @@ class CodecsModuleTest(unittest.TestCase):
file().close.assert_called() 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): class StreamReaderTest(unittest.TestCase):

View File

@ -0,0 +1,2 @@
The :class:`codecs.CodecInfo` object has been made copyable and pickleable.
Patched by Robert Lehmann and Furkan Onder.