Skip to content

gh-145980: Add support for alternative alphabets in the binascii module #145981

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
serhiy-storchaka merged 12 commits into from
Mar 20, 2026
+471 −350
Merged

gh-145980: Add support for alternative alphabets in the binascii module #145981

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
f47f4bd
gh-145980: Add support for alternative alphabets in the binascii module
serhiy-storchaka Mar 15, 2026
ce5bcd2
Update documentation.
serhiy-storchaka Mar 15, 2026
f59fffe
Update tests.
serhiy-storchaka Mar 15, 2026
33437a5
Refactoring: inline static functions for Base85.
serhiy-storchaka Mar 16, 2026
044fa5a
Merge branch 'main' into binascii-alphabet
serhiy-storchaka Mar 16, 2026
3caf10d
Regen global strings.
serhiy-storchaka Mar 16, 2026
c27319a
Fix Sphinx warnings.
serhiy-storchaka Mar 16, 2026
1abf3dd
Merge branch 'main' into binascii-alphabet
serhiy-storchaka Mar 16, 2026
4444158
Remove old tests.
serhiy-storchaka Mar 17, 2026
133505d
Remove less common alphabets.
serhiy-storchaka Mar 17, 2026
f0f5960
Merge branch 'main' into binascii-alphabet
serhiy-storchaka Mar 17, 2026
c609bbb
Merge branch 'main' into binascii-alphabet
serhiy-storchaka Mar 17, 2026
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
Prev Previous commit
Next Next commit
Update tests.
  • Loading branch information
@serhiy-storchaka
serhiy-storchaka committed Mar 15, 2026
commit f59fffe8e077dcdc616fe05a93f18647dfd79dd1
106 changes: 58 additions & 48 deletions Lib/test/test_binascii.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,43 @@ def test_exceptions(self):
self.assertIsSubclass(binascii.Incomplete, Exception)

def test_constants(self):
for name in ('BASE64_ALPHABET', 'URLSAFE_BASE64_ALPHABET',
'CRYPT_ALPHABET', 'BCRYPT_ALPHABET',
'UU_ALPHABET', 'XX_ALPHABET',
'BINHEX_ALPHABET'):
value = getattr(binascii, name)
self.assertIsInstance(value, bytes)
self.assertEqual(len(value), 64)
self.assertEqual(len(set(value)), 64)
self.assertEqual(binascii.BASE64_ALPHABET,
b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
b'abcdefghijklmnopqrstuvwxyz'
b'0123456789+/')
self.assertEqual(binascii.URLSAFE_BASE64_ALPHABET,
binascii.BASE64_ALPHABET[:-2] + b'-_')
self.assertEqual(binascii.CRYPT_ALPHABET,
b'./0123456789'
b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
b'abcdefghijklmnopqrstuvwxyz')
self.assertEqual(binascii.BCRYPT_ALPHABET,
b'./'
b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
b'abcdefghijklmnopqrstuvwxyz'
b'0123456789')
self.assertEqual(binascii.UU_ALPHABET, bytes(range(32, 32+64)))
self.assertEqual(binascii.XX_ALPHABET,
b'+-0123456789'
b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
b'abcdefghijklmnopqrstuvwxyz')
self.assertEqual(binascii.BINHEX_ALPHABET,
b'!"#$%&\'()*+,-012345689'
b'@ABCDEFGHIJKLMNPQRSTUVXYZ['
b'`abcdefhijklmpqr')

self.assertEqual(binascii.BASE85_ALPHABET,
b'0123456789'
b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
b'abcdefghijklmnopqrstuvwxyz'
b'!#$%&()*+-;<=>?@^_`{|}~')
self.assertEqual(binascii.ASCII85_ALPHABET, bytes(range(33, 33+85)))
self.assertEqual(binascii.Z85_ALPHABET,
b'0123456789'
b'abcdefghijklmnopqrstuvwxyz'
b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
b'.-:+=^!/*?&<>()[]{}@%$#')

for name in ('BASE85_ALPHABET', 'ASCII85_ALPHABET',
'Z85_ALPHABET'):
value = getattr(binascii, name)
Expand Down Expand Up @@ -323,10 +352,7 @@ def test_base64_alphabet(self):
b'ABCDEFGHIJKLMNPQRSTUVXYZ[`abcdefhijklmpqr')
data = self.type2test(self.rawdata)
encoded = binascii.b2a_base64(data, alphabet=alphabet)
std_alphabet = (b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
b'abcdefghijklmnopqrstuvwxyz'
b'0123456789+/')
trans = bytes.maketrans(std_alphabet, alphabet)
trans = bytes.maketrans(binascii.BASE64_ALPHABET, alphabet)
expected = binascii.b2a_base64(data).translate(trans)
self.assertEqual(encoded, expected)
self.assertEqual(binascii.a2b_base64(encoded, alphabet=alphabet), self.rawdata)
Expand All @@ -336,24 +362,17 @@ def test_base64_alphabet(self):
self.assertEqual(binascii.b2a_base64(data, alphabet=alphabet), b'\n')
self.assertEqual(binascii.a2b_base64(data, alphabet=alphabet), b'')

with self.assertRaises(TypeError):
binascii.b2a_base64(data, alphabet=None)
with self.assertRaises(TypeError):
binascii.a2b_base64(data, alphabet=None)
with self.assertRaises(TypeError):
binascii.b2a_base64(data, alphabet=alphabet.decode())
with self.assertRaises(TypeError):
binascii.a2b_base64(data, alphabet=alphabet.decode())
for func in binascii.b2a_base64, binascii.a2b_base64:
with self.assertRaises(TypeError):
func(data, alphabet=None)
with self.assertRaises(TypeError):
func(data, alphabet=alphabet.decode())
with self.assertRaises(ValueError):
func(data, alphabet=alphabet[:-1])
with self.assertRaises(ValueError):
func(data, alphabet=alphabet+b'?')
with self.assertRaises(TypeError):
binascii.a2b_base64(data, alphabet=bytearray(alphabet))
with self.assertRaises(ValueError):
binascii.b2a_base64(data, alphabet=alphabet[:-1])
with self.assertRaises(ValueError):
binascii.a2b_base64(data, alphabet=alphabet[:-1])
with self.assertRaises(ValueError):
binascii.b2a_base64(data, alphabet=alphabet+b'?')
with self.assertRaises(ValueError):
binascii.a2b_base64(data, alphabet=alphabet+b'?')

def test_ascii85_valid(self):
# Test Ascii85 with valid data
Expand Down Expand Up @@ -645,9 +664,7 @@ def test_base85_alphabet(self):
b'ABCDEFGHIJKLMNOPQRSTUVWXYZ.-:+=^!/*?&<>()[]{}@%$#')
data = self.type2test(self.rawdata)
encoded = binascii.b2a_base85(data, alphabet=alphabet)
std_alphabet = (b'0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
b'abcdefghijklmnopqrstuvwxyz!#$%&()*+-;<=>?@^_`{|}~')
trans = bytes.maketrans(std_alphabet, alphabet)
trans = bytes.maketrans(binascii.BASE85_ALPHABET, alphabet)
expected = binascii.b2a_base85(data).translate(trans)
self.assertEqual(encoded, expected)
self.assertEqual(binascii.a2b_base85(encoded, alphabet=alphabet), self.rawdata)
Expand All @@ -657,24 +674,17 @@ def test_base85_alphabet(self):
self.assertEqual(binascii.b2a_base85(data, alphabet=alphabet), b'')
self.assertEqual(binascii.a2b_base85(data, alphabet=alphabet), b'')

for func in binascii.b2a_base85, binascii.a2b_base85:
with self.assertRaises(TypeError):
func(data, alphabet=None)
with self.assertRaises(TypeError):
func(data, alphabet=alphabet.decode())
with self.assertRaises(ValueError):
func(data, alphabet=alphabet[:-1])
with self.assertRaises(ValueError):
func(data, alphabet=alphabet+b'?')
with self.assertRaises(TypeError):
binascii.b2a_base85(data, alphabet=None)
with self.assertRaises(TypeError):
binascii.a2b_base85(data, alphabet=None)
with self.assertRaises(TypeError):
binascii.b2a_base85(data, alphabet=alphabet.decode())
with self.assertRaises(TypeError):
binascii.a2b_base85(data, alphabet=alphabet.decode())
with self.assertRaises(TypeError):
binascii.a2b_base85(data, alphabet=bytearray(alphabet))
with self.assertRaises(ValueError):
binascii.b2a_base85(data, alphabet=alphabet[:-1])
with self.assertRaises(ValueError):
binascii.a2b_base85(data, alphabet=alphabet[:-1])
with self.assertRaises(ValueError):
binascii.b2a_base85(data, alphabet=alphabet+b'?')
with self.assertRaises(ValueError):
binascii.a2b_base85(data, alphabet=alphabet+b'?')
binascii.a2b_base64(data, alphabet=bytearray(alphabet))

def test_uu(self):
MAX_UU = 45
Expand Down