Skip to content

gh-62040: Raise ValueError on invalid *errors* argument in several codecs #136611

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions Lib/encodings/base64_codec.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@
### Codec APIs

def base64_encode(input, errors='strict'):
assert errors == 'strict'
if errors != 'strict':
raise ValueError(f'Unsupported error handling mode: "{errors}" - must be "strict"')
return (base64.encodebytes(input), len(input))

def base64_decode(input, errors='strict'):
assert errors == 'strict'
if errors != 'strict':
raise ValueError(f'Unsupported error handling mode: "{errors}" - must be "strict"')
return (base64.decodebytes(input), len(input))

class Codec(codecs.Codec):
Expand Down
14 changes: 10 additions & 4 deletions Lib/encodings/bz2_codec.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,20 @@
import codecs
import bz2 # this codec needs the optional bz2 module !

### Codec Helpers

def _assert_strict(errors):
if errors != 'strict':
raise ValueError(f'Unsupported error handling mode: "{errors}" - must be "strict"')

### Codec APIs

def bz2_encode(input, errors='strict'):
assert errors == 'strict'
_assert_strict(errors)
return (bz2.compress(input), len(input))

def bz2_decode(input, errors='strict'):
assert errors == 'strict'
_assert_strict(errors)
return (bz2.decompress(input), len(input))

class Codec(codecs.Codec):
Expand All @@ -28,7 +34,7 @@ def decode(self, input, errors='strict'):

class IncrementalEncoder(codecs.IncrementalEncoder):
def __init__(self, errors='strict'):
assert errors == 'strict'
_assert_strict(errors)
self.errors = errors
self.compressobj = bz2.BZ2Compressor()

Expand All @@ -44,7 +50,7 @@ def reset(self):

class IncrementalDecoder(codecs.IncrementalDecoder):
def __init__(self, errors='strict'):
assert errors == 'strict'
_assert_strict(errors)
self.errors = errors
self.decompressobj = bz2.BZ2Decompressor()

Expand Down
6 changes: 4 additions & 2 deletions Lib/encodings/hex_codec.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@
### Codec APIs

def hex_encode(input, errors='strict'):
assert errors == 'strict'
if errors != 'strict':
raise ValueError(f'Unsupported error handling mode: "{errors}" - must be "strict"')
return (binascii.b2a_hex(input), len(input))

def hex_decode(input, errors='strict'):
assert errors == 'strict'
if errors != 'strict':
raise ValueError(f'Unsupported error handling mode: "{errors}" - must be "strict"')
return (binascii.a2b_hex(input), len(input))

class Codec(codecs.Codec):
Expand Down
6 changes: 4 additions & 2 deletions Lib/encodings/quopri_codec.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@
from io import BytesIO

def quopri_encode(input, errors='strict'):
assert errors == 'strict'
if errors != 'strict':
raise ValueError(f'Unsupported error handling mode: "{errors}" - must be "strict"')
f = BytesIO(input)
g = BytesIO()
quopri.encode(f, g, quotetabs=True)
return (g.getvalue(), len(input))

def quopri_decode(input, errors='strict'):
assert errors == 'strict'
if errors != 'strict':
raise ValueError(f'Unsupported error handling mode: "{errors}" - must be "strict"')
f = BytesIO(input)
g = BytesIO()
quopri.decode(f, g)
Expand Down
6 changes: 4 additions & 2 deletions Lib/encodings/uu_codec.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
### Codec APIs

def uu_encode(input, errors='strict', filename='<data>', mode=0o666):
assert errors == 'strict'
if errors != 'strict':
raise ValueError(f'Unsupported error handling mode: "{errors}" - must be "strict"')
infile = BytesIO(input)
outfile = BytesIO()
read = infile.read
Expand All @@ -35,7 +36,8 @@ def uu_encode(input, errors='strict', filename='<data>', mode=0o666):
return (outfile.getvalue(), len(input))

def uu_decode(input, errors='strict'):
assert errors == 'strict'
if errors != 'strict':
raise ValueError(f'Unsupported error handling mode: "{errors}" - must be "strict"')
infile = BytesIO(input)
outfile = BytesIO()
readline = infile.readline
Expand Down
14 changes: 10 additions & 4 deletions Lib/encodings/zlib_codec.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,20 @@
import codecs
import zlib # this codec needs the optional zlib module !

### Codec Helpers

def _assert_strict(errors):
if errors != 'strict':
raise ValueError(f'Unsupported error handling mode: "{errors}" - must be "strict"')

### Codec APIs

def zlib_encode(input, errors='strict'):
assert errors == 'strict'
_assert_strict(errors)
return (zlib.compress(input), len(input))

def zlib_decode(input, errors='strict'):
assert errors == 'strict'
_assert_strict(errors)
return (zlib.decompress(input), len(input))

class Codec(codecs.Codec):
Expand All @@ -26,7 +32,7 @@ def decode(self, input, errors='strict'):

class IncrementalEncoder(codecs.IncrementalEncoder):
def __init__(self, errors='strict'):
assert errors == 'strict'
_assert_strict(errors)
self.errors = errors
self.compressobj = zlib.compressobj()

Expand All @@ -42,7 +48,7 @@ def reset(self):

class IncrementalDecoder(codecs.IncrementalDecoder):
def __init__(self, errors='strict'):
assert errors == 'strict'
_assert_strict(errors)
self.errors = errors
self.decompressobj = zlib.decompressobj()

Expand Down
12 changes: 12 additions & 0 deletions Lib/test/test_codecs.py
Original file line number Diff line number Diff line change
Expand Up @@ -3128,6 +3128,18 @@ def test_uu_invalid(self):
# Missing "begin" line
self.assertRaises(ValueError, codecs.decode, b"", "uu-codec")

def test_invalid_error_input(self):
# decoders/encoders require errors == 'strict'

for encoding in bytes_transform_encodings:
with self.subTest(encoding=encoding):
encoder = codecs.getencoder(encoding)
decoder = codecs.getdecoder(encoding)

self.assertRaises(ValueError, encoder, 'in', errors='notstrict')
self.assertRaises(ValueError, decoder, 'in', errors='notstrict')



# The codec system tries to add notes to exceptions in order to ensure
# the error mentions the operation being performed and the codec involved.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
The ``base64_codec``, ``uu_codec``, ``quopri_codec``, ``hex_codec``,
``zlib_codec`` and ``bz2_codec`` now raise a :exc:`ValueError` when their
decoder/encoder is provided an *errors* parameter that is not equal to
``'strict'``.
Loading